Tableau Connector for Stripe

Build 21.0.7930

Coupons

Get and delete the available discount of a Subscription.

Table Specific Information

Select

Server-Side Query Support

The connector 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 connector.

  • Id, CreatedAt support the following operators <,>>=, <, <=, =.

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 retreive:

-Coupons list:

SELECT * FROM Coupons

-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

Update is not supported.

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

One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.

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 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 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 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 coupons for.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930