RCUR

Subscription groups

Switch a subscription to another plan

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

Switching right away prorates what is left of the running period, starts a new period today and charges the difference through the mandate. Switching at the next payment keeps the current plan until then. A switch planned earlier is replaced.

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

Path parameters

  • subscriptionId string required

Request body

application/json

The plan to switch to and when. Check the amount first with GET on the same path.

  • plan string

    Id of the template to switch to, from the options

  • timing string

    immediate prorates the running period and charges the difference now; next_payment keeps the current plan until the next payment

    One of immediate next_payment

  • settlement number

    Optional. The amount you expect to be charged for a switch right away; the switch is refused when it is different now

Responses

201 The subscription is switched, or the switch is planned SubscriptionPlanChange object
  • 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
422 Validation error ValidationError object
  • status integer required
  • error string required
  • fields object
Try it Send this request with your own API key

Requests run against the live data of the organization that owns the key. This POST request changes that data.