Objects

The SubscriptionPlanOptions object

Fields of the SubscriptionPlanOptions object.

Attributes

• current object nullable required
  3 child attributes

  • template_id string
  • group_id string nullable
  • name string
• options array of objects required
  8 child attributes

  • plan string

    Id of the template to switch to, to send as plan

  • name string
  • description string nullable
  • direction string

    One of upgrade downgrade interval

  • currency string
  • amount number

    Amount per period of the new plan

  • interval string
  • timings object

    What the switch means per moment; immediate is null when it is not possible for this subscription

    2 child attributes

    • immediate object nullable
    • next_payment object
• scheduled SubscriptionPlanChange object required
  12 child attributes · SubscriptionPlanChange

  • status string required

    One of scheduled applied cancelled

  • timing string required

    One of immediate next_payment

  • direction string required

    One of upgrade downgrade interval

  • from string required
  • to string required
  • effective_on string required

    Today for a switch right away, otherwise the date of the next payment

  • currency string
  • old_amount string
  • new_amount string
  • credit string

    Credit for the unused part of the running period (switch right away)

  • settlement string

    Amount charged for the switch (switch right away)

  • credit_left string

    Credit that stays on the subscription for the next payments