Api Subscription

This Section guides you to create subscription via api payment mode.

The API subscription is compatible with all types of integration methods. If you want to skip the 3DS option, please contact Foloosi's support team.

NOTE,

A subscription can only be created when the API is set to live mode.

Basic Requirements

• Foloosi merchant account - click here to sign up .

• Create api credentials - click here to create.

Steps to create subscription

To create a subscription using any type of integration, simply add the required post data to the initialize API.

// additional data to be passed with initialize api,
api_subscription :  "Yes", /**NOTE- THIS FIELD MUST BE IN YES */
recurring_data : {
    plan : {
        name : "Api new plan", /** YOUR PLAN NAME*/
        billing_type : "day", /** value must be day/week/month/year */
        billing_cycle : 1, /** it only applicable for week and month billing type.ex Every 1 weeks */
        billing_currency : "AED", //it should be 3 digit code and other than AED you should enabled multi currency option from Foloosi
        billing_amount : "SUBSCRIPTION AMOUNT",
        setup_fee : "SETUP FEE", //which is subscription setup one time fee
        total_count : 10, //number of deductions
        description : "daily demo plan",
        start_date : "dd-mm-yyyy" //which is optional param.if you given value should be in the format
                                  //Note : if you given date means .at the time of payment will be charged by transaction
                                  //amount as you given .subscription recurring will start on the given date and given billing amount
    },
    customer : {
        name : "CUSTOMER NAME",
        email : "CUSTOMER EMAIL ID"',
        mobile : "CUSTOMER MOBILE NO",
    }
}

Sample images

After successful subscription creation, it has to be listed in Foloosi panel. Please login to view the subscription created.

Subscription list

Click the subscription id to view details like below

Subscription detail popup

To get the Transaction Details And Subscription number

For Transaction Details, you can use the Get request as below.

GET API LINK: https://api.foloosi.com/v1/api/transaction-detail/YOUR_TRANSACTION_ID

HEADERS:
secret_key : YOUR_SECRET_KEY

SAMPLE RESPONSE:
{
    "message": "Transaction detail are",
    "data": {
        "transaction_no": "FLSXXXXXXXXXXXXXX",
        "receipt": null,
        "request_currency": "AED",
        "request_amount": 18,
        "customer_currency": "AED",
        "customer_amount": 18,
        "merchant_currency": null,
        "merchant_amount": null,
        "status": "pending",
        "created": "2022-11-01T10:21:04+00:00",
        "optional1": "order-id-123",\\optional fields passed on initialize api
        "optional2": "order-reference",\\optional fields passed on initialize api
        "optional3": "",\\optional fields passed on initialize api
        "subscription_no": "FLSSXXXXXXXXXXXXX"
    }
}

To get the Subscription Details

For Subscription Details, you can use the Get request as below,

GET API LINK: https://api.foloosi.com/v1/open/subscription-link/detail/YOUR_TRANSACTION_ID

HEADERS:
secret_key : YOUR_SECRET_KEY

SAMPLE RESPONSE:
{
    "message": "Subscription details are",
    "data": {
        "customer": {
            "name": "FOLOOSI CUSTOMER",
            "email": "[email protected]",
            "mobile": "567812345",
            "card_last_four": "5123"
        },
        "plan": {
            "name": "Mobile PostPaid",
            "type": "Billed Every month",
            "amount": "AED 114.60",
            "unit": "1 x AED 114.60 per unit",
            "setup_fee": 0,
            "status": "active",
            "created": "01-10-2022 02:11 am"
        },
        "invoices": [
            {
                "id": 50094,
                "subscription_id": 1031,
                "billing_type": "month",
                "billing_count": 1,
                "bill_date": "2022-11-01",
                "status": "paid"
            },
            {
                "id": 50095,
                "subscription_id": 1031,
                "billing_type": "month",
                "billing_count": 1,
                "bill_date": "2022-12-01",
                "status": "pending"
            }
        ]
    }
}

To cancel a Subscription

NOTE : Follow any one of the methods below to cancel a subscription,

a. To cancel a Subscription with api , you can use the api given below,

PUT API LINK: https://api.foloosi.com/v1/open/subscription-link/suspend

HEADERS:
secret_key : YOUR_SECRET_KEY

BODY:
subscription_no : YOUR_SUBSCRIPTION_NO

SAMPLE RESPONSE:
{
    "message": "Subscription cancelled successfully",
    "data": {
        "status": 200
    }
}

b. You can cancel the subscription directly from foloosi panel.

• login to foloosi panel.

• click subscriptions under subscription category.

• click the subscription id, it will open a popup as shown below.

cancel subscription

NOTE

Supports 170 World Currencies

Properties

List of properties available:

Name	Type	Required	Description
merchant_key	String	true	your foloosi merchant key
secret_key	String	true	your foloosi secret key
reference_token	String	false	the reference token - generates automatically if null
site_redirect_url	String	false	the url which will get payment response after payment completed.
transaction_amount	String	true	transaction amount
currency	String	true	transaction currency
customer_name	String	false	customer name - auto render in payment popup if passed
customer_email	String	false	customer email - auto render in payment popup if passed
customer_mobile	String	false	customer mobile - auto render in payment popup if passed
customer_address	String	false	customer address - auto render in payment popup if passed
customer_city	String	false	customer city - auto render in payment popup if passed
billing_state	String	false	Billing State - auto render in payment popup if passed
billing_postal_code	String	false	Billing Postcode - auto render in payment popup if passed
billing_country	String	false	Billing Country - auto render in payment popup if passed
api_subscription	String	true	It must be Yes for create subscription
recurring_data	Array	true	It contain subscription details
plan	Array	true	It must have plan detail
name	String	true	It must be string and name for the plan
biling_type	String	true	it must be day/week/month/year
billing_cycle	Integer	true	it only applicable for week and month billing type.ex Every 1 weeks
billing_currency	String	true	it should be 3 digit code and other than AED you should enabled multi currency option from Foloosi
billing_amount	Integer	true	recurring amount should be passed here
setup_fee	Integer	false	which is subscription setup one time fee
total_count	Integer	true	number of deductions in recurring
description	String	true	subscription description should be entered
start_date	String	false	which is optional param.if you given value should be in the format('dd-mm-yyyy') if you given date means .at the time of payment will be charged by transaction amount as you given .subscription recurring will start on the given date and given billing amount
customer	Array	true	It should contain customer details
name	String	true	it must be customer name
email	String	true	it must be customer email Id
mobile	Integer	true	it must be customer mobile number

Support

Visit https://www.foloosi.com for support requests or email to [email protected].

Developed by

Foloosi Technologies Pvt Ltd.

License

Copyrights (c) 2024 Foloosi