Create subscription

​

Sample Request for create Subscription

{
  {
    
    "returnUrl": "https://www.google.com",
    "quoteCurrCode": "INR",
    "items": [
        {
            "name": "ProductName4",
            "description": "ProductDescriptoin1",
            "amount": 100,
            "quantity": 1
        },
        {
            "name": "ProductName5",
            "description": "ProductDescriptoin2",
            "amount": 60,
            "quantity": 2
        }
       
    ],
    
    "billTo": {
        "name": "XYZ",
        "postalCode": "110001",
        "country": "INDIA"
    },
    "name": "XYZ",
    "email": "customer30@gmail.com",
    
    "description": "Testing first subscription end to end",
    "maxQuoteAmount": "500",
    
    "billAtStart": true,
    "pendingExpire": "120",
    
    "dayUntillDue": "2",
    "frequency": "MNTH",
    "maxUnpaidInvoices" : "2",
    "postMaxUnpaidInvoices": "PAUSED",
    "maxUnpausedInvoiceDueCount" : "1",
    
}
}

​

Parameter’s Description

• pendingExpire: Number of minutes after which, if the status of the subscription is PENDING (Customer did not pay), it becomes PENDING_EXPIRED, which is a terminal state, and now customers cannot pay on the same subscription. By default that subs will be marked as expired by the system after 24 hrs. However, with the help of the pendingExpire param, this time can be reduced to a minimum: 10 mins to a max of 7 days.
• dayUntillDue: Period of time from the issue date after which DUE invoice is converted into OVERDUE status.
• maxUnpaidInvoices: Maximum number of unpaid invoices allowed for a subscription. If the number of unpaid invoices exceeds this limit, the subscription status will be paused.
• postMaxUnpaidInvoices: Subscription status after maxUnpaidInvoices the threshold is crossed by the customer. Default Value: PAUSED
• maxUnpausedInvoiceDueCount: Maximum number of unpaid invoices count allowed after that the subscription is PAUSED by the system. For Ex: If a subscription has been paused due to 3 non payment of invoices and this parameter is set to be 2 then once the customer pays 1 invoice the subscription will be re activated.
• billTo: Billing Details of the customer.
• items: Items the customer wants to buy.
• returnUrl: The URL to which the customer will be redirected after completing the payment. This can be a success page or a failure page based on the payment status.
• frequency: Frequency of the subscription renewal period.
• billAtStart: If this is true, then the subscription is prepaid based subscription and allows to deduction of money before providing the product to the end customer and generating the invoice at the start of the subscription period. If this is false then it is a postpaid subscription which creates an invoice at the end of the subscription period.
• billingDateAnchor: Some types of billing cycles need to be started from a specific date of a month. An example of this is Amazon Web Services, where the invoice will always be raised on the 1st day of the month, even if the customer started using the platform on the 15th of the month.