Skip to main content
POST
Create an installment payment plan

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.

Headers

Idempotency-Key
string

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: 255

Body

application/json
account_id
string<uuid>
required

Customer account the plan bills.

total_amount
number
required

Total amount the plan covers.

order_id
string<uuid> | null

Optional order the plan settles.

name
string | null
payment_method_id
string | null

Stored payment method for auto-charge.

auto_charge
boolean
default:false
installments
object[]

Installment schedule (sequence, amount, due_date).

notes
string | null

Response

Payment plan created.

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>