Pause a subscription

• Sandbox: POST https://sandbox.payme.io/api/pause-subscription
• Production: POST https://live.payme.io/api/pause-subscription

Credentials

• Request body field seller_payme_id (required): The seller's MPL. You can send it in the PayMe-Merchant-Key header instead.
• Request body field payme_client_key (optional): Partners only: your partner key. You can send it in the PayMe-Partner-Key header instead. A seller authenticates with seller_payme_id alone.

Overview

Pauses a subscription in status 2 (Active), 4 (Failed) or 7 (Failed, retry pending). Other statuses return error 305. PayMe sends a sub-pause callback, and sub_error_text holds the pause reason that PayMe writes (in Hebrew).

While the subscription is paused, nothing is charged. Each iteration whose date passes is skipped: it counts in sub_iterations_skipped, reduces sub_iterations_left and sends sub-iteration-skipped. Skipped iterations aren't charged after you resume. If every remaining iteration is skipped, the subscription becomes 6 (Completed) while paused.

Resume with Resume a subscription. A paused subscription can't be canceled: resume it first.

A subscription in status 4 has no working card. To fix it, have the buyer pay again with Pay a subscription rather than pausing and resuming it.

Authentication

Send seller_payme_id (the seller's MPL) in the JSON body or the PayMe-Merchant-Key header. 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

This endpoint takes no path, query or header parameters.

Request body

Content type: application/json

Request example

{
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "sub_payme_id": "SUB16885-68336QPL-UQSSS1CC-SYKXI53N"
}

Code samples

curl

curl -X POST 'https://sandbox.payme.io/api/pause-subscription' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "sub_payme_id": "SUB16885-68336QPL-UQSSS1CC-SYKXI53N"
}'

Node.js

const response = await fetch("https://sandbox.payme.io/api/pause-subscription", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
    "sub_payme_id": "SUB16885-68336QPL-UQSSS1CC-SYKXI53N"
  }),
});

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

Python

import requests

response = requests.post(
    "https://sandbox.payme.io/api/pause-subscription",
    json={
        "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
        "sub_payme_id": "SUB16885-68336QPL-UQSSS1CC-SYKXI53N",
    },
)

print(response.text)

PHP

<?php

$body = <<<'BODY'
{
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "sub_payme_id": "SUB16885-68336QPL-UQSSS1CC-SYKXI53N"
}
BODY;

$ch = curl_init('https://sandbox.payme.io/api/pause-subscription');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $body,
]);

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

echo $response;

Responses

200 — The subscription is paused. (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": 3,
  "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
}

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

{
  "status_code": 1,
  "status_error_details": "Required parameter is missing",
  "status_additional_info": "sub_payme_id",
  "status_error_code": 1,
  "session": "FhT3aXe7"
}