ShopEazydevelopers
API referenceMerchant API BetaBilling

The credit balance and the last 30 credits in or out

Beta
Credentials
  • OAuth access token
Scopes
store:read
GET
/v1/merchant/stores/{storeId}/billing/credits

Access: OAuth scope store:read; 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.

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/billing/credits' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "balance": 50,    "history": [      {        "occurredAt": 1792924376538,        "credits": 50,        "feature": null,        "reason": "Free trial credits"      }    ]  }}

How many extra seats or stores the business pays for PUT

More is charged pro-rata today on the saved card and works at once. Fewer applies at the renewal, and is refused while the business uses the room. `billing:write` is opt-in on the OAuth consent screen. Access: OAuth scope `billing:write`; owner/admin only; write-gated by the subscription.

Buy a credit pack on the saved card POST

Charges the card already on file. The `Idempotency-Key` is what keeps a retry from charging twice. A card is never typed into an app: with none saved the answer is `no_card`. `billing:write` is opt-in on the OAuth consent screen. Access: OAuth scope `billing:write`; owner/admin only; write-gated by the subscription.