The Price object
Attributes
- idstring
Unique identifier for the object.
- activeboolean
Whether the price can be used for new purchases.
- currencyenum
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- metadataobject
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.
- nicknamenullable string
A brief description of the price, hidden from customers.
- productstringExpandable
The ID of the product this price is associated with.
- recurringnullable object
The recurring components of a price such as
interval
andusage_type
. - typeenum
One of
one_time
orrecurring
depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. - unit_
amountnullable integer The unit amount in cents to be charged, represented as a whole integer if possible. Only set if
billing_scheme=per_unit
.
More attributes
- objectstring
- billing_
schemeenum - createdtimestamp
- currency_
optionsnullable objectExpandable - custom_
unit_ amountnullable object - livemodeboolean
- lookup_
keynullable string - tax_
behaviornullable enum - tiersnullable array of objectsExpandable
- tiers_
modenullable enum - transform_
quantitynullable object - unit_
amount_ decimalnullable decimal string
Create a price
Creates a new price for an existing product. The price can be recurring or one-time.
Parameters
- currencyenumRequired
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- activeboolean
Whether the price can be used for new purchases. Defaults to
true
. - metadataobject
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - nicknamestring
A brief description of the price, hidden from customers.
- productstringRequired unless product_data is provided
The ID of the product that this price will belong to.
- recurringobject
The recurring components of a price such as
interval
andusage_type
. - unit_
amountintegerRequired conditionally A positive integer in cents (or 0 for a free price) representing how much to charge. One of
unit_amount
orcustom_unit_amount
is required, unlessbilling_scheme=tiered
.
More parameters
- billing_
schemeenum - currency_
optionsobject - custom_
unit_ amountobjectRequired unless unit_amount is provided - lookup_
keystring - product_
dataobjectRequired unless product is provided - tax_
behaviorenum - tiersarray of objectsRequired if billing_scheme=tiered
- tiers_
modeenumRequired if billing_scheme=tiered - transfer_
lookup_ keyboolean - transform_
quantityobject - unit_
amount_ decimalstring
Returns
The newly created Price
object is returned upon success. Otherwise, this call raises an error.
Update a price
Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
Parameters
- activeboolean
Whether the price can be used for new purchases. Defaults to
true
. - metadataobject
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - nicknamestring
A brief description of the price, hidden from customers.
More parameters
- currency_
optionsobject - lookup_
keystring - tax_
behaviorenum - transfer_
lookup_ keyboolean
Returns
The updated price object is returned upon success. Otherwise, this call raises an error.
Retrieve a price
Retrieves the price with the given ID.
Parameters
No parameters.
Returns
Returns a price if a valid price or plan ID was provided. Raises an error otherwise.
List all prices
Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active
to false.
Parameters
- activeboolean
Only return prices that are active or inactive (e.g., pass
false
to list all inactive prices). - currencyenum
Only return prices for the given currency.
- productstring
Only return prices for the given product.
- typeenum
Only return prices of type
recurring
orone_time
.
More parameters
- createdobject
- ending_
beforestring - limitinteger
- lookup_
keysarray of strings - recurringobject
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
prices, starting after prices starting_after
. Each entry in the array is a separate price object. If no more prices are available, the resulting array will be empty.