Create Razorpay Subscription
curl --request POST \
--url https://api.example.com/api/payments/razorpay/{environment}/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"planId": "plan_123",
"totalCount": 12,
"subject": {
"type": "team",
"id": "team_123"
},
"customerEmail": "buyer@example.com"
}
'import requests
url = "https://api.example.com/api/payments/razorpay/{environment}/subscriptions"
payload = {
"planId": "plan_123",
"totalCount": 12,
"subject": {
"type": "team",
"id": "team_123"
},
"customerEmail": "buyer@example.com"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
planId: 'plan_123',
totalCount: 12,
subject: {type: 'team', id: 'team_123'},
customerEmail: 'buyer@example.com'
})
};
fetch('https://api.example.com/api/payments/razorpay/{environment}/subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/payments/razorpay/{environment}/subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'planId' => 'plan_123',
'totalCount' => 12,
'subject' => [
'type' => 'team',
'id' => 'team_123'
],
'customerEmail' => 'buyer@example.com'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/payments/razorpay/{environment}/subscriptions"
payload := strings.NewReader("{\n \"planId\": \"plan_123\",\n \"totalCount\": 12,\n \"subject\": {\n \"type\": \"team\",\n \"id\": \"team_123\"\n },\n \"customerEmail\": \"buyer@example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/payments/razorpay/{environment}/subscriptions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"planId\": \"plan_123\",\n \"totalCount\": 12,\n \"subject\": {\n \"type\": \"team\",\n \"id\": \"team_123\"\n },\n \"customerEmail\": \"buyer@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/payments/razorpay/{environment}/subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"planId\": \"plan_123\",\n \"totalCount\": 12,\n \"subject\": {\n \"type\": \"team\",\n \"id\": \"team_123\"\n },\n \"customerEmail\": \"buyer@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"subscription": {
"subscriptionId": "sub_123",
"planId": "plan_123",
"customerId": "cust_123",
"subjectType": "<string>",
"subjectId": "<string>",
"currentStart": "2023-11-07T05:31:56Z",
"currentEnd": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"quantity": 123,
"chargeAt": "2023-11-07T05:31:56Z",
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z",
"totalCount": 123,
"authAttempts": 123,
"paidCount": 123,
"remainingCount": 123,
"shortUrl": "<string>",
"hasScheduledChanges": true,
"changeScheduledAt": "2023-11-07T05:31:56Z",
"offerId": "<string>",
"authorizationPaymentId": "pay_123",
"authorizationVerifiedAt": "2023-11-07T05:31:56Z",
"notes": {},
"providerCreatedAt": "2023-11-07T05:31:56Z",
"syncedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"checkoutOptions": {
"key": "rzp_test_xxx",
"subscription_id": "sub_123",
"prefill": {
"name": "<string>",
"email": "jsmith@example.com",
"contact": "<string>"
},
"name": "<string>",
"description": "<string>",
"callback_url": "<string>"
}
}{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}Razorpay Payments
Create Razorpay Subscription
Create a Razorpay Subscription and mirror it locally, then return Checkout options for authorization. The backend first evaluates the caller’s INSERT policy on payments.razorpay_subscriptions so apps can restrict which subjects can start subscriptions.
POST
/
api
/
payments
/
razorpay
/
{environment}
/
subscriptions
Create Razorpay Subscription
curl --request POST \
--url https://api.example.com/api/payments/razorpay/{environment}/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"planId": "plan_123",
"totalCount": 12,
"subject": {
"type": "team",
"id": "team_123"
},
"customerEmail": "buyer@example.com"
}
'import requests
url = "https://api.example.com/api/payments/razorpay/{environment}/subscriptions"
payload = {
"planId": "plan_123",
"totalCount": 12,
"subject": {
"type": "team",
"id": "team_123"
},
"customerEmail": "buyer@example.com"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
planId: 'plan_123',
totalCount: 12,
subject: {type: 'team', id: 'team_123'},
customerEmail: 'buyer@example.com'
})
};
fetch('https://api.example.com/api/payments/razorpay/{environment}/subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/payments/razorpay/{environment}/subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'planId' => 'plan_123',
'totalCount' => 12,
'subject' => [
'type' => 'team',
'id' => 'team_123'
],
'customerEmail' => 'buyer@example.com'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/payments/razorpay/{environment}/subscriptions"
payload := strings.NewReader("{\n \"planId\": \"plan_123\",\n \"totalCount\": 12,\n \"subject\": {\n \"type\": \"team\",\n \"id\": \"team_123\"\n },\n \"customerEmail\": \"buyer@example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/payments/razorpay/{environment}/subscriptions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"planId\": \"plan_123\",\n \"totalCount\": 12,\n \"subject\": {\n \"type\": \"team\",\n \"id\": \"team_123\"\n },\n \"customerEmail\": \"buyer@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/payments/razorpay/{environment}/subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"planId\": \"plan_123\",\n \"totalCount\": 12,\n \"subject\": {\n \"type\": \"team\",\n \"id\": \"team_123\"\n },\n \"customerEmail\": \"buyer@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"subscription": {
"subscriptionId": "sub_123",
"planId": "plan_123",
"customerId": "cust_123",
"subjectType": "<string>",
"subjectId": "<string>",
"currentStart": "2023-11-07T05:31:56Z",
"currentEnd": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"quantity": 123,
"chargeAt": "2023-11-07T05:31:56Z",
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z",
"totalCount": 123,
"authAttempts": 123,
"paidCount": 123,
"remainingCount": 123,
"shortUrl": "<string>",
"hasScheduledChanges": true,
"changeScheduledAt": "2023-11-07T05:31:56Z",
"offerId": "<string>",
"authorizationPaymentId": "pay_123",
"authorizationVerifiedAt": "2023-11-07T05:31:56Z",
"notes": {},
"providerCreatedAt": "2023-11-07T05:31:56Z",
"syncedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"checkoutOptions": {
"key": "rzp_test_xxx",
"subscription_id": "sub_123",
"prefill": {
"name": "<string>",
"email": "jsmith@example.com",
"contact": "<string>"
},
"name": "<string>",
"description": "<string>",
"callback_url": "<string>"
}
}{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Payment provider environment.
Available options:
test, live Body
application/json
- Option 1
- Option 2
Notes keys starting with insforge_ are reserved and rejected. Either totalCount or endAt is required.
Minimum string length:
1Example:
"plan_123"
Required range:
x >= 1Show child attributes
Show child attributes
Unix timestamp in seconds.
Required range:
x >= 1Required range:
x >= 1Unix timestamp in seconds.
Required range:
x >= 1Unix timestamp in seconds.
Required range:
x >= 1Required string length:
1 - 255Maximum string length:
2048Required string length:
1 - 255Required string length:
1 - 32Native Razorpay subscription notes, available in webhook payloads.
Show child attributes
Show child attributes
Was this page helpful?
⌘I