Skip to content
Indiana
Dashboard
Docs
Browse docs / Read usage billing invoices

Read usage billing invoices

POST/api/v1/billing/invoices/read

Read bounded pages of the current customer's usage invoices and settlement states using persisted financial facts.

SDK 0.0.1Updated

Make the request

Read bounded pages of the current customer's usage invoices and settlement states using persisted financial facts.

Credential
Customer token only. Identity is bound to the token.
Permission
billing:read
Set the base URL and App ID from SDK setup. These examples use placeholders and do not execute requests. Never put a server key in browser code.
request.shShell
curl -X POST "$GROOVE_BASE_URL/api/v1/billing/invoices/read" \  -H "Authorization: Bearer $GROOVE_CUSTOMER_TOKEN" \  -H "X-Groove-Project: $GROOVE_PROJECT_ID" \  -H "X-Groove-Environment: sandbox" \  -H "Content-Type: application/json" \  -d '{  "after": null,  "limit": 50}'

The response tab lists field types, not an example payload. Actual values depend on customer state.

Request parameters

JSON body

afteruuid | nullRequired

The after value for this operation. Its accepted type and constraints are listed above and below.

limitintegerRequired

Maximum records per page, subject to the contract limit.

min: 1 · max: 100

Response fields

Successful responses include requestId and scope. Use the actual business status or accepted field to determine the result. Optional fields are omitted when unavailable.

HTTP 200 · application/json

requestIduuidRequired

Server-generated HTTP request UUID. Include it when reporting a failed request.

scopeobjectRequired

The App and environment of this response. Headers only verify scope; they cannot switch key scope.

Show child fields
projectIdstringRequired

App ID bound to the credential.

minLength: 1

environmentenumRequired

Separate data scope: sandbox or live.

Show allowed values

"sandbox""live"

invoicesobjectRequired

The invoices value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
rowsarrayRequired

The rows value for this operation. Its accepted type and constraints are listed above and below.

maxItems: 100

Show child fields
iduuidRequired

The id value for this operation. Its accepted type and constraints are listed above and below.

sourceKindenumRequired

The sourceKind value for this operation. Its accepted type and constraints are listed above and below.

Show allowed values

"product""usage"

providerInvoiceIdstring | nullRequired

The providerInvoiceId value for this operation. Its accepted type and constraints are listed above and below.

statusenumRequired

The status value for this operation. Its accepted type and constraints are listed above and below.

Show allowed values

"accruing""open""pending""paid""failed""void"

currencyenumRequired

Currency code supported by the published price.

Show allowed values

"USD""EUR""CNY""GBP""JPY""CAD""AUD""NZD""CHF""HKD""SGD""KRW""INR""BRL""MXN""TWD""THB""IDR""MYR""PHP""VND""ZAR""AED""SAR""SEK""NOK""DKK""PLN""CZK""HUF""ILS""TRY""RON"

startsAtdate-timeRequired

The startsAt value for this operation. Its accepted type and constraints are listed above and below.

endsAtdate-timeRequired

The endsAt value for this operation. Its accepted type and constraints are listed above and below.

amountMinorstringRequired

The amountMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^(0|[1-9]\d{0,14})$

grossAmountMinorstringRequired

The grossAmountMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^(0|[1-9]\d{0,14})$

discountMinorstringRequired

The discountMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^(0|[1-9]\d{0,14})$

paidAmountMinorstringRequired

The paidAmountMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^(0|[1-9]\d{0,14})$

refundedAmountMinorstringRequired

The refundedAmountMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^(0|[1-9]\d{0,14})$

createdAtdate-timeRequired

ISO 8601 UTC time when the record was created.

hostedInvoiceUrluri | nullRequired

The hostedInvoiceUrl value for this operation. Its accepted type and constraints are listed above and below.

adjustmentobject | nullRequired

The adjustment value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
originalInvoiceIduuidRequired

The originalInvoiceId value for this operation. Its accepted type and constraints are listed above and below.

amountMinorstringRequired

The amountMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^-?(0|[1-9]\d{0,8})$

acceptedAtdate-time | nullRequired

The acceptedAt value for this operation. Its accepted type and constraints are listed above and below.

linesarrayRequired

The lines value for this operation. Its accepted type and constraints are listed above and below.

maxItems: 100

Show child fields
iduuidRequired

The id value for this operation. Its accepted type and constraints are listed above and below.

entitlementIduuidRequired

The entitlementId value for this operation. Its accepted type and constraints are listed above and below.

entitlementVersionIduuidRequired

The entitlementVersionId value for this operation. Its accepted type and constraints are listed above and below.

productVersionIduuidRequired

The productVersionId value for this operation. Its accepted type and constraints are listed above and below.

authorizationIduuidRequired

The authorizationId value for this operation. Its accepted type and constraints are listed above and below.

entityIduuid | nullRequired

Entity ID within the current customer scope, for configured entity and license features.

unitsobjectRequired

The units value for this operation. Its accepted type and constraints are listed above and below.

amountMinorstringRequired

The amountMinor value for this operation. Its accepted type and constraints are listed above and below.

pattern: ^(0|[1-9]\d{0,17})(\.\d{1,30})?$

cashPriceobjectRequired

The cashPrice value for this operation. Its accepted type and constraints are listed above and below.

linesLimitedbooleanRequired

The linesLimited value for this operation. Its accepted type and constraints are listed above and below.

nextCursoruuid | nullRequired

Next-page cursor; null means end. Pass unchanged and clear when filters change.

Handle errors

Common failures
CodeRecovery
UNAUTHENTICATEDVerify the key or refresh the expired customer token once.
FORBIDDENCheck current key permissions and customer access.
INVALID_REQUESTCheck field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCHUse the App and environment bound to the credential.

Common failures

  • UNAUTHENTICATED

    Recovery
    Verify the key or refresh the expired customer token once.

  • FORBIDDEN

    Recovery
    Check current key permissions and customer access.

  • INVALID_REQUEST

    Recovery
    Check field types, UUIDs, decimal strings and mutually exclusive fields.

  • SCOPE_MISMATCH

    Recovery
    Use the App and environment bound to the credential.

Related:All request and error conventions·Back to endpoint index