Archive a customer

curl --request POST \
  --url https://api.metronome.com/v1/customers/archive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "8deed800-1b7a-495d-a207-6c52bac54dc9"
}
'

{
  "data": {
    "id": "8deed800-1b7a-495d-a207-6c52bac54dc9"
  }
}

Customers

Archive a customer

Use this endpoint to archive a customer while preserving auditability. Archiving a customer will automatically archive all contracts as of the current date and void all corresponding invoices. Use this endpoint if a customer is onboarded by mistake.

Usage guidelines:

Once a customer is archived, it cannot be unarchived.
Archived customers can still be viewed through the API or the UI for audit purposes.
Ingest aliases remain idempotent for archived customers. In order to reuse an ingest alias, first remove the ingest alias from the customer prior to archiving.
Any notifications associated with the customer will no longer be triggered.

POST

customers

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The ID of the customer to archive

string<uuid>

required

Response

Success

data

object

required

Show child attributes

Get an embeddable customer dashboard

Archive billing provider configurations for a customer

⌘I