Skip to content

Plans ​

GET /api/plans ​

All plans with prices and subscriber counts

  • Access: Administrator

POST /api/plans ​

Create a plan (server plan with a preset, or account plan with limits)

  • Access: Administrator
  • Body: name, kind, description?, features?, preset?, limits?, prices?, stock?, perCustomerMax?, visibility?

GET /api/plans/{id} ​

One plan

  • Access: Administrator
  • Path parameters: id

PUT /api/plans/{id} ​

Change a plan

  • Access: Administrator
  • Path parameters: id

DELETE /api/plans/{id} ​

Delete a plan that was never used

  • Access: Administrator
  • Path parameters: id

POST /api/plans/{id}/archive ​

Hide a plan from the store but keep its records

  • Access: Administrator
  • Path parameters: id

POST /api/plans/{id}/duplicate ​

Copy a plan (hidden and inactive)

  • Access: Administrator
  • Path parameters: id

PUT /api/plans/{id}/prices ​

Replace the current prices of a plan (old prices stay for existing subscribers)

  • Access: Administrator
  • Path parameters: id
  • Body: prices[{cycle, amount, currency, trialDays?, setupFee?}]

POST /api/plans/{id}/unarchive ​

Bring an archived plan back

  • Access: Administrator
  • Path parameters: id

POST /api/plans/reorder ​

Set the order plans are shown in

  • Access: Administrator
  • Body: ids

Released under the AGPL-3.0-only license.