Subaccounts
Disable Subaccount
Subaccounts
Disable Subaccount
Immediately disables a subaccount and transfers any remaining credits back to the parent account.
POST
/
v1
/
subaccounts
/
{subaccount_id}
/
disable
Headers
authorization
string
requiredYour API key for authentication.
Path Parameters
subaccount_id
string
requiredThe unique identifier of the subaccount to which you want to transfer credits.
Response
status
string
Whether the subaccount was successfully disabled.
subaccount_id
string
The affected subaccount’s unique identifier.
transferred_amount
number
The amount of credits transferred back to the parent account.
new_parent_balance
number
The new balance of the parent account after the transfer.