Skip to main content
GET
/
v1
/
coupons
List Coupons
curl --request GET \
  --url https://api.withflex.com/v1/coupons \
  --header 'Authorization: Bearer <token>'
{
  "coupons": [
    {
      "coupon_id": "fcoup_1234567890",
      "amount_off": 0,
      "duration_in_months": 0,
      "metadata": {},
      "name": "Example",
      "percent_off": 0,
      "max_redemptions": 0,
      "times_redeemed": 0,
      "valid": false,
      "created_at": "2024-01-01T00:00:00Z",
      "test_mode": false
    }
  ]
}

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

name
string | null

Filter coupons by name.

Example:

"Example"

Response

Success

coupons
object[]
required