Docs/Billing/Preview a coupon

Preview a coupon

GET/v1/billing/coupon/{code}🔑 API key required

Check a promo code before subscribing: validity and the exact totals it produces for a plan/period.

Query parameters

FieldTypeDescription
planoptionalbuilder | scale | enterprisePlan to price against (default builder).
monthsoptional1 | 3 | 6 | 12Prepay length to price (default 1).

Response fields

FieldTypeDescription
validbooleanWhether the code can be redeemed right now (false → reason).
kind / valuestring / numberpercent (1-100) or fixed (USDC off per cycle).
durationCyclesnumber | nullHow many cycles stay discounted (null = every cycle).
discountedCycleUsdcnumberOne cycle's price with the coupon applied.
totalUsdcnumberExact total for the requested months (discounted + full cycles mixed).
409 with { valid: false, reason } when the code is expired/exhausted/not eligible for the plan. A code you already redeemed stays usable for you even when globally exhausted.