API: Get Current User

Retrieve the authenticated user’s profile, including email, current plan, and credit balances.

Endpoint

GEThttps://app.podwise.ai/api/open/v1/me

Response


type Response = {
  success: true,
  result: {
    // The authenticated user's unique ID
    userId: string,
    // The user's registered email address
    email: string | null,
    // Current effective plan: "Free", "Standard", "Pro", or "Enterprise"
    plan: string,
    // Underlying subscription plan before an Enterprise entitlement is applied
    originalPlan: "Free" | "Standard" | "Pro",
    credits: {
      // Remaining view credits for the current billing period (-1 means unlimited)
      view: number,
      // Remaining AI processing credits for the current billing period, resets monthly (-1 means unlimited)
      aiProcessing: number,
      // Remaining purchased AI processing credits (never expire)
      aiProcessingAddOn: number,
      // -1 when public-episode AI processing is included; otherwise 0
      publicEpisodeAiProcessing: -1 | 0,
    },
  },
}

For Enterprise users, plan is "Enterprise" while originalPlan preserves the underlying subscription plan. credits.aiProcessing and credits.aiProcessingAddOn return 0 because private imports and uploaded audio use Enterprise usage-based billing instead of subscription credits. credits.publicEpisodeAiProcessing returns -1 because public-episode processing is included, subject to fair use limits.

Authorization Error Codes