Coupons
Get Coupons
Coupons
Get Coupons
Retrieve a list of coupons
GET
/
v1
/
coupons
X-Api-Key
string
*
X-Api-Key
Required
string
name
string
name
string
Filter coupons by name
curl --location --request GET 'https://client.corrily.com/v1/coupons'
{
"message": "Successfully retrieved all coupons.",
"success": true,
"coupons": [
{
"api_id": "coupon_1",
"name": "Coupon_1",
"currency": null,
"coupon_type": {
"coupon_type": "percentage"
},
"value": 10,
"active_from": null,
"active_till": null,
"org": 1,
"status": "ACTIVE",
"created_at": "2024-01-17T09:40:18.058647+00:00",
"updated_at": "2024-01-17T09:40:18.058647+00:00",
"coupon_external_coupons": []
}
]
}
Query Params
name
string
Filter coupons by name
Response
success
boolean
Whether or not the request completed successfully.
message
string
Text information about request status. In case of an error here will be a useful explanation.
coupons
array
An array of found coupons
coupon
object
A coupon object
api_id
string
Coupon’s api_id value
name
string
Coupon’s name
currency
string
Coupon’s currency. Can be null
coupon_type
object
Coupon_type object
coupon_type
string
Can be:
- ‘percentage’ for coupons with discount in percents.
- ‘fixed_amount’ for coupons with fixed discount
value
number
Coupon’s value for discount
active_from
string
ISODate value since which a coupon can be applied.
active_till
string
ISODate value until which a coupon can be used.
status
string
Coupon’s status. Can be: “ACTIVE” and “NOT_ACTIVE”
coupon_external_coupons
array
Attached to coupon external coupons
coupon_external_coupon
object
An external coupon object
external_coupon
object
External coupon object
source
string
External coupon source. Can be: “STRIPE”, “CHARGEBEE”, “RECURLY”
curl --location --request GET 'https://client.corrily.com/v1/coupons'
{
"message": "Successfully retrieved all coupons.",
"success": true,
"coupons": [
{
"api_id": "coupon_1",
"name": "Coupon_1",
"currency": null,
"coupon_type": {
"coupon_type": "percentage"
},
"value": 10,
"active_from": null,
"active_till": null,
"org": 1,
"status": "ACTIVE",
"created_at": "2024-01-17T09:40:18.058647+00:00",
"updated_at": "2024-01-17T09:40:18.058647+00:00",
"coupon_external_coupons": []
}
]
}