Skip to main content
PATCH
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
name
string
description
string | null
active
boolean

Deactivating a plan prevents new subscriptions but doesn't affect existing ones.

defaultProvider
enum<string> | null
Available options:
esewa,
khalti,
fonepay
gracePeriodDays
integer
Required range: 0 <= x <= 365
reminderDaysBeforeDue
integer
Required range: 0 <= x <= 30
overdueReminderIntervalDays
integer
Required range: 0 <= x <= 30
overdueAction
enum<string>
Available options:
keep_active,
mark_past_due,
pause,
cancel

Response

Updated plan.

id
string
Example:

"bpl_01j9x2k3m4n5p6q7r8s9t0u1v2"

object
enum<string>
Available options:
plan
name
string
Example:

"Pro Monthly"

description
string | null
amount
integer

Recurring amount in paisa.

Example:

99900

currency
string
Example:

"NPR"

interval_unit
enum<string>
Available options:
day,
week,
month,
quarter,
year
interval_count
integer
default:1
Example:

1

grace_period_days
integer
Example:

3

trial_days
integer
Example:

14

default_provider
enum<string> | null
Available options:
esewa,
khalti,
fonepay
active
boolean
billing_scheme
enum<string>

metered plans bill on reported usage.

Available options:
per_unit,
metered
aggregation_method
enum<string> | null

Usage aggregation for metered plans.

Available options:
sum,
max,
last_ever,
null
dunning_settings
object | null
metadata
object | null
livemode
boolean

true when created with a live key, false for sandbox.