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
Get all coupons
Get all coupons.
Required permissions:coupon:read
Authorizations
Value for the Authorization header parameter.
Query Parameters
The collection page number
The number of items per page
0 < x < 100
Response
The code that can be used to apply this coupon or to use it with the api.
The frequency at which a coupon should be applied.
Possible values:
once
: The coupon will be applied once for the first billing period.limited
: The coupon will be applied for a limited number of billing periods.lifetime
: The coupon will be applied forever.
The name of this coupon, which will be displayed to the user in the checkout process, customer front, etc.
The type of this coupon.
Possible values:
percentage
: A percentage will be taken off the total plan amount.fixed_amount
: A fixed amount will be taken off the total plan amount. It will never go below 0.
The date and time when the resource was created.
The date and time this coupon will expire. If null, there is no expiration date.
The fixed amount this coupon should apply. Required for type fixed_amount
.
The number of billing periods the coupon will be applied for. Required for frequency limited
.
The id of this coupon.
Whether this coupon is enabled or not.
The number of times this coupon can be redeemed in total. If null, there is no limit.
The percentage this coupon should apply. Required for type percentage
.
0 < x < 100
Has this coupon been redeemed by a customer? If yes, it cannot be edited or deleted anymore.
The date and time when the resource was last updated.
Was this page helpful?