Struct SubscriptionPhase

pub struct SubscriptionPhase {
    pub uid: Option<String>,
    pub cadence: SubscriptionCadence,
    pub periods: Option<i32>,
    pub recurring_price_money: Money,
    pub ordinal: Option<i64>,
}

Describes a phase in a subscription plan.

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

Fields

uid: Option<String>

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

cadence: SubscriptionCadence

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

periods: Option<i32>

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.

ordinal: Option<i64>

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.

Trait Implementations

impl Clone for SubscriptionPhase

fn clone(&self) -> SubscriptionPhase

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SubscriptionPhase

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SubscriptionPhase

fn default() -> SubscriptionPhase

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubscriptionPhase

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SubscriptionPhase

fn eq(&self, other: &SubscriptionPhase) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SubscriptionPhase

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SubscriptionPhase

impl StructuralPartialEq for SubscriptionPhase