Skip to main content
GET
Preview proration for a plan change

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

Query Parameters

newPlanId
string
required

Response

Proration preview.

Computed proration estimate (amounts only, no persisted object). NOTE: this object uses camelCase keys (legacy); snake_case alignment is a tracked follow-up.

creditAmount
integer

Paisa credited for unused time on the current plan.

debitAmount
integer

Paisa charged for remaining time on the new plan.

netAmount
integer

debitAmount - creditAmount (positive = customer owes more).

currency
string
Example:

"NPR"

periodStart
string<date-time>
periodEnd
string<date-time>
currentPlan
object
newPlan
object