Skip to main content
GET
/
subscription
/
api
/
v1
/
subscriptions
/
{id}
Get Subscription
curl --request GET \
  --url https://api.payaza.africa/live/subscription/api/v1/subscriptions/{id} \
  --header 'Authorization: <api-key>'
import requests

url = "https://api.payaza.africa/live/subscription/api/v1/subscriptions/{id}"

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/{id}', 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/{id}",
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/{id}"

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/{id}")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.payaza.africa/live/subscription/api/v1/subscriptions/{id}")

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": {
    "id": 21,
    "customerId": "test-trial",
    "customerEmail": "johndoe@gmail.com",
    "firstName": null,
    "lastName": null,
    "customerAuthorizedAt": null,
    "status": "ACTIVE",
    "currentPeriodStart": "2026-07-08T20:20:32.893234",
    "currentPeriodEnd": "2026-07-09T20:20:32.893236",
    "nextChargeDate": "2026-07-09T20:20:32.893236",
    "trialEndDate": null,
    "pauseResumesAt": null,
    "cancelAt": null,
    "pausedAt": null,
    "cancelledAt": null,
    "cancellationReason": null,
    "cardExpiryAlertSent": false,
    "connectionMode": "Live",
    "enrollmentReference": "SUBREF_FF29C28B70034065A6",
    "enrollmentTxnReference": "SUB_ENROLL_21_1783539495235",
    "chargeMode": "DIRECT_CHARGE",
    "metadata": null,
    "createdAt": "2026-07-08T19:38:15.22973",
    "updatedAt": "2026-07-08T20:20:33.000927",
    "customerBearsFee": false,
    "enrollConfirmed": true
  }
}

Authorizations

Authorization
string
header
required

Payaza {{Public API Key in Base 64}}

Path Parameters

id
string
required

The Plan ID.

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 comprehensive subscription information record.