Class: Stripe::Capability::FutureRequirements

Inherits:
StripeObject
  • Object
show all
Defined in:
lib/stripe/resources/capability.rb

Defined Under Namespace

Classes: Alternative, Error

Constant Summary

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from StripeObject

#last_response

Method Summary

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#alternatives ⇒ Object (readonly)

Fields that are due and can be satisfied by providing the corresponding alternative fields instead.



33
34
35
 
# File 'lib/stripe/resources/capability.rb', line 33

def alternatives
  @alternatives
end

#current_deadline ⇒ Object (readonly)

Date on which ‘future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability’s enablement state prior to transitioning.



35
36
37
 
# File 'lib/stripe/resources/capability.rb', line 35

def current_deadline
  @current_deadline
end

#currently_due ⇒ Object (readonly)

Fields that need to be collected to keep the capability enabled. If not collected by ‘future_requirements`, these fields will transition to the main `requirements` hash.



37
38
39
 
# File 'lib/stripe/resources/capability.rb', line 37

def currently_due
  @currently_due
end

#disabled_reason ⇒ Object (readonly)

This is typed as an enum for consistency with ‘requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.



39
40
41
 
# File 'lib/stripe/resources/capability.rb', line 39

def disabled_reason
  @disabled_reason
end

#errors ⇒ Object (readonly)

Fields that are ‘currently_due` and need to be collected again because validation or verification failed.



41
42
43
 
# File 'lib/stripe/resources/capability.rb', line 41

def errors
  @errors
end

#eventually_due ⇒ Object (readonly)

Fields you must collect when all thresholds are reached. As they become required, they appear in ‘currently_due` as well.



43
44
45
 
# File 'lib/stripe/resources/capability.rb', line 43

def eventually_due
  @eventually_due
end

#past_due ⇒ Object (readonly)

Fields that weren’t collected by ‘requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.



45
46
47
 
# File 'lib/stripe/resources/capability.rb', line 45

def past_due
  @past_due
end

#pending_verification ⇒ Object (readonly)

Fields that might become required depending on the results of verification or review. It’s an empty array unless an asynchronous verification is pending. If verification fails, these fields move to ‘eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.



47
48
49
 
# File 'lib/stripe/resources/capability.rb', line 47

def pending_verification
  @pending_verification
end