Create or Update Plan

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Some Caveats

  • Plans can only be edited if they have no subscriptions attached to them.
  • There is no way to move customers between plans. You must cancel the first subscription and create a new subscription with the new plan.

These will be fixed with a pro-rata feature in future. Due to the complex nature of our subscription system, most likely only recurring payments will be pro-rated. Fixed payments will be calculated from the original subscription start date, and only those that are future dated will be taken.

If you have opinions on the pro-rata feature, please get in contact. I'm all ears.

Body Params
string
required

A label for the plan

fixedPayments
array of objects

Schedule any number of fixed point-in-time payments

fixedPayments
recurringPayment
object

Only one recurring payment can be created. Create multiple plans if you need more than one.

string

A free field (JSON preferred) that will be added to each payment that is generated from this plan.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json