Skip to content
This repository has been archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
17 lines (12 loc) · 1.29 KB

SubscriptionPhase.md

File metadata and controls

17 lines (12 loc) · 1.29 KB

SquareConnect.SubscriptionPhase

Description

Note: This model is in beta.

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

Properties

Name Type Description Notes
uid String The Square-assigned ID of the subscription phase. This field cannot be changed after a `SubscriptionPhase` is created. [optional]
cadence String The billing cadence of the phase. For example, weekly or monthly. This field cannot be changed after a `SubscriptionPhase` is created. See SubscriptionCadence for possible values
periods Number The number of `cadence`s 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. [optional]
recurring_price_money Money The amount to bill for each `cadence`.
ordinal Number 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. [optional]