POST/Organizations
Creates an organization with its first purchase (product lines and seats, a payment confirmation token or a
trial, billing address and the disclosure the user agreed to). The Idempotency-Key header is required; a
retry must reuse the same key. The creating user becomes OrganizationAdmin, takes a seat and joins the crew
database, and a billing customer record is created for the organization. Returns 201 with the organization
id and outcome Created, or outcome VerificationPending when the payment method is a bank account awaiting
micro-deposit verification: the organization then runs on a trial that converts to paid once the bank
verifies, and the response carries the hosted verification URL and the deposit arrival date. Returns 200
with outcome ActionRequired and a client secret when the payment needs extra authentication such as 3D
Secure, after which the request is retried with the same key; 402 when the payment is declined. Product ids
come from Billing_Get.
| Field | Type | Required | Description |
|---|
| Idempotency-Key | string | Optional | |
Request Body
| Field | Type | Required | Description |
|---|
| name | string | Optional | |
| lines | AddOrganizationRequestPurchaseLine[] | Optional | |
| confirmationTokenId | string | Optional | |
| consent | AddOrganizationRequestConsentRecord | Optional | |
| startTrial | boolean | Optional | |
| billingAddress | AddOrganizationRequestAddress | Optional | |
AddOrganizationRequestPurchaseLine
| Field | Type | Description |
|---|
| productId | uuid | |
| seats | integer | |
AddOrganizationRequestConsentRecord
| Field | Type | Description |
|---|
| disclosureVersion | string| null | |
| disclosedTerms | string| null | |
AddOrganizationRequestAddress
| Field | Type | Description |
|---|
| line1 | string| null | |
| line2 | string| null | |
| city | string| null | |
| state | string| null | |
| postalCode | string| null | |
| country | string| null | |
Response
| Field | Type | Description |
|---|
| outcome | string| null | |
| organizationId | uuid | |
| clientSecret | string| null | |
| hostedVerificationUrl | string| null | |
| verificationArrivalDate | date-time| null | |