Paymish Loading Docs Preparing guides, collections, and live API references...
Paymish Docs

Retrieve a list of subscriptions

Topics

Endpoint Overview

Subscription

Retrieve a list of subscriptions

Retrieve a list of subscriptions with pagination, filtering, and sorting.

GET /api/payment-service/external/v1/subscription/all Requires authentication

Purpose

Use this endpoint to retrieve a list of subscriptions. It belongs to the Subscription collection and is designed for backend integrations.

Request shape

9 parameters and 0 documented body fields using application/json.

Implementation Guide

Recommended workflow

1

Authenticate first and inject a valid bearer token or secret key before calling the endpoint.

2

Validate the input data, identifiers, and account state in your application before making the request.

3

Send the GET request from your backend using the required headers and the expected content type (application/json).

4

Persist the important identifiers returned in the response so later lookups, webhooks, or support actions can be linked correctly.

Implementation notes

  • Validate and encode query parameters before sending them so filters and pagination behave predictably.

Query Parameters

page
integer
Page number for pagination
limit
integer
Number of records per page
name
string
Filter subscriptions by name
status
string
Filter subscriptions by status (e.g., active, expired)
amount
number
Filter subscriptions by amount
expiry_start
string
Filter subscriptions expiring after a specific date (start date)
expiry_end
string
Filter subscriptions expiring before a specific date (end date)
sort
string
Sort subscriptions by a specific field (e.g., createdAt)
order
string
Sort order (asc for ascending, desc for descending)

Responses

200 A list of subscriptions retrieved successfully.
400 Invalid request parameters.
401 Unauthorized access.
500 Internal server error.

Expected Outcomes

200

Success example

A list of subscriptions retrieved successfully.

Representative Response 
{
  "status": "success",
  "message": "Record retrieved successfully",
  "data": {
    "reference": "PM-REF-12345",
    "status": "success"
  }
}
400

Record not found

Invalid request parameters.

Representative Error 
{
  "status": "error",
  "message": "Requested record was not found.",
  "errors": {
    "reference": [
      "Check the identifier and merchant context before retrying."
    ]
  }
}
After the response:
  • Log the Paymish reference or request context returned by the API so support teams can trace the call later.
  • Retry only when the failure is safe to repeat; otherwise correct the payload or auth state first.
  • Store enough internal metadata to match the API response back to your order, payout, case, or checkout record.

Language Notes

Python

Use `requests` from a backend worker, service, or Django/Flask app and centralize headers in a reusable helper.

Node.js

Use `axios` or `fetch` from Node.js services only; do not place secret credentials in frontend bundles.

PHP

Wrap cURL usage in a small client class so auth headers, error handling, and logging stay consistent.

cURL

Use cURL for smoke testing and debugging, then move the final logic into your backend service code.

Code Examples

Python 
import requests

headers = {
    "Authorization": "Bearer YOUR_SECRET_KEY",
}
response = requests.get(
    "https://api.paymish.com/api/payment-service/external/v1/subscription/all",
    headers=headers,
)

data = response.json()
print(data)
Node.js 
const axios = require("axios");

const response = await axios({
  method: "get",
  url: "https://api.paymish.com/api/payment-service/external/v1/subscription/all",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
  }
});

console.log(response.data);
cURL 
curl https://api.paymish.com/api/payment-service/external/v1/subscription/all \
   \
  -H "Authorization: Bearer YOUR_SECRET_KEY"
PHP 
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/payment-service/external/v1/subscription/all");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_SECRET_KEY",
]);

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
Previous endpoint Blacklist a recipient Next endpoint Create a new subscription