API Reference (Max only)
Customers

Customers

A customer represents a Discord user who has subscribed to or paid for something on your server at least once. Customers are derived from subscription and invoice activity.

GET /v1/customers

List customers for the server.

Tier: B  ·  Auth: required  ·  Idempotent: N/A

Query parameters

ParameterTypeDescription
activebooleanIf true, only customers with at least one active subscription. If false, only customers without any active subscription. Omit to return all customers.
limitintegerPage size (max 100, default 50).
cursorstringPagination cursor.

Request

curl "https://subscord.com/api/v1/customers?active=true&limit=50" \
  -H "Authorization: Bearer ssk_live_..."

Response — 200 OK

{
  "data": [
    {
      "discordUserId": "987654321098765432",
      "username": "johndoe",
      "isActive": true,
      "totalPaid": 4995,
      "currency": "USD",
      "memberSince": "2025-08-12T10:32:01.000Z",
      "resubscribedCount": 5
    }
  ],
  "nextCursor": "eyJjdXN0b21lcklkIjoiOTg3NjU0..."
}

Performance note. Customer listing aggregates subscription and invoice data per customer. Prefer narrow filters (active=true) and reasonable page sizes — and cache the result in your system if you list frequently.

GET /v1/customers/{discordUserId}

Look up a single customer by their Discord user ID.

Tier: A  ·  Auth: required  ·  Idempotent: N/A

Path parameters

ParameterTypeDescription
discordUserIdstringThe Discord user ID (snowflake).

Request

curl https://subscord.com/api/v1/customers/987654321098765432 \
  -H "Authorization: Bearer ssk_live_..."

Response — 200 OK

{
  "discordUserId": "987654321098765432",
  "username": "johndoe",
  "isActive": true,
  "totalPaid": 4995,
  "currency": "USD",
  "memberSince": "2025-08-12T10:32:01.000Z",
  "resubscribedCount": 5
}

Errors

StatusCodeWhen
400invalid_requestdiscordUserId is missing.
404not_foundNo customer with that ID is known to Subscord.
404not_foundThe user exists in Subscord but has never subscribed to or paid on this server.

Field reference

FieldTypeDescription
discordUserIdstringThe customer's Discord user ID.
usernamestringThe customer's most recently observed Discord username.
isActivebooleantrue if the customer has at least one active subscription on this server.
totalPaidintegerSum of all completed payments by this customer on this server, in minor units of currency. See Conventions.
currencystringISO 4217 currency code. Defaults to "USD" if the customer has never paid.
memberSincestring | nullUTC ISO 8601 timestamp of the customer's earliest completed payment, or null if none.
resubscribedCountintegerNumber of completed invoices for this customer on this server.