TDV Adapter for Stripe

Build 22.0.8462

SubscriptionDiscounts

Get and delete the available discount of a Subscription.

Table Specific Information

Select

Server-Side Query Support

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

  • SubscriptionId 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:

-Subscriptions Discount list:

SELECT * FROM SubscriptionDiscounts

Insert

Insert is not supported.

Update

Update is not supported.

Delete

To delete a discount for a Subscription, specify the SubscriptionId:

DELETE FROM SubscriptionDiscounts WHERE SubscriptionId = 'sub_155dae52s'

Columns

Name Type ReadOnly References Description
SubscriptionId [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.

Name String False

Name of the coupon displayed to customers on for instance invoices or receipts.

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

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.

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.

Object String False

String representing the object's type. Objects of the same type share the same value.

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.

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 line item id that the discount's coupon was applied to if it was applied directly to a invoice line item.

PromotionCode String False

The promotion code applied to create this discount.The promotion code applied to create this discount.

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 Subscription discounts for.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462