ViewerBillingStatus

The billing status of an organization's subscription.

Use this to display billing warnings, restrict actions for unpaid accounts, or guide users toward resolving payment issues.

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

Values

ViewerBillingStatus.TRIAL {#trial}

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

ViewerBillingStatus.ACTIVE {#active}

Subscription is active and in good standing.

ViewerBillingStatus.PAST_DUE {#past-due}

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

ViewerBillingStatus.EXPIRED {#expired}

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

ViewerBillingStatus.CANCELED {#canceled}

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

ViewerBillingStatus.SUSPENDED {#suspended}

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

ViewerBillingStatus.PAYMENT_PENDING {#payment-pending}

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

ViewerBillingStatus.PAYMENT_FAILED {#payment-failed}

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

Member Of

ViewerOrganizationBilling object