Get Payment Schedule

GET 
/v1/open-api/contract/:id/monthly-payment

Get the active (non-cancelled) payment schedule of a single contract, ordered by date ascending. This is the same set of rows as the monthlyPayments field of GET /v1/open-api/contract/{id}. Not paginated — a contract has at most one active schedule, up to ~240 rows.

If the contract has no schedule the response is an empty array.

Requires grant PERMISSION_OPEN_API_CONTRACT:READ.

Request

Responses

200

The contract's active payment schedule.

401

Invalid, revoked or expired token (401) — also returned when the connection was revoked or the company is blocked.

Produced by the authentication filter, so the body is a reduced envelope: no error, no requestId, and errors is null rather than []. Every cause yields the same fixed English message.

403

The token lacks the required permission:scope grant (403).

429

Rate limit of 60 requests/minute exceeded (429). Like 401, this comes from the authentication filter: reduced envelope, fixed English message, no error object and no Retry-After header.