Update customer

Changes a customer's details. Send only what you want to change. The body has the same fields as Create customer.

What's replaced and what's kept

  • A field or block you leave out keeps its current value.
  • To clear a text field, such as phone, send an empty string ''. null is ignored and keeps the old value.
  • organisation: null removes the organisation.
  • shipping_address: null removes the shipping address and sets same_as_billing_address to false.
  • same_as_billing_address: true copies the billing address to the shipping address. Any shipping_address you send is then ignored.
  • tag_list replaces all the customer's tags. Send [] to remove every tag. Leave it out to keep them. To change only the tags, use Replace customer tags.
  • customer.status changes the status. Send active or dormant. Other values are ignored without an error, and the status doesn't change.

The response is the updated customer, without tags.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

Your merchant profile ID. Required in every request.

Find it in the BillPro dashboard address, after /profiles/. For example, in /profiles/1234/orders the profile ID is 1234.

string
required

ID of the customer.

Body Params

Every key is optional. Send only what you want to change.

customer
object

Optional. The customer's details.

organisation
object | null

Optional. The customer's company. Send null to remove it. If you send any field, send name too.

billing_address
object

Optional. The billing address.

shipping_address
object | null

Optional. The shipping address. Send null to remove it. Ignored when same_as_billing_address is true.

boolean

Optional. true uses the billing address as the shipping address. false saves the shipping_address you send.

tag_list
array of strings

Optional. The customer's complete list of tags. Replaces the current list. Send [] to remove every tag. Leave it out to keep the current tags.

tag_list
Responses

Language
Credentials
Bearer
API token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json