WIwithflex
Coupons

List Coupons

Returns a list of your coupons. Optionally filter by name.

get/v1/coupons

Request

  • Base URL
    https://api.withflex.com
  • URL
    https://api.withflex.com/v1/coupons
  • Auth
    HTTP bearer

Query parameters

namestring nullable

Filter coupons by name.

Example:Example

Response

An envelope wrapping a list of coupon objects.

Example response

{
  "coupons": [
    {
      "coupon_id": "fcoup_1234567890",
      "amount_off": 2500,
      "applies_to": {
        "products": [
          "fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
        ]
      },
      "duration": "once",
      "duration_in_months": 0,
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "name": "Example",
      "percent_off": 0,
      "max_redemptions": 0,
      "times_redeemed": 0,
      "valid": false,
      "created_at": "2026-06-15T14:30:00Z",
      "test_mode": false
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.