Subscription

This Section guides you to create subscription via api.

The subscription documention will guide you, how to integrate subscription payment via api. 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 and send the subscription link to the customer via SMS or email, this process will skip the payment step before creating the subscription. The link will be sent after the subscription is created, and the customer can proceed with the payment.

// Create Subscription
POST API LINK: https://api.foloosi.com/v1/subscription/create

// Post Body Fields
{
    "plan_name" : "Api new plan test", /** YOUR PLAN NAME*/
    "billing_type" : "month", /** 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", /** Optional - which is subscription setup one time fee */
    "total_count" : 10, /** number of deductions */
    "description" : "monthly 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   
    "notify_email" : "Yes" || "No",
    "notify_sms" : "Yes" || "No",
    "customer" : {
        "name" : "CUSTOMER NAME",
        "email" : "CUSTOMER EMAIL ID",
        "phone_code" : "CUSTOMER MOBILE CODE", /** Eg: +971 */
        "phone_number" : "CUSTOMER MOBILE NO"
    }
}

//Sample response
{
    "message": "Subscription created successfully",
    "data": {
        "subscription_no": "FAPISC1234567XXXXXX122fw11"
    }
}

Sample images

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

Click the subscription id to view details like below

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.
NOTE
Supports 170 World Currencies
Properties
List of properties available:
Name
Type
Required
Description
secret_key
String
true
your foloosi secret key
plan_name
String
true
Your Subscription Plan Name
billing_type
String
true
value must be day/week/month/year
billing_cycle
integer
false
it only applicable for week and month billing type.ex Every 1 weeks
setup_fee
String
false
which is subscription setup one time fee
billing_amount
String
true
subscription amount
billing_currency
String
true
transaction currency
total_count
Integer
true
number of deductions
description
String
false
describe the subscription details.
start_date
Date
false
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 Format should be in "dd-mm-yyyy".
name
String
false
customer name - auto render in payment popup if passed
email
String
true
customer email Id
phone_number
String
true
customer mobile number
phone_code
String
true
customer mobile code