Get coupon

Retrieve the details of an existing coupon.

GET /v1/coupons/{id}

Get coupon

cURL

curl --request GET \
  --url https://api.hyperline.co/v1/coupons/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "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",
  "discount_amount": 2000,
  "currency": "EUR",
  "deletedAt": "2024-12-20T16:04:11Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Response

200

application/json

Coupon amount

Coupon percent

id · string · required

Coupon ID.

Example:

"cou_DKL4Xcb5VSa8CQ"

name · string · required

Coupon name.

Example:

"Partner discount"

description · string | null · required

Coupon description.

Example:

null

expiration_date · string<date-time> | null · required

Date corresponding to the expiration of the coupon.

Example:

null

redemption_limit · number | null · required

Maximum number of subscriptions to which a single coupon can be applied.

Example:

null

product_ids · string[] · required

List of product IDs the coupon can be applied to. If empty, the coupon can be applied to any product.

Example:

[
  "itm_DKL4Xcb5VSa8CQ",
  "itm_1234567890abcdef"
]

created_at · string<date-time> · required

UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

type · enum<string> · required

Available options: amount

discount_amount · number · required

Amount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.

Example:

2000

currency · enum<string> | null · required

Currency code. See ISO 4217.

Available options: EUR, AED, AFN, XCD, ALL, AMD, AOA, ARS, USD, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, XOF, 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

Example:

"EUR"

deletedAt · string<date-time> | null · required

UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"