API overview

The REST API uses JSON request and response bodies, standard HTTP status codes, and bearer authentication.

MoneyCopy Anchor Link

Amounts are integers in the smallest currency unit. 4900 in usd means $49.00.

PaginationCopy Anchor Link

List endpoints return up to limit items and a next_cursor. Pass it as cursor to get the next page.

let cursor: string | undefined;
do {
  const page = await client.referrals.list({ limit: 100, cursor });
  for (const referral of page.data) handle(referral);
  cursor = page.nextCursor ?? undefined;
} while (cursor);

IdempotencyCopy Anchor Link

Send an Idempotency-Key header with any POST request. If the same key is sent again within 24 hours, you get the original response instead of a duplicate.

Rate limitsCopy Anchor Link

Each key can make 100 requests per second in live mode. When you go over, you get a 429 with a Retry-After header.