Schema2020-08-27object

subscription_schedule_configuration_item

A phase item describes the price and quantity of a phase.

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

SubscriptionScheduleConfigurationItem

object

A phase item describes the price and quantity of a phase.

billing_thresholds

optionalnullable

Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period

price

required

ID of the price to which the customer should be subscribed.

quantity integer

optional

Quantity of the plan to which the customer should be subscribed.

tax_rates array

optionalnullable

The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.

Root JSON Schema

{"description":"A phase item describes the price and quantity of a phase.","properties":{"billing_thresholds":{"anyOf":[{"$ref":"#/components/schemas/subscription_item_billing_thresholds"}],"description":"Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period","nullable":true},"price":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/price"},{"$ref":"#/components/schemas/deleted_price"}],"description":"ID of the price to which the customer should be subscribed.","x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/price"},{"$ref":"#/components/schemas/deleted_price"}]}},"quantity":{"description":"Quantity of the plan to which the customer should be subscribed.","type":"integer"},"tax_rates":{"description":"The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.","items":{"$ref":"#/components/schemas/tax_rate"},"nullable":true,"type":"array"}},"required":["price"],"title":"SubscriptionScheduleConfigurationItem","type":"object","x-expandableFields":["billing_thresholds","price","tax_rates"]}