v5

OpenAPI 3.1.02026-08-025631,1012.8 MB
Organization Billing

Redeem Promo

Redeem a promo code on a FRESH org — no Checkout, no card (BACKE-2854).

Ethan directive 2026-07-22: a promo code must let the user continue without entering a CC. This creates the subscription server-side with the coupon attached (the self-serve twin of the manual comp flow), stamps metadata.organization_id so the subscription webhook grants tier + POC cap, and sets the org's plan fields inline so the user continues IMMEDIATELY (no webhook-latency paywall).

Only codes whose window bills $0 (percent_off=100 — every POC code by validated shape) can start service card-less: a partial discount with no payment method would generate a FAILING first invoice (service cut + dunning — strictly worse than the card form; the uncollectable shape POC-PROMO-CAP-2026-07-17 exists to prevent). Partial codes get a clear redirect to checkout, where the discount still applies. Card-ask happens at coupon end (finances' T-7d lifecycle).

Every failure carries a reason — never a silent no-op.

post/v1/organizations/billing/redeem-promo

Request body

codestring required
planstring

Plan slug to start on the comped window (product_tier, e.g. managed_build). Must be self-serve and match the code's product restriction.

Response

Successful Response

redeemedboolean required
codestring required
planstring required
account_typestring required
subscription_idstring required
poc_usage_cap_centsinteger nullable

POC promo usage ceiling (cents), granted via the subscription webhook (cap_source=poc_promo:*).

duration_in_monthsinteger nullable