Skip to main content
GET
/
coupons
List Coupons
curl --request GET \
  --url https://api.atlas.co/functions/v1/coupons \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "coupon",
      "name": "<string>",
      "percent_off": 123,
      "amount_off": 123,
      "currency": "<string>",
      "duration": "<string>",
      "duration_in_months": 123,
      "max_redemptions": 123,
      "times_redeemed": 123,
      "redeem_by": 123,
      "applies_to": {
        "products": [
          "<string>"
        ]
      },
      "valid": true,
      "metadata": {},
      "created": 123
    }
  ],
  "has_more": true,
  "total_count": 123
}

Authorizations

Authorization
string
header
required

API key (sk_test_* or sk_live_*)

Query Parameters

limit
integer
default:10
Required range: x <= 100
offset
integer
default:0

Response

200 - application/json

Coupon list

object
enum<string>
Available options:
list
data
object[]
has_more
boolean
total_count
integer