Preview Invoice

GET

invoices

{id}

preview

Preview an invoice as HTML

curl --request GET \
  --url https://billing.example.com/v1/invoices/{id}/preview \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/invoices/{id}/preview', 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://billing.example.com/v1/invoices/{id}/preview",
  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: Bearer <token>"
  ],
]);

$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://billing.example.com/v1/invoices/{id}/preview"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://billing.example.com/v1/invoices/{id}/preview")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

"<string>"

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  }
}

Path Parameters

Parameter	Type	Description
`id`	string	The invoice ID (e.g. `inv_001`).

This is a public endpoint and does not require authentication. Invoice preview URLs can be shared directly with customers.

Example Request

curl https://api.recurso.dev/v1/invoices/inv_001/preview

Response

Returns the rendered invoice as HTML with content type text/html.

HTTP/1.1 200 OK
Content-Type: text/html; charset=utf-8

<!DOCTYPE html>
<html>
  <head><title>Invoice REC/2024/0001</title></head>
  <body>
    <!-- Rendered invoice markup -->
  </body>
</html>

Notes

The response is raw HTML, not JSON. Set your client to accept text/html.
The rendered HTML includes all invoice line items, tax breakdowns, and your organization’s branding.
Draft invoices can also be previewed, making this useful for verifying layout before finalizing.

Embed the preview URL in customer-facing emails or portals so customers can view their invoices without logging in.

Errors

Status	Code	When	Fix
400	`validation_failed`	`id` is not a valid UUID.	Pass the invoice’s UUID.
401	`unauthorized`	API key missing or invalid (`invalid_api_key`), or a live/test mode mismatch (`key_mode_mismatch`).	Send `Authorization: Bearer <api_key>` with a key for the right mode.
404	`not_found`	No invoice with that ID exists in your tenant.	Check the ID, and that the key belongs to the tenant that owns the invoice.
429	`rate_limited`	Rendering is an expensive endpoint and has a stricter rate limit.	Back off and retry after the limit window; cache rendered output where possible.
500	`internal_error`	The invoice or its customer could not be loaded, or rendering failed.	Retry; if it persists, contact support with the invoice ID.

See Errors for the error envelope and the full code taxonomy.

Authorizations

Authorization

string

header

required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

string<uuid>

required

Response

Print-ready invoice document.

The response is of type string.

Preview an invoice as HTML

curl --request GET \
  --url https://billing.example.com/v1/invoices/{id}/preview \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/invoices/{id}/preview', 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://billing.example.com/v1/invoices/{id}/preview",
  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: Bearer <token>"
  ],
]);

$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://billing.example.com/v1/invoices/{id}/preview"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://billing.example.com/v1/invoices/{id}/preview")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

"<string>"

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  }
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Path Parameters

Example Request

Response

Notes

Errors

Authorizations

Path Parameters

Response

​Path Parameters

​Example Request

​Response

​Notes

​Errors

Authorizations

Path Parameters

Response

Path Parameters

Example Request

Response

Notes

Errors