System Status

Customers

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.

Returns a list of customers

get

Get all customers

Query parameters
createdTimestring · date-timeOptional

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:

  • gt–return values where the createdTime field is after this timestamp
  • gte–return values where the createdTime field is after or equal to this timestamp
  • lt–return values where the createdTime field is before this timestamp
  • lte–return values where the createdTime field is before or equal to this timestamp
updatedTimestring · date-timeOptional

A 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:

  • gt–return values where the updatedTime field is after this timestamp
  • gte–return values where the updatedTime field is after or equal to this timestamp
  • lt–return values where the updatedTime field is before this timestamp
  • lte–return values where the updatedTime field is before or equal to this timestamp
endingBeforestringOptional

A 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.

startingAfterstringOptional

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.

limitinteger · min: 1 · max: 100Optional

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

emailstringOptional

Only return customers with the given email

idsstring[]Optional

Only return customers with the given IDs

requestToBeForgottenbooleanOptional

Only return customers where requestToBeForgotten is true or false

Responses
200

200 OK

application/json
get
/customers

Creates a new customer

post

Creates a new customer object

Body
idstringOptional

The unique identifier of a customer.

Example: 5823594808
emailstring · emailOptional

The customer email address.

Example: [email protected]
metadataany ofOptional
or
or
localestringOptional

A locale designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.

Example: en_US
typestring · enumOptional

The type of customer.

Example: individualPossible values:
enabledbooleanOptional

Usually used to disable the customer. The default is true. If false, attempts to create orders for the customer will fail.

Example: true
Responses
post
/customers

Gets a customer by ID

get

Retrieves the details of a customer by supplying the unique identifier of the customer

Path parameters
idstringRequired

Customer ID

Responses
200

200 OK

application/json
get
/customers/{id}

Updates an existing customer

post

Updates an existing customer

Path parameters
idstringRequired

Customer ID

Body
emailstring · emailOptional

The customer email address.

Example: [email protected]
defaultSourceIdstringOptional

The identifier of the default source attached to this customer.

Example: src_fd74a5c5-0163-469a-ae8e-031f0259b576
requestToBeForgottenbooleanOptional

If true, indicates this customer has submitted a request to be forgotten.

Example: true
typestring · enumOptional

The type of customer.

Example: individualPossible values:
metadataany ofOptional
or
or
localestringOptional

A locale designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code

Example: en_US
enabledbooleanOptional

Usually used to disable the customer. The default is true. If false, attempts to create orders for the customer will fail.

Example: true
Responses
200

200 OK

application/json
post
/customers/{id}

Deletes a customer by ID

delete

Permanently deletes a customer by supplying the unique identifier of the customer

Path parameters
idstringRequired

Customer ID

Responses
delete
/customers/{id}
No content

Attaches a source to a customer

post

Attaches a source to a customer

Path parameters
idstringRequired

Customer ID

sourceIdstring · uuidRequired

Source ID

Responses
200

200 OK

application/json
post
/customers/{id}/sources/{sourceId}

Detaches a source from a customer

delete

Detaches a source from a customer

Path parameters
idstringRequired

Customer ID

sourceIdstring · uuidRequired

Source ID

Responses
delete
/customers/{id}/sources/{sourceId}
No content
PreviousCountry specificationsNextEvents

Last updated