Skip to main content
GET
Get a coupon

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

Coupon.

id
string
Example:

"cpn_01j9x2k3m4n5p6q7r8s9t0u1v2"

object
enum<string>
Available options:
coupon
code
string
Example:

"WELCOME10"

name
string
Example:

"Welcome 10%"

discount_type
enum<string>
Available options:
percent,
amount
percent_off
integer | null

Percent discount (1–100), when discount_type is percent.

Example:

10

amount_off
integer | null

Fixed discount in paisa, when discount_type is amount.

currency
string
Example:

"NPR"

duration
enum<string>
Available options:
once,
repeating,
forever
duration_in_cycles
integer | null

Billing cycles the discount applies, when duration is repeating.

max_redemptions
integer | null
redeemed_count
integer
Example:

0

redeem_by
string<date-time> | null
applies_to_plan_ids
string[] | null

Restrict to specific plan IDs, or null for all plans.

active
boolean
metadata
object | null
livemode
boolean

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