Copy page

Guides

Orders and revenue

Orders and revenue

Use read:orders to sync payment history into your CRM or reporting pipeline.

Operations

Operation	Scope	Description
LIST_ORDERS	read:orders	Paginated order list with filters
GET_ORDER	read:orders	Single order by Clearway order id

Both are wired on {docsEnv.apiBaseUrl} — see the API Reference.

List orders

Code
curl -s -X POST "{docsEnv.apiBaseUrl}/LIST_ORDERS" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit": 25, "lookbackDays": 90, "status": "paid"}'

Request body fields

Field	Type	Default	Notes
limit	number	25	Max rows per page (capped server-side)
lookbackDays	number	90	How far back to search
status	string	—	Optional filter (paid, pending, etc.)
cursor	string	—	Pagination cursor from a prior response

Response shape

Each order in orders is sanitized for integrators — no Stripe or internal provider ids. Typical fields:

• orderId, amountCents, currency, status
• customerEmail, customerName
• clearwayFeeCents, estimatedClearwayFeeCents
• paidAt, createdAt, countryCode
• checkoutSessionId, paymentLinkId (Clearway ids only)
• brandId — platform brand slug when multi-brand
• metadata — merchant-safe key/value pairs only

Get one order

Code
curl -s -X POST "{docsEnv.apiBaseUrl}/GET_ORDER" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"orderId": "YOUR_ORDER_UUID"}'

Missing or cross-tenant orders return 404 NOT_FOUND (no existence leak).

Multi-brand context

When your account has multiple platform brands, pass x-brand-id with the brand slug so list/get respect brand-scoped visibility. See Request headers.

Rate limits

API keys: 60 requests / 60 seconds per operation. See Rate limits.

Next steps

• Request headers — x-brand-id, x-cid
• API keys and scopes — grant read:orders
• API Reference — full request schemas