Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get a billing account
Gets a billing account.
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.
Gets a billing account.
Not available yet. Sylphx Billing is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.
- Path
GET https://api.sylphx.com/v1/orgs/acme/billing_accounts/billing-account - Scope
billing:read - Effect
read— nothing is written. - Collection billing_accounts
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the billing account to get. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/billing_accounts/default. |
uid | string | bac_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | BillingAccountSpec | Desired state. Required. |
status | BillingAccountStatus | Observed state. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong 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_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#BillingAccountSpec
| Field | Type | What it is |
|---|---|---|
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. |
spend_limit | Money | The monthly spend limit on usage past the included amounts. Unset means the default (USD 200) unless unlimited_spend is set. |
unlimited_spend | bool | No spend limit; requires a verified payment method. |
billing_email | string | Where invoices and payment notices are sent. |
#BillingAccountStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
plan_version | string | The plan version the org is on, for example 2026-11-02. Output only. |
state | BillingAccountState | The payment standing. Output only. One of active, past_due, suspended. |
currency_code | string | The currency every invoice of the org is in, ISO 4217. Output only. |
period_start_time | timestamp | The start of the current billing period. Output only. |
period_end_time | timestamp | The end of the current billing period. Output only. |
payment_method_verified | bool | A payment method is on file and verified. Output only. |
effective_spend_limit | Money | The spend limit in force, after the default is applied; unset when unlimited. Output only. |
payment_method | string | The default payment method, for example visa •••• 4242; empty when none is saved. Output only. |
#Money
| Field | Type | What it is |
|---|---|---|
currency_code | string | ISO 4217 currency, for example USD. Required. |
units_minor | int64 | The amount in the currency's minor unit (cents for USD). Required. |
#Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/billing_accounts/billing-account" \
-H "Authorization: Bearer $SYLPHX_API_KEY"