ShopEazydevelopers
API referenceMerchant API BetaBilling

What the business paid ShopEazy, fee invoices and recent sales and refunds

Beta
Credentials
  • OAuth access token
Scopes
store:read
Role
Owners and admins only. Staff get 403 forbidden.
GET
/v1/merchant/stores/{storeId}/billing/money

Subscription and credit charges, platform fee invoices, and the recent ledger over the last days days.

Access: OAuth scope store:read; owner/admin only; not write-gated.

Authorization

merchantOAuth store:read
headerAuthorizationBearer <token>

OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.

Scope: store:read

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

Query Parameters

days?integer
Range1 <= value <= 365
Default30

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/billing/money' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "days": 30,    "sales": {      "amount": 0,      "currency": "ZAR"    },    "refunds": {      "amount": 0,      "currency": "ZAR"    },    "paidToShopeazy": {      "amount": 0,      "currency": "ZAR"    },    "feeInvoices": [],    "ledger": []  }}