Update a subscription
- Paymish
- Subscription
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 PUT 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.
- Validate the request payload on your backend before sending it, especially the 10 documented body fields.
- Protect state-changing operations with strong validation, logging, and retry rules to avoid duplicate mutations.
Path Parameters
id
required
Request Body
Content type: application/json
planId
SUB12345
planName
Premium Plan
customerId
CUST789
amount
49.99
nextPaymentDate
2024-10-01
startDate
2024-09-01
subscriptionCode
SUB_ABC123
paymentCount
12
interval
monthly
status
active
Responses
Expected Outcomes
Success example
Subscription updated successfully.
{
"message": "Subscription updated successfully."
}Failure example
Bad request due to invalid input.
{
"status": "error",
"message": "Invalid request payload. Check `planId` and try again.",
"errors": {
"planId": [
"`planId` is required."
]
}
}- 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",
"Content-Type": "application/json",
}
payload = {
"planId": "SUB12345",
"planName": "Premium Plan",
"customerId": "CUST789",
"amount": 49.99,
"nextPaymentDate": "2024-10-01"
}
response = requests.put(
"https://api.paymish.com/api/payment-service/external/v1/subscription/{id}",
headers=headers,
json=payload,
)
data = response.json()
print(data)const axios = require("axios");
const response = await axios({
method: "put",
url: "https://api.paymish.com/api/payment-service/external/v1/subscription/{id}",
headers: {
Authorization: "Bearer YOUR_SECRET_KEY",
"Content-Type": "application/json",
},
data: {
"planId": "SUB12345",
"planName": "Premium Plan",
"customerId": "CUST789",
"amount": 49.99,
"nextPaymentDate": "2024-10-01"
}
});
console.log(response.data);curl https://api.paymish.com/api/payment-service/external/v1/subscription/{id} \
-X PUT \
-H "Authorization: Bearer YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "planId": "SUB12345", "planName": "Premium Plan", "customerId": "CUST789", "amount": 49.99, "nextPaymentDate": "2024-10-01" }'<?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, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer YOUR_SECRET_KEY",
"Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
"planId" => "SUB12345",
"planName" => "Premium Plan",
"customerId" => "CUST789",
"amount" => 49.99,
"nextPaymentDate" => "2024-10-01",
]));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);