Collect an issued invoice from credits, balance, then card

Collects an issued invoice: credit grants first, then prepaid balance, then the card on file — the same waterfall the dunning workflow runs.

POST /v1/billing/invoices/{id}/collect

Billing → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/billing/invoices/{id}/collect`
Method	`POST`
Operation	`collectInvoice`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Collects an issued invoice: credit grants first, then prepaid balance, then the card on file — the same waterfall the dunning workflow runs.

A DECLINE IS NOT AN ERROR. It answers with paid=false, a reason, and the invoice still open, because a declined collection is a normal business outcome that must remain retryable — and because sealing it as a failure would wedge dunning behind a replayed decline. Only a successful collection is sealed, so a retry of a paid invoice replays the receipt instead of charging again.

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

Request

1 field.

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the invoice id.

Response

Status	Body	Meaning
`200`	Collected	ok

200 body — 23 fields.

Field	In	Type	Always	Description
`balanceUsedCents`	body	integer	—	BalanceUsedCents is how much was covered by prepaid balance.
`cardChargedCents`	body	integer	—	CardChargedCents is how much was charged to the card on file.
`creditUsedCents`	body	integer	—	CreditUsedCents is how much was covered by credit grants.
`invoice`	body	Invoice	—
`invoice.amountDueCents`	body	integer	—	AmountDueCents is what remains collectible.
`invoice.amountPaidCents`	body	integer	—	AmountPaidCents is what has been collected so far.
`invoice.createdAt`	body	string	—	CreatedAt is when the draft was raised, RFC3339.
`invoice.currency`	body	string	—	Currency is the ISO 4217 code.
`invoice.customerEmail`	body	string	—	CustomerEmail is where it is sent.
`invoice.id`	body	string	—	ID is the invoice id — what the issue, collect and void ops address.
`invoice.lines`	body	InvoiceLine[]	—	Lines are the charges on the invoice.
`invoice.lines[].amount`	body	integer	—	Amount is the line total in whole cents (250000 is $2,500.00).
`invoice.lines[].description`	body	string	—	Description is the human-readable line, e.g.
`invoice.lines[].quantity`	body	integer	—	Quantity is the number of units, when the line is metered.
`invoice.lines[].unitPrice`	body	integer	—	UnitPrice is the per-unit price in cents, when the line is metered.
`invoice.number`	body	string	—	Number is the human-facing invoice number, e.g.
`invoice.paymentRef`	body	string	—	PaymentRef is the processor reference for the collection, once paid.
`invoice.status`	body	string	—	Status is draft, open, paid, void or uncollectible.
`invoice.subtotalCents`	body	integer	—	SubtotalCents is the sum of the lines.
`invoice.userId`	body	string	—	UserID is the customer billed.
`paid`	body	boolean	—	Paid reports whether the invoice is now settled in full.
`processorRef`	body	string	—	ProcessorRef is the processor's reference for any card charge — the field that proves money moved at the gateway rather than only in our ledger.
`reason`	body	string	—	Reason explains a decline or partial collection.

Failure carries the platform error shape — see Errors.

Examples

hanzo billing invoices collect <id>

import { Configuration, BillingApi } from 'hanzoai';

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

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).collect_invoice(id='id')

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

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

use hanzo_cloud::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::collect_invoice(&cfg, Default::default()).await?;

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

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

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

curl -X POST https://api.hanzo.ai/v1/billing/invoices/<id>/collect \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool commerce, op collectInvoice — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "commerce",
         "arguments": {
           "op": "collectInvoice",
           "input": {
             "id": "<id>"
           }
         }
       }
     }'

Billing API · All Hanzo APIs · Interactive reference

Collect an issued invoice from credits, balance, then card

Request

Response

Examples

On this page