Get a coupon
/v1/projects/{project}/coupons/{coupon} in the Coupons API.
One coupon with its currency ISO code loaded. A coupon of another project, or a deleted one, is 404 RESOURCE_NOT_FOUND.
Three fields that are easy to misread
plan_ids: []means every plan, not no plans. An empty array is how the coupon itself reads an empty plan relation: the code applies to every plan in the project, including plans added later. Treating it as "restricted to nothing" inverts the meaning.
redemptions.remaining is derived, not stored. Prefer it over computing max_redemptions - count yourself. The quota counts settled redemptions plus reservations whose hold has not expired, so an in-flight checkout is already accounted for, and an abandoned one returns its slot without any sweeper job. Your own subtraction will disagree.
discount.value is a decimal string with four places: "25.0000" for 25% off, "10.0000" for ten of the coupon's currency. Parse it as a decimal, never a float. currency_id is null on a percentage coupon and set on a fixed-amount one, because a percentage applies to a plan in any currency and a fixed amount only to plans priced in its own.
currency (the ISO code) is present only when the relation is loaded: on a single read, a create and an update, not on every list row.
Requires ability
The token must hold this ability, or the call is refused with 403.
MCP tool
Runs the same action from an agent, behind the same ability.
Authorization
bearerToken A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.
In: header
Path Parameters
The project, resolved by the route binder.
uuidThe coupon, resolved within the project by the route binder.
uuidResponses
200OKapplication/json
The coupon.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.
404Not foundRESOURCE_NOT_FOUNDapplication/json
An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on