curl --request GET \
--url https://api.cloud.flexprice.io/v1/coupons \
--header 'x-api-key: <api-key>'
{
"items": [
{
"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>"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123
}
}
Lists coupons with filtering
curl --request GET \
--url https://api.cloud.flexprice.io/v1/coupons \
--header 'x-api-key: <api-key>'
{
"items": [
{
"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>"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123
}
}
Enter your API key in the format x-api-key <api-key>*
1 <= x <= 1000
x >= 0
asc
, desc
published
, deleted
, archived
OK
The response is of type object
.