Clearway Documentation
  • Home
  • Guides
  • Merchant API
  • Investor Read API
Back to Merchant APIInformation
Analytics
    Read analyticspost
Checkout
    Create checkout sessionspostCreate payment intentpost
Customers
    Manage customerspost
Orders
    Get orderpostRead orderspost
Payment links
    Create payment linkspostList payment linkspost
Payments
    Preview platform feespostProcess refundspostResolve embed displaypost
Products
    Write merchant couponspostWrite productspostDelete productpostGet productpostRead merchant couponspostRead productspostUpdate merchant couponpostUpdate productpost
Subscriptions
    Cancel subscriptionspostChange subscription planspostRead subscriptionspostPreview subscription plan changespost
Schemas
powered by Zudoku
Clearway Documentation
Clearway Documentation

Customers

Download schema

Manage customers

POST
https://api-dev.clearway.to
/LIST_MERCHANT_CUSTOMERS

Dashboard-only — returns 403 API_GATEWAY_KEY_FORBIDDEN when called with an API key on the merchant API gateway. Use the Clearway dashboard instead. List merchant customers with lifetime stats and repeat purchase data. Requires the manage:customers scope (or full_access).

Manage customers › Headers

x-cid
​string

Optional correlation id for support trails.

x-brand-id
​string

Optional platform brand slug for multi-brand merchants.

Manage customers › Request Body

limit
​number
Additional properties are allowed

Manage customers › Responses

Success

MerchantApiSuccessEnvelope
success
​boolean · required
Additional properties are allowed
POST/LIST_MERCHANT_CUSTOMERS
curl https://api-dev.clearway.to/LIST_MERCHANT_CUSTOMERS \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "limit": 50 }'
Example Request Body
{ "limit": 50 }
json
application/json
Example Responses
{ "success": true }
json
application/json

CheckoutOrders