Fetch Details of a Pending Update

GET /v1/subscriptions/:id/retrieve_scheduled_changes

Use this endpoint to retrieve details of a pending update. This happens when a Subscription is updated using the end of cycle option for the schedule_change_at parameter.

Example

A Subscription is to be charged on the 1st of every month. It was charged on January 01, 2021. On January 15, 2021, it was updated using the end of cycle option for the schedule_change_at parameter. In this case, the update goes live after the Subscription is charged on February 01, 2021. Such updates are said to be scheduled updates and details of such updates can be fetched using this API.

Request

Curl

curl -u : \
-X GET https://api.razorpay.com/v1/subscriptions/sub_00000000000001/retrieve_scheduled_changes \

```java: Java
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String subscriptionId = "sub_00000000000001";

Subscription subscription = razorpay.subscription.fetchPendingUpdate(subscriptionId);

```php: PHP
$api = new Api($key_id, $secret);

$api->subscription->fetch($subscriptionId)->pendingUpdate()

```javascript: Node.js
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.subscriptions.pendingUpdate(subscriptionId)

```python: Python
import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.subscription.pending_update(subscriptionId)

```ruby: Ruby
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

subscriptionId = "sub_00000000000001"

Razorpay::Subscription.fetch(subscriptionId).pending_update

```go: Go
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

body, err := client.Subscription.PendingUpdate("", nil, nil)

```csharp: .NET
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

string subscriptionId = "sub_00000000000001";

Subscription subscription = client.Subscription.Fetch(subscriptionId).FetchPendingUpdate();

Response

Success

{
  "id":"sub_00000000000001",
  "entity":"subscription",
  "plan_id":"plan_00000000000003",
  "customer_id":"cust_00000000000001",
  "status":"active",
  "current_start":1580284732,
  "current_end":1580841000,
  "ended_at":null,
  "quantity":25,
  "notes":{
    "notes_key_1":"Tea, Earl Grey, Hot",
    "notes_key_2":"Tea, Earl Grey… decaf."
  },
  "charge_at":1580841000,
  "start_at":1580284732,
  "end_at":1611081000,
  "auth_attempts":0,
  "total_count":6,
  "paid_count":1,
  "customer_notify":true,
  "created_at":1580284702,
  "expire_by":1580626111,
  "short_url":"https://rzp.io/i/fFWTkbf",
  "has_scheduled_changes":true,
  "change_scheduled_at":1557253800,
  "source": "api",
  "offer_id":"offer_JHD834hjbxzhd38d",
  "remaining_count":5
}
```json: Failure
{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The api key provided is invalid",
    "source": "NA",
    "step": "NA",
    "reason": "NA",
    "metadata": {}
  }
}

Parameters

id mandatory : string The unique identifier linked to a Subscription. For example, sub_00000000000001.

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

The API key/secret provided is invalid.

• code: 4xx
• description: This error occurs due to a mismatch between the API credentials passed in the API call and those generated on the Dashboard.
• solution: Ensure that the API keys are active and correctly entered, with no whitespaces before or after the keys.