API Reference

Update child organization licensing

patch
{scheme}://{server}/v0/organizations/mine/child-organizations//licensing

Apply a desired license to a child organization. The requested license is evaluated against the organization's current billing state and the appropriate transition is applied.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

ID of the child organization whose licenses to update.

Body Params
licenses
array of objects
required
length between 1 and 1

Desired license to apply. Exactly one license per request is supported today; the array shape is reserved for future multi-SKU support.

licenses*
string
enum
required

Identifies the product to license. "sublime_email_security" is the only SKU available today.

Allowed:
string
required

Desired billing state for the license. Valid values: "trialing", "active", "canceled". Use "canceled" to downgrade an existing license back to free.

int32 | null
1 to 90

Length of the trial in days (only used when status is trialing.) If not set, the default trial length will be used.

Response

Updated about 2 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 2 months ago