Skip to main content
GET
List a sub-publishing agreement's recoupment ledger
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

GET /publisher/sub-publishing//recoupment Returns RecoupmentLedger rows for the agreement, ordered oldest first so the running-balance sequence reads naturally. The top-level runningBalance/currency are taken from the agreement’s full history (not just the current page). Authorization: user role + publisher addon.

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

id
string<uuid>
required

Query Parameters

page
integer
Required range: x >= 1
size
integer

Default 20, max 100.

Response

Ledger fetched.

Standard server envelope used by the statement, reconciliation, sub-publishing, and analytics endpoints.

status
enum<string>
Available options:
success,
error
message
string
data
object