Skip to main content
GET
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

Response

Invoice object.

id
string
Example:

"inv_01j9x2k3m4n5p6q7r8s9t0u1v2"

object
enum<string>

String representing the object's type.

Available options:
invoice
number
string

Human-readable invoice number.

Example:

"INV-20260607-E0479E"

status
enum<string>
Available options:
draft,
open,
paid,
overdue,
void,
uncollectible
amount_due
integer

Total amount due in paisa.

amount_paid
integer

Amount paid so far in paisa.

currency
string
Example:

"NPR"

issued_at
string<date-time> | null
due_at
string<date-time> | null
paid_at
string<date-time> | null
hosted_invoice_url
string<uri> | null

Public hosted payment page for this invoice, or null if none has been generated.

customer
object | null
subscription
object | null
plan
object | null
metadata
object | null
livemode
boolean

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