Interface MicrotransactionPlayerPurchase

interface MicrotransactionPlayerPurchase {
    checkout_session_id: null | string;
    commission_minor: number;
    country: string;
    created_at: string;
    currency: string;
    entitlements?: MicrotransactionEntitlement[];
    environment: MicrotransactionEnvironment;
    fulfillment_status: MicrotransactionFulfillmentStatus;
    grant_usage: MicrotransactionGrantUsage[];
    has_consumed_grants: boolean;
    has_usable_grants: boolean;
    id: string;
    items: MicrotransactionGrant[];
    paid_at: null | string;
    payment_status: MicrotransactionPaymentStatus;
    player_id: string;
    product: {
        id: string;
        name: null | string;
        sku: null | string;
        type: null | MicrotransactionProductType;
        version: null | number;
    };
    product_id: string;
    provider: null | "stripe" | "xsolla";
    provider_fee_minor: null | number;
    quantity: number;
    refunded_minor: number;
    subtotal_minor: number;
    tax_collection?: null | MicrotransactionTaxCollection;
    tax_minor: number;
    title_id: string;
    total_minor: number;
}

Hierarchy

Properties

checkout_session_id commission_minor country created_at currency entitlements? environment fulfillment_status grant_usage has_consumed_grants has_usable_grants id items paid_at payment_status player_id product product_id provider provider_fee_minor quantity refunded_minor subtotal_minor tax_collection? tax_minor title_id total_minor

Properties

checkout_session_id

checkout_session_id: null | string

commission_minor

commission_minor: number

country

country: string

created_at

created_at: string

currency

currency: string

Optional entitlements

entitlements?: MicrotransactionEntitlement[]

environment

environment: MicrotransactionEnvironment

fulfillment_status

fulfillment_status: MicrotransactionFulfillmentStatus

grant_usage

grant_usage: MicrotransactionGrantUsage[]

has_consumed_grants

has_consumed_grants: boolean

has_usable_grants

has_usable_grants: boolean

id

id: string

items

items: MicrotransactionGrant[]

paid_at

paid_at: null | string

payment_status

payment_status: MicrotransactionPaymentStatus

player_id

player_id: string

Always present on authenticated self-history, unlike older generic order DTOs.

product

product: {
    id: string;
    name: null | string;
    sku: null | string;
    type: null | MicrotransactionProductType;
    version: null | number;
}

Product snapshot for this purchase, not a replacement for the current catalog.

Type declaration

product_id

product_id: string

provider

provider: null | "stripe" | "xsolla"

provider_fee_minor

provider_fee_minor: null | number

Null until actual costs are reconciled; never confuse an estimate with a payout.

quantity

quantity: number

refunded_minor

refunded_minor: number

subtotal_minor

subtotal_minor: number

Optional tax_collection

tax_collection?: null | MicrotransactionTaxCollection

Frozen decision, also returned inside checkout/session.order. Null/absent for legacy orders; never infer from current provider facts. Warnings do not imply zero tax owed.

tax_minor

tax_minor: number

title_id

title_id: string

total_minor

total_minor: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc