Customers
Last updated
Last updated
The Customers resource is designed to manage customer data effectively by providing endpoints for various operations. It enables you to create new customer records, retrieve a list of existing customers, update details for specific customers, and remove customer records when necessary. This API is essential for maintaining accurate and up-to-date customer information within your application, ensuring seamless integration and efficient data handling.
Get all customers
/customers
A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
createdTime[gt]=2020-09-22T12:09:44ZA filter on the list based on the updatedTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
updatedTime[gt]=2020-09-22T12:09:44ZA cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.
A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.
A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
Only return customers with the given email
Only return customers with the given IDs
Only return customers where requestToBeForgotten is true or false
Creates a new customer object
/customers
The unique identifier of a customer.
5823594808The customer email address.
jsmith@digitalriver.comThe ship to addresss of the customer.
The identifier of the default source attached to this customer.
fd74a5c5-0163-469a-ae8e-031f0259b576Key-value pairs used to store additional data. Value can be string, boolean or integer types.
{"coupon":"iOS"}A locale designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.
en_USThe type of customer.
individualbusiness, individualUsually used to disable the customer. The default is <code>true</code>. If <code>false</code>, attempts to create orders for the customer will fail.
trueA list of tax identifiers for this customer.
Retrieves the details of a customer by supplying the unique identifier of the customer
/customers/{id}
Customer ID
Updates an existing customer
/customers/{id}
Customer ID
The customer email address.
jsmith@digitalriver.comThe ship to addresss of the customer.
The identifier of the default source attached to this customer.
fd74a5c5-0163-469a-ae8e-031f0259b576If <code>true</code>, indicates this customer has submitted a request to be forgotten.
trueThe type of customer.
individualbusiness, individualKey-value pairs used to store additional data. Value can be string, boolean or integer types.
{"coupon":"iOS"}A locale designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.
en_USUsually used to disable the customer. The default is <code>true</code>. If <code>false</code>, attempts to create orders for the customer will fail.
trueA list of tax identifiers for this customer.
Permanently deletes a customer by supplying the unique identifier of the customer
/customers/{id}
Customer ID
No body
Attaches a source to a customer
/customers/{id}/sources/{sourceId}
Customer ID
Source ID
Detaches a source from a customer
/customers/{id}/sources/{sourceId}
Customer ID
Source ID
No body