Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Jobs and cron
Localization
Monitoring
Notifications
Payments
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
List usage invoices
Lists usage invoices, newest first.
Lists usage invoices, newest first.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_invoices - Scope
billing:read - Effect
read— nothing is written. - Collection usage_invoices
- Query
page_size,page_token,filter - Pagination the answer carries
usage_invoicesand, when there is more,next_page_token
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to list in. Required. |
page_size | int32 | At most this many; default 50, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
filter | string | AIP-160 filter, for example subject = "…". |
#Response
| Field | Type | What it is |
|---|---|---|
usage_invoices | UsageInvoice[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
#UsageInvoice
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/usage_invoices/{usage_invoice}. |
uid | string | uinv_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
number | string | The invoice number. Output only. |
subject | Subject | Who owes it. Output only. |
period | string | The month, YYYY-MM. Output only. |
kind | string | period or threshold. Output only. |
state | string | tax_pending, issued, or void. Output only. |
tax_pending_reason | string | Why it is not issued yet, when tax_pending (for example location_required, grant_tax_treatment). Output only. |
gross_minor | string | The amounts, minor units, decimal strings. Output only. |
subtotal_minor | string | Before tax. Output only. |
tax_minor | string | The tax. Output only. |
post_tax_credit_minor | string | Credit settled after tax. Output only. |
total_minor | string | What is owed: subtotal plus tax minus post-tax credit. Output only. |
amount_paid_minor | string | Paid so far. Output only. |
collection_mode | string | standard or hold, fixed at issue. Output only. |
issue_time | timestamp | When it was issued. Output only. |
due_time | timestamp | When it is due. 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. |
#Subject
| Field | Type | What it is |
|---|---|---|
end_user | string | An end user's id (Sylphx Auth, or the app's own OIDC issuer). One of the kind group. |
customer_organization | string | A customer organization's id. One of the kind group. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_invoices" \
-H "Authorization: Bearer $SYLPHX_API_KEY"