Create a Payment Plan

curl --request POST \
  --url https://api.flutterwave.com/v3/payment-plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 5000,
  "name": "the akhlm postman plan 2",
  "interval": "monthly",
  "duration": 48
}
'

import requests

url = "https://api.flutterwave.com/v3/payment-plans"

payload = {
    "amount": 5000,
    "name": "the akhlm postman plan 2",
    "interval": "monthly",
    "duration": 48
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 5000,
    name: 'the akhlm postman plan 2',
    interval: 'monthly',
    duration: 48
  })
};

fetch('https://api.flutterwave.com/v3/payment-plans', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flutterwave.com/v3/payment-plans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 5000,
    'name' => 'the akhlm postman plan 2',
    'interval' => 'monthly',
    'duration' => 48
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flutterwave.com/v3/payment-plans"

	payload := strings.NewReader("{\n  \"amount\": 5000,\n  \"name\": \"the akhlm postman plan 2\",\n  \"interval\": \"monthly\",\n  \"duration\": 48\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flutterwave.com/v3/payment-plans")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 5000,\n  \"name\": \"the akhlm postman plan 2\",\n  \"interval\": \"monthly\",\n  \"duration\": 48\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flutterwave.com/v3/payment-plans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 5000,\n  \"name\": \"the akhlm postman plan 2\",\n  \"interval\": \"monthly\",\n  \"duration\": 48\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "Payment plan created",
  "data": {
    "id": 3807,
    "name": "the akhlm postman plan 2",
    "amount": 5000,
    "interval": "monthly",
    "duration": 48,
    "status": "active",
    "currency": "NGN",
    "plan_token": "rpp_12d2ef3d5ac1c13b9d30",
    "created_at": "2020-01-16T18:08:19.000Z"
  }
}

POST

payment-plans

Create a Payment Plan

curl --request POST \
  --url https://api.flutterwave.com/v3/payment-plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 5000,
  "name": "the akhlm postman plan 2",
  "interval": "monthly",
  "duration": 48
}
'

import requests

url = "https://api.flutterwave.com/v3/payment-plans"

payload = {
    "amount": 5000,
    "name": "the akhlm postman plan 2",
    "interval": "monthly",
    "duration": 48
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 5000,
    name: 'the akhlm postman plan 2',
    interval: 'monthly',
    duration: 48
  })
};

fetch('https://api.flutterwave.com/v3/payment-plans', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flutterwave.com/v3/payment-plans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 5000,
    'name' => 'the akhlm postman plan 2',
    'interval' => 'monthly',
    'duration' => 48
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flutterwave.com/v3/payment-plans"

	payload := strings.NewReader("{\n  \"amount\": 5000,\n  \"name\": \"the akhlm postman plan 2\",\n  \"interval\": \"monthly\",\n  \"duration\": 48\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flutterwave.com/v3/payment-plans")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 5000,\n  \"name\": \"the akhlm postman plan 2\",\n  \"interval\": \"monthly\",\n  \"duration\": 48\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flutterwave.com/v3/payment-plans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 5000,\n  \"name\": \"the akhlm postman plan 2\",\n  \"interval\": \"monthly\",\n  \"duration\": 48\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "Payment plan created",
  "data": {
    "id": 3807,
    "name": "the akhlm postman plan 2",
    "amount": 5000,
    "interval": "monthly",
    "duration": 48,
    "status": "active",
    "currency": "NGN",
    "plan_token": "rpp_12d2ef3d5ac1c13b9d30",
    "created_at": "2020-01-16T18:08:19.000Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

amount

integer<int32>

required

name

string

required

interval

string

required

duration

integer<int32>

required

Response

200 - application/json; charset=utf-8

status

string

required

message

string

required

data

Data65 · object

required

Show child attributes

Example:

{
  "id": 3807,
  "name": "the akhlm postman plan 2",
  "amount": 5000,
  "interval": "monthly",
  "duration": 48,
  "status": "active",
  "currency": "NGN",
  "plan_token": "rpp_12d2ef3d5ac1c13b9d30",
  "created_at": "2020-01-16T18:08:19.000Z"
}

API Documentation

Charges

Tokenized Charges

Preauthorization

Transactions

Transfers

Beneficiaries

Virtual Cards

Virtual Account Numbers

Collection Subaccounts

Payout Subaccounts

Subscriptions

Payment Plans

Bill Payments

Banks

Misc

Settlements

Otps

Chargebacks

Create a Payment Plan

Authorizations

Body

Response