latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

Admin APIs
block-data-approvals

List Contract Payments

Payment triage across Block contracts, for account management.

Finance asked for "dashboarding so account management can see the status of the block payments and escalate outreach" — while being explicit that an overdue invoice never revokes access. So this view exists precisely so the escalation is human.

Wider than the Active Contracts tab on purpose: it keeps terminal contracts with money still outstanding, and contracts inside the access grace window — which is exactly when a contract vanishes from every "active" view while the customer is still being served.

100% DB-backed, so it stays usable when Stripe is degraded. Counts are computed server-side so the chips and badges cannot disagree.

get/api/v1/admin/block/contract-payments

Query parameters

payment_statestring nullable

Filter to one payment state (paid/due/overdue/...).

Filter to one payment state (paid/due/overdue/...).

in_graceboolean nullable
unpaid_after_termboolean nullable
sortstring
orderstring
qstring nullable

Client or dataset substring.

Client or dataset substring.

Response

Successful Response

totalinteger required
countsobject