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

Update plan details

Topics

Endpoint Overview

Plans

Update plan details

Update plan details

PUT /api/payment-service/external/v1/plans/update-plan-details Requires authentication

Purpose

Use this endpoint to update plan details. It belongs to the Plans collection and is designed for backend integrations.

Request shape

0 parameters and 6 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 PUT 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 the request payload on your backend before sending it, especially the 6 documented body fields.
  • Protect state-changing operations with strong validation, logging, and retry rules to avoid duplicate mutations.

Request Body

Content type: application/json

planId required
number
The ID of the plan to update Example: 98
planName required
string
The name of the plan Example: Updated Plan Name
planDescription required
string
A description of the plan Example: Updated plan description
planAmount required
number
The amount for the plan Example: 200
interval required
string
Interval of the plan (e.g., Daily, Weekly, Monthly) Example: Monthly
maxNoOfPayment required
number
Maximum number of payments allowed for the plan Example: 5

Responses

200 Plan details updated successfully
400 Bad request

Expected Outcomes

200

Success example

Plan details updated successfully

Representative Response 
{
  "message": "Plan detail update successfully."
}
400

Failure example

Bad request

Representative Error 
{
  "error": "Plan detail not found!"
}
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",
    "Content-Type": "application/json",
}
payload = {
  "planId": 98,
  "planName": "Updated Plan Name",
  "planDescription": "Updated plan description",
  "planAmount": 200,
  "interval": "Monthly"
}

response = requests.put(
    "https://api.paymish.com/api/payment-service/external/v1/plans/update-plan-details",
    headers=headers,
    json=payload,
)

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

const response = await axios({
  method: "put",
  url: "https://api.paymish.com/api/payment-service/external/v1/plans/update-plan-details",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  data: {
  "planId": 98,
  "planName": "Updated Plan Name",
  "planDescription": "Updated plan description",
  "planAmount": 200,
  "interval": "Monthly"
}
});

console.log(response.data);
cURL 
curl https://api.paymish.com/api/payment-service/external/v1/plans/update-plan-details \
  -X PUT \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{   "planId": 98,   "planName": "Updated Plan Name",   "planDescription": "Updated plan description",   "planAmount": 200,   "interval": "Monthly" }'
PHP 
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/payment-service/external/v1/plans/update-plan-details");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_SECRET_KEY",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    "planId" => 98,
    "planName" => "Updated Plan Name",
    "planDescription" => "Updated plan description",
    "planAmount" => 200,
    "interval" => "Monthly",
]));

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
Previous endpoint Get plan details Next endpoint Delete plan.