Chilkat Online Tools

PureBasic / Razorpay APIs / Create Subscription

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "username")
    CkHttp::setCkPassword(http, "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.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    resp.i = CkHttp::ckPostJson3(http,"https://api.razorpay.com/v1/subscriptions","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

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": [
  ]
}