Skip to content
Console
On this page

Billing accounts

A BillingAccount is an org's plan subscription and payment standing: the plan it is on, its spend limit, and its billing period.

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.

A BillingAccount is an org's plan subscription and payment standing: the plan it is on, its spend limit, and its billing period. Each org has exactly one, orgs/{org}/billing_accounts/default, created with the org.

Service Sylphx Billing · Resource type billing.sylphx.com/BillingAccount · Name pattern orgs/{org}/billing_accounts/{billing_account} · Shape spec_status

Fields

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

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a billing account.
GETlistLists an org's billing accounts: exactly one, default.
PATCHupdateUpdates a billing account: changes plan, spend limit, or billing email.
POSTsetup_payment_methodStarts 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.

get

Gets a billing account.

GET https://api.sylphx.com/v1/orgs/acme/billing_accounts/billing-account · scope billing:read · effect read · not available yet · Request, response and examples

list

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

GET https://api.sylphx.com/v1/orgs/acme/billing_accounts · scope billing:read · effect read · not available yet · paginated · Request, response and examples

update

Updates a billing account: changes plan, spend limit, or billing email.

PATCH https://api.sylphx.com/v1/orgs/acme/billing_accounts/billing-account · scope billing:admin · effect write · not available yet · Request, response and examples

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.

POST https://api.sylphx.com/v1/orgs/acme/billing_accounts/billing-account:setupPaymentMethod · scope billing:admin · effect write · not available yet · Request, response and examples