> ## Documentation Index > Fetch the complete documentation index at: https://razorpay-60c89f9a-mintlify-audit-missing-sections-1778528421.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Create a Subscription Link > **POST** `/v1/subscriptions` Use this endpoint to create a Subscription link. ### Request ````curl: Curl theme={null} curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \ -X POST https://api.razorpay.com/v1/subscriptions \ -H "Content-Type: application/json" \ -d '{ "plan_id": "plan_00000000000001", "total_count": 12, "quantity": 1, "start_at": 1561852800, "expire_by": 1561939199, "customer_notify": true, "addons": [ { "item": { "name": "Delivery charges", "amount": 30000, "currency": "INR" } } ], "offer_id":"offer_JHD834hjbxzhd38d", "notes": { "notes_key_1":"Tea, Earl Grey, Hot", "notes_key_2":"Tea, Earl Grey… decaf." }, "notify_info":{ "notify_phone": "+919876543210", "notify_email": "gaurav.kumar@example.com" } }' ```csharp: .NET RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]"); Dictionary subscriptionRequest = new Dictionary(); subscriptionRequest.Add("plan_id", "plan_Z6t7VFTb9xHeOs"); subscriptionRequest.Add("total_count", 12); subscriptionRequest.Add("quantity", 1); subscriptionRequest.Add("customer_notify", true); subscriptionRequest.Add("start_at", 1580453311); subscriptionRequest.Add("expire_by", 1580626111); List> addons = new List>(); Dictionary linesItem = new Dictionary(); Dictionary item = new Dictionary(); item.Add("name", "Delivery charges"); item.Add("amount", 30000); item.Add("currency", "INR"); linesItem.Add("item", item); addons.Add(linesItem); subscriptionRequest.Add("addons", addons); subscriptionRequest.Add("offer_id", "offer_Z6t7VFTb9xHeOs"); Dictionary notes = new Dictionary(); notes.Add("notes_key_1", "Tea, Earl Grey, Hot"); notes.Add("notes_key_2", "Tea, Earl Grey… decaf."); subscriptionRequest.Add("notes", notes); Dictionary notifyInfo = new Dictionary(); notifyInfo.Add("notify_phone", "+919876543210"); notifyInfo.Add("notify_email", "gaurav.kumar@example.com"); subscriptionRequest.Add("notify_info", notifyInfo); Subscription subscription = client.Subscription.Create(subscriptionRequest); ```java: Java RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]"); JSONObject subscriptionRequest = new JSONObject(); subscriptionRequest.put("plan_id", "plan_HoYg68p5kmuvzD"); subscriptionRequest.put("total_count", 12); subscriptionRequest.put("quantity", 1); subscriptionRequest.put("customer_notify", true); subscriptionRequest.put("start_at", 1580453311); subscriptionRequest.put("expire_by", 1580626111); List addons = new ArrayList<>(); JSONObject linesItem = new JSONObject(); JSONObject item = new JSONObject(); item.put("name","Delivery charges"); item.put("amount",30000); item.put("currency","INR"); linesItem.put("item",item); addons.add(linesItem); subscriptionRequest.put("addons",addons); subscriptionRequest.put("offer_id","offer_JTUADI4ZWBGWur"); JSONObject notes = new JSONObject(); notes.put("notes_key_1","Tea, Earl Grey, Hot"); notes.put("notes_key_2","Tea, Earl Grey… decaf."); subscriptionRequest.put("notes", notes); JSONObject notifyInfo = new JSONObject(); notifyInfo.put("notify_phone","+919876543210"); notifyInfo.put("notify_email","gaurav.kumar@example.com"); subscriptionRequest.put("notify_info",notifyInfo); Subscription subscription = razorpay.subscriptions.create(subscriptionRequest); ```php: PHP $api = new Api($key_id, $secret); $api->subscription->create(array('plan_id' => 'plan_HoYg68p5kmuvzD','total_count' => 12,'quantity' => 1,'expire_by' => 1633237807,'customer_notify' => true, 'addons' => array(array('item'=>array('name' => 'Delivery charges','amount' => 30000,'currency' => 'INR'))),'notes'=>array('notes_key_1'=>'Tea, Earl Grey, Hot','notes_key_2'=>'Tea, Earl Grey… decaf.'),'notify_info'=>array('notify_phone' => '+919876543210','notify_email'=> 'gaurav.kumar@example.com'))); ```javascript: Node.js var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' }) instance.subscriptions.create({ plan_id: "plan_HoYg68p5kmuvzD", total_count: 12, quantity: 1, expire_by: 1633237807, customer_notify: true, addons: [ { item: { name: "Delivery charges", amount: 30000, currency: "INR" } } ], notes: { notes_key_1: "Tea, Earl Grey, Hot", notes_key_2: "Tea, Earl Grey… decaf." }, notify_info: { notify_phone: "+919876543210", notify_email: "gaurav.kumar@example.com" } }) ```python: Python import razorpay client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET")) client.subscription.create({ 'plan_id': 'plan_HoYg68p5kmuvzD', 'total_count': 12, 'quantity': 1, 'expire_by': 1633237807, 'customer_notify': True, 'addons': [{'item': {'name': 'Delivery charges', 'amount': 30000, 'currency': 'INR'}}], 'notes': {'notes_key_1': 'Tea, Earl Grey, Hot', 'notes_key_2': 'Tea, Earl Grey\xe2\x80\xa6 decaf.'}, 'notify_info': {'notify_phone': '+919876543210', 'notify_email': 'gaurav.kumar@example.com'} }) ```ruby: Ruby require "razorpay" Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET') para_attr = { "plan_id": "plan_HoYg68p5kmuvzD", "total_count": 12, "quantity": 1, "expire_by": 1633237807, "customer_notify": 1, "addons": [ { "item": { "name": "Delivery charges", "amount": 30000, "currency": "INR" } } ], "notes": { "notes_key_1": "Tea, Earl Grey, Hot", "notes_key_2": "Tea, Earl Grey… decaf." }, "notify_info": { "notify_phone": "+919876543210", "notify_email": "gaurav.kumar@example.com" } } Razorpay::Subscription.create(para_attr) ```go: Go import ( razorpay "github.com/razorpay/razorpay-go" ) client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET") data := map[string]interface{}{ "plan_id": "plan_00000000000001", "total_count": 12, "quantity": 1, "start_at": 1561852800, "expire_by": 1561939199, "customer_notify": true, "addons": []interface{}{ map[string]interface{}{ "item": map[string]interface{}{ "name": "Delivery charges", "amount": 30000, "currency": "INR", }, }, }, "offer_id":"offer_JHD834hjbxzhd38d", "notes": map[string]interface{}{ "notes_key_1":"Tea, Earl Grey, Hot", "notes_key_2":"Tea, Earl Grey… decaf.", }, "notify_info":map[string]interface{}{ "notify_phone": "+919876543210", "notify_email": "gaurav.kumar@example.com", }, } body, err := client.Subscription.Create(data, nil) ```` ### Response ````json: Success theme={null} { "id":"sub_00000000000002", "entity":"subscription", "plan_id":"plan_00000000000001", "status":"created", "current_start":null, "current_end":null, "ended_at":null, "quantity":1, "notes":{ "notes_key_1":"Tea, Earl Grey, Hot", "notes_key_2":"Tea, Earl Grey… decaf." }, "charge_at":1580453311, "start_at":1580453311, "end_at":1587061800, "auth_attempts":0, "total_count":12, "paid_count":0, "customer_notify":true, "created_at":1580283117, "expire_by":1581013800, "short_url":"https://rzp.io/i/m0y0f", "has_scheduled_changes":false, "change_scheduled_at":null, "source": "api", "offer_id":"offer_JHD834hjbxzhd38d", "remaining_count":12 } ```json: Failure { "error": { "code": "BAD_REQUEST_ERROR", "description": "Link expire by cannot be lesser than the current time." } } ```` ### Parameters `plan_id` *mandatory* : `string` The unique identifier of a plan that should be linked to the Subscription. For example, `plan_00000000000001`. `total_count` *mandatory* : `integer` 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`. `quantity` *optional* : `integer` 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 /month/license. The customer wants 5 licenses. You should pass `5` as the quantity. The customer is charged 500 (5 x 100) monthly. By default, this value is set to `1`. `start_at` *optional* : `integer` Unix timestamp that 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`. `expire_by` *optional* : `integer` 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. `customer_notify` *optional* : `boolean` Indicates whether the communication to the customer would be handled by businesses or Razorpay. Possible values: * `true` (default): Communication handled by Razorpay. * `false`: Communication handled by businesses. `addons` : `object` Array that contains details of any upfront amount you want to collect as part of the authorisation transaction. `item` : `object` Details of the upfront amount you want to charge your customer. `name` *optional* : `string` A name for the upfront amount you want to charge the customer. For example, `Delivery Fee`. `amount` *optional* : `integer` The upfront amount in the currency subunit you want to charge the customer. For example ,`30000`. `currency` *optional* : `string` The currency in which you want to charge the customer. This has to match the plan currency. For example, `INR`. `offer_id` *optional* : `string` The unique identifier of the offer that is linked to the Subscription. You can obtain this from the Dashboard. For example, `offer_JHD834hjbxzhd38d`. `notes` *optional* : `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”`. `notify_info` : `object` The customer's email and phone number to which notifications are to be sent. Use this array only if you have set the `customer_notify` parameter to `true`. That is, Razorpay sends notifications to the customer. The customer details entered in the API request are only to notify the customer about the Subscription. The same will not be prefilled in the checkout as per the government guidelines. `notify_phone` *optional* : `string` The customer's phone number. `notify_email` *optional* : `string` The customer's email. You can perform various actions related to Subscriptions using the Dashboard. ### 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](/payments/subscriptions/states) 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 Link expire by cannot be lesser than the current time. * code: 400 * description: This error occurs when the time mentioned in the `expire_by` parameter has already passed. For example, if today's date is December 12, 2022, but the expiry date is mentioned as December 10, 2022. * solution: Ensure that the time passed in the `expiry_by` parameter occurs after the current time at the time of creating the Subscription link.