Create a subaccount

View as Markdown
Create a subaccount for a tenant, customer, environment, or team. Optional limits can be provided inline.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Request

This endpoint expects an object.
namestringRequired1-200 characters
externalIdstringOptional1-200 characters
limitsobjectOptional
metadataobjectOptional

Response

Created
createdAtstring
defaultSpaceIdstringformat: "uuid"
idstring1-64 characters
Opaque identifier for a BCTRL subaccount.
limitsobject
namestring1-200 characters

Customer-facing resource name. 1–200 characters.

statusenum
updatedAtstring
archivedAtstring or nullOptional
externalIdstring or nullOptional
metadataobject or nullOptional
usageobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error