Charge Subscription

Charge a specific subscription using the provided subscription reference ID.

POST /api/v2/subscriptions/{subReferenceId}/charge

Charge Subscription

cURL

curl --request POST \
  --url https://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/charge \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <x-client-id>' \
  --header 'X-Client-Secret: <x-client-secret>' \
  --data '
{
  "amount": 1,
  "scheduledOn": "2023-01-20",
  "remarks": "Charge Subscription",
  "merchantTxnId": "test-txn-id-888"
}
'

import requests

url = "https://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/charge"

payload = {
    "amount": 1,
    "scheduledOn": "2023-01-20",
    "remarks": "Charge Subscription",
    "merchantTxnId": "test-txn-id-888"
}
headers = {
    "X-Client-Id": "<x-client-id>",
    "X-Client-Secret": "<x-client-secret>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-Id': '<x-client-id>',
    'X-Client-Secret': '<x-client-secret>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 1,
    scheduledOn: '2023-01-20',
    remarks: 'Charge Subscription',
    merchantTxnId: 'test-txn-id-888'
  })
};

fetch('https://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/charge', 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://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/charge",
  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([
    'amount' => 1,
    'scheduledOn' => '2023-01-20',
    'remarks' => 'Charge Subscription',
    'merchantTxnId' => 'test-txn-id-888'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Client-Id: <x-client-id>",
    "X-Client-Secret: <x-client-secret>"
  ],
]);

$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://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/charge"

	payload := strings.NewReader("{\n  \"amount\": 1,\n  \"scheduledOn\": \"2023-01-20\",\n  \"remarks\": \"Charge Subscription\",\n  \"merchantTxnId\": \"test-txn-id-888\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Client-Id", "<x-client-id>")
	req.Header.Add("X-Client-Secret", "<x-client-secret>")
	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://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/charge")
  .header("X-Client-Id", "<x-client-id>")
  .header("X-Client-Secret", "<x-client-secret>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 1,\n  \"scheduledOn\": \"2023-01-20\",\n  \"remarks\": \"Charge Subscription\",\n  \"merchantTxnId\": \"test-txn-id-888\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/charge")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = '<x-client-id>'
request["X-Client-Secret"] = '<x-client-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 1,\n  \"scheduledOn\": \"2023-01-20\",\n  \"remarks\": \"Charge Subscription\",\n  \"merchantTxnId\": \"test-txn-id-888\"\n}"

response = http.request(request)
puts response.read_body

200

Charge Subscription Success

{
  "status": "OK",
  "message": "Subscription charge initialized",
  "payment": {
    "paymentId": 122129,
    "cfOrderId": 112234,
    "referenceId": null,
    "subReferenceId": 110386,
    "currency": "INR",
    "amount": 1,
    "cycle": 1,
    "status": "INITIALIZED",
    "addedOn": "2023-01-19 16:49:49",
    "retryAttempts": 0,
    "remarks": "",
    "failureReason": "",
    "scheduledOn": "2023-01-20",
    "initiatedOn": "2023-01-19",
    "merchantTxnId": "test-txn-id-888"
  }
}

Headers

X-Client-Id · string · required

Client ID provided by Cashfree.

Example:

"asdf1234"

X-Client-Secret · string · required

Client Secret provided by Cashfree.

Example:

"qwer9876"

Path Parameters

subReferenceId · integer · required

The reference ID of the subscription to be charged.

Example:

2596620

Body

application/json

amount · number

Amount to be charged.

Example:

1

scheduledOn · string<date>

Date to schedule the charge.

Example:

"2023-01-20"

remarks · string

Remarks for the charge.

Example:

"Charge Subscription"

merchantTxnId · string

Merchant transaction ID for the charge.

Example:

"test-txn-id-888"

Response

200

application/json

Successful charge of the subscription.