Coupons
Get and delete the available discount of a Subscription.
Table Specific Information
Select
Server-Side Query Support
The cmdlet uses 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 cmdlet.
- Id support the following operator =.
- CreatedAt support the following operators <,>>=,<=,=.
- AccountId support the following operator =.
You can select:
A specific coupon by specifying its Id:
SELECT * FROM Coupons WHERE Id = 'nReumrk6'
Insert
To create a new coupon, at least Duration is required. If Duration is set to 'repeating', DurationInMonths is also required:
INSERT INTO Coupons (Id, Duration, DurationInMonths, PercentOff, Currency) VALUES ('12345678', 'repeating', '12', '50', 'ALL')
Update
To modify a credit note, specify its Id:
Update Coupons set name = 'non-repeating' where Id = 'mIKfjEfL'
Delete
To delete a coupon, specify the Id field:
DELETE FROM Coupons WHERE Id = 'nReumrk6'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id of the coupon. | |
| CreatedAt | Datetime | True |
The creation date. | |
| 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 |
Describes how long a customer who applies this coupon will get the discount. One of forever, once, and repeating. | |
| DurationInMonths | Integer | False |
If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once. | |
| AmountOff | Integer | False |
Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer. | |
| PercentOff | Decimal | 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 a percent_off of 50 will make a $100 invoice $50 instead. | |
| Valid | Boolean | True |
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. | |
| MetadataAggregate | String | False |
The set of key/value pairs that you can attach to a coupon object. | |
| TimesRedeemed | Integer | True |
Number of times this coupon has been applied to a customer. | |
| Object | String | True |
String representing the object's type. Objects of the same type share the same value. | |
| AppliesTo | String | False |
Contains information about what this coupon applies to. This field is not included by default. To include it in the response, expand the applies_to field. | |
| Livemode | Boolean | True |
Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
| Name | String | False |
Name of the coupon displayed to customers on, for instance, invoices or receipts. |
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 |
| CurrencyOptions | String |
Coupons defined in each available currency option (only supported if amount_off is passed). Each key must be a three-letter ISO currency code and a supported currency. |
| AccountId | String |
The Id of the connected account to get coupons for. |