AdminUserSubscriptionDto

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

AdminUserSubscriptionDto

{
  "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"
}