Prices

Create, update, and query the available prices in Stripe.

Table Specific Information

Select

Server-Side Query Support

The driver uses 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 supports the following operator: =.
Active supports the following operator: =.
Created supports the following operators: =, >=, <=, >, <.
Currency supports the following operator: =.
LookupKey supports the following operator: =.
MetadataAggregate supports the following operator: =.
Product supports the following operator: =.
RecurringInterval supports the following operator: =.
RecurringUsageType supports the following operator: =.
Type supports the following operator: =.
AccountId supports the following operator: =.

You can select:

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

ProductId or ProductName, and Currency are required to create a price:

INSERT INTO Prices (Active, BillingScheme, LookupKey, Nickname, Currency, Product, RecurringInterval, RecurringAggregateUsage, RecurringIntervalCount, RecurringUsageType, TransformQuantityDivideBy, TransformQuantityRound, UnitAmount, TaxBehavior) VALUES (true, 'per_unit', 'def', 'test_insert', usd, 'prod_P8AoSHyvPlfYMp', 'month', 'max', 3, 'metered', 2, 'up', 10, 'unspecified')

INSERT INTO Prices (Active, BillingScheme, Currency, LookupKey, MetadataAggregate, Nickname, Product, RecurringInterval, RecurringAggregateUsage, RecurringIntervalCount, RecurringUsageType, Tiersmode, TiersAggregate) values (false, 'tiered', 'usd', 'TestKey5', '[{\"A\":\"BCD\",\"E\":\"FGH\",\"I\":\"JKL\"}]', 'Nickname1', 'prod_PDm7du7ErjMSwY', 'week', 'last_during_period', 5, 'metered', 'volume', '[{\"up_to\":\"inf\",\"flat_amount_decimal\":\"356\",\"unit_amount_decimal\":\"785\"}]')

Update

To update a price, specify the Id:

UPDATE Prices SET Active = false, MetadataAggregate = '{\"title\" : \"test price\"}'  WHERE Id = 'price_1HeiRmATXQzBWNrlQOSoEytH'

Delete

Delete is not supported.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		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.
CustomUnitAmountEnabled	Boolean	False		Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
CustomUnitAmountMaximum	Integer	False		The maximum unit amount the customer can specify for this item.
CustomUnitAmountMinimum	Integer	False		The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
CustomUnitAmountPreset	Integer	False		The starting unit amount which can be updated by the customer.
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		A brief description of the plan, hidden from customers.
Product	String	False	Products.Id	The Id of the product this price is associated with.
ProductDataName	String	False		These fields can be used to create a new product that this price will belong to. The product's name, meant to be displayable to the customer.
ProductDataActive	Boolean	False		These fields can be used to create a new product that this price will belong to. Whether the product is currently available for purchase. Defaults to true.
ProductDataMetadata	String	False		These fields can be used to create a new product that this price will belong to. Set of key-value pairs that you can attach to an object.
ProductDataStatementDescriptor	String	False		These fields can be used to create a new product that this price will belong to. An arbitrary string to be displayed on your customer's credit card or bank statement.
ProductDataTaxCode	String	False		These fields can be used to create a new product that this price will belong to. A tax code ID.
ProductDataUnitLabel	String	False		These fields can be used to create a new product that this price will belong to. A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
RecurringInterval	String	False		The frequency at which a subscription is billed. One of day, week, month or year. The allowed values are day, month, week, year.
RecurringAggregateUsage	String	False		Specifies a usage aggregation strategy for prices of usage_type=metered.
RecurringIntervalCount	Integer	False		The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
RecurringUsageType	String	False		Configures how the quantity per period should be determined. Can be either metered or licensed. Defaults to licensed. The allowed values are licensed, metered.
Type	String	True		Value is either 'one_time' or 'recurring' depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. The allowed values are one_time, recurring.
TiersAggregate	String	False		Array of elements representing a pricing tier.
TiersMode	String	False		Defines if the tiering price should be graduated or volume based.
TransformQuantityDivideBy	Integer	False		Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with tiers. Divide usage by this number.
TransformQuantityRound	String	False		Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with tiers. After division, either round the result up or down.
UnitAmount	Integer	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	True		String representing the object's type. Objects of the same type share the same value.
Livemode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
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.
ProductDataDefaultPrice	String	True		These fields can be used to view the fields of the product that this price will belong to. The ID of the Price object that is the default price for this product.
ProductDataDescription	String	True		These fields can be used to view the fields of the product that this price will belong to. The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
ProductDataObject	String	True		These fields can be used to view the fields of the product that this price will belong to. String representing the object’s type. Objects of the same type share the same value.
ProductDataCreated	Datetime	True		These fields can be used to view the fields of the product that this price will belong to. String representing the object’s type. Time at which the object was created.
ProductDataImages	String	True		These fields can be used to view the fields of the product that this price will belong to. A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
ProductDataLivemode	Boolean	True		These fields can be used to view the fields of the product that this price will belong to. Has the value true if the object exists in live mode or the value false if the object exists in test mode.
ProductDataMarketingFeatures	String	True		These fields can be used to view the fields of the product that this price will belong to. A list of up to 15 marketing features for this product. These are displayed in pricing tables.
ProductDataPackageDimensionsHeight	Double	True		These fields can be used to view the fields of the product that this price will belong to. Height, in inches.
ProductDataPackageDimensionsLength	Double	True		These fields can be used to view the fields of the product that this price will belong to. Length, in inches.
ProductDataPackageDimensionsWeight	Double	True		These fields can be used to view the fields of the product that this price will belong to. Weight, in inches.
ProductDataPackageDimensionsWidth	Double	True		These fields can be used to view the fields of the product that this price will belong to. Width, in inches.
ProductDataShippable	Boolean	True		These fields can be used to view the fields of the product that this price will belong to. Whether this product is shipped (i.e., physical goods).
ProductDataUpdated	Datetime	True		These fields can be used to view the fields of the product that this price will belong to. Time at which the object was last updated.
ProductDataUrl	String	True		These fields can be used to view the fields of the product that this price will belong to. A URL of a publicly-accessible webpage for this product.

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.
TransferLookupKey	Boolean	If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.

JDBC Driver for Stripe