RCUR

Subscription groups

Show the plans a subscription can switch to

get https://rcur.app/api/v2/subscriptions/{subscriptionId}/plan

The other plans in the group of the subscription, each with what a switch right away (with proration) and a switch at the next payment would cost. Empty when the subscription cannot switch.

Requires your API key as Authorization: Bearer <key>. See authentication.

Path parameters

  • subscriptionId string required

Responses

200 The plans the subscription can switch to SubscriptionPlanOptions object
  • 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

404 Resource not found Error object
  • status integer required
  • error string required
Try it Send this request with your own API key

Requests run against the live data of the organization that owns the key.