> For the complete documentation index, see [llms.txt](https://docs.foloosi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.foloosi.com/subscriptions/subscription.md).

# 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 ](https://foloosi.com/business-signup).
* Create api credentials - [click here to create](/get-started/create-api-credentials.md).

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

{% code lineNumbers="true" %}

```javascript
// 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"
    }
}

```

{% endcode %}

#### Sample images

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

<figure><img src="https://2728483298-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MQCT5TjkKNyS34llPoX%2Fuploads%2FAMmztaxIWS1VWqgGcqHU%2Fsubscrption.png?alt=media&amp;token=9d23f6d0-01ee-4c5c-8b28-ee4a4da9b4fa" alt=""><figcaption><p>Subscription list</p></figcaption></figure>

Click the subscription id to view details like below

<figure><img src="https://2728483298-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MQCT5TjkKNyS34llPoX%2Fuploads%2FMbHZrILKoFMC8TQoj9S5%2Fsubscrption-2.png?alt=media&amp;token=7662ab11-9ead-4d01-8459-e9898cccbd65" alt=""><figcaption><p>Subscription detail popup</p></figcaption></figure>

**To get the Subscription Details**&#x20;

For Subscription Details, you can use the Get request as below,&#x20;

{% code lineNumbers="true" %}

```
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": "tech@foloosi.com",
            "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"
            }
        ]
    }
}
```

{% endcode %}

**To cancel a Subscription**&#x20;

**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,&#x20;

```javascript

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.

  *

  <figure><img src="https://2728483298-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MQCT5TjkKNyS34llPoX%2Fuploads%2FXx11Catiy4V7JyjQBkQM%2Fsubscrption-cancel.png?alt=media&amp;token=6bf81cc2-3e36-4ae7-80aa-0d09fe4c9a6f" alt=""><figcaption><p>cancel subscription</p></figcaption></figure>

  **NOTE**

  Supports 170 World Currencies

  ## Properties

  List of properties available:

  <table><thead><tr><th width="148">Name</th><th width="98">Type</th><th width="122">Required</th><th width="211">Description</th></tr></thead><tbody><tr><td>secret_key</td><td>String</td><td>true</td><td>your foloosi secret key</td></tr><tr><td>plan_name</td><td>String</td><td>true</td><td>Your Subscription Plan Name</td></tr><tr><td>billing_type</td><td>String</td><td>true</td><td>value must be day/week/month/year</td></tr><tr><td>billing_cycle</td><td>integer</td><td>false</td><td>it only applicable for week and month billing type.ex Every 1 weeks</td></tr><tr><td>setup_fee</td><td>String</td><td>false</td><td>which is subscription setup one time fee</td></tr><tr><td>billing_amount</td><td>String</td><td>true</td><td>subscription amount </td></tr><tr><td>billing_currency</td><td>String</td><td>true</td><td>transaction currency</td></tr><tr><td>total_count</td><td>Integer</td><td>true</td><td>number of deductions</td></tr><tr><td>description</td><td>String</td><td>false</td><td>describe the subscription details.</td></tr><tr><td>start_date</td><td>Date</td><td>false</td><td>if you given date means .at the time of payment will be charged by transaction,<br>amount as you given .subscription recurring will start on the given date and given billing amount<br>Format should be in "dd-mm-yyyy".</td></tr><tr><td>name</td><td>String</td><td>false</td><td>customer name - auto render in payment popup if passed</td></tr><tr><td>email</td><td>String</td><td>true</td><td>customer email Id</td></tr><tr><td>phone_number</td><td>String</td><td>true</td><td>customer mobile number</td></tr><tr><td>phone_code</td><td>String</td><td>true</td><td>customer mobile code </td></tr></tbody></table>

#### Support

Visit  <https://www.foloosi.com> for support requests or email to <tech@foloosi.com>.

## Developed by

Foloosi Technologies Pvt Ltd.

## License

Copyrights (c) 2025 Foloosi