Proteside Docs
Endpoint referenceOrganizations

Create a child organization (partner)

POST /organizations endpoint of the Proteside API: parameters, request body, responses and code samples.

POST
/organizations

Creates an organization with parent_org_id = your organization. The owner receives an invitation e-mail (tolerant to failure: see owner_invite). Default approval policies are seeded. Only one level of nesting is allowed.

Authorization

bearerAuth
headerAuthorizationBearer <token>

API token created in Settings → API. Scopes are attached to the token; each operation lists its required scope in x-scope.

Header Parameters

Idempotency-Key?string

Replays the original response for 24 h

Length1 <= length <= 255

Request Body

application/json
  1. body
name*string
Length2 <= length <= 120
owner_email*string
Formatemail
plan?string

Plan of the child organization. essential is the Store plan (one store, 20,000 checkout pageviews/month, 7 days of history, no PCI reports). business_<n>k are the Business tiers by monthly checkout pageviews, 50,000 to 500,000 (unlimited domains and users, 90 days of history, PCI reports). enterprise has custom limits. Legacy plans from before October 2026 (standard, growth, pro) are no longer accepted here.

Default"business_100k"
Value in"essential""business_50k""business_100k""business_150k""business_200k""business_250k""business_300k""business_400k""business_500k""enterprise"
billing_mode?string
Default"partner"
Value in"partner""stripe"

Response Body

Created

application/json
  1. response
id?string
Formatuuid
name?string
plan?string

essential (Store), business_50k … business_500k (Business tiers), enterprise, or a legacy plan (standard, growth, pro) on organizations created before October 2026.

billing_mode?string
Value in"stripe""partner"
parent_org_id?|
Formatuuid
owner_email?|
Formatemail
partner_settings?
created_at?string
Formatdate-time
owner_invite?string
Value in"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"}