Chilkat Online Tools

PureBasic / Razorpay APIs / Create Plan

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.

    ; {
    ;   "period": "weekly",
    ;   "interval": 1,
    ;   "item": {
    ;     "name": "Test plan - Weekly",
    ;     "amount": 69900,
    ;     "currency": "INR",
    ;     "description": "Description for the test plan - Weekly"
    ;   },
    ;   "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,"period","weekly")
    CkJsonObject::ckUpdateInt(json,"interval",1)
    CkJsonObject::ckUpdateString(json,"item.name","Test plan - Weekly")
    CkJsonObject::ckUpdateInt(json,"item.amount",69900)
    CkJsonObject::ckUpdateString(json,"item.currency","INR")
    CkJsonObject::ckUpdateString(json,"item.description","Description for the test plan - Weekly")
    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/plans","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 '{
  "period": "weekly",
  "interval": 1,
  "item": {
    "name": "Test plan - Weekly",
    "amount": 69900,
    "currency": "INR",
    "description": "Description for the test plan - Weekly"
  },
  "notes": {
    "notes_key_1": "Tea, Earl Grey, Hot",
    "notes_key_2": "Tea, Earl Grey… decaf."
  }
}'
https://api.razorpay.com/v1/plans

Postman Collection Item JSON

{
  "name": "Create Plan",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"period\": \"weekly\",\n  \"interval\": 1,\n  \"item\": {\n    \"name\": \"Test plan - Weekly\",\n    \"amount\": 69900,\n    \"currency\": \"INR\",\n    \"description\": \"Description for the test plan - Weekly\"\n  },\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/plans",
      "protocol": "https",
      "host": [
        "api",
        "razorpay",
        "com"
      ],
      "path": [
        "v1",
        "plans"
      ]
    },
    "description": "You must create a plan before creating a subscription via the Checkout or using the Subscription Link feature.\n\nKnow more about the <a href=\"https://razorpay.com/docs/api/subscriptions/#create-a-plan\" target=\"_blank\">Create a Plan</a> API."
  },
  "response": [
  ]
}