Payment plans

Base URL: $CONSUMER_API

The object

idstring · required
tenant_idstring · required
case_idstring · required
account_idstring · required
account_numberstring · optional

Number of the referenced account, e.g. CTA-000044. Omitted when unknown.

account_holder_namestring · optional

Display name of the customer who holds the referenced account. Omitted when unknown.

total_amount_centsinteger (int64) · required
installment_countinteger · required
installment_amount_centsinteger (int64) · required
remaining_amount_centsinteger (int64) · required
next_due_datestring (date-time) · required
statusstring · required

one of active, completed, defaulted, cancelled

interest_basis_pointsinteger · optional
interest_amount_centsinteger (int64) · optional
installmentsarray of PlanInstallment · optional
Show child attributes
idstring · required
tenant_idstring · required
plan_idstring · required
numberinteger · required
due_datestring (date-time) · required
amount_centsinteger (int64) · required
statusstring · required

one of pending, paid, overdue

paid_atstring · optional · nullable
created_atstring (date-time) · required
created_atstring (date-time) · required
updated_atstring (date-time) · required
The object
{
  "id": "pay_2Y8DroSLB6irBEM756sHb0qz5Mk",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "case_id": "cas_2gmnNK0lRMC9tOMtZsWDhKGHpGe",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "total_amount_cents": 125000,
  "installment_count": 1,
  "installment_amount_cents": 125000,
  "remaining_amount_cents": 125000,
  "next_due_date": "2026-11-19T09:30:00Z",
  "status": "active",
  "interest_basis_points": 1,
  "interest_amount_cents": 125000,
  "installments": [
    {
      "id": "pla_2HjiILFe8bV48DfMmhxs4j54up1",
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "plan_id": "pla_2lVU4nTwUfHw6nxUwjbOeRn8u5D",
      "number": 1,
      "due_date": "2026-11-19T09:30:00Z",
      "amount_cents": 125000,
      "status": "pending",
      "paid_at": "2026-11-19T09:30:00Z",
      "created_at": "2026-11-19T09:30:00Z"
    }
  ],
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}

List payment plans for consumer

Logs

GET /payment-plans

Pages the payment plans (debt instalment agreements) on accounts linked to the caller. Filter with account_id, case_id and status; pagination uses limit and after.

Parameters

limitinteger · query · optional

Maximum resources to return (default 20, maximum 100).

afterstring · query · optional

Opaque cursor returned by the previous page.

account_idstring · query · optional

Restrict results to one linked consumer account.

Returns

200 Payment plans

curl -X GET "$CONSUMER_API/payment-plans" \
  -H "Authorization: Bearer sk_test_..."
Response 200

Payment plans

Get a payment plan authorized for the authenticated consumer

Logs

GET /payment-plans/{id}

Returns one payment plan, with its instalments and status, when it belongs to an account linked to the caller. Plans outside the caller's scope return 404.

Parameters

idstring · path · required

Identifier of the payment plan to return.

Returns

200 Payment plan belonging to one of the consumer's linked accounts

Show attributes
idstring · required
tenant_idstring · required
case_idstring · required
account_idstring · required
account_numberstring · optional

Number of the referenced account, e.g. CTA-000044. Omitted when unknown.

account_holder_namestring · optional

Display name of the customer who holds the referenced account. Omitted when unknown.

total_amount_centsinteger (int64) · required
installment_countinteger · required
installment_amount_centsinteger (int64) · required
remaining_amount_centsinteger (int64) · required
next_due_datestring (date-time) · required
statusstring · required

one of active, completed, defaulted, cancelled

interest_basis_pointsinteger · optional
interest_amount_centsinteger (int64) · optional
installmentsarray of PlanInstallment · optional
Show child attributes
idstring · required
tenant_idstring · required
plan_idstring · required
numberinteger · required
due_datestring (date-time) · required
amount_centsinteger (int64) · required
statusstring · required

one of pending, paid, overdue

paid_atstring · optional · nullable
created_atstring (date-time) · required
created_atstring (date-time) · required
updated_atstring (date-time) · required

Errors 401 · 403 · 404

curl -X GET "$CONSUMER_API/payment-plans/{id}" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "id": "pay_2Y8DroSLB6irBEM756sHb0qz5Mk",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "case_id": "cas_2gmnNK0lRMC9tOMtZsWDhKGHpGe",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "total_amount_cents": 125000,
  "installment_count": 1,
  "installment_amount_cents": 125000,
  "remaining_amount_cents": 125000,
  "next_due_date": "2026-11-19T09:30:00Z",
  "status": "active",
  "interest_basis_points": 1,
  "interest_amount_cents": 125000,
  "installments": [
    {
      "id": "pla_2HjiILFe8bV48DfMmhxs4j54up1",
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "plan_id": "pla_2lVU4nTwUfHw6nxUwjbOeRn8u5D",
      "number": 1,
      "due_date": "2026-11-19T09:30:00Z",
      "amount_cents": 125000,
      "status": "pending",
      "paid_at": "2026-11-19T09:30:00Z",
      "created_at": "2026-11-19T09:30:00Z"
    }
  ],
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}