Skip to main content

Coupon object

This object represents a coupon.

Schema

{
"coupon": {
"lago_id": "b7ab2926-1de8-4428-9bcd-779314ac129b",
"name": "coupon_name",
"code": "coupon_code",
"amount_cents": 5000,
"amount_currency": "USD",
"percentage_rate": null,
"coupon_type": "fixed_amount",
"frequency": "recurring",
"frequency_duration": 3,
"expiration": "time_limit",
"expiration_date": "2022-08-08",
"created_at": "2022-04-29T08:59:51Z"
}
}
AttributesDescription
lago_id     String     Not nullUnique identifier of the coupon in Lago application.
name     String     Not nullCoupon name.
code     String     Not nullCode identifying the coupon.
amount_cents     IntegerAmount in cents.
amount_currency     StringCurrency of the amount.
expiration     String     Not null
Expiration type.
Possible values
- time_limit
- no_expiration
expiration_date     String
ISO 8601 datetime in UTC
Expiration date of the coupon.
coupon_type     String     Not null
Coupon type.
Possible values
- fixed_amount
- percentage
percentage_rate     FloatPercentage rate of the coupon.
frequency     String     Not null
Frequency type.
Possible values
- once
- recurring
frequency_duration     IntegerIt determines the number of billing periods to which the coupon applies
created_at     String     Not null    
ISO 8601 datetime in UTC
Date of coupon creation.