Create a subscription

Creates a subscription on an existing mandate (internal or external).

ARGUMENTS

Scroll inside to view more
Argument
Description
metadata optional
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
amount REQUIRED
The amount to charge on a recurring basis. A positive integer in paisa (one hundredth of a Rupee). e.g. 100 means Rs 1. Should be less than or equal to mandate's maximum_amount or equal to mandate's collection_amount. Must be less than or equal to Rs 1 crore (1 billion paisa).
count optional
The total number of ACH debits that should be taken by this subscription. If not specified, the subscription will continue until cancelled. The resulting final charge date should be on or before the mandate's final_collection_date.
day_of_month optional
As per RFC 2445. The day of the month to charge customers on. 1-28 or -1 to indicate the last day of the month.
interval REQUIRED
The unit of time between charge dates. One of week, month or year. Must result in at least one charge date within the next one year. All arising charge dates should fall between mandate's first_collection_date and final_collection_date.
interval_count optional, default value is 1
The number of intervals (specified in the interval property) between charge dates. For example, interval= month and interval_count = 3 bills every three months. Must be greater than or equal to 1. Must result in at least one charge date within the next one year. All arising charge dates must fall between mandate's first_collection_date and final_collection_date.
month optional, default is current month
The name of the month on which to charge a customer. Must be lower case.
name optional
The name of the subscription. This will be set as the reference_creditor on each ACH debit created. Must not exceed 255 characters.
start_date optional
The date on which the first ACH debit should be charged. Must be within one year of creation, and on or after the mandate's first_collection_date. When blank, this will be set as today or the internal mandate's first_collection_date, whichever is later. Must match the day_of_month, if any.
mandate REQUIRED
The identifier of the associated mandate on which the subscription should create ACH debits. Mandate's status must be active, and mandate's status_cancel must not be cancel_requested or cancel_submitted. Mandate should not have any existing pending_customer_approval or active subscription attached to it. Mandate should not belong to any plan. Mandate's NACH profile must have a creditor bank account else ACH debits cannot be created on it. frequency must be ADHO.

Returns Returns a subscription object.

API Endpoints
Sandbox Link
POST
https://api-test.lotuspay.com/v1/subscriptions
Production Link
POST
https://api.lotuspay.com/v1/subscriptions
Authorization Header
Last updated 1 year ago