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

Get payment plans

Topics

Endpoint Overview

Plans

Get payment plans

GET /api/payment-service/external/v1/plans/get-plans Requires authentication

Purpose

Use this endpoint to get payment plans. It belongs to the Plans collection and is designed for backend integrations.

Request shape

13 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

status
string
Status (Active/Archived/Deleted)
interval
string
Interval (Daily/Weekly/Monthly/Quarterly/Biannually/Annually)
noOfSubscriptions
integer
Number of subscriptions
noOfSubscriptionType
string
Number of subscription type (moreThan/lessThan/equals)
amount
number
Amount
amountType
string
Amount type (moreThan/lessThan/equals)
revenueAmount
number
Revenue amount
revenueType
string
Revenue amount type (moreThan/lessThan/equals)
searchPlanText
string
Search plan text
startDate
string
Start date (YYYY-MM-DD)
endDate
string
End date (YYYY-MM-DD)
limit
integer
Number of items per page
page
integer
Page number

Responses

200 Get plans
400 Bad request

Expected Outcomes

200

Success example

Get plans

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

Record not found

Bad request

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/plans/get-plans",
    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/plans/get-plans",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
  }
});

console.log(response.data);
cURL 
curl https://api.paymish.com/api/payment-service/external/v1/plans/get-plans \
   \
  -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/plans/get-plans");
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 Create New Plan Next endpoint Get plan details