One purchase's server-calculated grant lot, not the player's aggregate inventory balance.

interface MicrotransactionGrantUsage {
    acquired_quantity: number;
    consumed_quantity: number;
    expired: boolean;
    expires_at: null | string;
    grant_id: null | string;
    granted_quantity: number;
    is_used: null | boolean;
    key: string;
    kind: "durable" | "consumable" | "pass";
    purchased_quantity: number;
    refunded_quantity: number;
    remaining_quantity: number;
    revoked_quantity: number;
    unrecoverable_quantity: number;
    usable_quantity: number;
    usage_status: MicrotransactionGrantUsageStatus;
}

Properties

acquired_quantity: number

Alias of actual granted_quantity, not the promised purchased_quantity.

consumed_quantity: number

acquired_quantity - remaining_quantity - revoked_quantity. Includes unrecoverable consumed units.

expired: boolean
expires_at: null | string
grant_id: null | string

Null when the captured purchase has not produced an actual grant lot.

granted_quantity: number

Actual granted units; zero when no lot exists, even if promised units are positive.

is_used: null | boolean

Consumable usage only. Durable/pass grants return null; ownership is not proof of gameplay use.

key: string
kind: "durable" | "consumable" | "pass"
purchased_quantity: number

Promised units from the frozen grant quantity multiplied by order quantity, not money.

refunded_quantity: number

Bounded revoked_quantity + unrecoverable_quantity. This overlaps consumed quantity; do not subtract twice.

remaining_quantity: number

Units remaining in the lot; expired/unavailable lots may still have raw remaining units.

revoked_quantity: number

Units actually recovered/revoked by a refund; not gameplay consumption.

unrecoverable_quantity: number

Refunded units that could not be recovered because already consumed. Overlaps consumed_quantity.

usable_quantity: number

Server-calculated usable units after expiry and payment/fulfillment restrictions.

Generated using TypeDoc