Skip to main content
POST
/
api
/
v2
/
subscriptions
/
{subReferenceId}
/
activate
Activate Subscription
curl --request POST \
  --url https://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/activate \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <x-client-id>' \
  --header 'X-Client-Secret: <x-client-secret>' \
  --data '
{
  "nextScheduledOn": "2021-12-17"
}
'
{
  "status": "OK",
  "subStatus": "ACTIVE",
  "subscriptionResponse": {
    "subReferenceId": 123456,
    "subscriptionId": "testabcd",
    "planId": "test_demo",
    "customerPhone": "9876543210",
    "customerName": "John Doe",
    "customerEmail": "abc@gmail.com",
    "addedOn": "2021-02-24 11:15:10"
  }
}

Documentation Index

Fetch the complete documentation index at: https://www.cashfree.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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 activated.

Example:

2646214

Body

application/json
​
nextScheduledOn
string<date>

The next scheduled date for the subscription activation.

Example:

"2021-12-17"

Response

Successful activation of the subscription.