SubscriptionItems
Create, update, delete, and query the available subscription items 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 and SubscriptionId support the following operator: =.
To query SubscriptionItems table, the Id of the subscription (SubscriptionId) whose items will be retrieved is required:
SELECT * FROM Subscriptions WHERE SubscriptionId = 'sub_A9WZGVTbvgBJ4t'
In addition to SubscriptionId, 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 SubscriptionItem by specifying its Id:
SELECT * FROM SubscriptionItems WHERE Id = 'sit_A9WZGVTbvgBJ4t'
Insert
SubscriptionId and PlanId columns are required to create a new subscription item.
INSERT INTO SubscriptionItems (SubscriptionId,PlanId,IsProrate,ProrationDate,Quantity) VALUES ('sub_A9YR1bLGFLQ5vV','gold $',true,2014-12-12,10)
Update
To update a subscription item, specify the Id column.
UPDATE SubscriptionItems SET PlanId = 'sub_A8TYczJcECr7Ph', IsProrate = false, ProrationDate = '2014-12-12', Quantity = 12 WHERE Id ='set_g155'
Delete
To delete a subscription item specify the Id of the item.
DELETE FROM SubscriptionItems WHERE Id = 'sit_A9WZGVTbvgBJ4t'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The Id of the subscription item. | |
| SubscriptionId | String | False |
The Id of the subscription. | |
| PlanId | String | False |
Plans.Id |
The Id of the plan. |
| Quantity | Double | False |
The quantity of the plan to which the customer should be subscribed. | |
| Created | Datetime | True |
Creation date. | |
| MetadataAggregate | String | False |
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. | |
| PriceId | String | False |
Prices.Id |
Unique identifier for the price. |
| Object | String | False |
String representing the object's type. Objects of the same type share the same value. | |
| BillingThresholdsUsageGte | Integer | False |
Usage threshold that triggers the subscription to create an invoice | |
| TaxRatesAggregate | String | False |
The tax rates which apply to this subscription_item. When set, the default_tax_rates on the subscription do not apply to this subscription_item. |
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 |
| IsProrate | Boolean |
Flag indicating whether to prorate switching plans during a billing cycle. |
| ProrationDate | Date |
If set, the proration will be calculated as though the subscription was updated at the given time. |
| AccountId | String |
The Id of the connected account to get subscription items for |