Offer API
Qty 1 · IncludedOne API for plans, access and offers. Your app asks what an account can do and gets one answer.
- GET/namespaces/acct_42/full-plan
- POST/namespaces/acct_42/usage/ai_credits/add
- POST/offers/spring_launch/checkout
- POST/cancel-sessions
{
"error": "limit_reached",
"message": "You've used 5,000 of 5,000 AI credits on the Pro plan…",
"offer": {
"plan": { "id": "team", "name": "Team" },
"interval": "month",
"price": 79,
"new_limit": 25000,
"checkout_url": "https://www.paypal.com/checkoutnow?token=…"
},
"retry_after_purchase": true
}- One call for access. The full plan merges the account's plan, offer extras and incentive into one list of features and limits.
- Usage metering. Count credits, seats and storage against each limit. At the limit, the API answers 402 with an upgrade and a checkout link.
- Signed webhooks. Plan changes, limit warnings and cancel saves, signed to the Standard Webhooks spec and retried when delivery fails.
- Keys for each side. A publishable key for the browser, a secret key for your server and short-lived account tokens for cancel flows.
- React SDK. Hooks and gates for access checks, plus headless checkout and cancel flow components you style like your app.
- OpenAPI spec. Browse every endpoint at
/docsor generate a client from/openapi.json.
