Skip to content
Guides
Update Plan

Update Plan

You can update your plan details, including the Plan Name, Plan Description, and Status. Updating the Status allows you to transition the plan between different statuses:

  • Active - Users/customers are free to subscribe to this plan.
  • Paused - New users/customers cannot subscribe to this plan. Those who already subscribed to this plan are not affected.
  • Archived - This status is available only when there are no active subscriptions with this plan. Users/customers cannot subscribe to archived plans.

Make a PATCH/pay-ins/plans/{planId} request to update plan details:

Example of a request payload

{
"name": "string",
"description": "string",
"status": "string"
}
NameDescription
statusAvailable statuses are:active, paused,archived

Additionally, you can manually change the statuses of plans using the Platform portal (from the Plans table).