ALalternativepayments
Customers

Patch customer

Changed on

Patch customer information (company, legal name, EIN, street address, sub-premise, city, state, postal code, country)

patch/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

Request body

citystring
countrystring
einstring
legal_namestring
namestring
postal_codestring
statestring
street_addressstring
sub_premisestring

Example request

{
  "city": "New York",
  "country": "USA",
  "ein": "12-3456789",
  "legal_name": "Acme Corporation Inc.",
  "name": "Acme Corp",
  "postal_code": "10001",
  "state": "NY",
  "street_address": "123 Main St, New York, NY 10001",
  "sub_premise": "Apt 1"
}

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