Skip to main content
POST
Apply a coupon to a subscription

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

Supply either couponId or promotionCode.

couponId
string
promotionCode
string

Response

Discount applied.

id
string
Example:

"sdsc_01j9x2k3m4n5p6q7r8s9t0u1v2"

object
enum<string>
Available options:
discount
subscription_id
string
coupon_id
string
promotion_code_id
string | null
started_at
string<date-time> | null
ends_at
string<date-time> | null

null for a forever discount.

cycles_remaining
integer | null

Remaining billing cycles for a repeating discount.

active
boolean