Skip to content
Indiana
Dashboard
Docs
Browse docs / Read customer holdings

Read customer holdings

POST/api/v1/customer-holdings

Read current memberships, entitlements and balance sources.

API v1Updated

Make the request

Read current memberships, entitlements and balance sources.

Credential
Server API key or customer token. Customer calls cannot select another customer.
Permission
entitlements: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 "$INDIANA_BASE_URL/api/v1/customer-holdings" \  -H "Authorization: Bearer $INDIANA_CUSTOMER_TOKEN" \  -H "X-Indiana-Project: $INDIANA_PROJECT_ID" \  -H "X-Indiana-Protocol: 0.5" \  -H "X-Indiana-Environment: sandbox" \  -H "Content-Type: application/json" \  -d '{}'

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

Request parameters

JSON body

customerIduuidOptional

Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.

entityIduuidOptional

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

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"

holdingsobjectRequired

The holdings 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.

snapshotAtdate-timeRequired

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

membershipsarrayRequired

The memberships 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.

productIdstringRequired

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

minLength: 1 · maxLength: 255

productVersionIduuidRequired

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

billingProductVersionIduuidRequired

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

versionintegerRequired

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

max: 9007199254740991

keystringRequired

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

minLength: 1 · maxLength: 64

namestringRequired

Display name of the customer or object; not an identity key.

minLength: 1 · maxLength: 120

groupIdstring | nullRequired

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

membershipTypeenumRequired

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

Show allowed values

"main""addon"

statusenumRequired

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

Show allowed values

"trial""active""past_due""ended""expired""trialing""paused""pending""scheduled""unknown"

cancelAtPeriodEndbooleanRequired

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

accessEnabledbooleanRequired

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

renewalChangeobject | nullRequired

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

Show child fields
productVersionIduuidRequired

The productVersionId 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.

minLength: 1 · maxLength: 120

versionintegerRequired

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

max: 9007199254740991

effectiveAtdate-timeRequired

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

benefitsAppliedAtdate-time | nullRequired

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

timingenumRequired

Immediate or end-of-cycle timing, only for supported plan-change actions.

Show allowed values

"immediate""renewal"

changeKindenumRequired

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

Show allowed values

"plan""seats""quantity"

featureobjectOptional

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

seatobject | nullRequired

The seat 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

"prepared""quoted""confirmed""pending""scheduled"

periodobject | nullRequired

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

Show child fields
phaseenumRequired

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

Show allowed values

"paid""trial"

startsAtdate-timeRequired

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

endsAtdate-time | nullRequired

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

membershipsLimitedbooleanRequired

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

balancesarrayRequired

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

maxItems: 500

Show child fields
internal_feature_iduuidRequired

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

keystringRequired

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

minLength: 1 · pattern: ^[a-zA-Z0-9_-]+$

namestringRequired

Display name of the customer or object; not an identity key.

minLength: 1 · maxLength: 120

kindenumRequired

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

Show allowed values

"access""metered""credit"

usageTypeenum | nullRequired

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

accessiblebooleanRequired

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

unlimitedbooleanRequired

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

availablestringRequired

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

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

heldstringRequired

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

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

debtstringRequired

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

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

nextExpiresAtdate-time | nullRequired

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

usageobject | nullRequired

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

Show child fields
internal_feature_iduuidRequired

The internal_feature_id 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.

operationIduuid | nullRequired

Business operation UUID. Subscription execution references operationId from previewAttach; balance refunds reference the original consumption.

usageobjectRequired

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

capacitystring | nullRequired

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

remainingstring | nullRequired

Remaining allowance at evaluation time. It is not reserved and does not guarantee later consumption.

withinLimitbooleanRequired

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

revisionintegerRequired

Revision of the specific versioned resource; Customer profile updates have no revision.

min: 0 · max: 9007199254740991

updatedAtdate-time | nullRequired

ISO 8601 UTC time of the last record update.

balancesLimitedbooleanRequired

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

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