Skip to main content
GET
/
customers
/
{id}
JavaScript
import Limitry from '@limitry/sdk';

const client = new Limitry({
  apiKey: process.env['LIMITRY_API_KEY'], // This is the default and can be omitted
});

const customer = await client.customers.retrieve('id');

console.log(customer.id);
{
  "id": "<string>",
  "projectId": "<string>",
  "externalId": "<string>",
  "name": "<string>",
  "email": "<string>",
  "billingCycleStart": "2023-11-07T05:31:56Z",
  "timezone": "<string>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API Key or Personal Access Token (PAT). When using PAT, include X-Project header.

Path Parameters

id
string
required

Customer ID (internal or external)

Response

Customer found

id
string
required

Internal customer ID

projectId
string
required

Project ID

externalId
string
required

Your customer identifier

name
string | null
required

Customer name

email
string | null
required

Customer email

billingCycleStart
string<date-time>
required

Billing cycle start date (ISO 8601). Period boundaries are calculated from this date.

timezone
string | null
required

IANA timezone for billing calculations (e.g., America/New_York). Falls back to project default.

metadata
object
required

Custom metadata

createdAt
string<date-time>
required

Created timestamp

updatedAt
string<date-time>
required

Updated timestamp