GET
/
coupons
curl --request GET \
  --url https://api.withorb.com/v1/coupons \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "7iz2yanVjQoBZhyH",
      "redemption_code": "HALFOFF",
      "discount": {
        "discount_type": "percentage",
        "applies_to_price_ids": [
          "h74gfhdjvn7ujokd",
          "7hfgtgjnbvc3ujkl"
        ],
        "reason": "<string>",
        "percentage_discount": 0.15
      },
      "times_redeemed": 123,
      "duration_in_months": 12,
      "max_redemptions": 123,
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination_metadata": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:
20

The number of items to fetch. Defaults to 20.

Required range: 1 < x < 100
​
cursor
string | null

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

​
show_archived
boolean | null

Show archived coupons as well (by default, this endpoint only returns active coupons).

​
redemption_code
string | null

Filter to coupons matching this redemption code.

Response

200
application/json
OK
​
data
object[]
required

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.

​
pagination_metadata
object
required

Was this page helpful?

Fetch alertCreate coupon