GET
/
coupons
/
{id}
Get a coupon by ID
curl --request GET \
  --url https://api.cloud.flexprice.io/v1/coupons/{id} \
  --header 'x-api-key: <api-key>'
{
  "amount_off": 123,
  "cadence": "once",
  "created_at": "<string>",
  "created_by": "<string>",
  "currency": "<string>",
  "duration_in_periods": 123,
  "environment_id": "<string>",
  "id": "<string>",
  "max_redemptions": 123,
  "metadata": {},
  "name": "<string>",
  "percentage_off": 123,
  "redeem_after": "<string>",
  "redeem_before": "<string>",
  "rules": {},
  "status": "published",
  "tenant_id": "<string>",
  "total_redemptions": 123,
  "type": "fixed",
  "updated_at": "<string>",
  "updated_by": "<string>"
}

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id
string
required

Coupon ID

Response

200
application/json

OK

The response is of type object.