ALalternativepayments
Customers

Archive a customer

Changed on

Archive a customer

delete/customers/{id}

Request

  • Base URL
    https://public-api.alternativepayments.io
  • URL
    https://public-api.alternativepayments.io/customers/{id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: customers:write

Path parameters

idstring required

Customer ID

Response

OK

citystring
countrystring
created_atstring
customer_integration_idstring
default_payment_method_idstring
einstring
emailstring
external_idstring
idstring
legal_namestring
namestring
postal_codestring
statestring
street_addressstring
sub_premisestring
tag_idsstring[] nullable

IDs of the tags applied to the customer; empty when it has none. null only on PATCH, archive or restore when the change succeeded but the tags couldn't be reloaded; GET the customer to read them.

Example response

{
  "tag_ids": [
    "0b8f3c5e-6d2a-4f1b-9a7e-3c4d5e6f7a8b"
  ]
}

Changes