Class: AdvancedBilling::SubscriptionState

Inherits:
Object
  • Object
show all
Defined in:
lib/advanced_billing/models/subscription_state.rb

Overview

The state of a subscription. * Live States * active - A normal, active subscription. It is not in a trial and is paid and up to date. * assessing - An internal (transient) state that indicates a subscription is in the middle of periodic assessment. Do not base any access decisions in your app on this state, as it may not always be exposed. * pending - An internal (transient) state that indicates a subscription is in the creation process. Do not base any access decisions in your app on this state, as it may not always be exposed. * trialing - A subscription in trialing state has a valid trial subscription. This type of subscription may transition to active once payment is received when the trial has ended. Otherwise, it may go to a Problem or End of Life state. * paused - An internal state that indicates that your account with Advanced Billing is in arrears. * Problem States * past_due - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers. * soft_failure - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed. * unpaid - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning -Overview) settings to have a Final Action of mark the subscription unpaid. * End of Life States * canceled - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://maxio.zendesk.com/hc/en-us/articles/24287076583565-Dunning -Overview) process without payment. See the [Reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Re activating-and-Resuming) documentation for info on how to restart a canceled subscription. While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance. * expired - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period. * failed_to_create - Indicates that signup has failed. (You may see this state in a signup_failure webhook.) * on_hold - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time. * suspended - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state. * trial_ended - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://maxio.zendesk.com/hc/en-us/articles/24261076617869-Product-E diting) for more details. See [Subscription States](https://maxio.zendesk.com/hc/en-us/articles/24252119027853-Subscript ion-States) for more info about subscription states and state transitions.

Constant Summary collapse

SUBSCRIPTION_STATE = 
[
  # TODO: Write general description for PENDING
  PENDING = 'pending'.freeze,

  # TODO: Write general description for FAILED_TO_CREATE
  FAILED_TO_CREATE = 'failed_to_create'.freeze,

  # TODO: Write general description for TRIALING
  TRIALING = 'trialing'.freeze,

  # TODO: Write general description for ASSESSING
  ASSESSING = 'assessing'.freeze,

  # TODO: Write general description for ACTIVE
  ACTIVE = 'active'.freeze,

  # TODO: Write general description for SOFT_FAILURE
  SOFT_FAILURE = 'soft_failure'.freeze,

  # TODO: Write general description for PAST_DUE
  PAST_DUE = 'past_due'.freeze,

  # TODO: Write general description for SUSPENDED
  SUSPENDED = 'suspended'.freeze,

  # TODO: Write general description for CANCELED
  CANCELED = 'canceled'.freeze,

  # TODO: Write general description for EXPIRED
  EXPIRED = 'expired'.freeze,

  # TODO: Write general description for PAUSED
  PAUSED = 'paused'.freeze,

  # TODO: Write general description for UNPAID
  UNPAID = 'unpaid'.freeze,

  # TODO: Write general description for TRIAL_ENDED
  TRIAL_ENDED = 'trial_ended'.freeze,

  # TODO: Write general description for ON_HOLD
  ON_HOLD = 'on_hold'.freeze,

  # TODO: Write general description for AWAITING_SIGNUP
  AWAITING_SIGNUP = 'awaiting_signup'.freeze
].freeze

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = PENDING) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/advanced_billing/models/subscription_state.rb', line 118

def self.from_value(value, default_value = PENDING)
  return default_value if value.nil?

  str = value.to_s.strip

  case str.downcase
  when 'pending' then PENDING
  when 'failed_to_create' then FAILED_TO_CREATE
  when 'trialing' then TRIALING
  when 'assessing' then ASSESSING
  when 'active' then ACTIVE
  when 'soft_failure' then SOFT_FAILURE
  when 'past_due' then PAST_DUE
  when 'suspended' then SUSPENDED
  when 'canceled' then CANCELED
  when 'expired' then EXPIRED
  when 'paused' then PAUSED
  when 'unpaid' then UNPAID
  when 'trial_ended' then TRIAL_ENDED
  when 'on_hold' then ON_HOLD
  when 'awaiting_signup' then AWAITING_SIGNUP
  else
    default_value
  end
end

.validate(value) ⇒ Object 



112
113
114
115
116
 
# File 'lib/advanced_billing/models/subscription_state.rb', line 112

def self.validate(value)
  return false if value.nil?

  SUBSCRIPTION_STATE.include?(value)
end