Agreements & settlement

Account-level reads: your agreements, upfront pacing, and settlement paper. Buyers read /agreements and /settlement; sellers read the mirror at /me/settlement. Concepts: Agreements, Settlement.

List your agreements

GET/v1/agreementscatalog:read

Your active agreements: what each unlocks and how it settles. The full shape is the agreement object.

Query parameters

Field	Type	Description
seller	string	Filter to one counterparty.
active	boolean	Only agreements whose effective window covers today. Default: true.

Response

200 Response
{
  "agreements": [
    {
      "agreement_id": "agr_71c0d2",
      "buyer": "yourco",
      "seller": "acme",
      "catalog_scope": ["open", "private"],
      "rate_card_refs": ["acme-yourco-2026q4"],
      "deal_types": ["preemptible", "fixed", "audience_as_aired", "audience_guaranteed"],
      "settlement_mode": "direct",
      "credit": null,
      "effective": {
        "start": "2026-10-01",
        "end": "2027-09-30"
      }
    }
  ]
}

Read upfront pacing

GET/v1/agreements/{id}/pacingcatalog:read

Commitment drawdown on an upfront agreement: what you committed, what you have booked, and whether you are on pace. See Upfront.

Response

200 Response
{
  "agreement_id": "agr_71c0d2",
  "commitment_gross": 2400000,
  "currency": "USD",
  "booked_gross": 1350000,
  "pace": 0.96,
  "quarters": [
    {
      "quarter": "2026-Q4",
      "committed": 800000,
      "booked": 610000,
      "remaining": 190000
    }
  ]
}

Errors

Status	Code	When
404	NOT_FOUND	No such agreement in your scope, or the agreement carries no upfront commitment.

List invoices (buyer)

GET/v1/settlement/invoicessettlement:read

Invoices on your cleared trades. Direct-settled orders never appear here: on direct, you invoice each other and the platform carries only the paper trail. See Settlement.

Query parameters

Field	Type	Description
order	string	Filter to one order.
period	string	Broadcast-calendar billing period, for example 2026-11.
status	enum	open, paid, credited.

Response

200 Response
{
  "invoices": [
    {
      "invoice_id": "inv_20c4a1",
      "order_id": "ord_9f3a12c4b7e1",
      "external_order_id": "q4-campaign-042",
      "estimate_id": "EST-4402",
      "period": "2026-11",
      "gross": 8100.00,
      "currency": "USD",
      "status": "open",
      "issued_at": "2026-11-30T00:00:00Z"
    }
  ]
}

Invoices cross-reference your external_order_id and the estimate_id from buyer_metadata, so your billing system can match the record.

Read your credit position

GET/v1/settlement/creditsettlement:read

Current limit and exposure on cleared trading. A cleared order that would breach the cap fails fast at create with CREDIT_LIMIT; see Errors.

Response

200 Response
{
  "currency": "USD",
  "credit_limit": 500000,
  "exposure": 121500,
  "available": 378500,
  "as_of": "2026-10-02T14:00:00Z"
}

List invoices (seller)

GET/v1/me/settlement/invoicessettlement:read

The seller mirror: outbound invoices on your cleared trades, with the same query parameters and shape as the buyer read. Make-good credits link back to the buyer credit they mirror, so the ledger stays back-to-back by construction.

Response

200 Response
{
  "invoices": [
    {
      "invoice_id": "inv_20c4a1",
      "order_id": "ord_9f3a12c4b7e1",
      "period": "2026-11",
      "gross": 8100.00,
      "currency": "USD",
      "status": "open",
      "make_good_ref": null
    }
  ]
}