Criar uma organização filha (parceiro)
Endpoint POST /organizations da API do Proteside: parâmetros, corpo da requisição, respostas e exemplos de código.
Cria uma organização com parent_org_id = a sua organização. O proprietário recebe um e-mail de convite (tolerante a falhas: veja owner_invite). As políticas de aprovação padrão são criadas. Só é permitido um nível de aninhamento.
bearerAuthAutorizaçãoBearer <token>Token de API criado em Configurações → API. Os escopos ficam vinculados ao token; cada operação lista o escopo exigido em x-scope.
Idempotency-Key?stringReproduz a resposta original por 24 h
1 <= length <= 255application/json- body
name*string2 <= length <= 120owner_email*stringemailplan?stringPlano da organização filha. essential é o plano Store (uma loja, 20.000 pageviews de checkout por mês, 7 dias de histórico, sem relatórios PCI). business_<n>k são as faixas do Business por pageviews mensais de checkout, de 50.000 a 500.000 (domínios e usuários ilimitados, 90 dias de histórico, relatórios PCI). enterprise tem limites sob medida. Os planos legados anteriores a outubro de 2026 (standard, growth, pro) não são mais aceitos aqui.
"business_100k""essential""business_50k""business_100k""business_150k""business_200k""business_250k""business_300k""business_400k""business_500k""enterprise"billing_mode?string"partner""partner""stripe"Criada
application/json- response
id?stringuuidname?stringplan?stringessential (Store), business_50k … business_500k (faixas do Business), enterprise, ou um plano legado (standard, growth, pro) em organizações criadas antes de outubro de 2026.
billing_mode?string"stripe""partner"parent_org_id?|uuidowner_email?|emailpartner_settings?created_at?stringdate-timeowner_invite?string"sent""existing_user""failed""skipped"curl -X POST "https://example.com/organizations" \ -H "Content-Type: application/json" \ -d '{ "name": "Loja do João", "owner_email": "joao@lojadojoao.com.br", "plan": "business_100k" }'{ "id": "7f3c1e2a-0b4d-4c8e-9f10-2a3b4c5d6e7f", "name": "Loja do João", "plan": "business_100k", "billing_mode": "partner", "parent_org_id": "a1b2c3d4-0000-4000-8000-000000000001", "owner_email": "joao@lojadojoao.com.br", "partner_settings": {}, "created_at": "2026-09-27T10:00:00.000Z", "owner_invite": "sent"}Evento de saída entregue na URL do seu webhook Webhook
Formato do evento que o Proteside envia para a URL do seu webhook: campos, tipos e exemplo de corpo.
Uso mensal (últimos 6 meses + mês atual) GET
Endpoint GET /organizations/{id}/usage da API do Proteside: parâmetros, corpo da requisição, respostas e exemplos de código.