Skip to main content
GET
Get invoice

Authorizations

Authorization
string
header
required

Biscuit-based bearer token. Obtain tokens from the Adaptyv Portal or via the /tokens endpoint. Tokens encode organization membership and role-based capabilities; the API verifies the token's cryptographic signature and authorization claims before processing requests. Use /tokens/attenuate to create restricted tokens for delegation.

Path Parameters

invoice_id
string
required

Foundry invoice UUID or Stripe invoice ID (in_xxx)

Response

Invoice detail

Public invoice detail DTO.

Renames amount_total_cents to amount_cents for consistency with the rest of the billing surface.

currency
string
required

Three-letter ISO 4217 currency code.

Example:

"usd"

id
string
required

Foundry invoice UUID.

Example:

"018f4c6b-1234-7abc-def0-0123456789ab"

status
string
required

Stripe invoice lifecycle state.

One of "draft", "open", "paid", "void", or "uncollectible".

Example:

"open"

stripe_invoice_id
string
required

Stripe invoice ID (in_xxx).

Example:

"in_1OqLk2LkdIwHu7ix6OboRpXl"

amount_cents
integer<int64> | null

Total amount in the invoice's currency, in the smallest unit (e.g. cents).

Example:

25000

experiment_id
string | null

Foundry experiment UUID linked to this invoice, if any.

Example:

"018f4c6b-5678-7abc-def0-0123456789cd"

hosted_invoice_url
string | null

Stripe-hosted payment page URL. None for draft invoices.

Example:

"https://invoice.stripe.com/i/acct_xxx/test_YWNjdF8xxx"

stripe_quote_id
string | null

Stripe quote ID that generated this invoice, if any.

Example:

"qt_1OqLk2LkdIwHu7ix6OboRpXl"