Skip to main content
POST
Create a promotion code

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
couponId
string
required
Example:

"cpn_01j9x2k3m4n5p6q7r8s9t0u1v2"

code
string
required
Example:

"LAUNCH50"

maxRedemptions
integer | null
expiresAt
string<date-time> | null
firstTimeTransaction
boolean
default:false
minimumAmount
integer | null

Minimum order amount in paisa.

customerIds
string[] | null
metadata
object | null

Response

Promotion code created.

id
string
Example:

"promo_01j9x2k3m4n5p6q7r8s9t0u1v2"

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

"LAUNCH50"

coupon_id
string
Example:

"cpn_01j9x2k3m4n5p6q7r8s9t0u1v2"

active
boolean
max_redemptions
integer | null
redeemed_count
integer
Example:

0

expires_at
string<date-time> | null
first_time_transaction
boolean

Restrict to a customer's first transaction.

minimum_amount
integer | null

Minimum order amount in paisa for the code to apply.

customer_ids
string[] | null

Restrict to specific customers, or null for any.

metadata
object | null
livemode
boolean

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