---
title: "Add"
method: POST
path: "/RecurringPayments/Add"
tags: ["Recurring Payments"]
---

# Add

`POST /RecurringPayments/Add`

This endpoint allows you to create a recurring payment.

## Headers

- `api-key` string, required
- `secret-key` string, required

## Request body

- object
  - `terminal_uid` string, required — Terminal unique identifier
  - `customer_uid` string, required — Customer unique identifier
  - `card_token` string, required — Saved card unique identifier.
  - `bank_account_uid` string — Customer bank account uid. This field is required in case this is bank masav order.
  - `company_bank_account_uid` string — This field is required in case this is bank masav order.
  - `cashier_uid` string, required — Cashier unique identifier
  - `currency_code` 'ILS' | 'USD' | 'EUR' | 'GPB', required
  - `instant_first_payment` boolean, required — Process the first payment immediately. If set to true, please make sure to set the recurring payment start_date to next charge due date - this will prevent duplicate charges. If set to false, the first charge will be processed on the start_date.
  - `recurring_type` 0 | 1 | 2, required — 0 - Daily 1 - Weekly 2 - Monthly
  - `recurring_range` integer, required — Determines the charges frequency. For example, if recurring_type is set to Monthly and recurring_range is set to 2, the charges will be processed every 2 months.
  - `number_of_charges` integer, required — If set to 0, the recurring payment will be unlimited. If set to a positive number, the recurring payment will stop after that many charges.
  - `start_date` string, required — Can't be the same date as today. This is the date when the first charge will be processed. If you want to charge immediately, set instant_first_payment to true and start_date to the next charge due date.
  - `end_date` string — When the recurring will stop, in case the recurring is unlimited.
  - `items` object[] — List of products or services included in the recurring payment.
    - `product_uid` string — Product unique identifier.
    - `quantity` number — Product quantity.
    - `price` number — Sell price.
    - `discount_type` 'percentage' | 'amount' — Set the product discount type.
    - `discount_value` number — Required if discount type have value
    - `product_invoice_extra_details` string — Additional details for the product on the invoice.
  - `one_time_items` object[] — List of products or services for one-time charges.
    - `product_uid` string — Product unique identifier.
    - `quantity` number — Product quantity.
    - `price` number — Sell price.
    - `discount_type` 'percentage' | 'amount' — Set the product discount type.
    - `discount_value` number — Required if discount type have value
    - `product_invoice_extra_details` string — Additional details for the product on the invoice.
  - `one_time_charge_date` string — Sets when the one time charge will be processed. This is only required if you have one_time_items.
  - `successful_invoice` boolean — Triggers and invoice creation if the charge is successful.
  - `send_customer_success_email` boolean — Send e-mail to customer if the charge is successful.
  - `customer_failure_email` boolean — Send e-mail to the customer for failure payment and inform him to contact the business to update payment details.
  - `send_customer_success_sms` boolean — Send SMS to customer if the charge is successful. This requires an SMS package to be purchased.
  - `customer_failure_sms` boolean — Send SMS to customer if the charge fails. This requires an SMS package to be purchased.
  - `extra_info` string — Additional information about the recurring payment.

## Response `200`

200

## Other responses

- `400` — 400

---

[API](https://skmtc.dev/payplus/apis/payplus-api-documentation-production.md) · [All operations](https://skmtc.dev/payplus/apis/payplus-api-documentation-production/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/payplus/payplus-api-documentation-production/revisions/2a893057392b/schema)