Fetch coupon
This endpoint retrieves a coupon by its ID. To fetch coupons by their redemption code, use the List coupons endpoint with the redemption_code parameter.
Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Response
A coupon represents a reusable discount configuration that can be applied either as a fixed or percentage amount to an invoice or subscription. Coupons are activated using a redemption code, which applies the discount to a subscription or invoice. The duration of a coupon determines how long it remains available for use by end users.
An archived coupon can no longer be redeemed. Active coupons will have a value of null for archived_at; this field will be non-null for archived coupons.
This allows for a coupon's discount to apply for a limited time (determined in months); a null value here means "unlimited time".
Also referred to as coupon_id in this documentation.
The maximum number of redemptions allowed for this coupon before it is exhausted; null here means "unlimited".
This string can be used to redeem this coupon for a given subscription.
The number of times this coupon has been redeemed.
Was this page helpful?