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.

Body

application/json
name
string
required
Example:

"Pro Monthly"

amount
integer
required

Recurring charge in paisa.

Example:

99900

intervalUnit
enum<string>
required
Available options:
day,
week,
month,
quarter,
year
Example:

"month"

description
string | null
currency
string
default:NPR
intervalCount
integer
default:1

How many intervalUnits per billing cycle. 2 + month = every 2 months.

gracePeriodDays
integer
default:0

Days after due date before triggering overdue action.

billingScheme
enum<string>
default:per_unit

metered bills on reported usage (see POST /v1/billing/subscriptions/{id}/usage). Set at creation; immutable afterwards.

Available options:
per_unit,
metered
aggregationMethod
enum<string>
default:sum

How usage records aggregate per period on metered plans.

Available options:
sum,
max,
last_ever
trialDays
integer

Free trial period in days (0–365).

Example:

14

defaultProvider
enum<string> | null
Available options:
esewa,
khalti,
fonepay
reminderDaysBeforeDue
integer

Send payment reminder this many days before invoice due date (0–30).

Example:

3

overdueReminderIntervalDays
integer

Repeat overdue reminders every N days (0–30).

overdueAction
enum<string>
default:mark_past_due

Action to take when a subscription goes overdue.

Available options:
keep_active,
mark_past_due,
pause,
cancel
metadata
object | null

Response

Plan created.

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.