> ## Documentation Index > Fetch the complete documentation index at: https://docs.sequencehq.com/llms.txt > Use this file to discover all available pages before exploring further. # Archive customer > Archive a [customer](/customers/overview). ## OpenAPI ````yaml customer.2024-07-30.product.live POST /customers/{id}/archive openapi: 3.0.0 info: title: '' description: '' version: 0.0.1 servers: - url: https://dev.seqhq.io description: E2E - url: https://dev.seqhq.io description: DEV - url: https://sandbox.sequencehq.com description: SANDBOX - url: https://eu.sequencehq.com description: PRODUCTION security: [] tags: - name: Customer Aliases - name: Contacts - name: Organizations - name: Customers paths: /customers/{id}/archive: servers: [] parameters: [] post: tags: - Customers summary: Archive customer description: Archive a [customer](/customers/overview). operationId: postCustomersByIdArchive parameters: - name: id in: path description: Customer ID required: true schema: type: string - name: Authorization in: header description: >- Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`. required: true schema: type: string - name: sequence-version in: header description: Use this header to select an API version required: false schema: type: string enum: - '2024-07-30' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Customer' example: 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 addresses: - purposes: - BILLING address: line1: 7500 Bluewater Rd NW town: Albuquerque state: NY postcode: '87121' country: US - purposes: - SHIPPING address: line1: Flat 1 line2: 123 Fake Street town: New York state: NY postcode: AB1 2EF 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 archivedAt: '2025-08-28T12:00:00Z' taxStatus: TAXED contacts: - id: 9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc name: John Smith email: john.smith@example.com billingPreference: NONE purposes: [] notificationSubscriptions: [] createdAt: '2022-06-28T16:47:00Z' updatedAt: '2022-06-28T16:47:00Z' archivedAt: '2023-06-28T16:47:00Z' status: ACTIVE customProperties: region: EU tier: gold examples: Customer: summary: '' value: 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 addresses: - purposes: - BILLING address: line1: 7500 Bluewater Rd NW town: Albuquerque state: NY postcode: '87121' country: US - purposes: - SHIPPING address: line1: Flat 1 line2: 123 Fake Street town: New York state: NY postcode: AB1 2EF 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 archivedAt: '2025-08-28T12:00:00Z' taxStatus: TAXED contacts: - id: 9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc name: John Smith email: john.smith@example.com billingPreference: NONE purposes: [] notificationSubscriptions: [] createdAt: '2022-06-28T16:47:00Z' updatedAt: '2022-06-28T16:47:00Z' archivedAt: '2023-06-28T16:47:00Z' status: ACTIVE customProperties: region: EU tier: gold '400': description: Bad Request content: {} '401': description: Unauthorized content: {} '500': description: Internal Server Error content: {} components: schemas: Customer: required: - address - addresses - contacts - createdAt - customProperties - id - integrationIds - legalName - organizations - status - taxStatus type: object example: 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 addresses: - purposes: - BILLING address: line1: 7500 Bluewater Rd NW town: Albuquerque state: NY postcode: '87121' country: US - purposes: - SHIPPING address: line1: Flat 1 line2: 123 Fake Street town: New York state: NY postcode: AB1 2EF 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 archivedAt: '2025-08-28T12:00:00Z' taxStatus: TAXED contacts: - id: 9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc name: John Smith email: john.smith@example.com billingPreference: NONE purposes: [] notificationSubscriptions: [] createdAt: '2022-06-28T16:47:00Z' updatedAt: '2022-06-28T16:47:00Z' archivedAt: '2023-06-28T16:47:00Z' status: ACTIVE customProperties: region: EU tier: gold properties: id: type: string description: Unique ID example: e309e948-088e-4d77-b654-cd85498f1555 createdAt: type: string description: Time at which the customer was initially created, in ISO 8601 format example: '2021-01-02T10:55:00Z' organizations: type: array description: Organizations that this customer is a member of example: - 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 items: $ref: '#/components/schemas/CustomerOrganization' legalName: type: string description: Legal name example: Fintech Payment Processing address: $ref: '#/components/schemas/Address' deprecated: true addresses: type: array description: >- The customer's addresses, each with the purposes it serves. At most one address is BILLING and at most one SHIPPING, and one address can be both. Empty when the customer has no addresses. The deprecated address field holds the BILLING address, or a placeholder with an empty line1, town and postcode when there is none. example: - purposes: - BILLING address: line1: 7500 Bluewater Rd NW town: Albuquerque state: NY postcode: '87121' country: US - purposes: - SHIPPING address: line1: Flat 1 line2: 123 Fake Street town: New York state: NY postcode: AB1 2EF country: US items: $ref: '#/components/schemas/CustomerAddressModel' url: type: string description: URL nullable: true example: https://example.com/ domain: type: string description: Customer's primary domain name nullable: true example: example.com label: type: string description: Label nullable: true example: Example customer integrationIds: type: array description: External services which are linked to this customer example: - 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 items: $ref: '#/components/schemas/IntegrationId' archivedAt: type: string description: Time at which the customer was archived, in ISO 8601 format nullable: true example: '2025-08-28T12:00:00Z' taxStatus: $ref: '#/components/schemas/TaxStatus' description: >- Tax status applicable to customer. Can be one of TAXED, TAX_EXEMPT or REVERSE_CHARGED. The default is TAXED. contacts: type: array description: Contacts for this customer example: - id: 9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc name: John Smith email: john.smith@example.com billingPreference: NONE purposes: [] notificationSubscriptions: [] createdAt: '2022-06-28T16:47:00Z' updatedAt: '2022-06-28T16:47:00Z' archivedAt: '2023-06-28T16:47:00Z' items: $ref: '#/components/schemas/Contact' status: $ref: '#/components/schemas/CustomerStatus' description: >- Customer status: - DRAFT means the customer has been extracted from a contract and has not yet been approved. It cannot be used while it is in DRAFT. - ACTIVE is the default state when a customer is created via API or dashboard. customProperties: type: object description: Custom key-value properties for this customer example: region: EU tier: gold additionalProperties: type: string CustomerOrganization: required: - id - members - owner type: object example: 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 - id: e06f36e2-0a44-404d-bdbc-b66a292609b0 name: FinTech Wealth Management properties: id: type: string description: Organization ID example: c0dc4e79-ec52-4811-8cf5-addb2527915c owner: $ref: '#/components/schemas/CustomerIdWithName' members: type: array description: >- Members of the customer organization, excluding the owner. These are the children in a parent-child relationship. example: - id: e309e948-088e-4d77-b654-cd85498f1555 name: Fintech Payment Processing - id: 50af5191-05a3-42a5-802a-6b59091157af name: Fintech Lending Services - id: e06f36e2-0a44-404d-bdbc-b66a292609b0 name: FinTech Wealth Management items: $ref: '#/components/schemas/CustomerIdWithName' Address: required: - country - line1 - postcode - town type: object description: Address example: line1: Flat 1 line2: 123 Fake Street town: New York state: NY postcode: AB1 2EF country: US properties: line1: type: string description: Address line 1 example: Flat 1 line2: type: string description: Address line 2 nullable: true example: 123 Fake Street town: type: string description: Town or city example: New York state: $ref: '#/components/schemas/State' description: State or province (required for USA and Canada) nullable: true postcode: type: string description: Postal code example: AB1 2EF country: $ref: '#/components/schemas/CountryCode' description: >- Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias ("United Kingdom", "UK"), in any case. Response values always use the alpha-2 code. CustomerAddressModel: required: - address - purposes type: object example: purposes: - BILLING address: line1: Flat 1 line2: 123 Fake Street town: New York state: NY postcode: AB1 2EF country: US properties: purposes: type: array description: >- What this address is used for: BILLING, SHIPPING, or both when one address serves both. An address needs at least one purpose, and each purpose can be on only one address. example: - BILLING items: $ref: '#/components/schemas/AddressPurpose' address: $ref: '#/components/schemas/Address' IntegrationId: required: - id - isPending - service type: object example: service: Xero id: ID lastSynced: '2022-06-28T16:47:00Z' isPending: false properties: service: $ref: '#/components/schemas/IntegrationService' id: type: string example: ID lastSynced: type: string nullable: true example: '2022-06-28T16:47:00Z' isPending: type: boolean example: false TaxStatus: type: string example: TAXED enum: - TAXED - TAX_EXEMPT - REVERSE_CHARGED Contact: required: - billingPreference - createdAt - email - id - name - notificationSubscriptions - purposes - updatedAt type: object example: id: 9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc name: John Smith email: john.smith@example.com billingPreference: PRIMARY purposes: - BILLING - SHIPPING notificationSubscriptions: - BILLING createdAt: '2022-06-28T16:47:00Z' updatedAt: '2022-06-28T16:47:00Z' archivedAt: '2023-06-28T16:47:00Z' properties: id: type: string description: Unique ID example: 9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc name: type: string description: Full name of this contact example: John Smith email: type: string description: Email address of this contact example: john.smith@example.com billingPreference: $ref: '#/components/schemas/ContactBillingPreference' description: >- Deprecated: use purposes and notificationSubscriptions. PRIMARY for the billing contact, STANDARD for a contact subscribed to BILLING notifications that is not the billing contact, NONE otherwise. deprecated: true purposes: type: array description: >- The roles this contact fills for the customer: BILLING, SHIPPING, both, or none. A customer has exactly one billing contact and at most one shipping contact; giving a contact a purpose removes it from the contact that held it. example: - BILLING - SHIPPING items: $ref: '#/components/schemas/ContactPurpose' notificationSubscriptions: type: array description: >- The Sequence emails this contact receives. BILLING covers invoices, credit notes and payment reminders. The billing contact must be subscribed to BILLING. example: - BILLING items: $ref: '#/components/schemas/NotificationSubscription' createdAt: type: string description: Time of creation. Formatted as an ISO 8601 timestamp. example: '2022-06-28T16:47:00Z' updatedAt: type: string description: Time of last update. Formatted as an ISO 8601 timestamp. example: '2022-06-28T16:47:00Z' archivedAt: type: string description: Time of archive. Formatted as an ISO 8601 timestamp. nullable: true example: '2023-06-28T16:47:00Z' CustomerStatus: type: string example: ACTIVE enum: - DRAFT - ACTIVE CustomerIdWithName: required: - id - name type: object description: ID of the customer that will own the organization. example: id: 50af5191-05a3-42a5-802a-6b59091157af name: FinTech Solutions Inc. properties: id: type: string description: Customer ID example: 50af5191-05a3-42a5-802a-6b59091157af name: type: string description: Customer legal name example: FinTech Solutions Inc. State: type: string example: NY enum: - AL - AK - AZ - AR - CA - CO - CT - DC - DE - FL - GA - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VT - VA - WA - WV - WI - WY - AB - BC - MB - NB - NL - NS - NT - NU - 'ON' - PE - QC - SK - YT CountryCode: type: string example: US enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW AddressPurpose: type: string example: BILLING enum: - BILLING - SHIPPING IntegrationService: type: string example: Xero enum: - Amazon_Redshift - GoCardless - Google_BigQuery - Google_Sheets - HubSpot - NetSuite - QuickBooks_Online - Salesforce - Slack - Snowflake - Stripe - Xero - Avalara - Anrok - Attio - Numeral - Rillet - Sphere ContactBillingPreference: type: string example: PRIMARY enum: - PRIMARY - STANDARD - NONE ContactPurpose: type: string example: BILLING enum: - BILLING - SHIPPING NotificationSubscription: type: string example: BILLING enum: - BILLING ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.