InvoiceDiscounts
Get the available discounts of invoices in Stripe.
Table Specific Information
Select
You can select from InvoiceDiscounts with the following queries:
SELECT * FROM InvoiceDiscounts WHERE Id = 'discount_1GhPzLJXTn'
SELECT * FROM InvoiceDiscounts WHERE Customer = 'cus_ABC123'
SELECT * FROM InvoiceDiscounts WHERE CouponPercentOff > 20.0
SELECT * FROM InvoiceDiscounts WHERE CouponValid = true
SELECT * FROM InvoiceDiscounts WHERE Start >= '2024-01-01'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the discount object. | |
| InvoiceId | String |
Invoices.Id | The Id of the Invoice, which the discount is attached to. |
| Customer | String | The Id of the Customer. | |
| Start | Datetime | Date that the coupon was applied. | |
| End | Datetime | If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null. | |
| Coupon | String | The Id of the coupon. | |
| CouponAmountOff | Integer | Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer. | |
| CouponCurrency | String | If amount_off has been set, the three-letter ISO code for the currency of the amount to take off. | |
| CouponName | String | Name of the coupon displayed to customers on, for instance, invoices or receipts. | |
| CouponCreatedAt | Datetime | The creation date. | |
| CouponDuration | String | Describes how long a customer who applies this coupon will get the discount. One of forever, once, and repeating. | |
| CouponDurationInMonths | Integer | If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once. | |
| CouponPercentOff | Decimal | 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 a percent_off of 50 will make a $100 invoice $50 instead. | |
| CouponRedeemBy | Datetime | Date after which the coupon can no longer be redeemed. | |
| CouponTimesRedeemed | Integer | Number of times this coupon has been applied to a customer. | |
| CouponValid | Boolean | Taking account of the above properties, whether this coupon can still be applied to a customer. | |
| CouponMaxRedemptions | Integer | Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. | |
| PromotionCode | String | The promotion code applied to create this discount. | |
| Subscription | String | The subscription that this coupon is applied to, if it is applied to a particular subscription. |
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 invoices for |