Docs

Add

POST /Organizations

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.

Headers

FieldTypeRequiredDescription
Idempotency-KeystringOptional

Request Body

FieldTypeRequiredDescription
namestringOptional
linesAddOrganizationRequestPurchaseLine[]Optional
confirmationTokenIdstringOptional
consentAddOrganizationRequestConsentRecordOptional
startTrialbooleanOptional
billingAddressAddOrganizationRequestAddressOptional

AddOrganizationRequestPurchaseLine

FieldTypeDescription
productIduuid
seatsinteger

AddOrganizationRequestConsentRecord

FieldTypeDescription
disclosureVersionstring| null
disclosedTermsstring| null

AddOrganizationRequestAddress

FieldTypeDescription
line1string| null
line2string| null
citystring| null
statestring| null
postalCodestring| null
countrystring| null

Response

FieldTypeDescription
outcomestring| null
organizationIduuid
clientSecretstring| null
hostedVerificationUrlstring| null
verificationArrivalDatedate-time| null