subscription-phase.md

Subscription Phase

Describes a phase in a subscription plan. For more information, see Set Up and Manage a Subscription Plan.

Structure

SubscriptionPhase

Fields

Name	Type	Tags	Description
uid	string | undefined	Optional	The Square-assigned ID of the subscription phase. This field cannot be changed after a SubscriptionPhase is created.
cadence	string	Required	Determines the billing cadence of a Subscription
periods	number | undefined	Optional	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.
recurringPriceMoney	Money | undefined	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
ordinal	bigint | undefined	Optional	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.

Example (as JSON)

{
  "uid": null,
  "cadence": "DAILY",
  "periods": null,
  "recurring_price_money": null,
  "ordinal": null
}