v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Billing Packages API

Create a BillingPackage

post/v1/organizations/{organization_id}/billing-packages

Path parameters

organization_idstring uuid required

The unique identifier of the Organization associated with the Ledger.

Headers

Content-Typestring

The type of media of the resource. Recommended value is application/json.

X-Request-Idstring uuid

A unique identifier used to trace and track each request.

Authorizationstring

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Request body

assetCodestring

countModestring

createdAtstring required

creditAccountAliasstring

debitAccountAliasstring

deletedAtstring

descriptionstring

enableboolean nullable required

feeAmountstring

freeQuotainteger

idstring required

labelstring required

ledgerIdstring required

maintenanceCreditAccountstring

organizationIdstring required

pricingModelstring

typestring required

updatedAtstring required

Example request

{
  "accountTarget": {
    "aliases": [
      "account_alpha",
      "account_beta"
    ],
    "portfolioId": "00000000-0000-0000-0000-000000000000",
    "segmentId": "00000000-0000-0000-0000-000000000000"
  },
  "assetCode": "BRL",
  "countMode": "perRoute",
  "createdAt": "2026-01-01T00:00:00Z",
  "creditAccountAlias": "account_fees_credit",
  "debitAccountAlias": "account_fees_debit",
  "deletedAt": "2026-06-01T00:00:00Z",
  "description": "Charges per completed transaction route",
  "discountTiers": [
    {
      "discountPercentage": "10.00",
      "minQuantity": 1000
    }
  ],
  "enable": true,
  "eventFilter": {
    "status": "APPROVED",
    "transactionRoute": "payment_route"
  },
  "feeAmount": "50.00",
  "freeQuota": 100,
  "id": "00000000-0000-0000-0000-000000000000",
  "label": "Monthly Volume Billing",
  "ledgerId": "00000000-0000-0000-0000-000000000000",
  "maintenanceCreditAccount": "account_maintenance_credit",
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "pricingModel": "tiered",
  "tiers": [
    {
      "maxQuantity": 999,
      "unitPrice": "1.50"
    }
  ],
  "type": "volume",
  "updatedAt": "2026-01-01T00:00:00Z"
}

Response