Skip to main content
GET
/
subscription
/
api
/
v1
/
subscriptions?page=
{page}
&size=
{size}
&status=
{status}
List Subscription
curl --request GET \
  --url 'https://api.payaza.africa/live/subscription/api/v1/subscriptions?page={page}&size={size}&status={status}' \
  --header 'Authorization: <api-key>'
import requests

url = "https://api.payaza.africa/live/subscription/api/v1/subscriptions?page={page}&size={size}&status={status}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.payaza.africa/live/subscription/api/v1/subscriptions?page={page}&size={size}&status={status}', 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.payaza.africa/live/subscription/api/v1/subscriptions?page={page}&size={size}&status={status}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://api.payaza.africa/live/subscription/api/v1/subscriptions?page={page}&size={size}&status={status}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.payaza.africa/live/subscription/api/v1/subscriptions?page={page}&size={size}&status={status}")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.payaza.africa/live/subscription/api/v1/subscriptions?page={page}&size={size}&status={status}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "Success",
  "data": {
    "content": [
      {
        "id": 132,
        "customerId": "CUST-12345",
        "customerEmail": "customer@example.com",
        "status": "ACTIVE",
        "nextChargeDate": "2026-07-30T04:07:06.026488"
      }
    ],
    "page": 0,
    "size": 10,
    "totalElements": 1,
    "totalPages": 1
  }
}

Authorizations

Authorization
string
header
required

Payaza {{Public API Key in Base 64}}

Query Parameters

page
integer
required

The page number to be retrieved.

size
integer
required

The number of records per page.

status
string
required

Filter subscriptions by status.

Response

Request Successful

success
boolean

Indicates if the request was successful.

Example:

true

message
string

Descriptive message regarding the operation.

Example:

"Success"

data
object

The payload containing the paginated list of subscription records paired with their respective plans.