Hyperline

Set the P&L flags (`excluded_from_pnl`, `is_one_off`) on the live charge of up to 500 transactions. An omitted field is left untouched. Charge-less transactions are skipped. `updated_count` reports the rows written.

bulk_set_spend_transactions_pnl_flags

Set (or clear with null) the accounting-software category (provider category id + display label) on the live charge of up to 500 transactions. Charge-less transactions are skipped. `updated_count` reports the rows written.

bulk_set_spend_transactions_accounting_category

Set (or clear with null) the per-payment category override on the live charge of up to 500 transactions. Charge-less transactions are skipped. `updated_count` reports the rows written.

bulk_set_spend_transactions_category

Bulk update provider mappings for multiple customers. Optionally sync payment methods from connected PSPs. Check the response for per-customer success/failure status.

bulk_update_customers_providers

Cancel a supplier contract. A future ends_at schedules the end; omitted or past ends_at ends it now.

cancel_spend_contract

Cancel a subscription. Supports immediate or end-of-period cancellation. Optionally specify a cancellation reason. On a cancelled subscription with a scheduled reinstatement, call it with an empty body to remove that reinstatement; the subscription stays cancelled.

cancel_subscription

Cancel a scheduled subscription transition before it is applied.

cancel_subscription_transition

Manually trigger payment collection for an invoice. Optionally specify a payment_method_id to charge.

charge_invoice

Clear the workspace's default AI agent billing plan marker. The plan itself is untouched. 404 when none is set.

clear_agent_default_plan

Detach a credit product's default AI rate card without deleting the card, or return 404 when none is attached.

clear_product_ai_rate_card

Close every month of a ledger through an ended month, after posting the revenue recognition due by its end; a user token needs the accounting_close permission.

close_ledger_period

Replace customer billing settings while preserving omitted plan_id and rate_card_id references; null detaches them, and a shared policy enables automatic telemetry billing.

upsert_agent_customer_billing_policy

Replace customer billing settings while preserving omitted plan_id and rate_card_id references; null detaches them, and a shared policy enables automatic telemetry billing.

upsert_default_customer_billing_policy

Confirm a suggested charge. Learns the transaction label as a matching pattern for the supplier.

confirm_spend_charge

Return the count of supplier contracts grouped by status.

count_spend_contracts_by_status

Create a supplier contract, attaching to an existing supplier (supplier_id) or a new one (new_supplier). Optionally attach already-uploaded files.

create_spend_contract

Create a data loader query after verifying it against the warehouse.

create_data_loader_query

Record a supplier charge that has no bank transaction (e.g. a past charge declared manually), attached to a contract and confirmed on creation.

create_spend_manual_charge

Add a category to the client's taxonomy. Its `key` is derived from the name and then frozen, so renaming the category later never breaks a filter or an integration. The new category sorts last and is usable everywhere a platform category is.

create_spend_category

Create a supplier for the client.

create_spend_supplier

Create a new accounting rule for account code routing or journal posting, with the filters, accounts and required fields the rule editor applies to its category.

create_accounting_rule

Create a shipping address with type shipping; billing creation is rejected because a customer can have at most one billing address, managed through the customer endpoint.

create_customer_address

Create a new aggregator that counts or sums billable events. Aggregators can then be linked to products via aggregator_id.

create_aggregator

Create an AI agent billing plan: name, billing mode (wallet/credits/windows), rate card reference, allowance windows, markups, per-seat credit grants and overage stance. Past-limit usage is priced EITHER by overage_markup_percent over the base rates OR by overage_rate_card_id, a currency rate card whose own rates are the overage price — never both. Metered overage mints the plan's invoice container.

create_agent_plan

Create a company with an approved account owner. Company creation must be enabled.

create_company

Create a new coupon with discount rules. Supports percentage or fixed amount discounts, duration limits, and redemption restrictions.

create_coupon

Create a credit note for an existing invoice by ID. Credit notes partially or fully reverse an invoice amount. Optionally trigger a refund via wallet, original payment method, or external settlement.

create_credit_note

Create a credit entity for a customer linked to a specific product with an optional initial balance.

create_customer_credit

Record credit usage for a customer's credit product. Deducts the specified usage_retained amount from the balance.

create_customer_credits_usage

Create a custom provider/item cost; an existing pair returns 200 with its unchanged rates, so use PUT /v1/ai/billing/costs/items/:id to edit it.

create_agent_cost_catalog_item

Create a new custom property definition with a name, type (text, email, number, boolean, date, select, multi_select), and optional default value.

create_custom_property

Create a new customer with billing details, address, currency, and optional provider mappings. Returns the full customer object.

create_customer

Create up to 50 customers in a single batch request. Returns successes and errors separately for each customer in the batch.

create_customers

Prepare a data export (customers, invoices, etc.) for download. Check export status via get_export, then download via download_export once ready.

create_export

Create a feature definition.

create_feature

Upload a new file (max 10MB). Requires multipart form data with a file field and metadata (name and customer_id).

create_file

Stage a file for upload instead of inlining it as base64. Returns `upload_url` and `id`. Send the raw bytes with `curl -T <local_path> "<upload_url>"` (HTTP PUT, no extra headers) within 15 minutes, then pass `{ "upload_id": "<id>" }` in place of `{ filename, mime_type, content_base64 }` in any tool that accepts files (e.g. quote `attachments`). Prefer this over inline base64 for any file you have on disk.

create_file_upload

Create a new invoice for a customer with line items, due date, and billing configuration. Returns the full invoice object.

create_invoice

Create multiple invoices asynchronously in batch. Track results via webhooks (invoice.batch.creation_succeeded / invoice.batch.creation_failed). Returns a batch_id.

create_invoices

Create a new invoicing entity with company details, address, and tax configuration. Used as the sender on invoices.

create_invoicing_entity