Customers

Look up customers and their current entitlement state.

A customer is a single end user of your app, identified by the app_user_id you assign. The customer object is the authoritative answer to "what can this user access right now?" — its entitlements map reflects every validated purchase across the user's devices.

The customer object#

app_user_idstring

The identifier you assigned this user, e.g. u_812.

entitlementsobject

A map of entitlement ID to its current state for this customer.

Show entitlement state

is_activeboolean

Whether the entitlement currently grants access.

expires_atstring

ISO 8601 expiry, or null for lifetime access.

platformstring

The last-seen platform, e.g. ios or android.

countrystring

ISO 3166-1 alpha-2 country code from the last session, e.g. US.

last_seen_atstring

ISO 8601 timestamp of the customer's most recent SDK activity.

List customers#

GET /v1/apps/{app}/customers

Returns the app's customers, most recently active first. Supports limit and cursor pagination.

appstringrequired

The app ID.

limitinteger

Page size, up to 100.

cursorstring

Cursor from the previous page's next_cursor.

bash

curl "https://api.cashsdk.com/v1/apps/app_2mK4pQ/customers?limit=2" \
  -H "Authorization: Bearer csk_sk_..."

json

{
  "data": [
    {
      "app_user_id": "u_812",
      "entitlements": {
        "pro": { "is_active": true, "expires_at": "2026-08-17T18:24:05Z" }
      },
      "platform": "ios",
      "country": "US",
      "last_seen_at": "2026-07-17T18:24:05Z"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJpZCI6InVfODEyIn0"
}

Retrieve a customer#

GET /v1/apps/{app}/customers/{app_user_id}

Returns a single customer with their full entitlement state.

appstringrequired

The app ID.

app_user_idstringrequired

The customer's app_user_id, e.g. u_812.

bash

curl https://api.cashsdk.com/v1/apps/app_2mK4pQ/customers/u_812 \
  -H "Authorization: Bearer csk_sk_..."

json

{
  "app_user_id": "u_812",
  "entitlements": {
    "pro": { "is_active": true, "expires_at": "2026-08-17T18:24:05Z" }
  },
  "platform": "ios",
  "country": "US",
  "last_seen_at": "2026-07-17T18:24:05Z"
}

An unknown app_user_id returns 404 Not Found. A customer with no purchases still resolves once they've been seen by the SDK, with an empty entitlements map.

Next steps#

Entitlements

Grant or revoke access for a customer.

Transactions

See a customer's purchase history.