curl --request GET \
--url https://api.hyperline.co/v1/promotion-codes \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0
},
"data": [
{
"id": "promo_DKL4Xcb5VSa8CQ",
"code": "PROMO123",
"coupon_id": "cou_DKL4Xcb5VSa8CQ",
"client_id": "cli_DKL4Xcb5VSa8CQ",
"customer_id": "cus_DKL4Xcb5VSa8CQ",
"plan_id": "plan_DKL4Xcb5VSa8CQ",
"product_id": "itm_DKL4Xcb5VSa8CQ",
"created_at": "2021-01-01T00:00:00.000Z",
"updated_at": "2021-01-01T00:00:00.000Z",
"expires_at": "2021-01-01T00:00:00.000Z",
"max_redemptions": 10,
"current_redemptions": 0,
"duration_count": 1,
"duration_period": "months",
"only_for_first_time_order": false
}
]
}
Retrieve all existing promotion codes.
curl --request GET \
--url https://api.hyperline.co/v1/promotion-codes \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0
},
"data": [
{
"id": "promo_DKL4Xcb5VSa8CQ",
"code": "PROMO123",
"coupon_id": "cou_DKL4Xcb5VSa8CQ",
"client_id": "cli_DKL4Xcb5VSa8CQ",
"customer_id": "cus_DKL4Xcb5VSa8CQ",
"plan_id": "plan_DKL4Xcb5VSa8CQ",
"product_id": "itm_DKL4Xcb5VSa8CQ",
"created_at": "2021-01-01T00:00:00.000Z",
"updated_at": "2021-01-01T00:00:00.000Z",
"expires_at": "2021-01-01T00:00:00.000Z",
"max_redemptions": 10,
"current_redemptions": 0,
"duration_count": 1,
"duration_period": "months",
"only_for_first_time_order": false
}
]
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
0 <= x <= 100
x >= 0
The response is of type object
.
Was this page helpful?