Function getSubscriptionState

packages/payments/src/subscription-state.ts:28–65

(
  org: SubscriptionStateInput
)

}

export function getSubscriptionState(
  org: SubscriptionStateInput
): SubscriptionState {
  if (process.env.SELF_HOSTED === 'true') {
    return 'self_hosted';
  }

  const now = new Date();
  const { subscriptionStatus, subscriptionCanceledAt, subscriptionEndsAt } = org;
  const endsInFuture = Boolean(subscriptionEndsAt && subscriptionEndsAt > now);

  switch (subscriptionStatus) {
    case null:
    case 'trialing':
      return endsInFuture ? 'trialing' : 'trial_expired';
    case 'active':
      // Cancel-at-period-end keeps the Polar status as `active` while
      // `canceledAt` is set; the subscription stays usable until it expires.
      if (subscriptionCanceledAt) {
        return 'canceling';
      }
      return subscriptionEndsAt && subscriptionEndsAt <= now
        ? 'expired'
        : 'active';
    case 'past_due':
      return 'past_due';
    case 'unpaid':
      return 'unpaid';
    case 'incomplete':
      return 'incomplete';
    case 'incomplete_expired':
      return 'expired';
    case 'canceled':
      return 'canceled';
    default:
      return 'expired';
  }
}

/**
 * Whether a given state should block access to the dashboard (and force the