API
Sign in

Prices

Create, retrieve, update, and list prices for products.

View as Markdown

A price defines the billing amount and interval for a product. One product can have many prices — for example, a monthly and an annual option for the same plan.

Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.

The price objectAsk

idstring

Unique identifier for the price, e.g. price_9Rz1wBqT.

productstringExpandable

The ID of the product this price belongs to, e.g. prod_7Kc4mNpQ. Expand to retrieve the full product object.

unit_amountinteger

The unit amount in the smallest currency unit (e.g. cents), e.g. 2900 for €29.00.

currencystring

Three-letter ISO currency code, e.g. EUR.

recurringobject

Billing frequency for subscription prices.

activeboolean

Whether the price can be used for new purchases. Defaults to true.

nicknamestring

An optional internal label for the price, e.g. "Monthly (legacy)".

createdinteger

Unix timestamp of when the price was created, e.g. 1716300000.

Create a priceAsk

Pass a product, unit_amount, currency, and optional recurring object to create a price. Omit recurring for one-time prices.

Retrieve a priceAsk

Update a priceAsk

Only active and nickname can be updated after creation. To change the amount, create a new price and archive the old one by setting active: false.

List pricesAsk

Returns a paginated list of prices. Filter by product to list all prices for a given product.

price.created and price.updated. See Events.

Was this page helpful?