Get a subscription by ID

Paymish Docs

Paymish
Subscription

Endpoint Overview

GET /api/payment-service/external/v1/subscription/{id} Requires authentication

Purpose

Use this endpoint to get a subscription by id. It belongs to the Subscription collection and is designed for backend integrations.

Request shape

1 parameter and 0 documented body fields using application/json.

Implementation Guide

Recommended workflow

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

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

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

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

Implementation notes

Construct path parameters carefully and avoid string concatenation mistakes when building the final URL.

Path Parameters

id required

integer

The ID of the subscription to retrieve

Responses

200 Subscription details retrieved successfully.

400 Bad request due to invalid subscription ID.

404 Subscription not found.

Expected Outcomes

Subscription details retrieved successfully.

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

Bad request due to invalid subscription ID.

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

import requests

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

data = response.json()
print(data)

const axios = require("axios");

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

console.log(response.data);

curl https://api.paymish.com/api/payment-service/external/v1/subscription/{id} \
   \
  -H "Authorization: Bearer YOUR_SECRET_KEY"

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/payment-service/external/v1/subscription/{id}");
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 a new subscription Next endpoint Update a subscription