Sign in
Admin Users

Get user subscription data

Retrieve subscription information for a user including product details, start/expiration dates, auto-renewal status, and active status

get/admin/users/{id}/subscription

Path parameters

idstring required
Example:user-uuid-here

User ID

Response

User subscription data retrieved successfully

userIdstring required

User ID

subscriptionIdstring

Subscription ID

providerSubscriptionIdstring

Provider-level subscription ID

productIdstring

Product ID

startedAtstring date-time

Subscription start date

expiresAtstring date-time

Subscription expiration date

autoRenewalboolean

Auto renewal status

isActiveboolean

Whether subscription is currently active

subscriptionSource'apple' | 'stripe' | 'funnelfox'

Subscription source/provider

subscriptionStatusstring

Subscription status in source provider

funnelFoxUserIdstring

FunnelFox external user identifier

funnelFoxSubscriptionIdstring

FunnelFox subscription ID (subs_id)

cancelAtPeriodEndboolean

FunnelFox cancel-at-period-end flag

Example response

{
  "userId": "user-uuid-here",
  "subscriptionId": "subscription-uuid-here",
  "providerSubscriptionId": "sub_123",
  "productId": "com.app.product.premium",
  "startedAt": "2024-01-01T00:00:00.000Z",
  "expiresAt": "2024-02-01T00:00:00.000Z",
  "autoRenewal": true,
  "isActive": true,
  "subscriptionSource": "stripe",
  "subscriptionStatus": "active",
  "funnelFoxUserId": "firebase-uid",
  "funnelFoxSubscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.