Customers
Archive customer
Latest Live API
- Account
- Billing
- Collections
- Customer
- Customers
- Organizations
- Customer Aliases
- Contacts
- Invoices
- Notifications
- Product
- Quote
- Taxes
- Usage
Version 2024-07-30
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Quote
- Taxes
- Usage
Customers
Archive customer
Archive a customer.
POST
/
customers
/
{id}
/
archive
curl --request POST \
--url https://eu.sequencehq.com/api/customers/{id}/archive \
--header 'Authorization: <authorization>'
{
"id": "e309e948-088e-4d77-b654-cd85498f1555",
"createdAt": "2021-01-02T10:55:00Z",
"organizations": [
{
"id": "c0dc4e79-ec52-4811-8cf5-addb2527915c",
"owner": {
"id": "50af5191-05a3-42a5-802a-6b59091157af",
"name": "FinTech Solutions Inc."
},
"members": [
{
"id": "e309e948-088e-4d77-b654-cd85498f1555",
"name": "Fintech Payment Processing"
},
{
"id": "50af5191-05a3-42a5-802a-6b59091157af",
"name": "Fintech Lending Services"
}
]
}
],
"legalName": "Fintech Payment Processing",
"address": {
"line1": "7500 Bluewater Rd NW",
"town": "Albuquerque",
"state": "NY",
"postcode": "87121",
"country": "US"
},
"url": "https://example.com/",
"domain": "example.com",
"label": "Example customer",
"integrationIds": [
{
"service": "Xero",
"id": "2aaff66f-ef30-4599-b192-c168fd4cd226",
"lastSynced": "2024-03-28T16:47:00Z",
"isPending": false
},
{
"service": "Stripe",
"id": "cus_OCtCxqQDgu1uX9",
"lastSynced": "2024-03-28T16:47:00Z",
"isPending": false
}
],
"taxStatus": "TAXED",
"contacts": [
{
"id": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
"name": "John Smith",
"email": "john.smith@example.com",
"billingPreference": "NONE",
"createdAt": "2022-06-28T16:47:00Z",
"updatedAt": "2022-06-28T16:47:00Z",
"archivedAt": "2023-06-28T16:47:00Z"
}
],
"status": "ACTIVE"
}
Headers
Your API credentials. Eg. Basic {credentials}
.
Use this header to select an API version
Available options:
2024-07-30
Path Parameters
Customer ID
Response
200
application/json
OK
The response is of type object
.
curl --request POST \
--url https://eu.sequencehq.com/api/customers/{id}/archive \
--header 'Authorization: <authorization>'
{
"id": "e309e948-088e-4d77-b654-cd85498f1555",
"createdAt": "2021-01-02T10:55:00Z",
"organizations": [
{
"id": "c0dc4e79-ec52-4811-8cf5-addb2527915c",
"owner": {
"id": "50af5191-05a3-42a5-802a-6b59091157af",
"name": "FinTech Solutions Inc."
},
"members": [
{
"id": "e309e948-088e-4d77-b654-cd85498f1555",
"name": "Fintech Payment Processing"
},
{
"id": "50af5191-05a3-42a5-802a-6b59091157af",
"name": "Fintech Lending Services"
}
]
}
],
"legalName": "Fintech Payment Processing",
"address": {
"line1": "7500 Bluewater Rd NW",
"town": "Albuquerque",
"state": "NY",
"postcode": "87121",
"country": "US"
},
"url": "https://example.com/",
"domain": "example.com",
"label": "Example customer",
"integrationIds": [
{
"service": "Xero",
"id": "2aaff66f-ef30-4599-b192-c168fd4cd226",
"lastSynced": "2024-03-28T16:47:00Z",
"isPending": false
},
{
"service": "Stripe",
"id": "cus_OCtCxqQDgu1uX9",
"lastSynced": "2024-03-28T16:47:00Z",
"isPending": false
}
],
"taxStatus": "TAXED",
"contacts": [
{
"id": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
"name": "John Smith",
"email": "john.smith@example.com",
"billingPreference": "NONE",
"createdAt": "2022-06-28T16:47:00Z",
"updatedAt": "2022-06-28T16:47:00Z",
"archivedAt": "2023-06-28T16:47:00Z"
}
],
"status": "ACTIVE"
}