Update a Subscription

Update a Subscription using the Razorpay API.

PATCH /v1/subscriptions/:id

Curl

curl -u <YOUR_KEY>:<YOUR_SECRET> \
-X PATCH https://api.razorpay.com/v1/subscriptions/sub_00000000000001 \
-H "Content-Type: application/json" \
-d '{
  "plan_id":"plan_00000000000002",
  "offer_id":"offer_JHD834hjbxzhd38d",
  "quantity":5,
  "remaining_count":5,
  "start_at":1496000432,
  "schedule_change_at":"now",
  "customer_notify": true
}'

Success

{
  "id":"sub_00000000000002",
  "entity":"subscription",
  "plan_id":"plan_00000000000002",
  "customer_id":"cust_00000000000002",
  "status":"authenticated",
  "current_start":null,
  "current_end":null,
  "ended_at":null,
  "quantity":3,
  "notes":{
    "notes_key_1":"Tea, Earl Grey, Hot",
    "notes_key_2":"Tea, Earl Grey… decaf."
  },
  "charge_at":1580453311,
  "start_at":1580453311,
  "end_at":1606588200,
  "auth_attempts":0,
  "total_count":6,
  "paid_count":0,
  "customer_notify":true,
  "created_at":1580283807,
  "expire_by":1580626111,
  "short_url":"https://rzp.io/i/yeDkUKy",
  "has_scheduled_changes":false,
  "change_scheduled_at":null,
  "source": "api",
  "offer_id":"offer_JHD834hjbxzhd38d",
  "remaining_count":6
}

Available in🇮🇳 India🇸🇬 Singapore🇺🇸 United States

Use this endpoint to update a Subscription.

Curl

curl -u <YOUR_KEY>:<YOUR_SECRET> \
-X PATCH https://api.razorpay.com/v1/subscriptions/sub_00000000000001 \
-H "Content-Type: application/json" \
-d '{
  "plan_id":"plan_00000000000002",
  "offer_id":"offer_JHD834hjbxzhd38d",
  "quantity":5,
  "remaining_count":5,
  "start_at":1496000432,
  "schedule_change_at":"now",
  "customer_notify": true
}'

Success

{
  "id":"sub_00000000000002",
  "entity":"subscription",
  "plan_id":"plan_00000000000002",
  "customer_id":"cust_00000000000002",
  "status":"authenticated",
  "current_start":null,
  "current_end":null,
  "ended_at":null,
  "quantity":3,
  "notes":{
    "notes_key_1":"Tea, Earl Grey, Hot",
    "notes_key_2":"Tea, Earl Grey… decaf."
  },
  "charge_at":1580453311,
  "start_at":1580453311,
  "end_at":1606588200,
  "auth_attempts":0,
  "total_count":6,
  "paid_count":0,
  "customer_notify":true,
  "created_at":1580283807,
  "expire_by":1580626111,
  "short_url":"https://rzp.io/i/yeDkUKy",
  "has_scheduled_changes":false,
  "change_scheduled_at":null,
  "source": "api",
  "offer_id":"offer_JHD834hjbxzhd38d",
  "remaining_count":6
}

Path Parameters

id · string · required

The unique identifier linked to a Subscription. For example, sub_00000000000001.

Request Parameters

plan_id · string

The unique identifier of the new plan that should be linked to the Subscription. For example, plan_00000000000001.

offer_id · string

The unique identifier of the offer that should be linked to the Subscription. You can obtain this from the Dashboard. For example, offer_JHD834hjbxzhd38d.

quantity · integer

The number of times the plan should be linked to the Subscription. For example, if the plan is ₹100/user/month and the customer has 5 users, you should pass 5 as the quantity to have the customer charged ₹500 (5 x ₹100) monthly. By default, this value is set to 1.

remaining_count · integer

This parameter is used to update the total_count for a Subscription. For example, let us consider a monthly Subscription with 12 billing cycles. The Subscription has been charged successfully 4 times and 3 more invoices have been issued, but have not been charged. The remaining count in such cases is 5. However, you can overwrite this value using this parameter.

start_at · integer

Unix timestamp. The new start date for the Subscription.

schedule_change_at · string

Represents when the Subscription should be updated.

• now (default): Updates the Subscription immediately.
• cycle_end: Updates the Subscription at the end of the current billing cycle.

customer_notify · boolean

Represents who sends notifications to the customer. Possible values:

• true (default): Notifications sent by Razorpay.
• false: Notifications sent by you.

Response Parameters

id · string

The unique identifier of the subscription created. For example, sub_00000000000001.

entity · string

The entity being created. Here, it will be subscription.

plan_id · string

The unique identifier for a plan that is linked to the created subscription. For example, plan_00000000000001.

customer_id · string

The unique identifier of the customer linked to the subscription. This is populated automatically once the customer completes the authorisation transaction. For example, cust_00000000000001.

