SubscriptionPhase

Describes a phase in a subscription plan variation.

For more information, see Subscription Plans and Variations.

Link to section

Properties

Link to section

uid

string

The Square-assigned ID of the subscription phase. This field cannot be changed after a SubscriptionPhase is created.

Link to section

cadence

string

Required

The billing cadence of the phase. For example, weekly or monthly. This field cannot be changed after a SubscriptionPhase is created.

Link to section

periods

integer(32-bit)

The number of cadences the phase lasts. If not set, the phase never ends. Only the last phase can be indefinite. This field cannot be changed after a SubscriptionPhase is created.

Link to section

recurring_price_money

The amount to bill for each cadence. Failure to specify this field results in a MISSING_REQUIRED_PARAMETER error at runtime.

Link to section

ordinal

integer(64-bit)

The position this phase appears in the sequence of phases defined for the plan, indexed from 0. This field cannot be changed after a SubscriptionPhase is created.

Link to section

pricing

The subscription pricing.