Skip to content
Console
Menu

Getting Started

Authentication

KV Store

sylphx billing invoices

Every sylphx billing invoices command: its argument, its flags and a run line.

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

The invoices commands of Sylphx Billing, as the CLI spells them: the same calls as the invoices API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

Not available yet. Sylphx Billing is declared in the registry but no backend serves it: every command answers 501 with the problem code UNIMPLEMENTED.

#get

Gets an invoice.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx billing invoices get orgs/acme/invoices/invoice

GET https://api.sylphx.com/v1/orgs/acme/invoices/invoice · scope billing:read · effect read · Request, response and examples

#record-payment

A seller operator records an externally verified full invoice payment. The platform-only scope cannot be granted by customer owners/admins. The invoice name identifies the customer, not the seller. References are immutable and idempotent per org and method; conflicting reuse is refused.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx billing invoices record-payment orgs/acme/invoices/invoice

POST https://api.sylphx.com/v1/orgs/acme/invoices/invoice:recordPayment · scope billing:payments:record · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--payment-methodstringcard or invoice debits cash; internal_settlement debits a dedicated noncash journal account, never cash or promotional/customer credit. Required.
--settlement-referencestringBank/provider/journal reference, 1..200 bytes, unique per org and method. Required.
--amountjsonPositive exact full outstanding balance in USD integer minor units. Required.

#list

Lists an org's invoices.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell
sylphx billing invoices list orgs/acme

GET https://api.sylphx.com/v1/orgs/acme/invoices · scope billing:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--page-sizeintAt most this many; default 50, clamped to 1000.
--page-tokenstringnext_page_token of the previous page.
--filterstringAIP-160 filter over labels and filterable fields.
--order-bystringAIP-132 ordering over filterable fields.