Get invoice

Get invoice

curl --request GET \
  --url https://devs.adaptyvbio.com/api/v1/invoices/{invoice_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://devs.adaptyvbio.com/api/v1/invoices/{invoice_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://devs.adaptyvbio.com/api/v1/invoices/{invoice_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://devs.adaptyvbio.com/api/v1/invoices/{invoice_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://devs.adaptyvbio.com/api/v1/invoices/{invoice_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

{
  "error": "experiment not found",
  "request_id": "req_019462a4-b1c2-7def-8901-23456789abcd"
}

{
  "error": "experiment not found",
  "request_id": "req_019462a4-b1c2-7def-8901-23456789abcd"
}

{
  "error": "experiment not found",
  "request_id": "req_019462a4-b1c2-7def-8901-23456789abcd"
}

{
  "error": "experiment not found",
  "request_id": "req_019462a4-b1c2-7def-8901-23456789abcd"
}

GET

api

invoices

{invoice_id}

Get invoice

curl --request GET \
  --url https://devs.adaptyvbio.com/api/v1/invoices/{invoice_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://devs.adaptyvbio.com/api/v1/invoices/{invoice_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://devs.adaptyvbio.com/api/v1/invoices/{invoice_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://devs.adaptyvbio.com/api/v1/invoices/{invoice_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://devs.adaptyvbio.com/api/v1/invoices/{invoice_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

{
  "error": "experiment not found",
  "request_id": "req_019462a4-b1c2-7def-8901-23456789abcd"
}

{
  "error": "experiment not found",
  "request_id": "req_019462a4-b1c2-7def-8901-23456789abcd"
}

{
  "error": "experiment not found",
  "request_id": "req_019462a4-b1c2-7def-8901-23456789abcd"
}

{
  "error": "experiment not found",
  "request_id": "req_019462a4-b1c2-7def-8901-23456789abcd"
}

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"

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"

Getting Started

Payments

API Endpoints

Authorizations

Path Parameters

Response