Book the Launch package on the saved card
- 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-Keyheader. A retry with the same key does the work once.
We set the shop up for the merchant, once per business. Charges the card already on file; a business that already booked it is not charged again (already: true). The Idempotency-Key keeps a retry from charging twice.
billing:write is opt-in on the OAuth consent screen.
Access: OAuth scope billing:write; owner/admin only; write-gated by the subscription.
merchantOAuth billing:writeAuthorizationBearer <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
storeId*stringA store the person can reach. Any other id answers 404, never 403.
Idempotency-Key*stringRequired 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.
^[A-Za-z0-9_-]{8,128}$OK
application/json- response
data*curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/billing/launch-package' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>'{ "data": { "booked": true, "already": true }}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.
What the business paid ShopEazy, fee invoices and recent sales and refunds GET
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.