Archive a merchant
Retires a merchant. Merchants are never deleted, because the documents already issued for them still need their branding: an archived merchant keeps rendering on those, but takes no new attribution — a tax calculation naming it is rejected. Idempotent, and the original archive time is kept. Returns the merchant with archived_at set.
Authorizations
API key authentication. Pass your API key as a Bearer token.
Headers
2026-04-01 A unique string used to ensure the request is processed exactly once. If you retry a request with the same idempotency key within 24 hours, the original response is returned without re-executing the operation.
255"ik_a1b2c3d4e5f6"
Path Parameters
Unique identifier for the merchant
Response
Success
When the merchant was created
"2026-08-01T10:00:00Z"
Name shown on the documents and emails issued for this merchant
"Northwind Traders"
Your own identifier for the merchant, unique within your organization
"acct_492"
Unique identifier for the merchant
"mrch_034DG8VMQwhPngo3S9mdKO"
When the merchant was last updated
"2026-08-01T12:30:00Z"
When the merchant was archived. Absent while the merchant is active; archived merchants take no new document attribution but keep rendering on historical documents.
"2026-08-20T12:00:00Z"
Square mark for places too small for the full logo, such as list rows
Logo shown beside yours in the header of documents and emails issued for this merchant
Support address shown to this merchant's buyers on its documents and emails
"support@northwind.example"