---
title: "Account Summary"
method: GET
path: "/api/account/summary"
---

# Account Summary

`GET /api/account/summary`

## Request

- Base URL: `https://api.animgen.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.animgen.com/api/account/summary`
- Auth: none declared

## Response `200`

Successful Response

- AccountSummaryOut
  - `user` AccountUserOut, required
    - `id` string, uuid, required
    - `email` string, required
    - `emailVerified` boolean
    - `isInternalUser` boolean
    - `welcomeCreditStatus` 'pending' | 'granted' | 'withheld' | 'not_applicable'
    - `emailVerificationRetryAfterSeconds` integer
    - `researchConsentRecorded` boolean, nullable
    - `createdAt` string, required
    - `updatedAt` string, required
    - `authMethods` string[]
  - `balance` CreditsBalanceOut, required
    - `total` integer, required
    - `expiringSoon` ExpiringCreditsItem[]
      - `source` string, required
      - `expiresAt` string, required
      - `amount` integer, required
    - `nextDailyGrantAt` string, nullable
    - `nextMonthlyGrantAt` string, nullable
  - `ledger` CreditLedgerOut, required
    - `items` CreditLedgerItem[]
      - `id` string, uuid, required
      - `type` string, required
      - `amount` integer, required
      - `lotId` string, uuid, nullable
      - `jobId` string, uuid, nullable
      - `animationId` string, uuid, nullable
      - `meta` object
      - `createdAt` string, required
    - `nextCursor` string, nullable
  - `subscription` UserSubscriptionOut, required
    - `planCode` string, nullable
    - `status` string, nullable
    - `currentPeriodStart` string, nullable
    - `currentPeriodEnd` string, nullable
    - `cancelAtPeriodEnd` boolean
    - `provider` string, nullable
    - `source` 'billing' | 'admin', nullable
    - `canChange` boolean
    - `pendingChange` BillingSubscriptionChangeOut
      - `requestId` string, uuid, required
      - `status` string, required
      - `changeType` 'upgrade' | 'downgrade', required
      - `applyMode` 'immediate' | 'next_period', required
      - `currentPlanCode` string, required
      - `targetPlanCode` string, required
      - `requestedAt` string, required
      - `effectiveAt` string, nullable
      - `processedAt` string, nullable
      - `immediateChargeAmountMinor` integer
      - `immediateChargeCurrency` string, nullable
      - `settlementAmountMinor` integer
      - `settlementCurrency` string, nullable
      - `reason` string, nullable
      - `paymentFailed` boolean
      - `paymentFailureCode` string, nullable
      - `submissionUnknown` boolean
    - `billingPlanCode` string, nullable
    - `billingStatus` string, nullable
    - `billingCurrentPeriodStart` string, nullable
    - `billingCurrentPeriodEnd` string, nullable
    - `billingCancelAtPeriodEnd` boolean
    - `billingProvider` string, nullable
    - `billingCanChange` boolean
  - `orders` BillingOrderListOut, required
    - `items` BillingOrderOut[]
      - `orderId` string, uuid, required
      - `orderType` string, required
      - `productCode` string, required
      - `billingPeriod` string, nullable
      - `amount` string, required
      - `currency` string, required
      - `status` string, required
      - `provider` string, required
      - `providerRef` string, nullable
      - `checkoutUrl` string, nullable
      - `manualContactEmail` string, nullable
      - `manualMessage` string, nullable
      - `purchaseIntent` BillingPurchaseIntent
        - `intentId` string, uuid, required
        - `entryPoint` 'locked_export_format' | 'export_upgrade_cta' | 'insufficient_credits' | 'insufficient_generation_credits' | 'insufficient_export_credits' | 'api_subscription_required' | 'storage_quota' | 'account_balance' | 'commercial_use' | 'marketing' | 'navigation' | 'other', required
        - `resumeAction` 'open_export' | 'continue_generation' | 'continue_export' | 'open_developer' | 'open_account' | 'open_pricing' | 'none'
        - `returnPath` string
        - `desiredFormat` 'clip_video' | 'webm_alpha' | 'prores_4444' | 'gif' | 'frames_zip' | 'spritesheet' | 'spritesheet_bundle' | 'spritesheet_json' | 'unity_meta' | 'unity_pack' | 'godot_pack' | 'unreal_paper2d_pack' | 'cocos_creator_pack' | 'construct3_pack', nullable
        - `sourceJobId` string, uuid, nullable
        - `sourceAssetId` string, uuid, nullable
        - `workspaceId` string, uuid, nullable
        - `compositionId` string, uuid, nullable
        - `flow` 'quick' | 'advanced' | 'api', nullable
        - `requiredCredits` integer, nullable
        - `availableCredits` integer, nullable
        - `shortageCredits` integer, nullable
      - `createdAt` string, required
      - `paidAt` string, nullable
      - `fulfilledAt` string, nullable
      - `cancelledAt` string, nullable
  - `storage` StorageUsageOut, required
    - `totalBytes` integer, required
    - `quotaBytes` integer, nullable
    - `uploadBytes` integer
    - `assetBytes` integer
    - `resourceCount` integer
    - `planCode` string, nullable
    - `quotaSource` string
    - `quotaUsedRatio` number, nullable
    - `quotaWarning` boolean
    - `quotaExceeded` boolean
  - `creditStats` AccountCreditStatsOut, required
    - `transactionCount` integer
    - `byType` object
    - `countsByType` object
  - `jobStats` AccountJobStatsOut, required
    - `total` integer
    - `active` integer
    - `succeeded` integer
    - `failed` integer
    - `cancelled` integer
    - `heldCredits` integer
    - `chargedCredits` integer
    - `byType` object
    - `byStatus` object
  - `workspaceCount` integer

---

[API](https://skmtc.dev/animgen/apis/aianimgenbackend.md) · [All operations](https://skmtc.dev/animgen/apis/aianimgenbackend/llms.txt) · [OpenAPI document](https://skmtc.dev/animgen/apis/aianimgenbackend/revisions/ac3744fbb14e?raw)