API documentation
Integrations
Analytics
Billable events
Companies
Coupons > Promotion codes
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoices > Transactions
Invoicing entities
Organisations
Payments
Price configurations
Products
Quotes
Subscriptions
- GETGet subscriptions
- GETGet subscription
- GETGet subscription phases
- GETGet subscription phase
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCreate subscription
- PUTUpdate subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- POSTRefresh seat products
- POSTRefresh subscriptions
- POSTReinstate subscription
- POSTTransition subscription to next phase
Third-party apps
Wallets
Coupons
Get coupons
Retrieve all existing coupons.
GET
/
v1
/
coupons
curl --request GET \
--url https://api.hyperline.co/v1/coupons \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0
},
"data": [
{
"id": "cou_DKL4Xcb5VSa8CQ",
"name": "Partner discount",
"description": "<string>",
"expiration_date": "2024-10-13T02:00:00.000Z",
"redemption_limit": 123,
"created_at": "2024-12-20T16:04:11Z",
"type": "amount",
"discount_amount": 2000,
"currency": "EUR"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Required range:
0 <= x <= 100
Required range:
x >= 0
Response
200 - application/json
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.hyperline.co/v1/coupons \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0
},
"data": [
{
"id": "cou_DKL4Xcb5VSa8CQ",
"name": "Partner discount",
"description": "<string>",
"expiration_date": "2024-10-13T02:00:00.000Z",
"redemption_limit": 123,
"created_at": "2024-12-20T16:04:11Z",
"type": "amount",
"discount_amount": 2000,
"currency": "EUR"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.