Available in🇮🇳 India🇲🇾 Malaysia🇸🇬 Singapore🇺🇸 United States
The Subscriptions entity has the following parameters.
The unique identifier of a plan that should be linked to the Subscription. For example,
plan_00000000000001.The unique identifier 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 Curlec. Possible values:
true(default): Communication handled by Razorpay Curlec.false: Communication handled by businesses.
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 RM 100/month/license. The customer wants 5 licenses. You should pass 5 as the quantity. The customer is charged RM 500 (5 x RM 100) monthly. By default, this value is set to
1.Status of the Subscription. Possible values:
createdauthenticatedactivependinghaltedcancelledcompletedexpired
The Unix timestamp of when the Subscription has completed its period or has been cancelled midway.
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 upfront amount in the currency subunit you want to charge the customer. For example ,
30000.The currency in which you want to charge the customer. This has to match the plan currency. For example,
MYR.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: Subscription has scheduled changes.false: Subscription does not have scheduled changes.
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.