Skip to main content

CheckoutPurpose

Why the checkout exists. Drives which side effect runs on webhook completion: ORG_WALLET_TOPUP credits an org_wallet; PLAYER_WALLET_TOPUP credits the caller's player_wallet; APP_ACCESS_PURCHASE upserts app_user_access; DONATION inserts donations; PROPERTY_TOKENS credits property_tokens; SHARED_APP_SUBSCRIPTION activates a paid shared-environment app slot.

enum CheckoutPurpose {
  ORG_WALLET_TOPUP
  PLAYER_WALLET_TOPUP
  APP_ACCESS_PURCHASE
  DONATION @deprecated
  PROPERTY_TOKENS @deprecated
  SHARED_APP_SUBSCRIPTION @deprecated
}

Values​

CheckoutPurpose.ORG_WALLET_TOPUP​

Add funds to an organization wallet. Requires orgId and amountCents, and the caller must hold the org "manage_billing" permission. Credits the org wallet on completion.

CheckoutPurpose.PLAYER_WALLET_TOPUP​

Add funds to the caller's own player wallet (player compute P2). Requires amountCents only — any authenticated user may fund their own wallet; no org permission is involved. Credits the player wallet idempotently on completion.

CheckoutPurpose.APP_ACCESS_PURCHASE​

Purchase a user's access to an app at a given tier. Requires appId and tierId. Upserts app_user_access on completion.

CheckoutPurpose.DONATION deprecated​

DEPRECATED

No longer purchasable; use ORG_WALLET_TOPUP or APP_ACCESS_PURCHASE. Retained for historical checkouts.

Deprecated. Historically a one-off donation to an app. No longer purchasable and rejected at runtime by createCheckout.

CheckoutPurpose.PROPERTY_TOKENS deprecated​

DEPRECATED

No longer purchasable; use ORG_WALLET_TOPUP or APP_ACCESS_PURCHASE. Retained for historical checkouts.

Deprecated. Historically a purchase of in-world property tokens. No longer purchasable and rejected at runtime by createCheckout.

CheckoutPurpose.SHARED_APP_SUBSCRIPTION deprecated​

DEPRECATED

Shared apps use org wallet hourly usage billing. Publish via publishAppToShared and top up with ORG_WALLET_TOPUP.

@deprecated Legacy recurring subscription for a paid shared app slot. No longer purchasable via createCheckout; retained for historical checkouts and webhook reconciliation.

Member Of​

Checkout object ● CheckoutFilterInput input ● CreateCheckoutInput input