?HAMA

Edit File Size: 4.84 KB

/home/byroehnu/.trash/node_modules11/flutterwave-node-v3/documentation/subscription.md

Text Base64

# SUBSCRIPTION

We recommend reading the main readme first, to understand the requirements for using the library and how to initiate this in your apps. This guide assumes you've read that.

Manage User subscriptions via any of these methods:
1. [Get all Subscriptions](#get-all-subscriptions)
2. [Fetch a Subscription](#fetch-subscriptions-with-customers-email)
3. [Cancel a Subscription](#cancel-a-subscription)
4. [Activate a Subscription](#activate-a-subscription)

## Get all subscriptions

This describes how to get all subscriptions

```javascript
const Flutterwave = require('flutterwave-node-v3');
const flw = new Flutterwave(process.env.FLW_PUBLIC_KEY, process.env.FLW_SECRET_KEY  );
const fetchSubscription = async () => {

try {
        
        const response = await flw.Subscription.fetch_all()
        console.log(response);
    } catch (error) {
        console.log(error)
    }

fetchSubscription();
```

Sample Response

```javascript
{
  "status": "success",
  "message": "Plan subscriptions fetched",
  "meta": {
    "page_info": {
      "total": 2,
      "current_page": 1,
      "total_pages": 1
    }
  },
  "data": [
    {
      "id": 4147,
      "amount": 2000,
      "customer": {
        "id": 247546,
        "customer_email": "developers@flutterwavego.com"
      },
      "plan": 3657,
      "status": "cancelled",
      "created_at": "2019-12-31T17:00:55.000Z"
    },
    {
      "id": 4146,
      "amount": 2000,
      "customer": {
        "id": 247490,
        "customer_email": "developers@flutterwavego.com"
      },
      "plan": 3657,
      "status": "cancelled",
      "created_at": "2019-12-31T14:44:20.000Z"
    }
  ]
}
```

## Fetch subscriptions with customer's email

This describes how to fetch subscriptions made by a single user.

```javascript
const Flutterwave = require('flutterwave-node-v3');
const flw = new Flutterwave(process.env.FLW_PUBLIC_KEY, process.env.FLW_SECRET_KEY  );
const getSubscription = async () => {

try {
        const data = {
            "email": "cornelius@flutterwavego.com"
        }
        const response = await flw.Subscription.get(data)
        console.log(response);
    } catch (error) {
        console.log(error)
    }
}
getSubscription();
```

Sample Response

```javascript
{
    "status": "success",
    "message": "Plan subscriptions fetched",
    "meta": {
        "page_info": {
            "total": 1,
            "current_page": 1,
            "total_pages": 1
        }
    },
    "data": [
        {
            "id": 15376,
            "amount": 2000,
            "customer": {
                "id": 1500129,
                "customer_email": "cornelius@flutterwavego.com"
            },
            "plan": 17490,
            "status": "cancelled",
            "created_at": "2022-01-24T15:05:45.000Z"
        }
    ]
}
```

## Cancel a subscription

This describes how to cancel a subscription

```javascript
const Flutterwave = require('flutterwave-node-v3');

const flw = new Flutterwave(process.env.FLW_PUBLIC_KEY, process.env.FLW_SECRET_KEY  );

const cancelSubscription = async () => {

try {
        const payload={
            "id":"4147" //This is the unique id of the subscription you want to cancel. It is returned in the Get a subscription call as data.id
        }
        
        const response = await flw.Subscription.cancel(payload)
        console.log(response);
    } catch (error) {
        console.log(error)
    }

}

cancelSubscription();
```

Sample Response

```javascript
{
  "status": "success",
  "message": "Subscription cancelled",
  "data": {
    "id": 4147,
    "amount": 2000,
    "customer": {
      "id": 247546,
      "customer_email": "developers@flutterwavego.com"
    },
    "plan": 3657,
    "status": "cancelled",
    "created_at": "2019-12-31T17:00:55.000Z"
  }
}
```

## Activate a subscription

This describes how to activate a subscription

```javascript
const Flutterwave = require('flutterwave-node-v3');

const flw = new Flutterwave(process.env.FLW_PUBLIC_KEY, process.env.FLW_SECRET_KEY  );

const activateSubscription = async () => {

try {
        const payload={
            "id":"4147" //This is the unique id of the subscription you want to activate. It is returned in the Get a subscription call as data.id
        }
        
        const response = await flw.Subscription.activate(payload)
        console.log(response);
    } catch (error) {
        console.log(error)
    }

}

activateSubscription();
```

Sample Response

```javascript
{
  "status": "success",
  "message": "Subscription activated",
  "data": {
    "id": 4147,
    "amount": 2000,
    "customer": {
      "id": 247546,
      "customer_email": "developers@flutterwavego.com"
    },
    "plan": 3657,
    "status": "active",
    "created_at": "2019-12-31T17:00:55.000Z"
  }
}

```

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
banks.md	13.22 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive
beneficiary.md	6.40 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive
billPayments.md	20.69 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive
collections.md	33.42 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive
ebills.md	2.35 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive
misc.md	5.85 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive
otp.md	2.36 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive
payment-plan.md	8.39 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive
settlements.md	12.92 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive
subaccount.md	9.89 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive
subscription.md	4.84 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive
tokenization.md	13.03 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive
transactions.md	20.99 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive
transfers.md	15.22 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive
virtualAccount.md	7.40 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive
virtualCard.md	11.38 KB	lrw-r--r--	2026-02-21 00:54:24	Edit Download recursive recursive

Directory Contents