{"openapi":"3.1.0","info":{"title":"Payments","version":"1.0.0","description":"API reference for accepting payments with PayMe — sales via hosted payment page, hosted fields or direct API, tokens, subscriptions, refunds and captures, 3D Secure, invoices and point-of-sale. Start with Getting Started for credentials, environments and a first sale."},"servers":[{"url":"https://sandbox.payme.io/api","description":"Sandbox"},{"url":"https://live.payme.io/api","description":"Production"}],"components":{"securitySchemes":{"merchantKey":{"type":"apiKey","in":"header","name":"PayMe-Merchant-Key"},"partnerKey":{"type":"apiKey","in":"header","name":"PayMe-Partner-Key"},"publicKey":{"type":"apiKey","in":"header","name":"PayMe-Public-Key"},"signature":{"type":"apiKey","in":"header","name":"PayMe-Signature"}}},"tags":[{"name":"Subscriptions"}],"paths":{"/generate-subscription":{"post":{"operationId":"post-generate-subscription","summary":"Create a subscription","tags":["Subscriptions"],"description":"## Overview\n\nCreates a subscription that charges the buyer once per iteration. A new subscription is in status `1` (Initial), and the response returns `sub_url`, the hosted page where the buyer enters a card. To skip that page, send a permanent `buyer_key`: the card is attached at once and the subscription is created in status `2` (Active).\n\n- Each iteration is charged separately: for 50.00 a month over 12 months, each month is charged 50.00.\n- Nothing is charged in this call, even with `buyer_key`. A background job that runs once a minute makes every charge, including the first: it runs within about a minute after `sub_start_date` (default: today) once a card is attached.\n- If the card check fails when the buyer pays on `sub_url`, the subscription moves to status `4` (Failed) and PayMe sends `sub-failure`. It isn't canceled and isn't retried: the buyer can pay again.\n- A failed scheduled charge moves the subscription to status `7` and is retried once a day, up to 7 attempts in total. A daily subscription, and the seventh consecutive failure, move to status `5` (Canceled) and send `sub-cancel` instead.\n- The response and the callbacks never contain the `buyer_key`. Read it with [Get buyer key](/payments/tokenization/post-get-buyer-key) and `sub_payme_id`.\n- `subscription_id` isn't unique: sending the same value twice creates two subscriptions.\n\nTo share one payment link with many buyers, send `sub_type` `10` (template). Each buyer who pays it gets their own subscription.\n\nLifecycle, retries, callbacks and price changes: [Subscriptions overview](/payments/subscriptions) and [Saved cards & recurring](/payments/saved-cards-recurring). \n\n## Authentication\n\nSend `seller_payme_id` (the seller's MPL) in the JSON body: on this endpoint the `PayMe-Merchant-Key` header alone isn't enough. Partners also send `payme_client_key`, in the body or the `PayMe-Partner-Key` header.\n\n## Errors\n\nErrors return `status_code` `1` with HTTP 500 unless the table says otherwise.\n\n| HTTP | Code | When |\n|---|---|---|\n| 500 | `1` | A required field is missing. `status_additional_info` names it. |\n| 500 | `24` | `sub_type` isn't `1` or `10` (for example the text `template`). |\n| 500 | `251` | The `seller_payme_id` matches no seller. |\n| 500 | `252` | The seller can't use `sub_currency`. |\n| 500 | `352` | `sub_price` is outside your account's range. |\n| 500 | `372` | `sub_iteration_type` isn't between `1` and `5`. |\n| 500 | `373` | `sub_iterations` isn't `-1` or between 1 and 54. |\n| 500 | `374` | `sub_start_date` is before today. |\n| 500 | `375` | A monthly subscription starts after the 28th of the month. |\n| 500 | `376` | `buyer_key` is a one-time token or can't be used, or `sub_payment_method` needs a `buyer_key`. |","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"The seller's MPL. Must be in the JSON body on this endpoint."},"payme_client_key":{"type":"string","description":"Partners only: your partner key. You can send it in the `PayMe-Partner-Key` header instead. A seller authenticates with `seller_payme_id` alone."},"sub_price":{"type":"integer","description":"Price of one iteration, in minor units (`5075` = 50.75). Default range 500–4,000,000; your account may have different limits. Out of range returns error `352`."},"sub_currency":{"type":"string","description":"ISO 4217 currency code, for example `ILS`. The seller must be allowed to use it (error `252`)."},"sub_description":{"type":"string","description":"What the buyer is paying for. Up to 300 characters."},"sub_iteration_type":{"type":"integer","description":"Billing interval: `1` Daily, `2` Weekly, `3` Monthly, `4` Yearly, `5` Quarterly. Other values return error `372`. See [Subscription iteration types](/payments/codes-statuses/subscription-iteration-types)."},"sub_start_date":{"type":"string","description":"Date of the first charge, `DD/MM/YYYY` or epoch seconds. Default: today. Must be today or later (error `374`). For a monthly subscription the day must be between 1 and 28 (error `375`). Nothing is charged before this date: use it for \"charge now, then monthly\" after a one-off sale with the same `buyer_key`."},"sub_iterations":{"type":"integer","description":"Number of iterations. `-1` (default) means unlimited; otherwise 1–54. Other values return error `373`."},"sub_type":{"type":"integer","description":"`1` Regular (default) or `10` Template: one shareable payment link, where each buyer who pays gets their own subscription. Send the number: the text `template` is rejected with error `24`."},"buyer_key":{"type":"string","description":"A permanent buyer token to attach instead of sending the buyer to `sub_url` (create it with `buyer_is_permanent: true` on [capture-buyer-token](/payments/tokenization/post-capture-buyer-token)). The subscription is then active at once; the first charge still runs in the background. A one-time token returns error `376`. Don't combine it with `sub_type` `10`."},"buyer_business_name":{"type":"string","description":"With `buyer_key`: the buyer's business name. Send it together with `buyer_business_code`."},"buyer_business_code":{"type":"string","description":"With `buyer_key`: the buyer's business registration number."},"sub_payment_method":{"type":"string","description":"Payment method. Default: `credit-card`. A method other than `credit-card` or `multi` needs a `buyer_key` (error `376`). With `buyer_key` this field is ignored and the token's method is used."},"subscription_id":{"type":"string","description":"Your own reference, up to 50 characters. Not unique: a repeated value creates a second subscription. [List subscriptions](/payments/query-apis/post-get-subscriptions) accepts it as a filter."},"sub_callback_url":{"type":"string","description":"URL that receives the subscription callbacks (`sub-create`, `sub-active`, `sub-iteration-success`, `sub-failure` and the others listed on [Callbacks](/payments/getting-started/callbacks#subscriptions)). Default: your partner's default callback URL, if one is set. No call changes it later."},"sub_return_url":{"type":"string","description":"Where the buyer is sent after paying on `sub_url`. PayMe adds `payme_status`, `payme_signature`, `sub_payme_id`, `subscription_id`, `transaction_id`, `price`, `currency` and `is_foreign_card` to the query string."},"sub_indicative_name":{"type":"string","description":"The buyer's name, stored on the subscription."},"sub_email_address":{"type":"string","description":"Buyer email for subscription emails. When a card is attached, the card holder's email replaces it."},"sub_indicative_mobile":{"type":"string","description":"Buyer mobile number, stored for reference. When a card is attached, the card holder's phone replaces it."},"sub_send_notification":{"type":"boolean","description":"`true` emails the payment link to `sub_email_address` when the subscription is created. Default: `false`."},"language":{"type":"string","description":"Language of the payment page, buyer emails and error messages: `he` (default), `en`, `es`, `ru` or `ar`."}},"required":["seller_payme_id","sub_price","sub_currency","sub_description","sub_iteration_type"]},"example":{"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","sub_price":5000,"sub_currency":"ILS","sub_description":"Monthly plan","sub_iteration_type":3,"sub_iterations":12,"sub_start_date":"01/12/2026","subscription_id":"order-1001","sub_callback_url":"https://www.example.com/payment/callback","sub_return_url":"https://www.example.com/payment/success","language":"en"}}}},"responses":{"200":{"description":"The subscription was created.","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"sub_url":{"type":"string","description":"The hosted payment page where the buyer enters a card. For a template, the shareable link."},"status_code":{"type":"integer","description":"`0` on success."},"payme_status":{"type":"string","description":"`success`."},"status_error_code":{"type":"integer","description":"`0` on success."},"seller_payme_id":{"type":"string","description":"The seller's MPL."},"seller_id":{"type":"string","description":"The partner's own reference for the seller, if the partner set one. Otherwise `null`."},"sub_payme_id":{"type":"string","description":"PayMe's subscription ID (`SUB…`). Use it in every other subscription call."},"sub_payme_code":{"type":"integer","description":"PayMe's numeric subscription ID."},"subscription_id":{"type":"string","description":"Your own reference, as sent when the subscription was created. `null` if you didn't send one."},"sub_created":{"type":"string","description":"When the subscription was created, `YYYY-MM-DD HH:MM:SS`."},"sub_start_date":{"type":"string","description":"Date of the first charge, `YYYY-MM-DD HH:MM:SS`."},"sub_prev_date":{"type":"string","description":"When the last successful charge ran. `null` until the first charge."},"sub_next_date":{"type":"string","description":"When the next charge is due. Ignore it on a canceled or completed subscription."},"sub_status":{"type":"integer","description":"Current status. See [Subscription statuses](/payments/codes-statuses/subscription-statuses)."},"sub_iteration_type":{"type":"integer","description":"Billing interval. See [Subscription iteration types](/payments/codes-statuses/subscription-iteration-types)."},"sub_currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."},"sub_price":{"type":"integer","description":"Price of one iteration, in minor units (`5000` = 50.00)."},"sub_description":{"type":"string","description":"What the buyer is paying for."},"sub_iterations":{"type":"integer","description":"Total number of iterations. `-1` means unlimited."},"sub_iterations_completed":{"type":"integer","description":"Iterations charged successfully."},"sub_iterations_skipped":{"type":"integer","description":"Iterations skipped while the subscription was paused. They are never charged."},"sub_iterations_left":{"type":"integer","description":"`sub_iterations` minus completed and skipped iterations. `-1` when unlimited."},"sub_paid":{"type":"boolean","description":"`true` once a card (buyer token) is attached to the subscription. It does not mean the current iteration was charged."},"sub_error_text":{"type":"string","description":"The last failure, pause or cancel reason. `null` if there is none. Reasons that PayMe writes are in Hebrew."},"sub_payment_date":{"type":"string","description":"Returned only when a card is attached: when the card was attached."},"buyer_card_mask":{"type":"string","description":"Returned only when a card is attached: the masked card number."},"buyer_card_exp":{"type":"string","description":"Returned only when a card is attached: card expiry, `MMYY`."},"buyer_name":{"type":"string","description":"Returned only when a card is attached: the card holder's name."},"buyer_email":{"type":"string","description":"Returned only when a card is attached: the card holder's email."},"buyer_phone":{"type":"string","description":"Returned only when a card is attached: the card holder's phone, or `null`."},"buyer_social_id":{"type":"string","description":"Returned only when a card is attached: the card holder's national ID, or `null`."}}},"example":{"sub_url":"https://sandbox.payme.io/subscription/generate/SUB16885-68336QPL-UQSSS1CC-SYKXI53N","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":1,"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":false,"sub_error_text":null}}}},"500":{"description":"The request was refused. See the error table.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_details":{"type":"string","description":"What went wrong, in the language you asked for (Hebrew by default)."},"status_additional_info":{"type":"string","description":"The field or value concerned. Can be `null`."},"status_error_code":{"type":"integer","description":"PayMe error code. See the error table above and [Errors](/payments/getting-started/errors)."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"seller_payme_id","status_error_code":1,"session":"FhT3aXe7"}}}}}}},"/pay-subscription":{"post":{"operationId":"post-generate-subscription-2","summary":"Pay a subscription","tags":["Subscriptions"],"description":"## Overview\n\nAttaches a card to a subscription and activates it. Use it when you collect the card in your own form instead of sending the buyer to `sub_url`, or to replace the card on a subscription in status `4` (Failed) or `7` (Failed, retry pending).\n\n- The call checks the card with a validation transaction and saves it as the subscription's buyer token. It doesn't charge an iteration: the status becomes `2` (Active), and the background job charges at `sub_next_date`. For a status-`7` subscription, that is the next retry date.\n- Only a subscription in status `1`, `4` or `7` can be paid. Any other status returns error `305`; an active subscription is never charged again by this call.\n- If the card check fails, the subscription moves to status `4` and PayMe sends `sub-failure`. Call this endpoint again with another card.\n- For a template (`sub_type` `10`), each successful call creates a new subscription for that buyer and returns it.\n- A lock stops two calls on the same subscription from running at once.\n\nThere is no card swap for an active subscription. \n\n## Authentication\n\nNo API key is needed: `sub_payme_id` identifies the seller, so you can make this call from the buyer's browser, like `pay-sale`. `seller_payme_id` and `payme_client_key` aren't read here.\n\n## Errors\n\nErrors return `status_code` `1` with HTTP 500 unless the table says otherwise.\n\n| HTTP | Code | When |\n|---|---|---|\n| 500 | `1` | A required field is missing. `status_additional_info` names it. |\n| 500 | `305` | The subscription isn't in status `1`, `4` or `7`. `status_additional_info` is the current status. |\n| 500 | `371` | No subscription has this `sub_payme_id`. |\n| 500 | Card error code | The card number, expiry or CVV is invalid, or the card check was declined: the response carries the card error code. |","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"sub_payme_id":{"type":"string","description":"The subscription (`sub_payme_id` from [Create a subscription](/payments/subscriptions/post-generate-subscription))."},"seller_payme_id":{"type":"string","description":"Not needed and not read by this call: `sub_payme_id` identifies the seller."},"credit_card_number":{"type":"string","description":"Card number."},"credit_card_exp":{"type":"string","description":"Card expiry, `MMYY`."},"credit_card_cvv":{"type":"string","description":"Card CVV."},"buyer_name":{"type":"string","description":"Card holder's full name."},"buyer_email":{"type":"string","description":"Card holder's email. It replaces the subscription's buyer email."},"buyer_phone":{"type":"string","description":"Card holder's phone number."},"buyer_social_id":{"type":"string","description":"Card holder's national ID."},"buyer_business_name":{"type":"string","description":"The buyer's business name. Send it together with `buyer_business_code`."},"buyer_business_code":{"type":"string","description":"The buyer's business registration number."},"payment":{"type":"object","description":"The newer request shape: a `payment` object with `payment.method` and that method's fields. When you send it, the `credit_card_*`, `buyer_name` and `buyer_email` fields aren't required.","properties":{"method":{"type":"string","description":"Payment method, for example `credit-card`."}},"required":["method"]}},"required":["sub_payme_id","credit_card_number","credit_card_exp","credit_card_cvv","buyer_name","buyer_email"]},"example":{"sub_payme_id":"SUB16885-68336QPL-UQSSS1CC-SYKXI53N","credit_card_number":"5326105300985846","credit_card_exp":"1230","credit_card_cvv":"658","buyer_name":"Israel Israeli","buyer_email":"buyer@example.com"}}}},"responses":{"200":{"description":"The card was attached and the subscription is active.","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"payme_status":{"type":"string","description":"`success`."},"status_error_code":{"type":"integer","description":"`0` on success."},"seller_payme_id":{"type":"string","description":"The seller's MPL."},"seller_id":{"type":"string","description":"The partner's own reference for the seller, if the partner set one. Otherwise `null`."},"sub_payme_id":{"type":"string","description":"PayMe's subscription ID (`SUB…`). Use it in every other subscription call."},"sub_payme_code":{"type":"integer","description":"PayMe's numeric subscription ID."},"subscription_id":{"type":"string","description":"Your own reference, as sent when the subscription was created. `null` if you didn't send one."},"sub_created":{"type":"string","description":"When the subscription was created, `YYYY-MM-DD HH:MM:SS`."},"sub_start_date":{"type":"string","description":"Date of the first charge, `YYYY-MM-DD HH:MM:SS`."},"sub_prev_date":{"type":"string","description":"When the last successful charge ran. `null` until the first charge."},"sub_next_date":{"type":"string","description":"When the next charge is due. Ignore it on a canceled or completed subscription."},"sub_status":{"type":"integer","description":"Current status. See [Subscription statuses](/payments/codes-statuses/subscription-statuses)."},"sub_iteration_type":{"type":"integer","description":"Billing interval. See [Subscription iteration types](/payments/codes-statuses/subscription-iteration-types)."},"sub_currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."},"sub_price":{"type":"integer","description":"Price of one iteration, in minor units (`5000` = 50.00)."},"sub_description":{"type":"string","description":"What the buyer is paying for."},"sub_iterations":{"type":"integer","description":"Total number of iterations. `-1` means unlimited."},"sub_iterations_completed":{"type":"integer","description":"Iterations charged successfully."},"sub_iterations_skipped":{"type":"integer","description":"Iterations skipped while the subscription was paused. They are never charged."},"sub_iterations_left":{"type":"integer","description":"`sub_iterations` minus completed and skipped iterations. `-1` when unlimited."},"sub_paid":{"type":"boolean","description":"`true` once a card (buyer token) is attached to the subscription. It does not mean the current iteration was charged."},"sub_error_text":{"type":"string","description":"The last failure, pause or cancel reason. `null` if there is none. Reasons that PayMe writes are in Hebrew."},"sub_payment_date":{"type":"string","description":"Returned only when a card is attached: when the card was attached."},"buyer_card_mask":{"type":"string","description":"Returned only when a card is attached: the masked card number."},"buyer_card_exp":{"type":"string","description":"Returned only when a card is attached: card expiry, `MMYY`."},"buyer_name":{"type":"string","description":"Returned only when a card is attached: the card holder's name."},"buyer_email":{"type":"string","description":"Returned only when a card is attached: the card holder's email."},"buyer_phone":{"type":"string","description":"Returned only when a card is attached: the card holder's phone, or `null`."},"buyer_social_id":{"type":"string","description":"Returned only when a card is attached: the card holder's national ID, or `null`."},"redirect_url":{"type":"string","description":"`sub_return_url` with `payme_status`, `payme_signature`, `sub_payme_id`, `subscription_id`, `transaction_id`, `price`, `currency` and `is_foreign_card` added. `null` if the subscription has no return URL."}}},"example":{"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":null,"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,"redirect_url":"https://www.example.com/payment/success?payme_status=success&payme_signature=…&sub_payme_id=SUB16885-68336QPL-UQSSS1CC-SYKXI53N"}}}},"500":{"description":"The request was refused or the card check failed. See the error table.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_details":{"type":"string","description":"What went wrong, in the language you asked for (Hebrew by default)."},"status_additional_info":{"type":"string","description":"The field or value concerned. Can be `null`."},"status_error_code":{"type":"integer","description":"PayMe error code. See the error table above and [Errors](/payments/getting-started/errors)."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"sub_payme_id","status_error_code":1,"session":"FhT3aXe7"}}}}}}},"/cancel-subscription":{"post":{"operationId":"postcancel-subscription","summary":"Cancel a subscription","tags":["Subscriptions"],"description":"## Overview\n\nCancels a subscription. No further charges run, `sub_status` becomes `5` (Canceled), and PayMe sends `sub-cancel` to the subscription's callback URL and emails the buyer. No call reactivates a canceled subscription.\n\n- You can cancel a subscription in status `1`, `2`, `4` or `7`. A paused subscription (status `3`) returns error `305`: [resume a subscription](/payments/subscriptions/patch-subscriptions-sub-payme-id-resume) first, then cancel it.\n- A cancellation through this endpoint keeps the old `sub_next_date`. Ignore `sub_next_date` on a canceled subscription.\n- Buyers have no self-service cancel link: the seller cancels, here or in the dashboard.\n- PayMe also cancels a subscription automatically after the last failed charge attempt. See [Saved cards & recurring](/payments/saved-cards-recurring). \n\n## Authentication\n\nSend `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`).\n\n## Errors\n\nErrors return `status_code` `1` with HTTP 500 unless the table says otherwise.\n\n| HTTP | Code | When |\n|---|---|---|\n| 500 | `1` | A required field is missing, or no credential was sent. `status_additional_info` names the field. |\n| 500 | `251` | The `seller_payme_id` matches no seller. |\n| 500 | `370` | The subscription belongs to another seller. |\n| 500 | `371` | No subscription has this `sub_payme_id`. |\n| 500 | `305` | The subscription isn't in status `1`, `2`, `4` or `7`, for example it is paused. |","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"The seller's MPL. You can send it in the `PayMe-Merchant-Key` header instead."},"payme_client_key":{"type":"string","description":"Partners only: your partner key. You can send it in the `PayMe-Partner-Key` header instead. A seller authenticates with `seller_payme_id` alone."},"sub_payme_id":{"type":"string","description":"The subscription (`sub_payme_id` from [Create a subscription](/payments/subscriptions/post-generate-subscription))."},"language":{"type":"string","description":"Language of error messages: `he` (default), `en`, `es`, `ru` or `ar`."}},"required":["seller_payme_id","sub_payme_id"]},"example":{"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","sub_payme_id":"SUB16885-68336QPL-UQSSS1CC-SYKXI53N","language":"en"}}}},"responses":{"200":{"description":"The subscription was canceled.","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"payme_status":{"type":"string","description":"`success`."},"status_error_code":{"type":"integer","description":"`0` on success."},"seller_payme_id":{"type":"string","description":"The seller's MPL."},"seller_id":{"type":"string","description":"The partner's own reference for the seller, if the partner set one. Otherwise `null`."},"sub_payme_id":{"type":"string","description":"PayMe's subscription ID (`SUB…`). Use it in every other subscription call."},"sub_payme_code":{"type":"integer","description":"PayMe's numeric subscription ID."},"subscription_id":{"type":"string","description":"Your own reference, as sent when the subscription was created. `null` if you didn't send one."},"sub_created":{"type":"string","description":"When the subscription was created, `YYYY-MM-DD HH:MM:SS`."},"sub_start_date":{"type":"string","description":"Date of the first charge, `YYYY-MM-DD HH:MM:SS`."},"sub_prev_date":{"type":"string","description":"When the last successful charge ran. `null` until the first charge."},"sub_next_date":{"type":"string","description":"When the next charge is due. Ignore it on a canceled or completed subscription."},"sub_status":{"type":"integer","description":"Current status. See [Subscription statuses](/payments/codes-statuses/subscription-statuses)."},"sub_iteration_type":{"type":"integer","description":"Billing interval. See [Subscription iteration types](/payments/codes-statuses/subscription-iteration-types)."},"sub_currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."},"sub_price":{"type":"integer","description":"Price of one iteration, in minor units (`5000` = 50.00)."},"sub_description":{"type":"string","description":"What the buyer is paying for."},"sub_iterations":{"type":"integer","description":"Total number of iterations. `-1` means unlimited."},"sub_iterations_completed":{"type":"integer","description":"Iterations charged successfully."},"sub_iterations_skipped":{"type":"integer","description":"Iterations skipped while the subscription was paused. They are never charged."},"sub_iterations_left":{"type":"integer","description":"`sub_iterations` minus completed and skipped iterations. `-1` when unlimited."},"sub_paid":{"type":"boolean","description":"`true` once a card (buyer token) is attached to the subscription. It does not mean the current iteration was charged."},"sub_error_text":{"type":"string","description":"The last failure, pause or cancel reason. `null` if there is none. Reasons that PayMe writes are in Hebrew."},"sub_payment_date":{"type":"string","description":"Returned only when a card is attached: when the card was attached."},"buyer_card_mask":{"type":"string","description":"Returned only when a card is attached: the masked card number."},"buyer_card_exp":{"type":"string","description":"Returned only when a card is attached: card expiry, `MMYY`."},"buyer_name":{"type":"string","description":"Returned only when a card is attached: the card holder's name."},"buyer_email":{"type":"string","description":"Returned only when a card is attached: the card holder's email."},"buyer_phone":{"type":"string","description":"Returned only when a card is attached: the card holder's phone, or `null`."},"buyer_social_id":{"type":"string","description":"Returned only when a card is attached: the card holder's national ID, or `null`."}}},"example":{"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":5,"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":{"description":"The request was refused. See the error table.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_details":{"type":"string","description":"What went wrong, in the language you asked for (Hebrew by default)."},"status_additional_info":{"type":"string","description":"The field or value concerned. Can be `null`."},"status_error_code":{"type":"integer","description":"PayMe error code. See the error table above and [Errors](/payments/getting-started/errors)."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Cannot perform action due to an incorrect status","status_additional_info":null,"status_error_code":305,"session":"FhT3aXe7"}}}}}}},"/pause-subscription":{"post":{"operationId":"post-pause-subscription","summary":"Pause a subscription","tags":["Subscriptions"],"description":"## Overview\n\nPauses 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).\n\nWhile 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.\n\nResume with [Resume a subscription](/payments/subscriptions/patch-subscriptions-sub-payme-id-resume). A paused subscription can't be canceled: resume it first.\n\nA subscription in status `4` has no working card. To fix it, have the buyer pay again with [Pay a subscription](/payments/subscriptions/post-generate-subscription-2) rather than pausing and resuming it.\n\n## Authentication\n\nSend `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`).\n\n## Errors\n\nErrors return `status_code` `1` with HTTP 500 unless the table says otherwise.\n\n| HTTP | Code | When |\n|---|---|---|\n| 500 | `1` | A required field is missing, or no credential was sent. `status_additional_info` names the field. |\n| 500 | `251` | The `seller_payme_id` matches no seller. |\n| 500 | `370` | The subscription belongs to another seller. |\n| 500 | `371` | No subscription has this `sub_payme_id`. |\n| 500 | `305` | The subscription isn't in status `2`, `4` or `7`. |","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"The seller's MPL. You can send it in the `PayMe-Merchant-Key` header instead."},"payme_client_key":{"type":"string","description":"Partners only: your partner key. You can send it in the `PayMe-Partner-Key` header instead. A seller authenticates with `seller_payme_id` alone."},"sub_payme_id":{"type":"string","description":"The subscription to pause (`sub_payme_id` from [Create a subscription](/payments/subscriptions/post-generate-subscription))."},"language":{"type":"string","description":"Language of error messages: `he` (default), `en`, `es`, `ru` or `ar`."}},"required":["seller_payme_id","sub_payme_id"]},"example":{"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","sub_payme_id":"SUB16885-68336QPL-UQSSS1CC-SYKXI53N"}}}},"responses":{"200":{"description":"The subscription is paused.","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"payme_status":{"type":"string","description":"`success`."},"status_error_code":{"type":"integer","description":"`0` on success."},"seller_payme_id":{"type":"string","description":"The seller's MPL."},"seller_id":{"type":"string","description":"The partner's own reference for the seller, if the partner set one. Otherwise `null`."},"sub_payme_id":{"type":"string","description":"PayMe's subscription ID (`SUB…`). Use it in every other subscription call."},"sub_payme_code":{"type":"integer","description":"PayMe's numeric subscription ID."},"subscription_id":{"type":"string","description":"Your own reference, as sent when the subscription was created. `null` if you didn't send one."},"sub_created":{"type":"string","description":"When the subscription was created, `YYYY-MM-DD HH:MM:SS`."},"sub_start_date":{"type":"string","description":"Date of the first charge, `YYYY-MM-DD HH:MM:SS`."},"sub_prev_date":{"type":"string","description":"When the last successful charge ran. `null` until the first charge."},"sub_next_date":{"type":"string","description":"When the next charge is due. Ignore it on a canceled or completed subscription."},"sub_status":{"type":"integer","description":"Current status. See [Subscription statuses](/payments/codes-statuses/subscription-statuses)."},"sub_iteration_type":{"type":"integer","description":"Billing interval. See [Subscription iteration types](/payments/codes-statuses/subscription-iteration-types)."},"sub_currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."},"sub_price":{"type":"integer","description":"Price of one iteration, in minor units (`5000` = 50.00)."},"sub_description":{"type":"string","description":"What the buyer is paying for."},"sub_iterations":{"type":"integer","description":"Total number of iterations. `-1` means unlimited."},"sub_iterations_completed":{"type":"integer","description":"Iterations charged successfully."},"sub_iterations_skipped":{"type":"integer","description":"Iterations skipped while the subscription was paused. They are never charged."},"sub_iterations_left":{"type":"integer","description":"`sub_iterations` minus completed and skipped iterations. `-1` when unlimited."},"sub_paid":{"type":"boolean","description":"`true` once a card (buyer token) is attached to the subscription. It does not mean the current iteration was charged."},"sub_error_text":{"type":"string","description":"The last failure, pause or cancel reason. `null` if there is none. Reasons that PayMe writes are in Hebrew."},"sub_payment_date":{"type":"string","description":"Returned only when a card is attached: when the card was attached."},"buyer_card_mask":{"type":"string","description":"Returned only when a card is attached: the masked card number."},"buyer_card_exp":{"type":"string","description":"Returned only when a card is attached: card expiry, `MMYY`."},"buyer_name":{"type":"string","description":"Returned only when a card is attached: the card holder's name."},"buyer_email":{"type":"string","description":"Returned only when a card is attached: the card holder's email."},"buyer_phone":{"type":"string","description":"Returned only when a card is attached: the card holder's phone, or `null`."},"buyer_social_id":{"type":"string","description":"Returned only when a card is attached: the card holder's national ID, or `null`."}}},"example":{"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":{"description":"The request was refused. See the error table.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_details":{"type":"string","description":"What went wrong, in the language you asked for (Hebrew by default)."},"status_additional_info":{"type":"string","description":"The field or value concerned. Can be `null`."},"status_error_code":{"type":"integer","description":"PayMe error code. See the error table above and [Errors](/payments/getting-started/errors)."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"sub_payme_id","status_error_code":1,"session":"FhT3aXe7"}}}}}}},"/subscriptions/{sub_payme_id}/resume":{"patch":{"security":[{"merchantKey":[]}],"operationId":"patch-subscriptions-sub-payme-id-resume","summary":"Resume a subscription","tags":["Subscriptions"],"description":"## Overview\n\nResumes 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`.\n\nExample: `PATCH https://sandbox.payme.io/api/subscriptions/SUB16885-68336QPL-UQSSS1CC-SYKXI53N/resume` with the header `PayMe-Merchant-Key: MPLDEMO-MPLDEMO-MPLDEMO-1234567`.\n\n## Authentication\n\nSend 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`).\n\n## Errors\n\nErrors return `status_code` `1` with HTTP 500 unless the table says otherwise.\n\n| HTTP | Code | When |\n|---|---|---|\n| 500 | `1` | A required field is missing, or no credential was sent. `status_additional_info` names the field. |\n| 500 | `251` | The `seller_payme_id` matches no seller. |\n| 500 | `370` | The subscription belongs to another seller. |\n| 500 | `371` | No subscription has this `sub_payme_id`. |\n| 400 | `305` | The subscription isn't paused. `status_additional_info` gives its current status. |","parameters":[{"name":"PayMe-Merchant-Key","in":"header","required":true,"description":"The seller's MPL. Or send it as `seller_payme_id` in a JSON body instead.","schema":{"type":"string"}},{"name":"sub_payme_id","in":"path","required":true,"description":"The subscription to resume (`sub_payme_id`, for example `SUB16885-68336QPL-UQSSS1CC-SYKXI53N`).","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"The seller's MPL, instead of the `PayMe-Merchant-Key` header."},"payme_client_key":{"type":"string","description":"Partners only: your partner key, instead of the `PayMe-Partner-Key` header."}}}}},"description":"Optional. Use it instead of the headers."},"responses":{"200":{"description":"The subscription is active again.","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"payme_status":{"type":"string","description":"`success`."},"status_error_code":{"type":"integer","description":"`0` on success."},"seller_payme_id":{"type":"string","description":"The seller's MPL."},"seller_id":{"type":"string","description":"The partner's own reference for the seller, if the partner set one. Otherwise `null`."},"sub_payme_id":{"type":"string","description":"PayMe's subscription ID (`SUB…`). Use it in every other subscription call."},"sub_payme_code":{"type":"integer","description":"PayMe's numeric subscription ID."},"subscription_id":{"type":"string","description":"Your own reference, as sent when the subscription was created. `null` if you didn't send one."},"sub_created":{"type":"string","description":"When the subscription was created, `YYYY-MM-DD HH:MM:SS`."},"sub_start_date":{"type":"string","description":"Date of the first charge, `YYYY-MM-DD HH:MM:SS`."},"sub_prev_date":{"type":"string","description":"When the last successful charge ran. `null` until the first charge."},"sub_next_date":{"type":"string","description":"When the next charge is due. Ignore it on a canceled or completed subscription."},"sub_status":{"type":"integer","description":"Current status. See [Subscription statuses](/payments/codes-statuses/subscription-statuses)."},"sub_iteration_type":{"type":"integer","description":"Billing interval. See [Subscription iteration types](/payments/codes-statuses/subscription-iteration-types)."},"sub_currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."},"sub_price":{"type":"integer","description":"Price of one iteration, in minor units (`5000` = 50.00)."},"sub_description":{"type":"string","description":"What the buyer is paying for."},"sub_iterations":{"type":"integer","description":"Total number of iterations. `-1` means unlimited."},"sub_iterations_completed":{"type":"integer","description":"Iterations charged successfully."},"sub_iterations_skipped":{"type":"integer","description":"Iterations skipped while the subscription was paused. They are never charged."},"sub_iterations_left":{"type":"integer","description":"`sub_iterations` minus completed and skipped iterations. `-1` when unlimited."},"sub_paid":{"type":"boolean","description":"`true` once a card (buyer token) is attached to the subscription. It does not mean the current iteration was charged."},"sub_error_text":{"type":"string","description":"The last failure, pause or cancel reason. `null` if there is none. Reasons that PayMe writes are in Hebrew."},"sub_payment_date":{"type":"string","description":"Returned only when a card is attached: when the card was attached."},"buyer_card_mask":{"type":"string","description":"Returned only when a card is attached: the masked card number."},"buyer_card_exp":{"type":"string","description":"Returned only when a card is attached: card expiry, `MMYY`."},"buyer_name":{"type":"string","description":"Returned only when a card is attached: the card holder's name."},"buyer_email":{"type":"string","description":"Returned only when a card is attached: the card holder's email."},"buyer_phone":{"type":"string","description":"Returned only when a card is attached: the card holder's phone, or `null`."},"buyer_social_id":{"type":"string","description":"Returned only when a card is attached: the card holder's national ID, or `null`."}}},"example":{"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":{"description":"The subscription isn't paused (`305`).","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_details":{"type":"string","description":"What went wrong, in the language you asked for (Hebrew by default)."},"status_additional_info":{"type":"string","description":"The field or value concerned. Can be `null`."},"status_error_code":{"type":"integer","description":"PayMe error code. See the error table above and [Errors](/payments/getting-started/errors)."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"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":{"description":"The request was refused. See the error table.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_details":{"type":"string","description":"What went wrong, in the language you asked for (Hebrew by default)."},"status_additional_info":{"type":"string","description":"The field or value concerned. Can be `null`."},"status_error_code":{"type":"integer","description":"PayMe error code. See the error table above and [Errors](/payments/getting-started/errors)."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Subscription was not found","status_additional_info":null,"status_error_code":371,"session":"FhT3aXe7"}}}}}}},"/subscriptions/{sub_payme_id}/set-price":{"patch":{"operationId":"patch-subscriptions-sub-id-set-price","summary":"Update a subscription's price","tags":["Subscriptions"],"description":"## Overview\n\nChanges the price of future iterations. The call charges nothing and doesn't change `sub_next_date`, `sub_start_date`, `sub_prev_date`, the iteration counters or the status. The billing day stays anchored to `sub_start_date`.\n\nYou can update:\n\n- an active subscription (status `2`);\n- a template (`sub_type` `10`) in status `1`: buyers who pay the link after the change get the new price, and subscriptions already created from it keep theirs;\n- a subscription in status `1` whose `sub_start_date` is still in the future.\n\nAny other subscription returns error `377` (HTTP 400).\n\nIf the price changed and the subscription has a buyer email, PayMe emails the buyer about the new price, subject to the seller's email settings.\n\nThere is no proration: for a mid-cycle upgrade, charge the difference once with `generate-sale` and the subscription's `buyer_key`, then call this endpoint. Don't cancel and re-create the subscription: that resets `sub_start_date` and the counters. \n\nExample: `PATCH https://sandbox.payme.io/api/subscriptions/SUB16885-68336QPL-UQSSS1CC-SYKXI53N/set-price`. More: [Saved cards & recurring](/payments/saved-cards-recurring).\n\n## Authentication\n\nSend `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`).\n\n## Errors\n\nErrors return `status_code` `1` with HTTP 500 unless the table says otherwise.\n\n| HTTP | Code | When |\n|---|---|---|\n| 500 | `1` | A required field is missing, or no credential was sent. `status_additional_info` names the field. |\n| 500 | `251` | The `seller_payme_id` matches no seller. |\n| 500 | `370` | The subscription belongs to another seller. |\n| 500 | `371` | No subscription has this `sub_payme_id`. |\n| 500 | `352` | `sub_price` is outside your account's range. |\n| 400 | `377` | This subscription's price can't be updated in its current status or type. |","parameters":[{"name":"sub_payme_id","in":"path","required":true,"description":"The subscription to update: its `sub_payme_id`, returned by [Create a subscription](/payments/subscriptions/post-generate-subscription). Your own `subscription_id` doesn't work here (error `371`).","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"The seller's MPL. You can send it in the `PayMe-Merchant-Key` header instead."},"payme_client_key":{"type":"string","description":"Partners only: your partner key. You can send it in the `PayMe-Partner-Key` header instead. A seller authenticates with `seller_payme_id` alone."},"sub_price":{"type":"integer","description":"New price of one iteration, in minor units (`5075` = 50.75). Default range 500–4,000,000; your account may have different limits (error `352`)."}},"required":["seller_payme_id","sub_price"]},"example":{"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","sub_price":7500}}}},"responses":{"200":{"description":"The price was updated, or was already this value.","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"payme_status":{"type":"string","description":"`success`."},"status_error_code":{"type":"integer","description":"`0` on success."},"seller_payme_id":{"type":"string","description":"The seller's MPL."},"seller_id":{"type":"string","description":"The partner's own reference for the seller, if the partner set one. Otherwise `null`."},"sub_payme_id":{"type":"string","description":"PayMe's subscription ID (`SUB…`). Use it in every other subscription call."},"sub_payme_code":{"type":"integer","description":"PayMe's numeric subscription ID."},"subscription_id":{"type":"string","description":"Your own reference, as sent when the subscription was created. `null` if you didn't send one."},"sub_created":{"type":"string","description":"When the subscription was created, `YYYY-MM-DD HH:MM:SS`."},"sub_start_date":{"type":"string","description":"Date of the first charge, `YYYY-MM-DD HH:MM:SS`."},"sub_prev_date":{"type":"string","description":"When the last successful charge ran. `null` until the first charge."},"sub_next_date":{"type":"string","description":"When the next charge is due. Ignore it on a canceled or completed subscription."},"sub_status":{"type":"integer","description":"Current status. See [Subscription statuses](/payments/codes-statuses/subscription-statuses)."},"sub_iteration_type":{"type":"integer","description":"Billing interval. See [Subscription iteration types](/payments/codes-statuses/subscription-iteration-types)."},"sub_currency":{"type":"string","description":"ISO 4217 currency code, e.g. `ILS`."},"sub_price":{"type":"integer","description":"Price of one iteration, in minor units (`5000` = 50.00)."},"sub_description":{"type":"string","description":"What the buyer is paying for."},"sub_iterations":{"type":"integer","description":"Total number of iterations. `-1` means unlimited."},"sub_iterations_completed":{"type":"integer","description":"Iterations charged successfully."},"sub_iterations_skipped":{"type":"integer","description":"Iterations skipped while the subscription was paused. They are never charged."},"sub_iterations_left":{"type":"integer","description":"`sub_iterations` minus completed and skipped iterations. `-1` when unlimited."},"sub_paid":{"type":"boolean","description":"`true` once a card (buyer token) is attached to the subscription. It does not mean the current iteration was charged."},"sub_error_text":{"type":"string","description":"The last failure, pause or cancel reason. `null` if there is none. Reasons that PayMe writes are in Hebrew."},"sub_payment_date":{"type":"string","description":"Returned only when a card is attached: when the card was attached."},"buyer_card_mask":{"type":"string","description":"Returned only when a card is attached: the masked card number."},"buyer_card_exp":{"type":"string","description":"Returned only when a card is attached: card expiry, `MMYY`."},"buyer_name":{"type":"string","description":"Returned only when a card is attached: the card holder's name."},"buyer_email":{"type":"string","description":"Returned only when a card is attached: the card holder's email."},"buyer_phone":{"type":"string","description":"Returned only when a card is attached: the card holder's phone, or `null`."},"buyer_social_id":{"type":"string","description":"Returned only when a card is attached: the card holder's national ID, or `null`."}}},"example":{"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":7500,"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":null,"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":{"description":"The price can't be updated (`377`).","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_details":{"type":"string","description":"What went wrong, in the language you asked for (Hebrew by default)."},"status_additional_info":{"type":"string","description":"The field or value concerned. Can be `null`."},"status_error_code":{"type":"integer","description":"PayMe error code. See the error table above and [Errors](/payments/getting-started/errors)."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Subscription update failed","status_additional_info":"Subscription price can not be updated","status_error_code":377,"session":"FhT3aXe7"}}}},"500":{"description":"The request was refused. See the error table.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_details":{"type":"string","description":"What went wrong, in the language you asked for (Hebrew by default)."},"status_additional_info":{"type":"string","description":"The field or value concerned. Can be `null`."},"status_error_code":{"type":"integer","description":"PayMe error code. See the error table above and [Errors](/payments/getting-started/errors)."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Invalid price, out of min-max bounds","status_additional_info":"100","status_error_code":352,"session":"FhT3aXe7"}}}}}}}}}