Skip to content
This repository has been archived by the owner on Dec 12, 2024. It is now read-only.

Latest commit

 

History

History
47 lines (31 loc) · 3.35 KB

AppliedCouponObject.md

File metadata and controls

47 lines (31 loc) · 3.35 KB
Raw

AppliedCouponObject

Properties

Name Type Description Notes
lagoId UUID Unique identifier of the applied coupon, created by Lago.
lagoCouponId UUID Unique identifier of the coupon, created by Lago.
couponCode String Unique code used to identify the coupon.
couponName String The name of the coupon.
lagoCustomerId UUID Unique identifier of the customer, created by Lago.
externalCustomerId String The customer external unique identifier (provided by your own application)
status StatusEnum The status of the coupon. Can be either `active` or `terminated`.
amountCents Integer The amount of the coupon in cents. This field is required only for coupon with `fixed_amount` type. [optional]
amountCentsRemaining Integer 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. [optional]
amountCurrency Currency [optional]
percentageRate String The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type. [optional]
frequency FrequencyEnum 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.
frequencyDuration Integer Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type [optional]
frequencyDurationRemaining Integer 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. [optional]
expirationAt OffsetDateTime 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. [optional]
createdAt OffsetDateTime 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.
terminatedAt OffsetDateTime 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. [optional]

Enum: StatusEnum

Name Value
ACTIVE "active"
TERMINATED "terminated"

Enum: FrequencyEnum

Name Value
ONCE "once"
RECURRING "recurring"