The unique identifier of the plan for which you want to retrieve all the Subscriptions.

The Unix timestamp from when Subscriptions are to be fetched.

The Unix timestamp till when Subscriptions are to be fetched.

The number of Subscriptions to be fetched. Default value is 10. Maximum value is 100. This can be used for pagination, in combination with skip.

The number of Subscriptions to be skipped. Default value is 0. This can be used for pagination, in combination with count.

The unique identifier linked to a Subscription.

The entity being created. Here, it is subscription.

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

The unique identifer of the customer who is subscribing to a plan. This is populated automatically after the customer completes the authorisation transaction.

The number of billing cycles for which the customer should be charged. For example, if a customer is buying a 1-year subscription billed on a bi-monthly basis, this value should be 6.

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

• 0: communication handled by businesses.
• 1 (default): communication handled by Razorpay.

The Unix timestamp, indicates from when the Subscription should start. If not passed, the Subscription starts immediately after the authorisation payment. For example, 1581013800. For Subscriptions with a future start_date, frequency is considered as_presented.

The number of times the customer should be charged the plan amount per invoice. For example, a customer subscribes to use software. The charges are ₹100.00/month/license. The customer wants 5 licenses. You should pass 5 as the quantity. The customer is charged ₹500.00 (5 x ₹100.00) monthly. By default, this value is set to 1.

Object consisting of key value pairs as notes.

This can be used to charge the customer a one-time fee before the start of the Subscription. This can include something like a one-time delivery charge or a security deposit. Know more about

Status of the Subscription. Possible values:

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

Know more about

Indicates the number of billing cycles the customer has already been charged.

Indicates the start time of the current billing cycle of a Subscription.

Indicates the end time of the current billing cycle of a Subscription.

The Unix timestamp of when the Subscription has completed its period or has been cancelled midway.

The Unix timestamp of when the next charge on the Subscription should be made.

The number of times the charge for the current billing cycle has been attempted on the card.

The Unix timestamp that indicates till when the customer can make the authorisation payment. For example, 1581013800. The default value is 30 years. Do not pass any value if you do not want to set an expiry date.

Array that contains details of any upfront amount you want to collect as part of the authorisation transaction.

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

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": "Gym Membership Plan.

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

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

• true
• false

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.

Indicates the number of billing cycles remaining on the Subscription. For example, 2.