Skip to main content
PATCH
/
payment-plans
/
{id}
Update a payment plan
curl --request PATCH \
  --url https://api.arcuserp.com/v1/payment-plans/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "auto_charge": true,
  "payment_method_id": "<string>",
  "notes": "<string>",
  "installments": [
    {}
  ]
}
'
import requests

url = "https://api.arcuserp.com/v1/payment-plans/{id}"

payload = {
"name": "<string>",
"auto_charge": True,
"payment_method_id": "<string>",
"notes": "<string>",
"installments": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
auto_charge: true,
payment_method_id: '<string>',
notes: '<string>',
installments: [{}]
})
};

fetch('https://api.arcuserp.com/v1/payment-plans/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcuserp.com/v1/payment-plans/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'auto_charge' => true,
'payment_method_id' => '<string>',
'notes' => '<string>',
'installments' => [
[

]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.arcuserp.com/v1/payment-plans/{id}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"auto_charge\": true,\n \"payment_method_id\": \"<string>\",\n \"notes\": \"<string>\",\n \"installments\": [\n {}\n ]\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.arcuserp.com/v1/payment-plans/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"auto_charge\": true,\n \"payment_method_id\": \"<string>\",\n \"notes\": \"<string>\",\n \"installments\": [\n {}\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/payment-plans/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"auto_charge\": true,\n \"payment_method_id\": \"<string>\",\n \"notes\": \"<string>\",\n \"installments\": [\n {}\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "payment_plan",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "total_amount": 123,
  "payment_method_id": "<string>",
  "auto_charge": true,
  "approval_status": "<string>",
  "requested_via": "<string>",
  "notes": "<string>",
  "installments": [
    {}
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

id
string<uuid>
required

Payment plan UUID.

Body

application/json
name
string
auto_charge
boolean
payment_method_id
string | null
notes
string | null
installments
object[]

Response

Updated payment plan.

An installment payment plan for a customer account, optionally linked to an order. Mirrors public.payment_plans.

id
string<uuid>
object
enum<string>
Available options:
payment_plan
entity_id
string<uuid>
account_id
string<uuid>
order_id
string<uuid> | null
name
string | null
total_amount
number
status
enum<string>
Available options:
active,
completed,
cancelled
payment_method_id
string | null
auto_charge
boolean
approval_status
string
requested_via
string
notes
string | null
installments
object[]

Installment schedule rows when expanded.

created_at
string<date-time>
updated_at
string<date-time>