Chilkat Online Tools

Ruby / Razorpay APIs / Create Subscription

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("username")
http.put_Password("password")

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "plan_id": "{plan_id}",
#   "total_count": 6,
#   "quantity": 1,
#   "start_at": 1735689600,
#   "expire_by": 1893456000,
#   "customer_notify": 1,
#   "addons": [
#     {
#       "item": {
#         "name": "Delivery charges",
#         "amount": 30000,
#         "currency": "INR"
#       }
#     }
#   ],
#   "offer_id": "{offer_id}",
#   "notes": {
#     "notes_key_1": "Tea, Earl Grey, Hot",
#     "notes_key_2": "Tea, Earl Grey… decaf."
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("plan_id","{plan_id}")
json.UpdateInt("total_count",6)
json.UpdateInt("quantity",1)
json.UpdateInt("start_at",1735689600)
json.UpdateInt("expire_by",1893456000)
json.UpdateInt("customer_notify",1)
json.UpdateString("addons[0].item.name","Delivery charges")
json.UpdateInt("addons[0].item.amount",30000)
json.UpdateString("addons[0].item.currency","INR")
json.UpdateString("offer_id","{offer_id}")
json.UpdateString("notes.notes_key_1","Tea, Earl Grey, Hot")
json.UpdateString("notes.notes_key_2","Tea, Earl Grey… decaf.")

http.SetRequestHeader("Content-Type","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.razorpay.com/v1/subscriptions","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X POST
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
  "plan_id":"{plan_id}",
  "total_count":6,
  "quantity":1,
  "start_at":1735689600,
  "expire_by":1893456000,
  "customer_notify":1,
  "addons":[
    {
      "item":{
        "name":"Delivery charges",
        "amount":30000,
        "currency":"INR"
      }
    }
  ],
  "offer_id":"{offer_id}",
  "notes":{
    "notes_key_1":"Tea, Earl Grey, Hot",
    "notes_key_2":"Tea, Earl Grey… decaf."
  }
}'
https://api.razorpay.com/v1/subscriptions

Postman Collection Item JSON

{
  "name": "Create Subscription",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"plan_id\":\"{plan_id}\",\n  \"total_count\":6,\n  \"quantity\":1,\n  \"start_at\":1735689600,\n  \"expire_by\":1893456000,\n  \"customer_notify\":1,\n  \"addons\":[\n    {\n      \"item\":{\n        \"name\":\"Delivery charges\",\n        \"amount\":30000,\n        \"currency\":\"INR\"\n      }\n    }\n  ],\n  \"offer_id\":\"{offer_id}\",\n  \"notes\":{\n    \"notes_key_1\":\"Tea, Earl Grey, Hot\",\n    \"notes_key_2\":\"Tea, Earl Grey… decaf.\"\n  }\n}"
    },
    "url": {
      "raw": "https://api.razorpay.com/v1/subscriptions",
      "protocol": "https",
      "host": [
        "api",
        "razorpay",
        "com"
      ],
      "path": [
        "v1",
        "subscriptions"
      ]
    },
    "description": "You can create a subscription using the a <a href=\"https://razorpay.com/docs/api/subscriptions/#create-a-subscription\" target=\"_blank\">Create a Subscription API</a>."
  },
  "response": [
  ]
}