Plans
Create, update, delete, and query the available Plans in Stripe.
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.
- Id, Created, and Product 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 retrieve:
-a Plan by specifying its Id:
SELECT * FROM Plans WHERE Id = 'gold'
-Plans created after a specific date(Created may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):
SELECT * FROM Plans WHERE Created > '2016-01-03'
Insert
Id, Name, Amount, Currency and Interval columns are required to create a new plan .
INSERT INTO Plans (Id,Name,Currency,Interval,IntervalCount,TrialPeriodDays,Amount) VALUES('123-a8z057u','Platinium Plan','usd','month',10,10,1)
Update
To update a plan, specify Id column.
UPDATE Plans SET Name = 'Test Plan',TrialPeriodDays=365,StatementDescriptor='RunClub Silver Plan' WHERE Id = '123easdas'
Delete
To delete a plan specify the Id of the plan.
DELETE FROM Plans WHERE Id = '123easdas5'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id of the plan. | |
| Active | Boolean | False |
Whether the plan can be used for new purchases. | |
| Amount | Int | False |
The amount in cents to be charged on the interval specified. | |
| AmountDecimal | Decimal | False |
The decimal value of amount in cents to be charged on the interval specified. | |
| UnitAmount | Decimal | False |
The amount in cents to be charged on the interval specified. | |
| AggregateUsage | String | False |
Specifies a usage aggregation strategy for plans of usage_type=metered. | |
| BillingScheme | String | False |
Describes how to compute the price per period. Either per_unit or tiered. | |
| Created | Datetime | True |
The creation date. | |
| Currency | String | False |
Currency in which subscription will be charged.. | |
| Nickname | String | False |
A brief description of the plan, hidden from customers. | |
| Product | String | False |
The product whose pricing this plan determines. | |
| 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. | |
| Interval | String | False |
One of day, week, month or year. The frequency with which a subscription should be billed. The allowed values are day, week, month. | |
| IntervalCount | Integer | False |
The number of intervals (specified in the interval property) between each subscription billing. For example, interval=month and interval_count=3 bills every 3 months. | |
| TrialPeriodDays | Integer | False |
Number of trial period days granted when subscribing a customer to this plan. Null if the plan has no trial period. | |
| MetadataAggregate | String | False |
Number of trial period days granted when subscribing a customer to this plan. Null if the plan has no trial period. | |
| TiersAggregate | String | False |
Each element represents a pricing tier. | |
| TiersMode | String | False |
Defines if the tiering price should be graduated or volume based. | |
| TransformUsageDivideBy | Integer | False |
Divide usage by this number. | |
| TransformUsageRound | String | False |
After division, either round the result up or down. | |
| UsageType | String | False |
Configures how the quantity per period should be determined. Can be either metered or licensed. |
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 plans for. |