Retrieve next subscription invoice

curl --request GET \
  --url https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/invoices/next \
  --header 'X-SALESBRICKS-KEY: <api-key>'

import requests

url = "https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/invoices/next"

headers = {"X-SALESBRICKS-KEY": "<api-key>"}

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

print(response.text)

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

fetch('https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/invoices/next', 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.salesbricks.com/api/v2/subscriptions/{subscription_id}/invoices/next",
  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-SALESBRICKS-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.salesbricks.com/api/v2/subscriptions/{subscription_id}/invoices/next"

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

	req.Header.Add("X-SALESBRICKS-KEY", "<api-key>")

	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.salesbricks.com/api/v2/subscriptions/{subscription_id}/invoices/next")

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

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

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

{
  "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invoice_number": "<string>",
  "due_at": "2023-11-07T05:31:56Z",
  "bill_at": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "fully_paid_at": "2023-11-07T05:31:56Z",
  "grand_total": 123,
  "remaining_amount": 123,
  "currency": "<string>",
  "is_renewal_estimate": true,
  "customer_name": "<string>",
  "time_zone": "<string>",
  "payments": [
    {
      "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_number": "<string>",
      "invoice_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "paid_amount": 123,
      "paid_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "error": "<string>"
    }
  ],
  "attachments": [
    "<unknown>"
  ],
  "line_items": [
    {
      "brick_name": "<string>",
      "brick_id": "<string>",
      "quantity": 123,
      "tax": 123,
      "grand_total": 123,
      "starts_at": "2023-11-07T05:31:56Z",
      "ends_at": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": "<unknown>"
}

{
  "error": {
    "code": "ERR_NOT_FOUND",
    "message": "Not found — the resource you are looking for does not exist."
  }
}

GET

subscriptions

{subscription_id}

invoices

Retrieve next subscription invoice

curl --request GET \
  --url https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/invoices/next \
  --header 'X-SALESBRICKS-KEY: <api-key>'

import requests

url = "https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/invoices/next"

headers = {"X-SALESBRICKS-KEY": "<api-key>"}

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

print(response.text)

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

fetch('https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/invoices/next', 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.salesbricks.com/api/v2/subscriptions/{subscription_id}/invoices/next",
  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-SALESBRICKS-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.salesbricks.com/api/v2/subscriptions/{subscription_id}/invoices/next"

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

	req.Header.Add("X-SALESBRICKS-KEY", "<api-key>")

	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.salesbricks.com/api/v2/subscriptions/{subscription_id}/invoices/next")

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

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

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

{
  "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invoice_number": "<string>",
  "due_at": "2023-11-07T05:31:56Z",
  "bill_at": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "fully_paid_at": "2023-11-07T05:31:56Z",
  "grand_total": 123,
  "remaining_amount": 123,
  "currency": "<string>",
  "is_renewal_estimate": true,
  "customer_name": "<string>",
  "time_zone": "<string>",
  "payments": [
    {
      "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_number": "<string>",
      "invoice_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "paid_amount": 123,
      "paid_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "error": "<string>"
    }
  ],
  "attachments": [
    "<unknown>"
  ],
  "line_items": [
    {
      "brick_name": "<string>",
      "brick_id": "<string>",
      "quantity": 123,
      "tax": 123,
      "grand_total": 123,
      "starts_at": "2023-11-07T05:31:56Z",
      "ends_at": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": "<unknown>"
}

{
  "error": {
    "code": "ERR_NOT_FOUND",
    "message": "Not found — the resource you are looking for does not exist."
  }
}

Authorizations

X-SALESBRICKS-KEY

string

header

required

API key for authentication

Path Parameters

subscription_id

string

required

Pattern: ^([a-zA-Z\d\-]+)$

Query Parameters

include_paid

enum<string>

Set to '1' or 'true' to include paid invoices in the response.

Available options:

1,

True,

true

Response

invoice_id

string<uuid>

required

Unique identifier for the invoice. If the id is null, this is an estimate

subscription_id

string<uuid>

required

ID of the subscription this invoice belongs to. Null for standalone (one-off) invoices.

customer_id

string<uuid>

required

ID of the customer who will pay this invoice

invoice_number

string

required

Short form identifier for the invoice. If the invoice_number is null, this is an estimate

due_at

string<date-time>

required

The date on which this invoice is expected to be paid by.

bill_at

string<date-time>

required

The date on which this invoice will be issued and potentially charged.

issued_at

string<date-time>

required

The date on which this invoice was issued.

status

string

required

Current status of the invoice. One of:

MUTED — Invoice will not be sent. Muted invoices come from migration cut-overs or from muting invoices in the product settings.
SCHEDULED — Scheduled to be issued on a future date.
OUTSTANDING — Issued and awaiting payment.
DUE — Payment is due.
PAST_DUE — Payment is past its due date.
PAID — Fully paid.
PARTIALLY_PAID — Partially paid, with a remaining balance.
ADJUSTED — Adjusted after issuance.
CREDITED — Settled by applying credit.
UNPAID — Unpaid.
PAUSED — Collection is paused.
VOIDED — Voided and no longer collectible.

fully_paid_at

string<date-time>

required

The date on which this invoice was fully paid.

grand_total

integer

required

Total amount due for this invoice.

Invoices that have not been generated yet (e.g. SCHEDULED) report the total expected at the time they were created. That figure does NOT include usage metered since — a usage invoice whose meters have not been priced reports 0. Pass ?calculate_expected_usage=true to re-price against the order and include estimated usage instead; it is slower, so it is off by default on list endpoints.

remaining_amount

integer

required

Remaining amount for this invoice.

currency

string

required

The currency in which the invoice is denominated (e.g., USD, EUR).

is_renewal_estimate

boolean

required

This is an estimate for a renewal that has not yet closed, but is expected to.

customer_name

string

Name of the customer who will pay this invoice

time_zone

string

Invoice timezone

payments

object[]

All payments made against this invoice, newest first.

Show child attributes

attachments

any[]

Current attachments for this invoice as a flat array. Each item includes 'target' field indicating invoice or subscription level. Sorted by unified order.

line_items

object[]

Line item breakdown for this invoice

Show child attributes

metadata

any

Optional metadata stored against the invoice.

Customers

Invoices

Payment Methods

Customer Contacts

Discount Coupons

Invoice Versions

Legal Entities

Plans

Revenue

Subscriptions

Subscription Management

Subscription State

Usage

Subscription History

Subscription Recasts

Subscription Upgrades

Retrieve next subscription invoice

Authorizations

Path Parameters

Query Parameters

Response