Retrieve

The UUID of the specific object.

A string describing the object type returned.

Whether or not this price accepts ad hoc amounts – also known as custom or user-defined amounts.

The maximum ad hoc amount in cents to be allowed, represented as a whole integer. For example 9900 is equivalent to $99.

The minimum ad hoc amount in cents to be allowed, represented as a whole integer. For example 9900 is equivalent to $99. If left blank, this will be interpreted as 0.

The amount in cents to be charged, represented as a whole integer. For example 9900 is equivalent to $99. If ad_hoc=true the amount is optional.

Whether or not this price is archived.

The max number of activations allowed per license. If null, this value will inherit from the value set on Product.

The price name, meant to be displayable to the customer.

Whether existing subscriptions can be switched to this price from the customer dashboard. If set to false, existing subscriptions cannot be switched to this price, preventing customers from upgrading or downgrading their subscription to this price option.

The ordering position of this price when displayed to customers.

The frequency at which a subscription is billed. One of day, week, month, or year. Only applicable during creation.

The number of intervals (specified in the recurring_interval attribute) between subscription billings. For example, recurring_interval=month and recurring_interval_count=3 bills every 3 months. The total duration of a billing cycle is not allowed to exceed 1 year. Only applicable during creation.

The number of periods a subscription with this price will renew for. After this amount of periods, the subscription will move to the complete state. Only applicable during creation.

The number of days after which the purchase associated with this price will be automatically revoked. This can be used to create time-limited access for a one-time or finite recurring price.

Whether or not purchases for this price should be revoked when subscriptions transition to the complete state.

Whether installment subscriptions using this price should be automatically restarted when they reach the completed state.

The amount in cents to be charged as a setup fee on the first billing period of a recurring price.

Whether or not this price has a setup fee.

The name that will display for the setup fee on the first billing period.

Whether or not the setup fee should be deferred until the trial period ends. If set to true, the setup fee will not be charged until the trial period ends.

The amount in cents that should be shown as the original amount before any price reductions, also known as the pre-sale price.

The default number of trial days when subscribing a customer to this price.

Time at which the object was archived. Measured in seconds since the Unix epoch.

Three-letter ISO currency code, in lowercase. This value will match the Account currency.

The full amount to be charged across all periods, represented as a whole integer. For prices without a recurring_period_count defined this is the same as amount. For finite prices, this is equal to amount * recurring_period_count. For example, a price that has an amount of $25 and is set to recur over 4 periods, will have a full_amount of $100.

Whether or not this object represents the current version of this price. (This will be false if the association was created to this price before it was altered. In this case, we will lookup the version of the price at the time it was associated.)

The current swap for this price.

Expandable – The associated swap ID.

Expandable – The associated product ID.

If present, subscriptions will be updated to this price when they renew.

Expandable – The associated price ID.

Time at which the object was discarded. Measured in seconds since the Unix epoch.

Time at which the object was created. Measured in seconds since the Unix epoch.

Time at which the object was last updated. Measured in seconds since the Unix epoch.