Skip to main content
GET
/
v1
/
coupons
List all coupons
curl --request GET \
  --url https://api.yorlet.com/v1/coupons \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "coupon",
      "amount_off": 123,
      "applies_to": {
        "invoice_item_types": [
          "<string>"
        ]
      },
      "currency": "<string>",
      "duration": "<string>",
      "duration_in_months": 123,
      "max_redemptions": 123,
      "metadata": {},
      "name": "<string>",
      "percent_off": 123,
      "redeem_by": 123,
      "valid": true,
      "account": "<string>",
      "deleted": false,
      "times_redeemed": 0
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

List all coupons

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
object[]
required