OrganizationSubscriptionStatus

Subscription status for an organization.

Use this to display billing warnings, gate features for unpaid accounts, or guide users toward resolving payment issues. Visible to every member of the organization regardless of role.

enum OrganizationSubscriptionStatus {
  TRIAL
  ACTIVE
  PAST_DUE
  EXPIRED
  CANCELED
  SUSPENDED
  PAYMENT_PENDING
  PAYMENT_FAILED
}

Values

OrganizationSubscriptionStatus.TRIAL {#trial}

Free trial period. The organization has full access until the trial expires.

OrganizationSubscriptionStatus.ACTIVE {#active}

Subscription is active and in good standing.

OrganizationSubscriptionStatus.PAST_DUE {#past-due}

A payment is overdue. Access continues but action is needed to avoid suspension.

OrganizationSubscriptionStatus.EXPIRED {#expired}

The free trial has ended without a subscription. Functionality is limited.

OrganizationSubscriptionStatus.CANCELED {#canceled}

The subscription was canceled. The organization is in a grace period.

OrganizationSubscriptionStatus.SUSPENDED {#suspended}

The account is suspended due to billing issues. Most operations are blocked.

OrganizationSubscriptionStatus.PAYMENT_PENDING {#payment-pending}

A payment is being processed. This is typically a brief transitional state.

OrganizationSubscriptionStatus.PAYMENT_FAILED {#payment-failed}

The most recent payment attempt failed. Update payment details to restore access.

Member Of

Organization object