catalog-subscription-plan-variation.md

Catalog Subscription Plan Variation

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.

Structure

Catalog Subscription Plan Variation

Fields

Name	Type	Tags	Description
name	str	Required	The name of the plan variation.
phases	List Subscription Phase	Required	A list containing each SubscriptionPhase for this plan variation.
subscription_plan_id	str	Optional	The id of the subscription plan, if there is one.
monthly_billing_anchor_date	long|int	Optional	The day of the month the billing period starts. Constraints: >= 1, <= 31
can_prorate	bool	Optional	Whether bills for this plan variation can be split for proration.
successor_plan_variation_id	str	Optional	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.

Example (as JSON)

{
  "name": "name2",
  "phases": [
    {
      "uid": "uid0",
      "cadence": "QUARTERLY",
      "periods": 112,
      "recurring_price_money": {
        "amount": 66,
        "currency": "TMT"
      },
      "ordinal": 78,
      "pricing": {
        "type": "STATIC",
        "discount_ids": [
          "discount_ids5",
          "discount_ids6"
        ],
        "price_money": {
          "amount": 202,
          "currency": "CNY"
        }
      }
    }
  ],
  "subscription_plan_id": "subscription_plan_id0",
  "monthly_billing_anchor_date": 38,
  "can_prorate": false,
  "successor_plan_variation_id": "successor_plan_variation_id2"
}