Create Subscription Invoice

curl --request POST \
  --url https://mapi.zbx.boomfi.xyz/v1/subscriptions/{subscriptionID}/invoices \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "due_date": "<string>",
  "properties": {},
  "title": "<string>"
}
'

import requests

url = "https://mapi.zbx.boomfi.xyz/v1/subscriptions/{subscriptionID}/invoices"

payload = {
    "due_date": "<string>",
    "properties": {},
    "title": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({due_date: '<string>', properties: {}, title: '<string>'})
};

fetch('https://mapi.zbx.boomfi.xyz/v1/subscriptions/{subscriptionID}/invoices', 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://mapi.zbx.boomfi.xyz/v1/subscriptions/{subscriptionID}/invoices",
  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([
    'due_date' => '<string>',
    'properties' => [
        
    ],
    'title' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://mapi.zbx.boomfi.xyz/v1/subscriptions/{subscriptionID}/invoices"

	payload := strings.NewReader("{\n  \"due_date\": \"<string>\",\n  \"properties\": {},\n  \"title\": \"<string>\"\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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://mapi.zbx.boomfi.xyz/v1/subscriptions/{subscriptionID}/invoices")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"due_date\": \"<string>\",\n  \"properties\": {},\n  \"title\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mapi.zbx.boomfi.xyz/v1/subscriptions/{subscriptionID}/invoices")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"due_date\": \"<string>\",\n  \"properties\": {},\n  \"title\": \"<string>\"\n}"

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

{
  "data": {
    "amount": "<string>",
    "created_at": "<string>",
    "currency": "<string>",
    "customer_id": "<string>",
    "due_at": "<string>",
    "id": "<string>",
    "issuing_at": "<string>",
    "org_id": "<string>",
    "properties": [
      123
    ],
    "reference": "<string>",
    "updated_at": "<string>"
  },
  "error": true,
  "message": "<string>"
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

POST

subscriptions

{subscriptionID}

invoices

Create Subscription Invoice

curl --request POST \
  --url https://mapi.zbx.boomfi.xyz/v1/subscriptions/{subscriptionID}/invoices \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "due_date": "<string>",
  "properties": {},
  "title": "<string>"
}
'

import requests

url = "https://mapi.zbx.boomfi.xyz/v1/subscriptions/{subscriptionID}/invoices"

payload = {
    "due_date": "<string>",
    "properties": {},
    "title": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({due_date: '<string>', properties: {}, title: '<string>'})
};

fetch('https://mapi.zbx.boomfi.xyz/v1/subscriptions/{subscriptionID}/invoices', 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://mapi.zbx.boomfi.xyz/v1/subscriptions/{subscriptionID}/invoices",
  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([
    'due_date' => '<string>',
    'properties' => [
        
    ],
    'title' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://mapi.zbx.boomfi.xyz/v1/subscriptions/{subscriptionID}/invoices"

	payload := strings.NewReader("{\n  \"due_date\": \"<string>\",\n  \"properties\": {},\n  \"title\": \"<string>\"\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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://mapi.zbx.boomfi.xyz/v1/subscriptions/{subscriptionID}/invoices")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"due_date\": \"<string>\",\n  \"properties\": {},\n  \"title\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mapi.zbx.boomfi.xyz/v1/subscriptions/{subscriptionID}/invoices")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"due_date\": \"<string>\",\n  \"properties\": {},\n  \"title\": \"<string>\"\n}"

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

{
  "data": {
    "amount": "<string>",
    "created_at": "<string>",
    "currency": "<string>",
    "customer_id": "<string>",
    "due_at": "<string>",
    "id": "<string>",
    "issuing_at": "<string>",
    "org_id": "<string>",
    "properties": [
      123
    ],
    "reference": "<string>",
    "updated_at": "<string>"
  },
  "error": true,
  "message": "<string>"
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

subscriptionID

string

required

Unique subscription identifier (sub_... or raw UUID)

Body

application/json

Invoice request

due_date

string

Invoice due date (RFC3339).

properties

object

Additional properties as a key-value map.

Show child attributes

title

string

Invoice title or subject line.

Response

data

object

Response payload when the request succeeded.

Show child attributes

error

boolean

True when the request failed.

message

string

Human-readable status or error message.

Basics

Paylinks

Plans

Subscriptions

Customers

Invoices

Payments

Events

Organisation

Secrets

Accounts

Bank Address Book

Virtual Accounts

Partners

Partner Automations

Partner Balance Monitoring

Instruments

Quotes

Orders

Trades

Create Subscription Invoice

Authorizations

Path Parameters

Body

Response