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
Release collection on an usage invoice
Releases a held invoice for collection, audited with who and why.
Releases a held invoice for collection, audited with who and why. Grant expiry or replacement never does.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_invoices/usage-invoice:releaseCollection - Scope
billing:credits.approve - Effect
write— a successful call changes state. - Collection usage_invoices
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The held invoice to release for collection. Required. |
reason | string | Who releases it, and why: both are kept. Required. |
#Response
| 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.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_STATE— The Resource is in a state that forbids the call.INVALID_FIELD— A field failed validation.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_invoices/usage-invoice:releaseCollection" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"reason":"…"}'