ShopEazydevelopers
API referenceMerchant API BetaBilling

How many extra seats or stores the business pays for

Beta
Credentials
  • OAuth access token
Scopes
billing:write
Role
Owners and admins only. Staff get 403 forbidden.
Subscription
Needs an active plan. Otherwise 403 subscription_locked.
Idempotency
Send an Idempotency-Key header. A retry with the same key does the work once.
PUT
/v1/merchant/stores/{storeId}/billing/extras/{kind}

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.

Authorization

merchantOAuth billing:write
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: billing:write

Path Parameters

storeId*string

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

kind*string
Value in"seats""stores"

Header Parameters

Idempotency-Key*string

Required on every write. Minted on the device when the person taps, reused on every retry. A write without one, or with one that does not match the pattern, is refused with 422 validation_error. Scoped to the token's subject, remembered 24 hours. A replay returns the first 2xx response with Idempotent-Replay: true; a request still running answers 409 in_flight; the same key with a different method, path or body answers 409 idempotency_key_reused; non-2xx results are not remembered. If the key store cannot be read nothing is processed and the answer is 503 idempotency_unavailable: retry with the same key.

Match^[A-Za-z0-9_-]{8,128}$

Request Body

application/json
  1. body
quantity*integer

How many extras in all, not how many more.

Range0 <= value <= 100

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PUT 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/billing/extras/<kind>' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{  "quantity": 1}'
Example Response
{  "data": {    "kind": "seats",    "quantity": 0,    "charged": {      "amount": 0,      "currency": "ZAR"    },    "endsAt": 0  }}

Switch an add-on on or off PUT

On charges the saved card pro-rata today. Off keeps the add-on working until the renewal that was paid for. Asks nothing: the caller quotes first (`getBillingQuote`) and confirms with the person. `billing:write` is opt-in on the OAuth consent screen. Access: OAuth scope `billing:write`; owner/admin only; write-gated by the subscription.

The credit balance and the last 30 credits in or out GET

Access: OAuth scope `store:read`; not write-gated.