Skip to content
Console
On this page

Usage invoices

A Usage Invoice is Money's own invoice for a subject's usage.

A Usage Invoice is Money's own invoice for a subject's usage. A threshold invoice is cut mid-month; the period invoice nets those off.

Service Sylphx Money · Resource type money.sylphx.com/UsageInvoice · Name pattern orgs/{org}/projects/{project}/envs/{env}/usage_invoices/{usage_invoice} · Shape record

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/usage_invoices/{usage_invoice}.
uidstringuinv_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
numberstringThe invoice number. Output only.
subjectSubjectWho owes it. Output only.
periodstringThe month, YYYY-MM. Output only.
kindstringperiod or threshold. Output only.
statestringtax_pending, issued, or void. Output only.
tax_pending_reasonstringWhy it is not issued yet, when tax_pending (for example location_required, grant_tax_treatment). Output only.
gross_minorstringThe amounts, minor units, decimal strings. Output only.
subtotal_minorstringBefore tax. Output only.
tax_minorstringThe tax. Output only.
post_tax_credit_minorstringCredit settled after tax. Output only.
total_minorstringWhat is owed: subtotal plus tax minus post-tax credit. Output only.
amount_paid_minorstringPaid so far. Output only.
collection_modestringstandard or hold, fixed at issue. Output only.
issue_timetimestampWhen it was issued. Output only.
due_timetimestampWhen it is due. 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 usage invoice.
GETlistLists usage invoices, newest first.
POSTrelease_collectionReleases a held invoice for collection, audited with who and why. Grant expiry or replacement never does.

get

Gets a usage invoice.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_invoices/usage-invoice · scope billing:read · effect read · Request, response and examples

list

Lists usage invoices, newest first.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_invoices · scope billing:read · effect read · paginated · Request, response and examples

release_collection

Releases a held invoice for collection, audited with who and why. Grant expiry or replacement never does.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_invoices/usage-invoice:releaseCollection · scope billing:credits.approve · effect write · Request, response and examples