Skip to main content
PUT
Update Customer

Authorizations

Authorization
string
header
required

Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.

Path Parameters

provider_customer_id
string
required

Provider customer ID (e.g. test_customer_id).

Body

application/json
name
string

Customer name (non-empty).

email
string

Customer email (non-empty); normalized to lowercase and trimmed server-side.

phone
string

Customer phone (non-empty).

provider_default_invoice_payment_method_id
string

Provider payment-method ID to set as the default for future invoices.

address
object

Customer address. Optional fields: line1, line2, city, state, postal_code, country.

shipping
object

Shipping details. Requires name and address.line1; optional phone and the other address fields.

metadata
object

String key/value pairs.

Response

Success.

data
object
required