Create an installment payment plan
curl --request POST \
--url https://api.arcuserp.com/v1/payment-plans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total_amount": 123,
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"payment_method_id": "<string>",
"auto_charge": false,
"installments": [
{}
],
"notes": "<string>"
}
'import requests
url = "https://api.arcuserp.com/v1/payment-plans"
payload = {
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total_amount": 123,
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"payment_method_id": "<string>",
"auto_charge": False,
"installments": [{}],
"notes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
total_amount: 123,
order_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
payment_method_id: '<string>',
auto_charge: false,
installments: [{}],
notes: '<string>'
})
};
fetch('https://api.arcuserp.com/v1/payment-plans', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'total_amount' => 123,
'order_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'payment_method_id' => '<string>',
'auto_charge' => false,
'installments' => [
[
]
],
'notes' => '<string>'
]),
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"
payload := strings.NewReader("{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"total_amount\": 123,\n \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"auto_charge\": false,\n \"installments\": [\n {}\n ],\n \"notes\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.arcuserp.com/v1/payment-plans")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"total_amount\": 123,\n \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"auto_charge\": false,\n \"installments\": [\n {}\n ],\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/payment-plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"total_amount\": 123,\n \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"auto_charge\": false,\n \"installments\": [\n {}\n ],\n \"notes\": \"<string>\"\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,
"status": "active",
"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"
}Payments
Create an installment payment plan
Creates an installment payment plan for a customer account, optionally
linked to an order. Installments and auto-charge settings are part of the
request body. Requires payments:write scope. Idempotent via the
Idempotency-Key header.
POST
/
payment-plans
Create an installment payment plan
curl --request POST \
--url https://api.arcuserp.com/v1/payment-plans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total_amount": 123,
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"payment_method_id": "<string>",
"auto_charge": false,
"installments": [
{}
],
"notes": "<string>"
}
'import requests
url = "https://api.arcuserp.com/v1/payment-plans"
payload = {
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total_amount": 123,
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"payment_method_id": "<string>",
"auto_charge": False,
"installments": [{}],
"notes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
total_amount: 123,
order_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
payment_method_id: '<string>',
auto_charge: false,
installments: [{}],
notes: '<string>'
})
};
fetch('https://api.arcuserp.com/v1/payment-plans', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'total_amount' => 123,
'order_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'payment_method_id' => '<string>',
'auto_charge' => false,
'installments' => [
[
]
],
'notes' => '<string>'
]),
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"
payload := strings.NewReader("{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"total_amount\": 123,\n \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"auto_charge\": false,\n \"installments\": [\n {}\n ],\n \"notes\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.arcuserp.com/v1/payment-plans")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"total_amount\": 123,\n \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"auto_charge\": false,\n \"installments\": [\n {}\n ],\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/payment-plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"total_amount\": 123,\n \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"auto_charge\": false,\n \"installments\": [\n {}\n ],\n \"notes\": \"<string>\"\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,
"status": "active",
"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"
}Authorizations
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.
Headers
Client-generated unique key for idempotent POST/PATCH/DELETE operations. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours. Pattern: or --.
Maximum string length:
255Body
application/json
Customer account the plan bills.
Total amount the plan covers.
Optional order the plan settles.
Stored payment method for auto-charge.
Installment schedule (sequence, amount, due_date).
Response
Payment plan created.
An installment payment plan for a customer account, optionally linked to an order. Mirrors public.payment_plans.
Available options:
payment_plan Available options:
active, completed, cancelled Installment schedule rows when expanded.
Was this page helpful?