Skip to main content
GET
List a subscription's billing history

Authorizations

x-api-key
string
header
required

Your secret key, from app.agentaos.ai -> Settings -> Developers -> API Keys. The key's prefix is both its identity and its environment: sk_test_... (sandbox, free, no verification) or sk_live_... (real money, requires business verification). A missing or invalid key returns 401.

Path Parameters

id
string<uuid>
required

Subscription UUID (the id field from the list response, not stripeSubscriptionId).

Response

The subscription's billing history.

id
string<uuid>
required
invoiceNumber
string
required
status
enum<string>
required
Available options:
issued,
paid,
voided
issuedAt
string<date-time>
required
amount
number
required

The settled amount for this cycle: the linked capture's settlement earnings (net + fee + vat) when one is available in the invoice's own fiat currency, else the merchant's fiat_amount, else the settlement-token amount. Already resolved server-side — never recompute this.

currency
string
required
disputed
boolean
required

Derived from the linked capture's dispute state, never persisted — reverts to false the instant a won dispute restores the capture. Only ever true when status is 'paid'.