List payouts

Answers the org's outbound payouts, newest first — amount, destination, status, and the failure reason where one applies.

GET /v1/billing/payouts

Billing → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/billing/payouts`
Method	`GET`
Operation	`get_billing_payouts`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Answers the org's outbound payouts, newest first — amount, destination, status, and the failure reason where one applies.

A payout is ORG-scoped rather than subject-scoped, so there is nothing to pin beyond the tenant the caller already is, and no query can widen it.

A named handler, not a closure, so zipdoc can lift this prose into the registry.

Request

GET /v1/billing/payouts takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	billing.Payout[]	ok
`default`	problem-details	refused

200 body — 13 fields.

Field	In	Type	Always
`[].amount`	body	integer (int64)	—
`[].arrivalDate`	body	string	—
`[].created`	body	string	—
`[].currency`	body	string	—
`[].description`	body	string	—
`[].destinationId`	body	string	—
`[].destinationType`	body	string	—
`[].failureCode`	body	string	—
`[].failureMessage`	body	string	—
`[].id`	body	string	—
`[].metadata`	body	any	—
`[].providerRef`	body	string	—
`[].status`	body	string	—

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo billing payouts

.ts

.py

.go

.rs

.java

import { Configuration, BillingApi } from 'hanzoai';

const api = new BillingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getBillingPayouts();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import BillingApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = BillingApi(client).get_billing_payouts()

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.BillingAPI.GetBillingPayouts(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, billing_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = billing_api::get_billing_payouts(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.BillingApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new BillingApi(client).getBillingPayouts();

curl https://api.hanzo.ai/v1/billing/payouts \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches billing through the billing tool, which names its 39 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_billing_accounts"
         }
       }
     }'

Billing API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList methods — GET /v1/billing/methods NextList plans