invoices

Get invoice

Fetches a single invoice by its Foundry UUID or Stripe invoice ID (in_xxx). The caller's org membership scopes visibility — an invoice belonging to an org the caller cannot access returns 404.

get/api/v1/invoices/{invoice_id}

Request

Base URL
https://devs.adaptyvbio.com
URL
https://devs.adaptyvbio.com/api/v1/invoices/{invoice_id}
Auth
HTTP bearer

Path parameters

invoice_idstring required

Foundry invoice UUID or Stripe invoice ID (in_xxx)

Response

Invoice detail

amount_centsinteger nullable

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

currencystring required

Three-letter ISO 4217 currency code.

experiment_idstring nullable

Foundry experiment UUID linked to this invoice, if any.

hosted_invoice_urlstring nullable

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

idstring required

Foundry invoice UUID.

statusstring required

Stripe invoice lifecycle state.

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

stripe_invoice_idstring required

Stripe invoice ID (in_xxx).

stripe_quote_idstring nullable

Stripe quote ID that generated this invoice, if any.

Example response

{
  "amount_cents": 25000,
  "currency": "usd",
  "experiment_id": "018f4c6b-5678-7abc-def0-0123456789cd",
  "hosted_invoice_url": "https://invoice.stripe.com/i/acct_xxx/test_YWNjdF8xxx",
  "id": "018f4c6b-1234-7abc-def0-0123456789ab",
  "status": "open",
  "stripe_invoice_id": "in_1OqLk2LkdIwHu7ix6OboRpXl",
  "stripe_quote_id": "qt_1OqLk2LkdIwHu7ix6OboRpXl"
}

Changes

No recorded changes to this operation across all 1 revision of this API.