Skip to main content

List coupons​

This endpoint returns a list of all coupons for an account in a list format.

The list of coupons is ordered starting from the most recently created coupon. The response also includes pagination_metadata, which lets the caller retrieve the next page of results if they exist. More information about pagination can be found in the Pagination-metadata schema.

Query Parameters
    limit integer

    Possible values: >= 1 and <= 1000

    Default value: 20

    cursor string
    show_archived boolean
    redemption_code string
Responses

OK

Response Headers
    Schema
      data object[] required
    • Array [
      • id string required

      Also referred to as coupon_id in this documentation.

      redemption_code string required

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

      discount object required
      oneOf

      object

      times_redeemed integer required

      The number of times this coupon has been redeemed.

      duration_in_months integer nullable required

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

      max_redemptions integer nullable required

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

      archived_at date-time nullable 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.

    • ]
      • pagination_metadata object required
      has_more boolean required
      next_cursor string nullable required
    Loading...