Skip to main content
POST
Create Razorpay Subscription

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environment
enum<string>
required

Payment provider environment.

Available options:
test,
live

Body

application/json

Notes keys starting with insforge_ are reserved and rejected. Either totalCount or endAt is required.

planId
string
required
Minimum string length: 1
Example:

"plan_123"

totalCount
integer
required
Required range: x >= 1
subject
object
required
endAt
integer

Unix timestamp in seconds.

Required range: x >= 1
quantity
integer
Required range: x >= 1
startAt
integer

Unix timestamp in seconds.

Required range: x >= 1
expireBy
integer

Unix timestamp in seconds.

Required range: x >= 1
customerNotify
boolean
offerId
string | null
Required string length: 1 - 255
description
string | null
Maximum string length: 2048
customerName
string | null
Required string length: 1 - 255
customerEmail
string<email> | null
customerContact
string | null
Required string length: 1 - 32
callbackUrl
string<uri> | null
notes
object

Native Razorpay subscription notes, available in webhook payloads.

Response

Razorpay subscription created

subscription
object
required
checkoutOptions
object
required