Chilkat Online Tools

PureBasic / Razorpay APIs / Fetch All Invoices for a 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")

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

    CkJsonObject::ckUpdateString(queryParams,"subscription_id","{sub_id}")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.razorpay.com/v1//invoices",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

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



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)


    ProcedureReturn
EndProcedure

Curl Command

curl -G -d "subscription_id=%7Bsub_id%7D"
	-u 'username:password'
https://api.razorpay.com/v1//invoices

Postman Collection Item JSON

{
  "name": "Fetch All Invoices for a Subscription",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.razorpay.com/v1//invoices?subscription_id={sub_id}",
      "protocol": "https",
      "host": [
        "api",
        "razorpay",
        "com"
      ],
      "path": [
        "v1",
        "",
        "invoices"
      ],
      "query": [
        {
          "key": "subscription_id",
          "value": "{sub_id}"
        }
      ]
    },
    "description": "You can fetch all invoices for a subscription using the <a href=\"https://razorpay.com/docs/api/subscriptions/#fetch-all-invoices-for-a-subscription\" target=\"_blank\">Fetch All Invoices for a Subscription API</a>. Here, the count indicates the number of invoices generated for the subscription."
  },
  "response": [
  ]
}