curl --request GET \
--url https://{defaultHost}/v1/coupons \
--header 'Authorization: Bearer <token>'{
"object": "list",
"pagination": {
"count": 3,
"limit": 20,
"page": 1,
"url": "/v1/coupons"
},
"data": [
{
"id": "4b472812-3435-4f35-9ab9-dde9b2d71e06",
"object": "coupon",
"archived": false,
"archived_at": null,
"amount_off": 500,
"currency": "usd",
"duration": "once",
"duration_in_months": null,
"expired": false,
"metadata": {},
"max_redemptions": null,
"max_redemptions_per_customer": null,
"max_subtotal_amount": null,
"min_subtotal_amount": null,
"name": "Test Coupon",
"percent_off": null,
"product_ids": [],
"redeem_by": null,
"times_redeemed": 0,
"discarded_at": null,
"created_at": 1773903536,
"updated_at": 1773903536
},
{
"id": "299369c0-88d7-4b9c-8a4b-0c1265af64ea",
"object": "coupon",
"archived": false,
"archived_at": null,
"amount_off": 500,
"currency": "usd",
"duration": "once",
"duration_in_months": null,
"expired": false,
"metadata": {},
"max_redemptions": null,
"max_redemptions_per_customer": null,
"max_subtotal_amount": null,
"min_subtotal_amount": null,
"name": "Test Coupon",
"percent_off": null,
"product_ids": [],
"redeem_by": null,
"times_redeemed": 0,
"discarded_at": null,
"created_at": 1773903536,
"updated_at": 1773903536
},
{
"id": "5eba9c18-58a2-4dee-90ce-94c0cbbf7f4b",
"object": "coupon",
"archived": false,
"archived_at": null,
"amount_off": 500,
"currency": "usd",
"duration": "once",
"duration_in_months": null,
"expired": false,
"metadata": {},
"max_redemptions": null,
"max_redemptions_per_customer": null,
"max_subtotal_amount": null,
"min_subtotal_amount": null,
"name": "Test Coupon",
"percent_off": null,
"product_ids": [],
"redeem_by": null,
"times_redeemed": 0,
"discarded_at": null,
"created_at": 1773903536,
"updated_at": 1773903536
}
]
}Returns a list of your coupons.
curl --request GET \
--url https://{defaultHost}/v1/coupons \
--header 'Authorization: Bearer <token>'{
"object": "list",
"pagination": {
"count": 3,
"limit": 20,
"page": 1,
"url": "/v1/coupons"
},
"data": [
{
"id": "4b472812-3435-4f35-9ab9-dde9b2d71e06",
"object": "coupon",
"archived": false,
"archived_at": null,
"amount_off": 500,
"currency": "usd",
"duration": "once",
"duration_in_months": null,
"expired": false,
"metadata": {},
"max_redemptions": null,
"max_redemptions_per_customer": null,
"max_subtotal_amount": null,
"min_subtotal_amount": null,
"name": "Test Coupon",
"percent_off": null,
"product_ids": [],
"redeem_by": null,
"times_redeemed": 0,
"discarded_at": null,
"created_at": 1773903536,
"updated_at": 1773903536
},
{
"id": "299369c0-88d7-4b9c-8a4b-0c1265af64ea",
"object": "coupon",
"archived": false,
"archived_at": null,
"amount_off": 500,
"currency": "usd",
"duration": "once",
"duration_in_months": null,
"expired": false,
"metadata": {},
"max_redemptions": null,
"max_redemptions_per_customer": null,
"max_subtotal_amount": null,
"min_subtotal_amount": null,
"name": "Test Coupon",
"percent_off": null,
"product_ids": [],
"redeem_by": null,
"times_redeemed": 0,
"discarded_at": null,
"created_at": 1773903536,
"updated_at": 1773903536
},
{
"id": "5eba9c18-58a2-4dee-90ce-94c0cbbf7f4b",
"object": "coupon",
"archived": false,
"archived_at": null,
"amount_off": 500,
"currency": "usd",
"duration": "once",
"duration_in_months": null,
"expired": false,
"metadata": {},
"max_redemptions": null,
"max_redemptions_per_customer": null,
"max_subtotal_amount": null,
"min_subtotal_amount": null,
"name": "Test Coupon",
"percent_off": null,
"product_ids": [],
"redeem_by": null,
"times_redeemed": 0,
"discarded_at": null,
"created_at": 1773903536,
"updated_at": 1773903536
}
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Only return objects that are archived or not archived.
Only return objects with the given IDs.
A limit on the number of items to be returned, between 1 and 100.
The page of items you want returned.
The query to be used for full text search of this collection.
Was this page helpful?