Skip to content
Console
On this page

List billing accounts

Lists an org's billing accounts: exactly one, `default`.

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.

Lists an org's billing accounts: exactly one, default.

Not available yet. This method answers 501 with the problem code UNIMPLEMENTED.

  • Path GET https://api.sylphx.com/v1/orgs/acme/billing_accounts
  • Scope billing:read
  • Effect read — nothing is written.
  • Collection billing_accounts
  • Query page_size, page_token, filter, order_by
  • Pagination the answer carries billing_accounts and, when there is more, next_page_token

Request

FieldTypeWhat it is
parentstringThe org to list in. Required.
page_sizeint32At 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.

Response

FieldTypeWhat it is
billing_accountsBillingAccount[]The page.
next_page_tokenstringThe token of the next page; empty on the last page.

BillingAccount

FieldTypeWhat it is
namestringorgs/{org}/billing_accounts/default.
uidstringbac_<cell><ulid>. Output only.
metaResourceMetaResource metadata.
specBillingAccountSpecDesired state. Required.
statusBillingAccountStatusObserved state. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

BillingAccountSpec

FieldTypeWhat it is
planstringThe public plan, for example plans/pro. Card accounts activate Pro by payment; approved invoice accounts may select it without a card. Required.
spend_limitMoneyThe customer's monthly cap on usage past included amounts. A lower cap is always enforced independently of the seller's reviewed credit limit.
unlimited_spendboolClears the self spend cap; never lifts a tier or reviewed credit limit.
billing_emailstringWhere invoices and payment notices are sent.
payment_methodstringCollection choice: card (default), or invoice with approved net terms.
invoice_terms_daysint32Net days from finalization, 1..365. Changes require billing:terms:approve and affect only newly finalized invoices, never frozen history.
invoice_terms_approvedboolCredit approval is an ordinary account setting, not a company flag. Writing this field requires billing:terms:approve in addition to admin.
credit_limitMoneyThe reviewed invoice receivable limit, USD. Unset/null on approved invoice terms means unlimited and never suspended. Finite limits retain net-term dunning. Writing requires billing:terms:approve; a self cap is separate.

BillingAccountStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
plan_versionstringThe plan version the org is on, for example 2026-11-02. Output only.
stateBillingAccountStateThe payment standing. Output only. One of active, past_due, suspended.
currency_codestringThe currency every invoice of the org is in, ISO 4217. Output only.
period_start_timetimestampThe start of the current billing period. Output only.
period_end_timetimestampThe end of the current billing period. Output only.
payment_method_verifiedboolA payment method is on file and verified. Output only.
effective_spend_limitMoneyThe spend limit in force, after the default is applied; unset when unlimited. Output only.
payment_methodstringThe default payment method, for example visa •••• 4242; empty when none is saved. Output only.

Money

FieldTypeWhat it is
currency_codestringISO 4217 currency, for example USD. Required.
units_minorint64The amount in the currency's minor unit (cents for USD). Required.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

Errors

Every error arrives in the body Errors describes.

Examples

curl "https://api.sylphx.com/v1/orgs/acme/billing_accounts" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"