curl --request POST \
--url https://us.api.flexprice.io/v1/coupons/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"coupon_ids": [
"<string>"
],
"expand": "<string>",
"filters": [
{
"data_type": "string",
"field": "<string>",
"operator": "eq",
"value": {
"array": [
"<string>"
],
"boolean": true,
"date": "<string>",
"number": 123,
"string": "<string>"
}
}
],
"limit": 500,
"offset": 1,
"order": "asc",
"sort": [
{
"direction": "asc",
"field": "<string>"
}
],
"status": "published"
}
'{
"items": [
{
"amount_off": "<string>",
"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": "<string>",
"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
}
}Use when listing or searching coupons (e.g. promo management). Returns a paginated list; supports filtering and sorting.
curl --request POST \
--url https://us.api.flexprice.io/v1/coupons/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"coupon_ids": [
"<string>"
],
"expand": "<string>",
"filters": [
{
"data_type": "string",
"field": "<string>",
"operator": "eq",
"value": {
"array": [
"<string>"
],
"boolean": true,
"date": "<string>",
"number": 123,
"string": "<string>"
}
}
],
"limit": 500,
"offset": 1,
"order": "asc",
"sort": [
{
"direction": "asc",
"field": "<string>"
}
],
"status": "published"
}
'{
"items": [
{
"amount_off": "<string>",
"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": "<string>",
"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>*
Filter