CustomerDiscounts
Get and delete the available discount of a Customer.
Table Specific Information
Select
Server-Side Query Support
The driver will use the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client side within the driver.
- CustomerId supports the following operator: =.
The provider supports all columns to be used as criteria in the WHERE clause of Select statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:
-Customers Discount list:
SELECT * FROM CustomerDiscounts WHERE CustomerId = 'cus_155dae52s'
Insert
Insert is not supported.
Update
Update is not supported.
Delete
To delete a discount for a Customer, specify the CustomerId:
DELETE FROM CustomerDiscounts WHERE CustomerId = 'cus_155dae52s'
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. | |
| Invoice | String | False |
The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. | |
| InvoiceItem | String | False |
The invoice item id (or invoice line item id for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. | |
| Subscription | String | False |
The subscription that this coupon is applied to, if it is applied to a particular subscription. | |
| PromotionCode | String | False |
The promotion code applied to create this discount.The promotion code applied to create this discount. | |
| 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. | |
| Name | String | False |
Name of the coupon displayed to customers on for instance invoices or receipts. | |
| DurationInMonths | Integer | False |
the number of months the coupon applies. | |
| 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. | |
| LiveMode | Boolean | False |
Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
| 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. | |
| MetadataAggregate | String | False |
Set of key-value pairs that you can attach to an object. |
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 |