Get an invoice

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/billing/invoices/{invoiceId} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/billing/invoices/{invoiceId}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/billing/invoices/{invoiceId}', 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://api.hyperprop.com/platform/v1/organization/billing/invoices/{invoiceId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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://api.hyperprop.com/platform/v1/organization/billing/invoices/{invoiceId}"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.hyperprop.com/platform/v1/organization/billing/invoices/{invoiceId}")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/billing/invoices/{invoiceId}")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "success": true,
  "data": {
    "invoice": {
      "id": "5b0c7a2e-3f41-4d1a-9c6e-2a8f0d9b7e13",
      "organizationId": "0e9b6a14-7c2d-4b8f-93a1-6d5e2f8c0b47",
      "kind": "month_final",
      "billingMonth": "2026-11-01",
      "periodFrom": "2026-10-01T05:00:00.000Z",
      "periodTo": "2026-11-01T05:00:00.000Z",
      "revision": 1,
      "replacesInvoiceId": "<string>",
      "replacedByInvoiceId": "<string>",
      "replacesNumber": null,
      "replacedByNumber": null,
      "status": "open",
      "displayStatus": "open",
      "paymentState": "awaiting_transfer",
      "number": "HP-0042",
      "currency": "usd",
      "subtotalCents": 2860000,
      "creditAppliedCents": 0,
      "creditNotesCents": 0,
      "taxCents": 0,
      "totalCents": 2860000,
      "amountDueCents": 2860000,
      "amountPaidCents": 0,
      "amountRemainingCents": 2860000,
      "dueDate": "2026-11-15T00:00:00.000Z",
      "finalizedAt": "2026-11-01T09:00:00.000Z",
      "sentAt": "2026-11-01T09:00:05.000Z",
      "paidAt": null,
      "voidedAt": null,
      "hostedInvoiceUrl": "https://invoice.example.com/i/acct_1/test_YWNjdF8x",
      "memo": null,
      "createdAt": "2026-11-01T08:59:58.000Z",
      "lines": [
        {
          "id": "8d6f3c1a-2b7e-4f90-a1c3-5e7d9b0f2a64",
          "billingMonth": "2026-11-01",
          "priceLineCode": "platform_futures",
          "family": "cme",
          "lineType": "usage",
          "source": "engine",
          "description": "CME, 1,300 traders, November 2026",
          "quantity": "1300.0000",
          "unitAmount": "22.0000",
          "amountCents": 2860000,
          "sort": 1
        }
      ],
      "usage": [
        {
          "billingMonth": "2026-11-01",
          "family": "cme",
          "units": 400,
          "previouslyBilled": 900
        }
      ],
      "explain": [
        "CME minimum 2,000 traders for November 2026: 1,300 billed (900 on earlier invoices), 700 added."
      ],
      "agreementId": "<string>",
      "agreementVersion": 3,
      "engineVersion": "2026-10-30"
    }
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Validation failed",
  "code": "VALIDATION_ERROR"
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Your role does not have view access to \"Billing & purchases revenue\"",
  "code": "INSUFFICIENT_PERMISSIONS"
}

{
  "success": false,
  "statusCode": 404,
  "error": "Not Found",
  "message": "No issued invoice with this ID in your organization",
  "code": "INVOICE_NOT_FOUND"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

{
  "statusCode": 504,
  "error": "Gateway Timeout",
  "message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
  "code": "REQUEST_TIMEOUT"
}