Retrieve a customer

Retrieve a customer by ID for the authenticated workspace. To retrieve a customer by external ID, prefix the ID with ext_.

GET /customers/{id}

Python

Python

from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.customers.get(request={
        "id": "<id>",
    })

    # Handle response
    print(res)

200

{
  "id": "<string>",
  "name": "<string>",
  "externalId": "<string>",
  "createdAt": "<string>",
  "email": "<string>",
  "avatar": "<string>",
  "stripeCustomerId": "<string>",
  "country": "<string>",
  "sales": 123,
  "saleAmount": 123,
  "firstSaleAt": "<string>",
  "subscriptionCanceledAt": "<string>",
  "link": {
    "id": "<string>",
    "domain": "<string>",
    "key": "<string>",
    "shortLink": "<string>",
    "url": "<string>",
    "programId": "<string>"
  },
  "programId": "<string>",
  "partner": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "image": "<string>"
  },
  "discount": {
    "id": "<string>",
    "amount": 123,
    "maxDuration": 123,
    "couponId": "<string>",
    "couponTestId": "<string>",
    "description": "<string>",
    "partnersCount": 123
  }
}

Authorizations

Authorization · string · header · required

Default authentication mechanism

Path Parameters

id · string · required

The unique ID of the customer. You may use either the customer's id on Dub (obtained via /customers endpoint) or their externalId (unique ID within your system, prefixed with ext_, e.g. ext_123).

Query Parameters

includeExpandedFields · boolean

Whether to include expanded fields on the customer (link, partner, discount).

Response

200

application/json

The customer object.

id · string · required

The unique ID of the customer. You may use either the customer's id on Dub (obtained via /customers endpoint) or their externalId (unique ID within your system, prefixed with ext_, e.g. ext_123).

name · string · required

Name of the customer.

externalId · string · required

Unique identifier for the customer in the client's app.

createdAt · string · required

The date the customer was created (usually the signup date or trial start date).

email · string | null

Email of the customer.

avatar · string | null

Avatar URL of the customer.

stripeCustomerId · string | null

The customer's Stripe customer ID. This is useful for attributing recurring sale events to the partner who referred the customer.

country · string | null

Country of the customer.

sales · number | null

Total number of sales for the customer.

saleAmount · number | null

Total amount of sales for the customer.

firstSaleAt · string | null

The date the customer made their first sale. Useful for calculating the time to first sale and LTV.

subscriptionCanceledAt · string | null

The date the customer canceled their subscription. Useful for calculating LTV and churn rate.

link · object

Show child attributes

programId · string | null

partner · object

Show child attributes

discount · object

Show child attributes