Skip to main content
POST
curl

Authorizations

Authorization
string
header
required

Your PayBridgeNP API key. Obtain one from the dashboard under Settings → API Keys. Prefix: sk_test_ for testing, sk_live_ for production.

Path Parameters

id
string
required

Body

application/json
newPlanId
string
required

ID of the new plan to switch to.

Example:

"bpl_01newplanid"

planId
string
deprecated

Deprecated alias for newPlanId.

prorationBehavior
enum<string>
default:none

none (default) schedules the switch for the next renewal; create_prorations applies an immediate prorated charge/credit.

Available options:
none,
create_prorations

Response

Plan change scheduled (default) or applied immediately (with proration).

Scheduled change (prorationBehavior=none).

subscription
object
next_plan
object