List plans - Paymish Developer Documentation

Paymish loading icon

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

Paymish Docs

List plans

Paymish
Plans

Endpoint Overview

GET /api/transaction-service/external/v1/plans Requires authentication

Purpose

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

Request shape

0 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

This is a read-oriented endpoint, so focus on validating inputs, handling auth, and storing the returned data safely.

Expected Outcomes

The lookup succeeds and returns data you can display, cache briefly, or use for reconciliation.

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

The lookup fails because the identifier does not exist or the record is not accessible in the current context.

{
  "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.

This endpoint does not currently expose structured parameters or response metadata in the imported specification.

Code Examples

import requests

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

data = response.json()
print(data)

const axios = require("axios");

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

console.log(response.data);

curl https://api.paymish.com/api/transaction-service/external/v1/plans \
   \
  -H "Authorization: Bearer YOUR_SECRET_KEY"

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/transaction-service/external/v1/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 payment page Next endpoint Create plan