Coupon
Get all redeemptions for a coupon
API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Coupon
Get all redeemptions for a coupon
Get all redeemptions for a coupon.
Required permissions:coupon:read
GET
/
coupons
/
{couponId}
/
redeemptions
curl -X GET \
/coupons/{couponId}/redeemptions \
--header "Authorization: Bearer <token>"
{
"data": [
{
"id": "<string>",
"redeemedAt": "2023-11-07T05:31:56Z",
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"name": "<string>"
},
"subscriptionItem": "https://example.com/"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}
Authorizations
Value for the Authorization header parameter.
Path Parameters
CouponRedemption identifier
Query Parameters
The collection page number
The number of items per page
Required range:
0 < x < 100
Response
200
application/json
CouponRedemption collection
Was this page helpful?
curl -X GET \
/coupons/{couponId}/redeemptions \
--header "Authorization: Bearer <token>"
{
"data": [
{
"id": "<string>",
"redeemedAt": "2023-11-07T05:31:56Z",
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"name": "<string>"
},
"subscriptionItem": "https://example.com/"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}