Skip to main content
POST
/
billing
/
invoices
/
custom
Create a custom invoice
curl --request POST \
  --url https://api.royalti.io/billing/invoices/custom \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "totalAmount": 250,
  "description": "One-time onboarding fee",
  "currency": "USD"
}
'
import requests

url = "https://api.royalti.io/billing/invoices/custom"

payload = {
"totalAmount": 250,
"description": "One-time onboarding fee",
"currency": "USD"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({totalAmount: 250, description: 'One-time onboarding fee', currency: 'USD'})
};

fetch('https://api.royalti.io/billing/invoices/custom', 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.royalti.io/billing/invoices/custom",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'totalAmount' => 250,
'description' => 'One-time onboarding fee',
'currency' => 'USD'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.royalti.io/billing/invoices/custom"

payload := strings.NewReader("{\n \"totalAmount\": 250,\n \"description\": \"One-time onboarding fee\",\n \"currency\": \"USD\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.royalti.io/billing/invoices/custom")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"totalAmount\": 250,\n \"description\": \"One-time onboarding fee\",\n \"currency\": \"USD\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/billing/invoices/custom")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"totalAmount\": 250,\n \"description\": \"One-time onboarding fee\",\n \"currency\": \"USD\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "TenantId": 123,
    "stripeSubscriptionId": "<string>",
    "stripeInvoiceId": "<string>",
    "invoiceNumber": "<string>",
    "description": "<string>",
    "lineItems": [
      {}
    ],
    "amount": 123,
    "taxAmount": 123,
    "discountAmount": 123,
    "totalAmount": 123,
    "currency": "USD",
    "dueDate": "2023-11-07T05:31:56Z",
    "paidDate": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "paymentMethod": "<string>",
    "referenceNumber": "<string>",
    "paymentReference": "<string>",
    "notes": "<string>",
    "metadata": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

POST /billing/invoices/custom Creates a manually-issued TenantInvoice (invoiceType: custom) — used for one-off charges outside the Stripe subscription flow. Authorization:
  • Required role: owner only

Code Examples

const response = await fetch('https://api.royalti.io/billing/invoices/custom', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "ref": "#/components/schemas/CreateCustomInvoiceRequest"
  })
});

const data = await response.json();
console.log(data);
import requests

response = requests.post(
  'https://api.royalti.io/billing/invoices/custom',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"ref":"#/components/schemas/CreateCustomInvoiceRequest"}
)

data = response.json()
print(data)
curl -X POST https://api.royalti.io/billing/invoices/custom \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ref":"#/components/schemas/CreateCustomInvoiceRequest"}'

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
totalAmount
number
required
Required range: x >= 0.01
description
string
required
taxAmount
number
discountAmount
number
currency
string
Example:

"USD"

dueDate
string<date-time>
lineItems
object[]
notes
string
paymentMethod
string
referenceNumber
string

Response

Custom invoice created

status
string
Example:

"success"

message
string
data
object

Locally-stored invoice row (TenantInvoice model) — custom/manual invoices only; Stripe-hosted invoices are fetched live and merged in GET /billing/invoices.