Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
On this page
sylphx billing billing_accounts
Every sylphx billing billing_accounts command: its argument, its flags and a run line.
This method is not served on the public API.
api.sylphx.comdoes 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 billing_accounts commands of Sylphx Billing, as the CLI spells them: the same
calls as the billing_accounts 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 a billing account.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx billing billing-accounts get orgs/acme/billing_accounts/billing-accountGET https://api.sylphx.com/v1/orgs/acme/billing_accounts/billing-account · scope billing:read · effect read · Request, response and examples
#list
Lists an org's billing accounts: exactly one, default.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx billing billing-accounts list orgs/acmeGET https://api.sylphx.com/v1/orgs/acme/billing_accounts · scope billing:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |
--filter | string | AIP-160 filter over labels and filterable fields. |
--order-by | string | AIP-132 ordering over filterable fields. |
#update
Updates a billing account: changes plan, spend limit, or billing email.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx billing billing-accounts update orgs/acme/billing_accounts/billing-account --spec.plan …PATCH https://api.sylphx.com/v1/orgs/acme/billing_accounts/billing-account · scope billing:admin · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.plan | string | The plan to be on, for example plans/pro. A change takes effect at once; an upgrade to Pro is prorated by day and requires a payment method. Required. |
--spec.spend-limit.currency-code | string | ISO 4217 currency, for example USD. |
--spec.spend-limit.units-minor | int | The amount in the currency's minor unit (cents for USD). |
--spec.unlimited-spend | bool | No spend limit; requires a verified payment method. |
--spec.billing-email | string | Where invoices and payment notices are sent. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#setup-payment-method
Starts saving a payment method for the org: returns a client secret the console confirms with Stripe.js, so card data never reaches Sylphx. The saved method becomes the account's default and is charged off-session for each finalized invoice.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx billing billing-accounts setup-payment-method orgs/acme/billing_accounts/billing-accountPOST https://api.sylphx.com/v1/orgs/acme/billing_accounts/billing-account:setupPaymentMethod · scope billing:admin · effect write · Request, response and examples