POST
/
subscriptions
/
{subscription_id}
/
manage

Authorizations

x-client-id
string
headerrequired

Client app ID. You can find your app id in the Merchant Dashboard.

x-client-secret
string
headerrequired

Client secret key. You can find your secret in the Merchant Dashboard.

Headers

x-api-version
string
default: 2023-08-01required

API version to be used. Format is in YYYY-MM-DD

x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

x-idempotency-key
string

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Path Parameters

subscription_id
string
required

Provide the SubscriptionId using which the subscription was created.

Body

application/json

Request body to manage a subscription.

subscription_id
string
required

The unique ID which was used to create subscription.

action
string
required

Action to be performed on the subscription. Possible values - CANCEL, PAUSE, ACTIVATE, CHANGE_PLAN.

action_details
object

Details of the action to be performed.

Response

200 - application/json

The response returned for Get, Create or Manage Subscription APIs.

authorisation_details
object

Details of the authorization done for the subscription. Returned in Get subscription and auth payments.

cf_subscription_id
string

Cashfree subscription reference number

customer_details
object

Subscription customer details.

plan_details
object

The response returned for Get, Create and Manage Plan APIs

subscription_expiry_time
string

Time at which the subscription will expire.

subscription_first_charge_time
string

Time at which the first charge will be made for the subscription. Applicable only for PERIODIC plans.

subscription_id
string

A unique ID passed by merchant for identifying the subscription.

subscription_meta
object

Subscription metadata.

subscription_note
string

Note for the subscription.

subscription_session_id
string

Subscription Session Id.

subscription_payment_splits
object[]

Payment splits for the subscription.

subscription_status
string

Status of the subscription.

subscription_tags
object

Tags for the subscription.