CustomerDiscounts
Columns
Name
Type
ReadOnly
References
Description
CustomerId [KEY]
String
False
The id of the subscription.
CouponId
String
False
The id of the coupon.
CreatedAt
Datetime
False
The creation date.
Start
Datetime
False
If the subscription has a trial, the beginning of that trial.
End
Datetime
False
If the subscription has a trial, the end of that trial.
Currency
String
False
If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
Duration
String
False
One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.
AmountOff
Integer
False
Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
PercentOff
Integer
False
Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $100 invoice $50 instead.
Valid
Boolean
False
Taking account of the above properties, whether this coupon can still be applied to a customer.
MaxRedemptions
Integer
False
Maximum number of times this coupon can be redeemed, in total, before it is no longer valid.
RedeemBy
Datetime
False
Date after which the coupon can no longer be redeemed.
TimesRedeemed
Integer
False
Number of times this coupon has been applied to a customer.
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name
Type
Description
AccountId
String
The Id of the connected account to get customer discounts for
Last updated