CatalogSubscriptionPlanVariation

Describes a subscription plan variation.

A subscription plan variation represents how the subscription for a product or service is sold. For more information, see Subscription Plans and Variations.

Link to section

Properties

Link to section

name

string

Required

The name of the plan variation.

Link to section

phases

Required

A list containing each SubscriptionPhase for this plan variation.

Link to section

subscription_plan_id

string

The id of the subscription plan, if there is one.

Link to section

monthly_billing_anchor_date

integer(64-bit)

The day of the month the billing period starts.

Min

Max

Link to section

can_prorate

boolean

Whether bills for this plan variation can be split for proration.

Link to section

successor_plan_variation_id

string

The ID of a "successor" plan variation to this one. If the field is set, and this object is disabled at all locations, it indicates that this variation is deprecated and the object identified by the successor ID be used in its stead.