status · string

Status of the subscription. Refer to the life cycle section for more details. Possible values:

• created
• authenticated
• active
• pending
• halted
• cancelled
• completed
• expired

current_start · integer

Unix timestamp. The start time of the current billing cycle of the subscription. For example, 1581013800.

current_end · integer

Unix timestamp. The end time of the current billing cycle of the subscription. For example, 1581013800.

ended_at · integer

The timestamp, in Unix format, when the subscription was completed or was cancelled. For example, 1581013800.

quantity · integer

The number of times the plan should be linked to the subscription. For example, if the plan is ₹100/user/month and the customer has 5 users, you should pass 5 as the quantity to have the customer charged ₹500 (5 x ₹100) monthly. By default, this value is set to 1.

notes · object

Notes you can enter for the contact for future reference. This is a key-value pair. You can enter a maximum of 15 key-value pairs. For example, "note_key": "Beam me up Scotty”.

charge_at · integer

Unix timestamp. This indicates when the next charge on the subscription should be made. For example, 1581013800.

offer_id · string

The unique identifier of the offer that should be linked to the subscription. For example, offer_JHD834hjbxzhd38d.

start_at · integer

The timestamp, in Unix format, when the subscription should start. If not passed, the subscription starts immediately after the authorisation payment. For example, 1581013800.

end_at · integer

The timestamp, in Unix format, when the subscription should end. For example, 1581013800.

auth_attempts · integer

The number of times that the charge for the current billing cycle has been attempted on the card. For example, 2.

total_count · integer

The number of billing cycles for which the customer should be charged. For example, 2. We support subscriptions for a maximum duration of 100 years. The number of billing cycles depends if the subscription is daily, weekly, monthly or yearly.

paid_count · integer

This indicates the number of billing cycles for which the customer has already been charged. For example, 2.

customer_notify · boolean

Indicates whether the communication to the customer would be handled by businesses or Razorpay.

• true: Communication handled by Razorpay. Defaults to true.
• false: Communication handled by businesses.

created_at · integer

The timestamp, in Unix format, when the subscription was created. For example, 1581013800.

expire_by · integer

The timestamp, in Unix format, till when the customer can make the authorisation payment. For example, 1581013800.

short_url · string

URL that can be used to make the authorisation payment. For example, https://rzp.io/i/PWtAiEo.

has_scheduled_changes · boolean

Indicates if the subscription has any scheduled changes. Possible values:

• true: Subscription has scheduled changes.
• false: Subscription does not have scheduled changes.

schedule_change_at · string

Represents when the subscription should be updated. Possible values:

• now (default): Updates the subscription immediately.
• cycle_end: Updates the subscription at the end of the current billing cycle.

remaining_count · integer

This indicates the number of billing cycles remaining on the subscription. For example, 2.

Errors

Subscriptions cannot be updated when payment mode is UPI

Code: 400

This error occurs when you are trying to update a Subscription authorised via UPI.

Solution: You cannot update a Subscription authorised via UPI mode or Emandate.

Can't update Subscription when Subscription is not in Authenticated or Active state

Code: 400

This error occurs when you are trying to update a Subscription in the created state.

Solution: Ensure that the Subscription status is either in the authenticated or active state.

Parameters to update can't be empty.

Code: 400

The PATCH request body is empty. At least one updatable field must be provided.

Solution: Include at least one of the updatable fields (plan_id, quantity, remaining_count, schedule_change_at) in the request body.

The remaining count must be at least 1.

Code: 400

remaining_count was passed as 0 or a negative value.

Solution: Pass remaining_count as a positive integer.

{any extra field} is/are not required and should not be sent.

Code: 400

The request body contains fields that are not updatable on a Subscription.

Solution: Only include updatable fields (plan_id, quantity, remaining_count, schedule_change_at).

subscriptions cannot be updated when payment mode is emandate.

Code: 400

The Subscription was authenticated via Emandate. Emandate subscriptions cannot be updated through this API.

Solution: Emandate subscriptions are immutable post-authentication. Cancel and create a new Subscription if changes are needed.

Request failed because another subscription operation is in progress.

Code: 400

A concurrent update, cancel or pause/resume operation is already running for the same Subscription. Razorpay holds a short-lived lock against the subscription id to prevent state-corruption.

Solution: Wait a few seconds and retry. If the issue persists, fetch the Subscription to confirm its current state before retrying.

Subscriptions with active offers can only be downgraded at the end of the billing cycle.

Code: 400

A plan_id change has been requested that downgrades the Subscription amount, but the Subscription has an active offer attached. Downgrades on offer-linked subscriptions are only allowed at the end of the current billing cycle.

Solution: Pass schedule_change_at: "cycle_end" so the downgrade is applied at the end of the current cycle, or remove the offer first.