Resume a subscription

• Sandbox: PATCH https://sandbox.payme.io/api/subscriptions/{sub_payme_id}/resume
• Production: PATCH https://live.payme.io/api/subscriptions/{sub_payme_id}/resume

Credentials

• Header PayMe-Merchant-Key (API key)
• Request body field seller_payme_id (optional): The seller's MPL, instead of the PayMe-Merchant-Key header.
• Request body field payme_client_key (optional): Partners only: your partner key, instead of the PayMe-Partner-Key header.

Overview

Resumes a paused subscription (status 3) and sets it to status 2 (Active). No callback is sent. Iterations skipped while the subscription was paused aren't charged; the next charge runs at sub_next_date.

Example: PATCH https://sandbox.payme.io/api/subscriptions/SUB16885-68336QPL-UQSSS1CC-SYKXI53N/resume with the header PayMe-Merchant-Key: MPLDEMO-MPLDEMO-MPLDEMO-1234567.

Authentication

Send the seller's MPL in the PayMe-Merchant-Key header, or as seller_payme_id in a JSON body. Partners also send payme_client_key, in the body or the PayMe-Partner-Key header. The subscription must belong to the seller (error 370).

Errors

Errors return status_code 1 with HTTP 500 unless the table says otherwise.

Parameters

Request body

Content type: application/json

Optional. Use it instead of the headers.

Request example

No example is documented; this template is generated from the fields — replace the placeholder values.

{
  "seller_payme_id": "<seller_payme_id>",
  "payme_client_key": "<payme_client_key>"
}

Code samples

curl

curl -X PATCH 'https://sandbox.payme.io/api/subscriptions/<sub_payme_id>/resume' \
  -H 'Content-Type: application/json' \
  -H 'PayMe-Merchant-Key: <PayMe-Merchant-Key>' \
  --data-raw '{}'

Node.js

const response = await fetch("https://sandbox.payme.io/api/subscriptions/<sub_payme_id>/resume", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    "PayMe-Merchant-Key": "<PayMe-Merchant-Key>",
  },
  body: JSON.stringify({}),
});

console.log(await response.text());

Python

import requests

response = requests.patch(
    "https://sandbox.payme.io/api/subscriptions/<sub_payme_id>/resume",
    headers={
        "PayMe-Merchant-Key": "<PayMe-Merchant-Key>",
    },
    json={},
)

print(response.text)

PHP

<?php

$body = <<<'BODY'
{}
BODY;

$ch = curl_init('https://sandbox.payme.io/api/subscriptions/<sub_payme_id>/resume');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'PayMe-Merchant-Key: <PayMe-Merchant-Key>',
    ],
    CURLOPT_POSTFIELDS => $body,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Responses

200 — The subscription is active again. (success)

{
  "status_code": 0,
  "payme_status": "success",
  "status_error_code": 0,
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "seller_id": null,
  "sub_payme_id": "SUB16885-68336QPL-UQSSS1CC-SYKXI53N",
  "sub_payme_code": 477004,
  "subscription_id": "order-1001",
  "sub_created": "2026-11-09 10:15:00",
  "sub_start_date": "2026-12-01 00:00:00",
  "sub_prev_date": null,
  "sub_next_date": "2026-12-01 00:00:00",
  "sub_status": 2,
  "sub_iteration_type": 3,
  "sub_currency": "ILS",
  "sub_price": 5000,
  "sub_description": "Monthly plan",
  "sub_iterations": 12,
  "sub_iterations_completed": 0,
  "sub_iterations_skipped": 0,
  "sub_iterations_left": 12,
  "sub_paid": true,
  "sub_error_text": "הושהה על ידי המשתמש בתאריך 09/11/2026 10:30:00",
  "sub_payment_date": "2026-11-09 10:20:00",
  "buyer_card_mask": "532610******5846",
  "buyer_card_exp": "1230",
  "buyer_name": "Israel Israeli",
  "buyer_email": "buyer@example.com",
  "buyer_phone": null,
  "buyer_social_id": null
}

400 — The subscription isn't paused (305). (error)

{
  "status_code": 1,
  "status_error_details": "Cannot perform action due to an incorrect status",
  "status_additional_info": "Subscription status: active",
  "status_error_code": 305,
  "session": "FhT3aXe7"
}

500 — The request was refused. See the error table. (error)

{
  "status_code": 1,
  "status_error_details": "Subscription was not found",
  "status_additional_info": null,
  "status_error_code": 371,
  "session": "FhT3aXe7"
}