- Documentation
- API References
- Integrations
- Templates
- Blog
- FAQ
- GitHub
- Getting started
- Add-ons
- Analytics
- Billable metrics
- Coupons
- Credit notes
- Customer usage
- Customers
- Events
- Fees
- Invoices
- Organizations
- Plans
- Resources
- Subscriptions
- Taxes
- Wallets
- Webhook endpoints
- Webhooks
API Reference
Apply a coupon
This endpoint is used to apply a specific coupon to a customer, before or during a subscription.
https://{region}.getlago.com/api/v1
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The customer external unique identifier (provided by your own application)
Unique code used to identify the coupon.
The type of frequency for the coupon. It can have three possible values: once, recurring or forever.
- If set to
once, the coupon is applicable only for a single use. - If set to
recurring, the coupon can be used multiple times for recurring billing periods. - If set to
forever, the coupon has unlimited usage and can be applied indefinitely.
Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a recurring frequency type
The amount of the coupon in cents. This field is required only for coupon with fixed_amount type.
The currency of the coupon. This field is required only for coupon with fixed_amount type.
The percentage rate of the coupon. This field is required only for coupons with a percentage coupon type.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The customer external unique identifier (provided by your own application)
Unique code used to identify the coupon.
The type of frequency for the coupon. It can have three possible values: once, recurring or forever.
- If set to
once, the coupon is applicable only for a single use. - If set to
recurring, the coupon can be used multiple times for recurring billing periods. - If set to
forever, the coupon has unlimited usage and can be applied indefinitely.
once, recurring, forever Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a recurring frequency type
The amount of the coupon in cents. This field is required only for coupon with fixed_amount type.
The currency of the coupon. This field is required only for coupon with fixed_amount type.
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW The percentage rate of the coupon. This field is required only for coupons with a percentage coupon type.
Response
Unique identifier of the applied coupon, created by Lago.
Unique identifier of the coupon, created by Lago.
Unique code used to identify the coupon.
The name of the coupon.
Unique identifier of the customer, created by Lago.
The customer external unique identifier (provided by your own application)
The status of the coupon. Can be either active or terminated.
active, terminated The amount of the coupon in cents. This field is required only for coupon with fixed_amount type.
The remaining amount in cents for a fixed_amount coupon with a frequency set to once. This field indicates the remaining balance or value that can still be utilized from the coupon.
The currency of the coupon. This field is required only for coupon with fixed_amount type.
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW The percentage rate of the coupon. This field is required only for coupons with a percentage coupon type.
The type of frequency for the coupon. It can have three possible values: once, recurring or forever.
- If set to
once, the coupon is applicable only for a single use. - If set to
recurring, the coupon can be used multiple times for recurring billing periods. - If set to
forever, the coupon has unlimited usage and can be applied indefinitely.
once, recurring, forever Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a recurring frequency type
The remaining number of billing periods to which the coupon is applicable. This field determines the remaining usage or availability of the coupon based on the remaining billing periods.
The date and time after which the coupon will stop applying to customer's invoices. Once the expiration date is reached, the coupon will no longer be applicable, and any further invoices generated for the customer will not include the coupon discount.
The date and time when the coupon was assigned to a customer. It is expressed in UTC format according to the ISO 8601 datetime standard.
This field indicates the specific moment when the coupon amount is fully utilized or when the coupon is removed from the customer's coupon list. It is expressed in UTC format according to the ISO 8601 datetime standard.
Was this page helpful?