Goldmine
Billing

Close a completed billing month

POST
/billing.v1.Billing/CloseBillingMonth

Closes billable postpaid usage into one immutable invoice for a completed UTC calendar month. Supply the first midnight of that month. The server derives the period end and does not invent charges for free usage.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/billing.v1.Billing/CloseBillingMonth" \  -H "Content-Type: application/json" \  -d '{}'
{
  "invoice": {
    "amount": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "currency": "string",
    "currencyExponent": 0,
    "id": "string",
    "overpaidAmount": "string",
    "paidAmount": "string",
    "periodEnd": "2019-08-24T14:15:22Z",
    "periodStart": "2019-08-24T14:15:22Z",
    "providerMode": "string",
    "refundedAmount": "string",
    "status": "string"
  }
}
{
  "code": "invalid_argument",
  "message": "The request was malformed, such as a missing required field or an unparseable cursor."
}
{
  "code": "unauthenticated",
  "message": "The request lacks a valid API key in the Authorization header."
}
{
  "code": "permission_denied",
  "message": "The API key is not allowed to perform this action on this workspace."
}
{
  "code": "internal",
  "message": "An internal server error occurred."
}

QueryProxyUsage

Returns the proxy bandwidth ledger over an inclusive date range, optionally narrowed by provider, pool, session, or account. Each row is a daily total of requests, errors, and bytes transferred. Results are paginated; follow the returned cursor for subsequent pages.

CreateBillingExport

Persists bounded CSV bytes and a JSON manifest for a UTC half-open period at a committed workspace high-water mark. The manifest states coverage and excludes events committed after that mark, including backdated events.