Skip to main content
DELETE
Archive a customer
Archiving is not deletion. Ledger history and completed transfers keep their references to the customer.
There is no unarchive endpoint. A customer archived by mistake has to be created again, which mints a new identifier.

Error codes

Authorizations

Authorization
string
header
required

A secret API key, sent as Authorization: Bearer sk_test_… in sandbox or Bearer sk_live_… in live.

Path Parameters

customerId
string
required

Customer ULID. A 26-character ULID.

Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

Response

Archived. The response has no body.