List Billing Packages

curl --request GET \
  --url https://fees.sandbox.lerian.net/v1/billing-packages \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>'

import requests

url = "https://fees.sandbox.lerian.net/v1/billing-packages"

headers = {
    "X-Organization-Id": "<x-organization-id>",
    "Content-Type": "<content-type>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Organization-Id': '<x-organization-id>', 'Content-Type': '<content-type>'}
};

fetch('https://fees.sandbox.lerian.net/v1/billing-packages', 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://fees.sandbox.lerian.net/v1/billing-packages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Content-Type: <content-type>",
    "X-Organization-Id: <x-organization-id>"
  ],
]);

$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://fees.sandbox.lerian.net/v1/billing-packages"

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

	req.Header.Add("X-Organization-Id", "<x-organization-id>")
	req.Header.Add("Content-Type", "<content-type>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://fees.sandbox.lerian.net/v1/billing-packages")
  .header("X-Organization-Id", "<x-organization-id>")
  .header("Content-Type", "<content-type>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://fees.sandbox.lerian.net/v1/billing-packages")

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

request = Net::HTTP::Get.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Content-Type"] = '<content-type>'

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

{
  "items": [
    {
      "id": "<string>",
      "label": "<string>",
      "description": "<string>",
      "enable": true,
      "organizationId": "<string>",
      "ledgerId": "<string>",
      "eventFilter": {
        "transactionRoute": "<string>",
        "status": "<string>"
      },
      "tiers": [
        {
          "minQuantity": 123,
          "maxQuantity": 123,
          "unitPrice": "<string>"
        }
      ],
      "freeQuota": 123,
      "discountTiers": [
        {
          "minQuantity": 123,
          "discountPercentage": "<string>"
        }
      ],
      "assetCode": "<string>",
      "debitAccountAlias": "<string>",
      "creditAccountAlias": "<string>",
      "feeAmount": "<string>",
      "maintenanceCreditAccount": "<string>",
      "accountTarget": {
        "segmentId": "<string>",
        "portfolioId": "<string>",
        "aliases": [
          "<string>"
        ]
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page": 123,
  "limit": 123,
  "total": 123
}

GET

billing-packages

List Billing Packages

curl --request GET \
  --url https://fees.sandbox.lerian.net/v1/billing-packages \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>'

import requests

url = "https://fees.sandbox.lerian.net/v1/billing-packages"

headers = {
    "X-Organization-Id": "<x-organization-id>",
    "Content-Type": "<content-type>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Organization-Id': '<x-organization-id>', 'Content-Type': '<content-type>'}
};

fetch('https://fees.sandbox.lerian.net/v1/billing-packages', 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://fees.sandbox.lerian.net/v1/billing-packages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Content-Type: <content-type>",
    "X-Organization-Id: <x-organization-id>"
  ],
]);

$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://fees.sandbox.lerian.net/v1/billing-packages"

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

	req.Header.Add("X-Organization-Id", "<x-organization-id>")
	req.Header.Add("Content-Type", "<content-type>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://fees.sandbox.lerian.net/v1/billing-packages")
  .header("X-Organization-Id", "<x-organization-id>")
  .header("Content-Type", "<content-type>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://fees.sandbox.lerian.net/v1/billing-packages")

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

request = Net::HTTP::Get.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Content-Type"] = '<content-type>'

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

{
  "items": [
    {
      "id": "<string>",
      "label": "<string>",
      "description": "<string>",
      "enable": true,
      "organizationId": "<string>",
      "ledgerId": "<string>",
      "eventFilter": {
        "transactionRoute": "<string>",
        "status": "<string>"
      },
      "tiers": [
        {
          "minQuantity": 123,
          "maxQuantity": 123,
          "unitPrice": "<string>"
        }
      ],
      "freeQuota": 123,
      "discountTiers": [
        {
          "minQuantity": 123,
          "discountPercentage": "<string>"
        }
      ],
      "assetCode": "<string>",
      "debitAccountAlias": "<string>",
      "creditAccountAlias": "<string>",
      "feeAmount": "<string>",
      "maintenanceCreditAccount": "<string>",
      "accountTarget": {
        "segmentId": "<string>",
        "portfolioId": "<string>",
        "aliases": [
          "<string>"
        ]
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page": 123,
  "limit": 123,
  "total": 123
}

Headers

X-Organization-Id

string

required

The unique identifier of the Organization associated with the request.

Example:

"019c96a0-0a98-7287-9a31-786e0809c769"

Authorization

string

The authorization token in the 'Bearer ' format.

Important: This header is required if your environment has Access Manager enabled. For more information, refer to the Access Manager documentation.

Content-Type

string

required

The type of media of the resource. Must be application/json.

Example:

"application/json"

Query Parameters

ledgerId

string

Unique identifier of the Ledger.

type

enum<string>

Filter by billing package type: volume or maintenance.

Available options:

volume,

maintenance

status

boolean

Filter by active status. true returns only active billing packages, false only inactive ones. Omit to return both.

page

integer

Page number (minimum 1).

limit

integer

Number of records per page (minimum 1).

Response

List of billing packages.

items

object[]

Show child attributes

page

integer

limit

integer

total

integer

⌘I

Getting started

Organizations API

Ledgers API

Assets API

Account Types API

Accounts API

Portfolios API

Segments API

Balances API

Transactions API

Operations API

Operation Routes API

Transaction Routes API

Metadata Indexes API

Holders API

Instruments API

Billing Packages API

Packages API

Billing Calculation API

Estimation API

Encryption API

Protection API

Asset Rates API

Error handling

Fees Engine

List Billing Packages

Headers

Query Parameters

Response