API reference · Schema
PromoRedemption
objectstringrequiredAlways `promo_redemption`: the type of this object
One of
promo_redemptionidstringrequiredUnique ID (`prdm_…`)
ID with prefix prdm_
amountstringrequiredInteger nano-USD as a decimal string
pattern ^-?[0-9]+$
expires_atstring (date-time)requiredWhen it expires (null: never) (ISO 8601, UTC)
Example
{
"object": "promo_redemption",
"id": "prdm_01jc5zq4m8k3v6x9t2w7r0b1e4",
"amount": "1500000000",
"expires_at": "2026-01-01T00:00:00.000Z"
}Used by
- Redeem a promo code for promotional credit
POST /v1/orgs/{org_id}/billing/promo-redemptions