List invoice items

curl --request GET \
  --url https://api.spacebring.com/billing/invoices/v1/items \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.spacebring.com/billing/invoices/v1/items"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.spacebring.com/billing/invoices/v1/items', 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.spacebring.com/billing/invoices/v1/items",
  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: Basic <encoded-value>"
  ],
]);

$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.spacebring.com/billing/invoices/v1/items"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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://api.spacebring.com/billing/invoices/v1/items")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "invoiceItems": [
    {
      "amount": 123,
      "baseAmounts": {
        "currencyCode": "<string>",
        "discountedAmount": 123,
        "totalAmount": 123,
        "totalExcludingTaxAmount": 123,
        "unitAmount": 123,
        "unitExcludingTaxAmount": 123,
        "tax": {
          "amount": 123,
          "inclusive": true,
          "rate": 123,
          "taxableAmount": 123
        }
      },
      "createDate": "2023-11-07T05:31:56Z",
      "currencyCode": "<string>",
      "description": "<string>",
      "discountedAmount": 123,
      "discounts": [
        {
          "coupon": {
            "amountOff": 123,
            "currencyCode": "<string>",
            "duration": "<string>",
            "durationInMonths": 123,
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "percentOff": 123,
            "productTypes": [
              "<string>"
            ],
            "type": "<string>"
          },
          "promocode": {
            "code": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "expiration": {
              "enabled": true,
              "date": "2023-11-07T05:31:56Z"
            },
            "limitByFirstPurchase": true
          },
          "subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "id": "<string>",
      "locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "netAmount": 123,
      "netUnitAmount": 123,
      "product": {
        "title": "<string>",
        "type": "creditPackage",
        "bookingRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "eventTicketRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "optionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "orderRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "quantity": 0,
      "totalAmount": 123,
      "totalExcludingTaxAmount": 123,
      "type": "<string>",
      "unitAmount": 123,
      "unitExcludingTaxAmount": 123,
      "booking": {},
      "companyRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "creditPackage": {},
      "customer": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "company",
        "logo": {
          "key": "<string>",
          "url": "<string>"
        },
        "title": "<string>",
        "user": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "about": "<string>",
          "email": "<string>",
          "name": "<string>",
          "phoneNumber": "<string>",
          "photoUrl": "<string>",
          "surname": "<string>"
        }
      },
      "deleteDate": "2023-11-07T05:31:56Z",
      "invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "issueDate": "2023-11-07T05:31:56Z",
      "membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "membershipRefCreatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "orderItem": {},
      "period": {
        "endDate": "2023-11-07T05:31:56Z",
        "startDate": "2023-11-07T05:31:56Z"
      },
      "plan": {},
      "status": "draft",
      "subscriptionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tax": {
        "amount": 123,
        "inclusive": true,
        "rate": 123,
        "taxableAmount": 123
      },
      "taxAmount": 123,
      "taxableAmount": 123,
      "ticket": {},
      "userCreatedBy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "surname": "<string>"
      }
    }
  ],
  "nextPageToken": "<string>",
  "searchQueryNext": "<string>"
}

{
  "message": "<string>",
  "type": "<string>"
}

Billing

List invoice items

List invoice items filtered by customer, location, invoice, type, status, pending, or date range. Pass invoiceRef for the items of one invoice; they page like the rest of the list. The createDate filter matches when the item was created; the status and issueDate filters match the invoice the item is on, so they return only items connected to an invoice. Pending items are not on an invoice and not part of a subscription: pass pending=true with customerRef for one customer’s pending items, or with locationRef for every pending item at a location. Without customerRef, invoiceRef or locationRef, lists the items of the whole network; an administrator limited to some locations needs one of them.

OAuth

Required scopes: invoices.readonly or invoices

GET

billing

invoices

items

List invoice items

curl --request GET \
  --url https://api.spacebring.com/billing/invoices/v1/items \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.spacebring.com/billing/invoices/v1/items"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.spacebring.com/billing/invoices/v1/items', 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.spacebring.com/billing/invoices/v1/items",
  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: Basic <encoded-value>"
  ],
]);

