Skip to main content

AdminUserDetailDto

activeSubscriptionsnumberrequired

Currently active or trialing subscriptions.

banExpiresdate-timenullablerequired
banReasonobjectnullablerequired
bannedbooleanrequired
createdAtdate-timerequired
emailstringrequired
emailVerifiedbooleanrequired
idstringrequired
imageobjectnullablerequired
lastSeenAtdate-timenullablerequired

Most recent session activity, null if never signed in.

monthlySpendCentsnumberrequired

Sum of paid-tier monthly-equivalent price across active subs, in the tier currency. Cents.

namestringrequired
organizations object[]required

Org memberships — orgs the user belongs to via the better-auth org plugin.

  • Array [
  • organizationIdstring
    organizationNamestring
    organizationSlugstring
    rolestring
  • ]
  • rolestringnullablerequired

    Possible values: [platform_admin, org_admin, org_member]

    subscriptions object[]required
  • Array [
  • agentIconUrlobjectnullablerequired
    agentIdstringrequired
    agentNamestringrequired
    agentSlugstringrequired
    billingIntervalstringrequired

    Possible values: [month, year, one_time]

    cancelAtPeriodEndbooleanrequired
    canceledAtdate-timenullablerequired
    createdAtdate-timerequired
    currencystringrequired
    currentPeriodEnddate-timenullablerequired
    idstringrequired
    isFreebooleanrequired
    paymentMethodBrandobject

    Brand of saved payment method, if any.

    paymentMethodLast4object

    Last 4 of saved payment method, if any.

    pendingChangeTypestringnullable

    Direction of the pending change. Drives the UI copy and which Stripe primitive is in play.

    Possible values: [upgrade, downgrade]

    pendingCreatedAtdate-timenullable
    pendingEffectiveAtdate-timenullable
    pendingInvoiceIdobjectnullable
    pendingPaymentStatusstringnullable

    awaiting_payment — upgrade invoice issued, not yet paid. payment_failed — Stripe attempted the charge and the users card was declined; dunning will retry. scheduled` — downgrade booked for the next billing cycle.

    Possible values: [awaiting_payment, payment_failed, scheduled]

    pendingScheduleIdobjectnullable
    pendingTierIdobjectnullable
    pendingTierNameobjectnullable
    pricenumberrequired

    Tier price in major units (e.g. dollars). Source: pricing tier row.

    statusstringrequired

    canceling is derived when cancelAtPeriodEnd=true and underlying status is active/trialing.

    Possible values: [active, trialing, canceling, past_due, canceled, incomplete, incomplete_expired, unpaid]

    stripeCustomerIdobjectnullablerequired
    stripeSubscriptionIdobjectnullablerequired
    tierIdstringrequired
    tierNamestringrequired
    updatedAtdate-timerequired
  • ]
  • totalSubscriptionsnumberrequired

    Total subscriptions ever held (active + canceled).

    AdminUserDetailDto
    {
    "activeSubscriptions": 0,
    "banExpires": "2024-07-29T15:51:28.071Z",
    "banReason": {},
    "banned": true,
    "createdAt": "2024-07-29T15:51:28.071Z",
    "email": "string",
    "emailVerified": true,
    "id": "string",
    "image": {},
    "lastSeenAt": "2024-07-29T15:51:28.071Z",
    "monthlySpendCents": 0,
    "name": "string",
    "organizations": [
    {
    "organizationId": "string",
    "organizationName": "string",
    "organizationSlug": "string",
    "role": "string"
    }
    ],
    "role": "platform_admin",
    "subscriptions": [
    {
    "agentIconUrl": {},
    "agentId": "string",
    "agentName": "string",
    "agentSlug": "string",
    "billingInterval": "month",
    "cancelAtPeriodEnd": true,
    "canceledAt": "2024-07-29T15:51:28.071Z",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "currency": "string",
    "currentPeriodEnd": "2024-07-29T15:51:28.071Z",
    "id": "string",
    "isFree": true,
    "paymentMethodBrand": {},
    "paymentMethodLast4": {},
    "pendingChangeType": "upgrade",
    "pendingCreatedAt": "2024-07-29T15:51:28.071Z",
    "pendingEffectiveAt": "2024-07-29T15:51:28.071Z",
    "pendingInvoiceId": {},
    "pendingPaymentStatus": "awaiting_payment",
    "pendingScheduleId": {},
    "pendingTierId": {},
    "pendingTierName": {},
    "price": 0,
    "status": "active",
    "stripeCustomerId": {},
    "stripeSubscriptionId": {},
    "tierId": "string",
    "tierName": "string",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "totalSubscriptions": 0
    }