Read every balance allocation, frozen rate and refund for an exact time range and customer or Entity. Subsequent pages retain snapshotAt and nextCursor. Totals remain separate per credit version.
SDK 0.0.1Updated
Make the request
Read every balance allocation, frozen rate and refund for an exact time range and customer or Entity. Subsequent pages retain snapshotAt and nextCursor. Totals remain separate per credit version.
Credential
Server API key or customer token. Customer calls cannot select another customer.
Permission
credits: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.
The response tab lists field types, not an example payload. Actual values depend on customer state.
Request parameters
JSON body
fromdate-timeRequired
The from value for this operation. Its accepted type and constraints are listed above and below.
todate-timeRequired
The to value for this operation. Its accepted type and constraints are listed above and below.
entityIduuidOptional
Entity ID within the current customer scope, for configured entity and license features.
snapshotAtdate-time | nullRequired
The snapshotAt value for this operation. Its accepted type and constraints are listed above and below.
afterobject | nullRequired
The after value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
atdate-timeRequired
The at value for this operation. Its accepted type and constraints are listed above and below.
iduuidRequired
The id value for this operation. Its accepted type and constraints are listed above and below.
positionintegerRequired
The position value for this operation. Its accepted type and constraints are listed above and below.
min: 0 · max: 9007199254740991
limitintegerRequired
Maximum records per page, subject to the contract limit.
min: 1 · max: 100
customerIduuidOptional
Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.
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"
statementobjectRequired
The statement value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
customerIduuidRequired
Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.
entityIduuid | nullRequired
Entity ID within the current customer scope, for configured entity and license features.
fromdate-timeRequired
The from value for this operation. Its accepted type and constraints are listed above and below.
todate-timeRequired
The to value for this operation. Its accepted type and constraints are listed above and below.
snapshotAtdate-timeRequired
The snapshotAt value for this operation. Its accepted type and constraints are listed above and below.
totalsarrayRequired
The totals value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 1000
Show child fields
creditVersionIduuidRequired
The creditVersionId value for this operation. Its accepted type and constraints are listed above and below.
namestringRequired
Display name of the customer or object; not an identity key.
consumedstringRequired
The consumed value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(0|[1-9]\d{0,12})(\.\d{1,12})?$
refundedstringRequired
The refunded value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(0|[1-9]\d{0,12})(\.\d{1,12})?$
netstringRequired
The net value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^-?(0|[1-9]\d{0,17})(\.\d{1,12})?$
rowsarrayRequired
The rows value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 100
Show child fields
operationIduuidRequired
Business operation UUID. Subscription execution references operationId from previewAttach; balance refunds reference the original consumption.
positionintegerRequired
The position value for this operation. Its accepted type and constraints are listed above and below.
min: 0 · max: 9007199254740991
kindenumRequired
The kind value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"consume""confirm""refund"
originalIduuid | nullRequired
The originalId value for this operation. Its accepted type and constraints are listed above and below.
occurredAtdate-timeRequired
The occurredAt 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.
entitlementNamestringRequired
The entitlementName value for this operation. Its accepted type and constraints are listed above and below.
sourceIduuidRequired
The sourceId value for this operation. Its accepted type and constraints are listed above and below.
creditVersionIduuidRequired
The creditVersionId value for this operation. Its accepted type and constraints are listed above and below.
creditNamestringRequired
The creditName value for this operation. Its accepted type and constraints are listed above and below.
unitsobjectRequired
The units value for this operation. Its accepted type and constraints are listed above and below.
amountstringRequired
Credit or ledger amount, using the field’s decimal-string or integer type.
pattern: ^(0|[1-9]\d{0,12})(\.\d{1,12})?$
pricingarrayRequired
The pricing value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 12
Show child fields
creditVersionIduuid | nullRequired
The creditVersionId value for this operation. Its accepted type and constraints are listed above and below.
meteredVersionIduuidRequired
The meteredVersionId value for this operation. Its accepted type and constraints are listed above and below.
dimensionstringRequired
The dimension value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1 · maxLength: 64
counterKeystringRequired
The counterKey value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1 · maxLength: 240
cycleStartdate-timeRequired
The cycleStart value for this operation. Its accepted type and constraints are listed above and below.
unitCostobjectRequired
The unitCost value for this operation. Its accepted type and constraints are listed above and below.
unitsobjectRequired
The units value for this operation. Its accepted type and constraints are listed above and below.
amountstringRequired
Credit or ledger amount, using the field’s decimal-string or integer type.
pattern: ^(0|[1-9]\d{0,12})(\.\d{1,12})?$
tierinteger | nullRequired
The tier value for this operation. Its accepted type and constraints are listed above and below.
propertiesobjectRequired
Validated pricing properties used to match dimensions and multipliers.
nextCursorobject | nullRequired
Next-page cursor; null means end. Pass unchanged and clear when filters change.
Show child fields
atdate-timeRequired
The at value for this operation. Its accepted type and constraints are listed above and below.
iduuidRequired
The id value for this operation. Its accepted type and constraints are listed above and below.
positionintegerRequired
The position value for this operation. Its accepted type and constraints are listed above and below.
min: 0 · max: 9007199254740991
Handle errors
Common failures
Code
Recovery
UNAUTHENTICATED
Verify the key or refresh the expired customer token once.
FORBIDDEN
Check current key permissions and customer access.
INVALID_REQUEST
Check field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCH
Use 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.