Introduction

API Reference Guide

API Changelog

API Basics

Authentication & Sandbox Setup

Entity & Metadata

Pagination & Rate Limiting

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Items

Plans

Subscriptions

Add-on

Linked Account

Stakeholder

Product Configuration

Transfers

Smart Collect

Smart Collect With TPV

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Terms and Conditions

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Payments

Subscriptions

Pause Subscription

API Test Keys

Pause a Subscription

POST
/v1/subscriptions/:id/pause

Click to copy

Use this endpoint to pause a Subscription.

Watch Out!

  • You can only pause a Subscriptions in the active state.
  • If you pause a Subscription in the authenticated state, it goes to the cancelled state.

Is this page helpful?

Curl

change language

change language

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2
-X POST https://api.razorpay.com/v1/subscriptions/sub_00000000000001/pause \
3
-H "Content-Type: application/json" \
4
-d '{
5
  "pause_at":"now"
6
}'

Success

Failure

1
{
2
  "id": "sub_00000000000001",
3
  "entity": "subscription",
4
  "plan_id": "plan_00000000000001",
5
  "status": "paused",
6
  "current_start": null,
7
  "current_end": null,
8
  "ended_at": null,
9
  "quantity": 1,
10
  "notes":{
11
    "notes_key_1":"Tea, Earl Grey, Hot",
12
    "notes_key_2":"Tea, Earl Grey… decaf."
13
  },
14
  "charge_at": null,
15
  "start_at": 1580626111,
16
  "end_at": 1583433000,
17
  "auth_attempts": 0,
18
  "total_count": 6,
19
  "paid_count": 0,
20
  "customer_notify": true,
21
  "created_at": 1580280581,
22
  "paused_at": 1590280581,
23
  "expire_by": 1580626111,
24
  "pause_initiated_by": "self",
25
  "short_url": "https://rzp.io/i/z3b1R61A9",
26
  "has_scheduled_changes": false,
27
  "change_scheduled_at": null,
28
  "source": "api",
29
  "offer_id":"offer_JHD834hjbxzhd38d",
30
  "remaining_count": 6
31
}
Path Parameters
id

*

string

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

Request Parameters
pause_at
string

The value should be now to pause a Subscription immediately.

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 authorization 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 MYR 100.00/user/month and the customer has 5 users, you should pass 5 as the quantity to have the customer charged MYR 500.00 (5 x MYR 100.00) 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 authorization 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 Curlec.

  • false: communication handled by businesses.
  • true: communication handled by Curlec. Defaults to true.

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 authorization payment. For example, 1581013800.

short_url
string

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

has_scheduled_changes
boolean

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

  • true
  • false

schedule_change_at
string

Represents when the subscription should be updated. Possible values:

  • now (default value): 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

The API key/secret provided is invalid.

Error Status: 4xx

This error occurs due to a mismatch between the API credentials passed in the API call and those generated on the dashboard.

Solution

Pause a Subscription

POST
/v1/subscriptions/:id/pause

Click to copy

Use this endpoint to pause a Subscription.

Watch Out!

  • You can only pause a Subscriptions in the active state.
  • If you pause a Subscription in the authenticated state, it goes to the cancelled state.

Is this page helpful?

Path Parameters
id

*

string

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

Request Parameters
pause_at
string

The value should be now to pause a Subscription immediately.

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 authorization 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 MYR 100.00/user/month and the customer has 5 users, you should pass 5 as the quantity to have the customer charged MYR 500.00 (5 x MYR 100.00) 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 authorization 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 Curlec.

  • false: communication handled by businesses.
  • true: communication handled by Curlec. Defaults to true.

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 authorization payment. For example, 1581013800.

short_url
string

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

has_scheduled_changes
boolean

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

  • true
  • false

schedule_change_at
string

Represents when the subscription should be updated. Possible values:

  • now (default value): 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

The API key/secret provided is invalid.

Error Status: 4xx

This error occurs due to a mismatch between the API credentials passed in the API call and those generated on the dashboard.

Solution

Curl

change language

change language

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2
-X POST https://api.razorpay.com/v1/subscriptions/sub_00000000000001/pause \
3
-H "Content-Type: application/json" \
4
-d '{
5
  "pause_at":"now"
6
}'

Success

Failure

1
{
2
  "id": "sub_00000000000001",
3
  "entity": "subscription",
4
  "plan_id": "plan_00000000000001",
5
  "status": "paused",
6
  "current_start": null,
7
  "current_end": null,
8
  "ended_at": null,
9
  "quantity": 1,
10
  "notes":{
11
    "notes_key_1":"Tea, Earl Grey, Hot",
12
    "notes_key_2":"Tea, Earl Grey… decaf."
13
  },
14
  "charge_at": null,
15
  "start_at": 1580626111,
16
  "end_at": 1583433000,
17
  "auth_attempts": 0,
18
  "total_count": 6,
19
  "paid_count": 0,
20
  "customer_notify": true,
21
  "created_at": 1580280581,
22
  "paused_at": 1590280581,
23
  "expire_by": 1580626111,
24
  "pause_initiated_by": "self",
25
  "short_url": "https://rzp.io/i/z3b1R61A9",
26
  "has_scheduled_changes": false,
27
  "change_scheduled_at": null,
28
  "source": "api",
29
  "offer_id":"offer_JHD834hjbxzhd38d",
30
  "remaining_count": 6
31
}