curl --request GET \
--url https://api.stigg.io/api/v1/contracts/{id}/billing/invoice-schedule \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.stigg.io/api/v1/contracts/{id}/billing/invoice-schedule"
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/contracts/{id}/billing/invoice-schedule', 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/contracts/{id}/billing/invoice-schedule",
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/contracts/{id}/billing/invoice-schedule"
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/contracts/{id}/billing/invoice-schedule")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stigg.io/api/v1/contracts/{id}/billing/invoice-schedule")
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": {
"contractId": "<string>",
"externalId": "<string>",
"isPreview": true,
"invoiceCount": 123,
"total": 123,
"invoices": [
{
"invoiceId": "<string>",
"state": "<string>",
"issueDate": "2023-11-07T05:31:56Z",
"currency": "<string>",
"subtotal": 123,
"tax": 123,
"total": 123,
"lineItems": [
{
"description": "<string>",
"quantity": 123,
"unitPrice": 123,
"amount": 123
}
],
"invoiceNumber": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"periodStart": "2023-11-07T05:31:56Z",
"periodEnd": "2023-11-07T05:31:56Z",
"discount": 123
}
]
}
}{
"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 contract by ID
The invoices the contract will produce, earliest issue date first — each with the period it covers, its issue and due dates, totals and line items. The complement to the summary: that says whether the money adds up, this says whether the customer will be invoiced when the order form says. On a draft the documents are regenerated first, so the schedule reflects the contract as it stands; on a published contract the persisted invoices are returned untouched. Pass count to read only the first N.
curl --request GET \
--url https://api.stigg.io/api/v1/contracts/{id}/billing/invoice-schedule \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.stigg.io/api/v1/contracts/{id}/billing/invoice-schedule"
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/contracts/{id}/billing/invoice-schedule', 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/contracts/{id}/billing/invoice-schedule",
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/contracts/{id}/billing/invoice-schedule"
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/contracts/{id}/billing/invoice-schedule")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stigg.io/api/v1/contracts/{id}/billing/invoice-schedule")
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": {
"contractId": "<string>",
"externalId": "<string>",
"isPreview": true,
"invoiceCount": 123,
"total": 123,
"invoices": [
{
"invoiceId": "<string>",
"state": "<string>",
"issueDate": "2023-11-07T05:31:56Z",
"currency": "<string>",
"subtotal": 123,
"tax": 123,
"total": 123,
"lineItems": [
{
"description": "<string>",
"quantity": 123,
"unitPrice": 123,
"amount": 123
}
],
"invoiceNumber": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"periodStart": "2023-11-07T05:31:56Z",
"periodEnd": "2023-11-07T05:31:56Z",
"discount": 123
}
]
}
}{
"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
The unique identifier of the entity
1 - 255Query Parameters
x >= 1Response
The contract's invoices, earliest first, with the period each covers.
Response object
The invoices a contract will produce, earliest issue date first. Where the summary says whether the money adds up, this says whether the customer will be invoiced when the order form says — so it is the check that catches line items which agree on a total but bill on different days.
Show child attributes
Show child attributes
Related topics
Get a single contract by IDGet a single entity by IDGet a single addon by IDGet a single subscription by IDGet a single coupon by ID