v1

latestOpenAPI 3.0.22026-07-24800528.1 KB

Customers

List all customers

Returns a list of your customers. The customers are returned sorted by creation date by default, with the most recent customers appearing first.

get/v2/customers

Query parameters

min_createdinteger

Applies a minimum epoch timestamp (ms) filter to the response created_at.

max_createdinteger

Applies a maximum epoch timestamp (ms) filter to the response created_at.

order_by'-created_at' | 'created_at'

The field in which the results are ordered by. A - prefix denotes that the results are in descending order.

limitinteger

A limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 10.

starting_afterstring

A cursor for use in pagination, starting_after takes in an item key and the subsequent call will return the following items in the list. This is mutually exclusive with ending_before.

ending_beforestring

A cursor for use in pagination, ending_before takes in an item key and the subsequent call will return the prior items in the list. This is mutually exclusive with starting_after.

Response

Returns a list of your customers. The customers are returned sorted by creation date by default, with the most recent customers appearing first.

messagestring required

statusinteger required

Example response

{
  "data": {
    "items": [
      {
        "created_at": 1574181282399,
        "key": "cus_1h1QBVUg03Ij69",
        "updated_at": 1574181282399,
        "company": {
          "key": "co_UD9407hi0jFiFe",
          "name": "Nice Company"
        },
        "country_iso": "CA",
        "customer_key": "c7773gg-3355-53cf-3f3g-fefe4445",
        "partnership_key": "part_1234567",
        "shared_id": "fake_shared_id",
        "sub_ids": [
          "youtube"
        ]
      }
    ]
  }
}