Change subscription plan

Enterprise Only

This endpoint is only available in the Enterprise package and requires the authenticated user to be a Super Admin.

Payment Platform Required

This endpoint is only available if a payment platform (Stripe, Paddle, etc.) has been configured in Mixpost.

Method: PUT

URL: https://example.com/<MIXPOST_CORE_PATH>/api/panel/workspaces/{workspaceUuid}/subscription/change-plan

Authorization: Bearer <token>

Body:

{
  "plan_id": 2,
  "cycle": "yearly",
  "prorate": true,
  "billing_immediately": false
}

Key	Format	Required	Description
plan_id	integer	required	The ID of the new subscription plan defined in Mixpost Dashboard
cycle	string	required	Billing cycle: monthly or yearly
prorate	boolean	required	Whether to prorate the subscription when changing plans
billing_immediately	boolean	required	Whether to bill the customer immediately for the plan change

Response:

200

{
  "success": true
}

401

{
  "message": "Unauthenticated."
}

403

{
  "message": "Access forbidden."
}

404

{
  "message": "Workspace not found."
}

422

{
  "message": "Validation errors",
  "errors": {}
}