List
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": "7ba1c401-9a59-45cd-bd42-ceeb0ca3dd1e",
"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": 1780925388,
"updated_at": 1780925388
},
{
"id": "ddc81737-7378-462a-a9f2-107425aeaa6b",
"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": 1780925388,
"updated_at": 1780925388
},
{
"id": "3f89efb9-1f88-477c-8dff-6399d7a5a78e",
"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": 1780925388,
"updated_at": 1780925388
}
]
}Coupons
List
Returns a list of your coupons.
GET
/
v1
/
coupons
List
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": "7ba1c401-9a59-45cd-bd42-ceeb0ca3dd1e",
"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": 1780925388,
"updated_at": 1780925388
},
{
"id": "ddc81737-7378-462a-a9f2-107425aeaa6b",
"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": 1780925388,
"updated_at": 1780925388
},
{
"id": "3f89efb9-1f88-477c-8dff-6399d7a5a78e",
"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": 1780925388,
"updated_at": 1780925388
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
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?
⌘I