Link an Offer to a Subscription

Link an Offer to a Subscription using the Razorpay API.

POST /v1/subscriptions

Curl

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": "<phone>",
    "notify_email": "<email>"
  }
}'

Success

{
  "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
}

Available in🇮🇳 India🇸🇬 Singapore🇺🇸 United States

Use this endpoint to link an existing Offer by creating a new Subscription link. Pass the offer_id: <offer_id> parameter in the request when creating a Subscription.

Curl

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": "<phone>",
    "notify_email": "<email>"
  }
}'

Success

{
  "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
}

Request Parameters

plan_id · string · required

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

total_count · integer · required

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 · 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 · 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 · 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 · 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 · string

A name for the upfront amount you want to charge the customer. For example, Delivery Fee.

amount · integer

The upfront amount in the currency subunit you want to charge the customer. For example ,30000.

currency · string

The currency in which you want to charge the customer. This has to match the plan currency. For example, INR.

offer_id · 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 · 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”.

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 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.

customer_email · string

The customer’s email address associated with the subscription.

change_scheduled_at · integer

Timestamp, in Unix format, when a scheduled update on this subscription is set to take effect. null when no update is pending.

source · string

The origin of the subscription. One of api (created via API), dashboard, or links.

Errors

Link expire by cannot be lesser than the current time.

Code: 400

The link expiry time is less than the current time.

Solution: Ensure the link expiration time is greater than your current time.

Offer Not Found.

Code: 400

The offer_id does not exist on the merchant account. Returned when a well-formed but non-existent offer id is passed.

Solution: Use a valid offer_id from an active offer created on the Dashboard.

The offer id must be 20 characters.

Code: 400

The value passed for offer_id is not in the expected offer_<14 alphanumeric chars> format (20 characters total). Returned for malformed or wrong-prefix offer ids.

Solution: Pass offer_id in the form offer_<14 alphanumeric chars>.

The id provided does not exist.

Code: 400

An empty string was passed for offer_id.

Solution: Either omit offer_id from the request body, or pass a valid offer id.

Discounted amount less than minimum payment amount.

Code: 400

The offer’s discount brings the plan amount below the minimum payable amount for the currency (₹1.00 for INR). Returned when applying the offer would make the per-cycle charge invalid.

Solution: Either use an offer with a smaller discount, or pick a plan with a higher per-cycle amount.

Offer not applicable for this subscription.

Code: 400

The offer exists but is not applicable for the supplied subscription. This typically happens because the offer’s currency, payment-method scope, plan-eligibility list or validity window does not match the subscription.

Solution: Use an offer that is applicable for the subscription’s plan, currency and payment method. You can review an offer’s applicability rules from the Razorpay Dashboard.