Creating and updating customers
Learn how to create and update a customer.
Last updated
Learn how to create and update a customer.
Last updated
Once you define a customer, you can create a customer object and then associate the object with checkouts. Once the object is created, you can save one or more payment sources to a customer as well as set a customer's default payment source.
The following provides guidance on how to define a customer. For complete specifications, refer to the Checkouts API reference documentation.
A customers id
must be forty characters or less in length. Anything longer, and a 400 Bad Request
with a code
of invalid_parameter
is returned.
We recommend that a customer's identifier be identical in both your system and our system.
If you don't provide us an id
value in the create customer request, we generate one for you and return it in the response.
The email
parameter represents a customer's email address. You can create multiple customers in your account that contain identical email
values.
You can use shipping
to store a customer's name
, phone
, email
, organization
, basic ship to address
, and detailed ship to additionalAddressInfo
.
Every customer can store one or more tax identifiers and tax certificates.
A customer's locale
is used to localize invoices and credit memos.
A customer's type
allows you to differentiate between business and individual customers.
If you set a customer's enabled
flag to false
, then any attempts to create orders that reference this customer will fail. You should only set enabled
to false
when you want to block a customer from placing orders. For example, you may decide this is necessary when a customer has a history of fraudulent behavior.
The defaultSourceId
should reference a source that customers have indicated is their default payment instrument.
For more information, refer to setting the default payment source on the Managing sources page.
When you update customer requests, you can use requestToBeForgotten
to instruct Digital River to delete a customer's data from our system.
For more information, refer to the Recording a customer's request to be forgotten page.
The process of creating and updating a customer is similar. In a create customer request, you're allowed to specify the object's unique identifier. However, you must pass in this unique identifier as a path parameter when updating a customer.
Updating a customer's request also allows you to record a customer's right to be forgotten.
The following POST/customers
request specifies a unique id
:
A successful request returns a 201 Created
whose payload contains a customer object:
Once you create a customer, you can reference this object in registered checkouts.