v2

latestOpenAPI 3.0.0Commercial2026-07-2649110209.4 KB

Customers

Retrieve a customer

Retrieve customer information by ID or email. View purchase history, subscriptions, and profile details.

get/v1/customers

Query parameters

customer_idstring

Example:cust_1234567890

The unique identifier of the customer.

emailstring

Example:customer@example.com

The email address of the customer.

Response

Successfully retrieved the customer

idstring required

Unique identifier for the object.

mode'test' | 'prod' | 'sandbox' required

String representing the environment.

objectstring required

String representing the object’s type. Objects of the same type share the same value.

emailstring required

Customer email address.

namestring nullable

Customer name.

metadataobject nullable

Additional metadata associated with the customer.

countrystring nullable required

The ISO 3166-1 alpha-2 country code for the customer.

created_atstring date-time required

Creation date of the customer

updated_atstring date-time required

Last updated date of the customer

Example response

{
  "email": "user@example.com",
  "name": "John Doe",
  "metadata": {
    "key": "value"
  },
  "country": "US",
  "created_at": "2023-01-01T00:00:00Z",
  "updated_at": "2023-01-01T00:00:00Z"
}