Skip to navigation
API ReferenceCustomers

Update a customer

Updates the fields you send. currency and test_clock can’t change.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Path parameters

customer_idstringRequired

The customer ID (cus_...).

Request

This endpoint expects an object.
external_idstring or nullOptional<=255 characters
namestring or nullOptional
emailstring or nullOptionalformat: "email"
payment_providerstring or nullOptional
Always use this provider for the customer. Changing it doesn't move a payment method already saved at another provider.
metadatamap from strings to stringsOptional
Up to 50 keys of your own, with keys up to 40 characters and values up to 500 characters.

Response

The updated customer.
idstring
object"customer"
currencystring
metadatamap from strings to strings
Up to 50 keys of your own, with keys up to 40 characters and values up to 500 characters.
livemodeboolean
created_atdatetime
external_idstringOptional
namestringOptional
emailstringOptionalformat: "email"
subscriptionstringOptional
The customer's current subscription, if any.
test_clockstringOptional
payment_providerstringOptional
The provider this customer pays through. Set by you as an override, or set when the customer first saves a payment method, after which the customer stays with that provider. Routing rule changes don't move them.
payment_method_statusenumOptional

Present once the customer has saved a payment method. unusable means the provider that holds it was removed: the method is kept on record, marked unusable and never charged, and the customer needs to save a new one. Left out before they save one.

Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error