Platform APISubaccounts

Update a subaccount

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

subaccount_idstringRequired
Subaccount ID.

Request

This endpoint expects an object.
subaccount_namestringOptional
The name for the new subaccount. This should be a unique identifier that distinguishes it from other subaccounts within the main account.
invite_user_emailstringOptional
This is the email address of the user you wish to invite to the subaccount. When this optional parameter is filled in, a "sign in" link will be generated and sent back in the response. The user can use this link to sign in and set up their account.
permissionsobjectOptional
These settings define the initial configuration for various features of the subaccount
pricing_tiers_attachlist of objectsOptional
Pricing tier IDs that this subaccount can choose from when selecting a subscription plan.
pricing_tiers_detachlist of objectsOptional
Pricing tiers will be removed from this subaccount and will no longer be available for selection when choosing a subscription plan.
import_subscriptionobjectOptional
This section is used when you want to import an existing Stripe subscription for the subaccount
twilio_account_sidstringOptional
This is the Twilio SID of the subaccount.
twilio_auth_tokenstringOptional
This is the Twilio Token of the subaccount.
concurrencyintegerOptional
The maximum calls the subaccount can handle at once.
operation_typeenumOptional
The type of operation to perform. You can import objects from the parent workspace to a subaccount or return objects from a subaccount in some cases.
Allowed values:
productsobjectOptional

Objects to be imported to or returned from the subaccount_id

Response

200
statusstring or null
responseobject or null

Errors