Skip to main content
PATCH
Update a 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.

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>