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",
"expiration": "time_limit",
"expiration_duration": 10,
"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     Integer     Not nullAmount in cents.
amount_currency     String     Not nullCurrency of the amount.
expiration     String     Not null
Expiration type.
Possible values
- time_limit
- no_expiration
expiration_duration     IntegerDuration of the coupon.
created_at     String     Not null    
ISO 8601 datetime in UTC
Date of coupon creation.