• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index
You are viewing an old version of the API
SubscriptionPhase

Describes a phase in a subscription plan.

For more information, see Set Up and Manage a Subscription Plan.

Properties
Name Description
uid
string

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

The billing cadence of the phase. For example, weekly or monthly. This field cannot be changed after a SubscriptionPhase is created.
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.
recurring_price_money
Money

The amount to bill for each cadence. Failure to specify this field results in a MISSING_REQUIRED_PARAMETER error at runtime.
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.