Menu
Platform
AI
Analytics
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
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx billing usage_reports
Every sylphx billing usage_reports 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 usage_reports commands of Sylphx Billing, as the CLI spells them: the same
calls as the usage_reports 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 usage report.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx billing usage-reports get orgs/acme/usage_reports/usage-reportGET https://api.sylphx.com/v1/orgs/acme/usage_reports/usage-report · scope billing:read · effect read · Request, response and examples
#list
Lists an org's usage reports, one per billing period.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx billing usage-reports list orgs/acmeGET https://api.sylphx.com/v1/orgs/acme/usage_reports · 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. |
#query
Queries usage over any time range, bucketed and grouped: the usage summary the console charts. Reads rollups; never raw events.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx billing usage-reports query orgs/acmePOST https://api.sylphx.com/v1/orgs/acme/usage_reports:query · scope billing:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--start-time | timestamp | The start of the range, inclusive. Required. |
--end-time | timestamp | The end of the range, exclusive; at most 400 days after start_time. Required. |
--granularity | enum | The bucket width. Required. One of hour, day, period. |
--projects | string | Only these projects; empty means every project. Repeat the flag for each value. |
--meters | string | Only these meter ids; empty means every meter. Repeat the flag for each value. |
--group-projects | bool | Group by project in addition to meter. |
--group-dimensions | string | Dimension keys to group by, for example model. Repeat the flag for each value. |
--group-end-customers | bool | Group by optional opaque end-customer attribution, not a price dimension. |