curl --request GET \
--url https://api.stigg.io/api/v1/customers/{id}/invoices/{invoiceRef} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.stigg.io/api/v1/customers/{id}/invoices/{invoiceRef}"
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.stigg.io/api/v1/customers/{id}/invoices/{invoiceRef}', 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.stigg.io/api/v1/customers/{id}/invoices/{invoiceRef}",
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.stigg.io/api/v1/customers/{id}/invoices/{invoiceRef}"
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.stigg.io/api/v1/customers/{id}/invoices/{invoiceRef}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stigg.io/api/v1/customers/{id}/invoices/{invoiceRef}")
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{
"data": {
"invoiceId": "<string>",
"invoiceExternalId": "<string>",
"invoiceNumber": "<string>",
"contractExternalId": "<string>",
"customerExternalId": "<string>",
"state": "OPEN",
"issueDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"paidDate": "2023-11-07T05:31:56Z",
"currency": "<string>",
"subtotal": 123,
"tax": 123,
"discount": 123,
"total": 123,
"lineItems": [
{
"description": "<string>",
"quantity": 123,
"unitPrice": 123,
"amount": 123,
"productExternalId": "<string>"
}
]
}
}{
"message": "<string>",
"code": "BadUserInput",
"reason": "<string>"
}{
"message": "<string>",
"code": "Unauthenticated"
}{
"message": "<string>",
"code": "IdentityForbidden"
}{
"message": "<string>",
"code": "CustomerNotFound"
}{
"message": "<string>",
"code": "RateLimitExceeded"
}Get a single invoice by ID
Retrieves a single invoice with its full detail, resolved by its ID. Works for a contract invoice and a subscription invoice alike, since invoices are addressed by their own ID.
curl --request GET \
--url https://api.stigg.io/api/v1/customers/{id}/invoices/{invoiceRef} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.stigg.io/api/v1/customers/{id}/invoices/{invoiceRef}"
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.stigg.io/api/v1/customers/{id}/invoices/{invoiceRef}', 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.stigg.io/api/v1/customers/{id}/invoices/{invoiceRef}",
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.stigg.io/api/v1/customers/{id}/invoices/{invoiceRef}"
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.stigg.io/api/v1/customers/{id}/invoices/{invoiceRef}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stigg.io/api/v1/customers/{id}/invoices/{invoiceRef}")
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{
"data": {
"invoiceId": "<string>",
"invoiceExternalId": "<string>",
"invoiceNumber": "<string>",
"contractExternalId": "<string>",
"customerExternalId": "<string>",
"state": "OPEN",
"issueDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"paidDate": "2023-11-07T05:31:56Z",
"currency": "<string>",
"subtotal": 123,
"tax": 123,
"discount": 123,
"total": 123,
"lineItems": [
{
"description": "<string>",
"quantity": 123,
"unitPrice": 123,
"amount": 123,
"productExternalId": "<string>"
}
]
}
}{
"message": "<string>",
"code": "BadUserInput",
"reason": "<string>"
}{
"message": "<string>",
"code": "Unauthenticated"
}{
"message": "<string>",
"code": "IdentityForbidden"
}{
"message": "<string>",
"code": "CustomerNotFound"
}{
"message": "<string>",
"code": "RateLimitExceeded"
}Authorizations
Server API Key
Headers
Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.
Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).
Path Parameters
External ID of the customer the invoice belongs to: your customer ref when mapped, otherwise the Received customer ID
1 - 255^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$The billing provider (Received) invoice ID
255Response
The invoice.
Response object
A customer invoice as reported by the connected billing provider.
Show child attributes
Show child attributes
