Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Account Holders

Disable account holder

Disable an account holder. Related external and internal accounts will be disabled at the same time.

post/account_holders/{id}/disable

Path parameters

idstring required

The ID of the account holder.

Response

200

idstring uuid required

The UUID of the account holder.

namestring required

The name of the account holder

objectstring required

Type of the object, account_holder.

created_atstring date-time required

The UTC timestamp of the creation of this account holder.

disabled_atstring date-time

The UTC timestamp of the disabling of this account holder.

metadataobject

Additional client data in JSON format. See Metadata.

Example response

{
  "name": "EndCustomerCo",
  "object": "account_holder",
  "metadata": {
    "property_a": true,
    "property_b": "some text"
  }
}