Prices
Create, update, and query the available prices in Stripe.
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.
- 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 Price by specifying its Id:
SELECT * FROM Prices WHERE Id = 'price_1HeiRmATXQzBWNrlQOSoEytH'
-Prices 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
Currency, UnitAmount are required to create a price.
INSERT INTO Prices (Currency, Product, UnitAmount, RecurringAggregate, TiersAggregate) VALUES (usd, 'prod_CwgQxpzDYxStuZ', 10, '{\"interval\":\"month\", \"interval_count\": \"3\"}', '[{\"up_to\": \"1\", \"unit_amount_decimal\": \"1000\", \"flat_amount_decimal\": \"1000\" },{\"up_to\": \"inf\", \"unit_amount_decimal\": \"1500\", \"flat_amount_decimal\": \"1500\"}]')
Update
To update a price, specify Id column.
UPDATE Plans SET Active = false WHERE Id = 'price_1HeiRmATXQzBWNrlQOSoEytH'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id of the price. | |
| Active | Boolean | False |
Whether the price can be used for new purchases. | |
| BillingScheme | String | False |
Describes how to compute the price per period. | |
| Created | Datetime | True |
The creation date. | |
| Currency | String | False |
Currency in which subscription will be charged.. | |
| LiveMode | String | True |
Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
| LookupKey | String | False |
A lookup key used to retrieve prices dynamically from a static string. | |
| MetadataAggregate | String | False |
Set of key-value pairs that you can attach to an object. | |
| Nickname | String | False |
Products.Id |
A brief description of the plan, hidden from customers. |
| Product | String | False |
The ID of the product this price is associated with. | |
| RecurringAggregate | String | False |
The recurring components of a price such as interval and usage_type. | |
| Type | String | False |
Value is either 'one_time' or 'recurring' depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. | |
| TiersAggregate | String | False |
Array of elements representing a pricing tier. | |
| TiersMode | String | False |
Defines if the tiering price should be graduated or volume based. | |
| TransformQuantity | String | False |
Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with tiers. | |
| UnitAmount | Double | False |
The unit amount in paise to be charged, represented as a whole integer if possible. | |
| UnitAmountDecimal | String | False |
The unit amount in paise to be charged, represented as a decimal string | |
| Object | String | False |
String representing the object's type. Objects of the same type share the same value. | |
| Livemode | Boolean | False |
Tells if the dispute is in livemode. | |
| TaxBehavior | String | False |
Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed. |
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 prices for. |