<- Object

Object

CatalogSubscriptionPlan

Describes a subscription plan.

A subscription plan represents what you want to sell in a subscription model, and includes references to each of the associated subscription plan variations. For more information, see Subscription Plans and Variations.

Link to section

Properties

Link to section

name

string

Required

The name of the plan.

Link to section

phases

A list of SubscriptionPhase containing the SubscriptionPhase for this plan. This field it required. Not including this field will throw a REQUIRED_FIELD_MISSING error

Link to section

subscription_plan_variations

The list of subscription plan variations available for this product

Link to section

eligible_item_ids

string [ ]

The list of IDs of CatalogItems that are eligible for subscription by this SubscriptionPlan's variations.

Link to section

eligible_category_ids

string [ ]

The list of IDs of CatalogCategory that are eligible for subscription by this SubscriptionPlan's variations.

Link to section

all_items

boolean

If true, all items in the merchant's catalog are subscribable by this SubscriptionPlan.