Skip to main content
PUT
/
billing
/
invoices
/
custom
/
{id}
Update a custom invoice
curl --request PUT \
  --url https://api.royalti.io/billing/invoices/custom/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "totalAmount": 1.01,
  "description": "<string>",
  "taxAmount": 123,
  "discountAmount": 123,
  "currency": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "lineItems": [
    {}
  ],
  "notes": "<string>",
  "paymentMethod": "<string>",
  "referenceNumber": "<string>"
}
'
import requests

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

payload = {
"totalAmount": 1.01,
"description": "<string>",
"taxAmount": 123,
"discountAmount": 123,
"currency": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"lineItems": [{}],
"notes": "<string>",
"paymentMethod": "<string>",
"referenceNumber": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
totalAmount: 1.01,
description: '<string>',
taxAmount: 123,
discountAmount: 123,
currency: '<string>',
dueDate: '2023-11-07T05:31:56Z',
lineItems: [{}],
notes: '<string>',
paymentMethod: '<string>',
referenceNumber: '<string>'
})
};

fetch('https://api.royalti.io/billing/invoices/custom/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'totalAmount' => 1.01,
'description' => '<string>',
'taxAmount' => 123,
'discountAmount' => 123,
'currency' => '<string>',
'dueDate' => '2023-11-07T05:31:56Z',
'lineItems' => [
[

]
],
'notes' => '<string>',
'paymentMethod' => '<string>',
'referenceNumber' => '<string>'
]),
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/{id}"

payload := strings.NewReader("{\n \"totalAmount\": 1.01,\n \"description\": \"<string>\",\n \"taxAmount\": 123,\n \"discountAmount\": 123,\n \"currency\": \"<string>\",\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"lineItems\": [\n {}\n ],\n \"notes\": \"<string>\",\n \"paymentMethod\": \"<string>\",\n \"referenceNumber\": \"<string>\"\n}")

req, _ := http.NewRequest("PUT", 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.put("https://api.royalti.io/billing/invoices/custom/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"totalAmount\": 1.01,\n \"description\": \"<string>\",\n \"taxAmount\": 123,\n \"discountAmount\": 123,\n \"currency\": \"<string>\",\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"lineItems\": [\n {}\n ],\n \"notes\": \"<string>\",\n \"paymentMethod\": \"<string>\",\n \"referenceNumber\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"totalAmount\": 1.01,\n \"description\": \"<string>\",\n \"taxAmount\": 123,\n \"discountAmount\": 123,\n \"currency\": \"<string>\",\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"lineItems\": [\n {}\n ],\n \"notes\": \"<string>\",\n \"paymentMethod\": \"<string>\",\n \"referenceNumber\": \"<string>\"\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": {}
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

PUT /billing/invoices/custom/ Authorization:
  • Required role: owner only

Code Examples

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

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

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

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

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Body

application/json

Partial update — any subset of CreateCustomInvoiceRequest fields.

totalAmount
number
Required range: x >= 0.01
description
string
taxAmount
number
discountAmount
number
currency
string
dueDate
string<date-time>
lineItems
object[]
notes
string
paymentMethod
string
referenceNumber
string

Response

Custom invoice updated

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.