Close an account v2

POST / v2 / core / accounts /:id / close

Removes access to the Account and its associated resources. Closed Accounts can no longer be operated on, but limited information can still be retrieved through the API in order to be able to track their history.

Learn more about calling API v2 endpoints.

Parameters

• applied _ configurations array of enums Configurations on the Account to be closed. All configurations on the Account must be passed in for this request to succeed. Possible enum values customer The Account can be used as a customer. merchant The Account can be used as a merchant. recipient The Account can be used as a recipient.

Returns

Returns an Account object.

Error Codes

400 account _ not _ yet _ compatible _ with _ v2

Account is not yet compatible with V2 APIs.

400 accounts _ v2 _ access _ blocked

Accounts v2 is not enabled for your merchant.

400 cannot _ delete _ account _ with _ balance

Account with Merchant or Recipient configuration with transfers feature cannot be closed because the account has a cash balance.

400 cannot _ delete _ customer _ with _ available _ cash _ balance

Account with Customer configuration cannot be closed because the customer has a cash balance.

400 configs _ must _ match _ to _ close

Account cannot be closed without specifying the right configurations.

400 non _ connect _ platform _ accounts _ v2 _ access _ blocked

Needs to use the newer API version or onboard to Connect.

400 pending _ transactions _ cannot _ be _ deleted

Account cannot be closed due to other pending resources.

400 platform _ registration _ required

The direct merchant has not signed up for Connect and cannot create connected accounts.

400 stripe _ loss _ liable _ cannot _ be _ deleted

Account with Stripe-owned loss liability and dashboard cannot be deleted.

400 v1 _ account _ instead _ of _ v2 _ account

V1 Account ID cannot be used in V2 Account APIs.

400 v1 _ customer _ instead _ of _ v2 _ account

V1 Customer ID cannot be used in V2 Account APIs.

404 not _ found

The resource wasn’t found.

429 account _ rate _ limit _ exceeded

Account cannot exceed a configured concurrency rate limit on updates.

Response

{ "id": "acct_1Nv0FGQ9RKHgCVdK", "object": "v2.core.account", "applied_configurations": [ "merchant" ], "contact_email": "jenny.rosen@example.com", "created": "2024-11-26T16:33:03.000Z", "dashboard": "none", "display_name": "Jenny Rosen", "livemode": true, "metadata": {}}

Account event types v2

This is a list of all public thin events we currently send for updates to Account, which are continually evolving and expanding. The payload of thin events is unversioned. During processing, you must fetch the versioned event from the API or fetch the resource’s current state.

Event types

Type

Filter events by type

Type

v2. core. account. closed

This event occurs when an Account is closed.

v2. core. account. created

Occurs when an Account is created.

v2. core. account. updated

Occurs when an Account is updated.

v2. core. account[configuration. customer]. capability _ status _ updated

Occurs when the status of an Account 's customer configuration capability is updated.

v2. core. account[configuration. customer]. updated

Occurs when an Account 's customer configuration is updated.

v2. core. account[configuration. merchant]. capability _ status _ updated

Occurs when the status of an Account 's merchant configuration capability is updated.

v2. core. account[configuration. merchant]. updated

Occurs when an Account 's merchant configuration is updated.

v2. core. account[configuration. recipient]. capability _ status _ updated

Occurs when the status of an Account 's recipient configuration capability is updated.

v2. core. account[configuration. recipient]. updated

Occurs when a Recipient's configuration is updated.

v2. core. account[defaults]. updated

This event occurs when Account defaults are created or updated.

v2. core. account[future _ requirements]. updated

Occurs when an Account 's future requirements are updated.

v2. core. account[identity]. updated

Occurs when an Identity is updated.

v2. core. account[requirements]. updated

Occurs when an Account 's requirements are updated.