Skip to main content
GET
List installment payment plans

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.

Query Parameters

account_id
string<uuid>

Filter by customer account.

order_id
string<uuid>

Filter by linked order.

status
enum<string>

Filter by plan status.

Available options:
active,
completed,
cancelled

Response

List of payment plans.

object
enum<string>
Available options:
list
data
object[]