curl --request GET \
--url https://api.hyperline.co/v1/coupons \
--header 'Authorization: Bearer <token>'{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0,
"approximateCount": false
},
"data": [
{
"id": "cou_DKL4Xcb5VSa8CQ",
"name": "Partner discount",
"description": null,
"expiration_date": null,
"redemption_limit": null,
"product_ids": [
"itm_DKL4Xcb5VSa8CQ",
"itm_1234567890abcdef"
],
"created_at": "2024-12-20T16:04:11Z",
"type": "amount",
"discount_amount": 2000,
"currency": "EUR"
}
]
}Retrieve existing coupons.
curl --request GET \
--url https://api.hyperline.co/v1/coupons \
--header 'Authorization: Bearer <token>'{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0,
"approximateCount": false
},
"data": [
{
"id": "cou_DKL4Xcb5VSa8CQ",
"name": "Partner discount",
"description": null,
"expiration_date": null,
"redemption_limit": null,
"product_ids": [
"itm_DKL4Xcb5VSa8CQ",
"itm_1234567890abcdef"
],
"created_at": "2024-12-20T16:04:11Z",
"type": "amount",
"discount_amount": 2000,
"currency": "EUR"
}
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
0 <= x <= 100x >= 0List of Coupon.
Show child attributes
Coupon ID.
"cou_DKL4Xcb5VSa8CQ"
Coupon name.
"Partner discount"
Coupon description.
null
Date corresponding to the expiration of the coupon.
null
Maximum number of subscriptions to which a single coupon can be applied.
null
List of product IDs the coupon can be applied to. If empty, the coupon can be applied to any product.
[
"itm_DKL4Xcb5VSa8CQ",
"itm_1234567890abcdef"
]amount Amount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.
2000
Currency code. See ISO 4217.
EUR, AED, AFN, XCD, ALL, AMD, AOA, ARS, USD, AUD, AWG, AZN, BAM, BBD, BDT, XOF, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, NOK, BWP, BYR, BZD, CAD, CDF, XAF, CHF, NZD, CLP, CNY, COP, CRC, CUP, CVE, ANG, CZK, DJF, DKK, DOP, DZD, EGP, MAD, ERN, ETB, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, XPF, NGN, NIO, NPR, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VEF, VND, VUV, WST, YER, ZAR, ZMW, ZWL "EUR"
Was this page helpful?