v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB

Coupons

List Coupons

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

get/v1/coupons

Query parameters

namestring nullable

Filter coupons by name.

Example:Example

Filter coupons by name.

Response

An envelope wrapping a list of coupon objects.

Example response

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