Skip to main content
GET
Fetch coupon

Authorizations

Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

coupon_id
string
required

Response

OK

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.

id
string
required

Also referred to as coupon_id in this documentation.

Example:

"7iz2yanVjQoBZhyH"

redemption_code
string
required

This string can be used to redeem this coupon for a given subscription.

Example:

"HALFOFF"

discount
PercentageDiscount · object
required
times_redeemed
integer
required

The number of times this coupon has been redeemed.

duration_in_months
integer | null
required

This allows for a coupon's discount to apply for a limited time (determined in months); a null value here means "unlimited time".

Example:

12

max_redemptions
integer | null
required

The maximum number of redemptions allowed for this coupon before it is exhausted; null here means "unlimited".

archived_at
string<date-time> | null
required

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.