$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.spacebring.com/billing/invoices/v1/items"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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://api.spacebring.com/billing/invoices/v1/items")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "invoiceItems": [
    {
      "amount": 123,
      "baseAmounts": {
        "currencyCode": "<string>",
        "discountedAmount": 123,
        "totalAmount": 123,
        "totalExcludingTaxAmount": 123,
        "unitAmount": 123,
        "unitExcludingTaxAmount": 123,
        "tax": {
          "amount": 123,
          "inclusive": true,
          "rate": 123,
          "taxableAmount": 123
        }
      },
      "createDate": "2023-11-07T05:31:56Z",
      "currencyCode": "<string>",
      "description": "<string>",
      "discountedAmount": 123,
      "discounts": [
        {
          "coupon": {
            "amountOff": 123,
            "currencyCode": "<string>",
            "duration": "<string>",
            "durationInMonths": 123,
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "percentOff": 123,
            "productTypes": [
              "<string>"
            ],
            "type": "<string>"
          },
          "promocode": {
            "code": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "expiration": {
              "enabled": true,
              "date": "2023-11-07T05:31:56Z"
            },
            "limitByFirstPurchase": true
          },
          "subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "id": "<string>",
      "locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "netAmount": 123,
      "netUnitAmount": 123,
      "product": {
        "title": "<string>",
        "type": "creditPackage",
        "bookingRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "eventTicketRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "optionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "orderRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "quantity": 0,
      "totalAmount": 123,
      "totalExcludingTaxAmount": 123,
      "type": "<string>",
      "unitAmount": 123,
      "unitExcludingTaxAmount": 123,
      "booking": {},
      "companyRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "creditPackage": {},
      "customer": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "company",
        "logo": {
          "key": "<string>",
          "url": "<string>"
        },
        "title": "<string>",
        "user": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "about": "<string>",
          "email": "<string>",
          "name": "<string>",
          "phoneNumber": "<string>",
          "photoUrl": "<string>",
          "surname": "<string>"
        }
      },
      "deleteDate": "2023-11-07T05:31:56Z",
      "invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "issueDate": "2023-11-07T05:31:56Z",
      "membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "membershipRefCreatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "orderItem": {},
      "period": {
        "endDate": "2023-11-07T05:31:56Z",
        "startDate": "2023-11-07T05:31:56Z"
      },
      "plan": {},
      "status": "draft",
      "subscriptionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tax": {
        "amount": 123,
        "inclusive": true,
        "rate": 123,
        "taxableAmount": 123
      },
      "taxAmount": 123,
      "taxableAmount": 123,
      "ticket": {},
      "userCreatedBy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "surname": "<string>"
      }
    }
  ],
  "nextPageToken": "<string>",
  "searchQueryNext": "<string>"
}

{
  "message": "<string>",
  "type": "<string>"
}

Authorizations

Authorization

string

header

required

See our authentication documentation for how to authorize your requests

Scopes

invoices.readonly

Read contracts, credit notes, discounts and invoices

invoices

Read and write contract, credit notes, discounts and invoices

Headers

spacebring-network-id

string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

createDate[gte]

string

Filter invoice items created on or after this date (ISO 8601). Use with createDate[lte] for a range.

createDate[lte]

string

Filter invoice items created on or before this date (ISO 8601). Use with createDate[gte] for a range.

customerRef

string<uuid>

UUID of the customer whose invoice items to list.

issueDate[gte]

string

Filter invoice items on invoices issued on or after this date (ISO 8601). Items not on an issued invoice are excluded. Use with issueDate[lte] for a range.

issueDate[lte]

string

Filter invoice items on invoices issued on or before this date (ISO 8601). Items not on an issued invoice are excluded. Use with issueDate[gte] for a range.

limit

integer

Maximum number of invoice items per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

Required range: 1 <= x <= 100

locationRef

string<uuid>

UUID of the location whose invoice items to list. Without customerRef, invoiceRef or locationRef, lists the invoice items of the whole network.

nextPageToken

string

Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.

status

string

Filter by the status of the invoice the item is on: draft (created but not sent), issued (sent to the customer but unpaid), paid (fully paid) or voided (cancelled and no longer valid). Items not on an invoice are excluded. Comma-separated, one or more of: draft, issued, paid, voided.

invoiceRef

string<uuid>

UUID of the invoice whose items to list, in place of customerRef or locationRef or with them. Pages and sorts like the rest of the list, and the other filters still apply.

pending

enum<string>

Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false.

Available options:

true,

false

type

string

Filter by invoice item type. Comma-separated, one or more of: creditPackage, custom, booking, eventTicket, subscription, order.

Response

invoiceItems

object[]

required

List of invoice items.

Show child attributes

nextPageToken

string

Pagination token to fetch the next page of results.

searchQueryNext

string

Search query parameters for the next page of results. Includes all filters used to fetch the current page.

Overview

APIs

Webhooks

List invoice items

OAuth

Authorizations

Scopes

Headers

Query Parameters

Response