Class: Recurly::Resources::Account

Inherits:

Recurly::Resource

• Object
• Recurly::Resource
• Recurly::Resources::Account

Defined in:

lib/recurly/resources/account.rb

Instance Attribute Summary

• #address ⇒ Address
• #bill_to ⇒ String

  An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.

• #billing_info ⇒ BillingInfo
• #cc_emails ⇒ String

  Additional email address that should receive account correspondence.

• #code ⇒ String

  The unique identifier of the account.

• #company ⇒ String
• #created_at ⇒ DateTime

  When the account was created.

• #custom_fields ⇒ Array[CustomField]

  The custom fields will only be altered when they are included in a request.

• #deleted_at ⇒ DateTime

  If present, when the account was last marked inactive.

• #dunning_campaign_id ⇒ String

  Unique ID to identify a dunning campaign.

• #email ⇒ String

  The email address used for communicating with this customer.

• #entity_use_code ⇒ String

  The Avalara AvaTax value that can be passed to identify the customer type for tax purposes.

• #exemption_certificate ⇒ String

  The tax exemption certificate number for the account.

• #external_accounts ⇒ Array[ExternalAccount]

  The external accounts belonging to this account.

• #first_name ⇒ String
• #has_active_subscription ⇒ Boolean

  Indicates if the account has an active subscription.

• #has_canceled_subscription ⇒ Boolean

  Indicates if the account has a canceled subscription.

• #has_future_subscription ⇒ Boolean

  Indicates if the account has a future subscription.

• #has_live_subscription ⇒ Boolean

  Indicates if the account has a subscription that is either active, canceled, future, or paused.

• #has_past_due_invoice ⇒ Boolean

  Indicates if the account has a past due invoice.

• #has_paused_subscription ⇒ Boolean

  Indicates if the account has a paused subscription.

• #hosted_login_token ⇒ String

  The unique token for automatically logging the account in to the hosted management pages.

• #id ⇒ String
• #invoice_template_id ⇒ String

  Unique ID to identify an invoice template.

• #last_name ⇒ String
• #object ⇒ String

  Object type.

• #override_business_entity_id ⇒ String

  Unique ID to identify the business entity assigned to the account.

• #parent_account_id ⇒ String

  The UUID of the parent account associated with this account.

• #preferred_locale ⇒ String

  Used to determine the language and locale of emails sent on behalf of the merchant to the customer.

• #preferred_time_zone ⇒ String

  The [IANA time zone name](docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names) used to determine the time zone of emails sent on behalf of the merchant to the customer.

• #shipping_addresses ⇒ Array[ShippingAddress]

  The shipping addresses on the account.

• #state ⇒ String

  Accounts can be either active or inactive.

• #tax_exempt ⇒ Boolean

  The tax status of the account.

• #updated_at ⇒ DateTime

  When the account was last changed.

• #username ⇒ String

  A secondary value for the account.

• #vat_number ⇒ String

  The VAT number of the account (to avoid having the VAT applied).

Attributes inherited from Recurly::Resource

#attributes

Method Summary

Methods inherited from Recurly::Resource

#==, #get_response, #inspect, #requires_client?, #to_json, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::ResourceCaster

#cast

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#address ⇒ Address

Returns:

• (Address)

# File 'lib/recurly/resources/account.rb', line 11

define_attribute :address, :Address

#bill_to ⇒ String

Returns An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.

Returns:

• (String) —

  An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.

# File 'lib/recurly/resources/account.rb', line 15

define_attribute :bill_to, String

#billing_info ⇒ BillingInfo

Returns:

• (BillingInfo)

# File 'lib/recurly/resources/account.rb', line 19

define_attribute :billing_info, :BillingInfo

#cc_emails ⇒ String

Returns Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.

Returns:

• (String) —

  Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.

# File 'lib/recurly/resources/account.rb', line 23

define_attribute :cc_emails, String

#code ⇒ String

Returns The unique identifier of the account. This cannot be changed once the account is created.

Returns:

• (String) —

  The unique identifier of the account. This cannot be changed once the account is created.

# File 'lib/recurly/resources/account.rb', line 27

define_attribute :code, String

#company ⇒ String

Returns:

• (String)

# File 'lib/recurly/resources/account.rb', line 31

define_attribute :company, String

#created_at ⇒ DateTime

Returns When the account was created.

Returns:

• (DateTime) —

  When the account was created.

# File 'lib/recurly/resources/account.rb', line 35

define_attribute :created_at, DateTime

#custom_fields ⇒ Array[CustomField]

Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.

Returns:

• (Array[CustomField]) —

  The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.

# File 'lib/recurly/resources/account.rb', line 39

define_attribute :custom_fields, Array, { :item_type => :CustomField }

#deleted_at ⇒ DateTime

Returns If present, when the account was last marked inactive.

Returns:

• (DateTime) —

  If present, when the account was last marked inactive.

# File 'lib/recurly/resources/account.rb', line 43

define_attribute :deleted_at, DateTime

#dunning_campaign_id ⇒ String

Returns Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.

Returns:

• (String) —

  Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.

# File 'lib/recurly/resources/account.rb', line 47

define_attribute :dunning_campaign_id, String

#email ⇒ String

Returns The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.

Returns:

• (String) —

  The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.

# File 'lib/recurly/resources/account.rb', line 51

define_attribute :email, String

#entity_use_code ⇒ String

Returns The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.

Returns:

• (String) —

  The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.

# File 'lib/recurly/resources/account.rb', line 55

define_attribute :entity_use_code, String

#exemption_certificate ⇒ String

Returns The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.

Returns:

• (String) —

  The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.

# File 'lib/recurly/resources/account.rb', line 59

define_attribute :exemption_certificate, String

#external_accounts ⇒ Array[ExternalAccount]

Returns The external accounts belonging to this account.

Returns:

• (Array[ExternalAccount]) —

  The external accounts belonging to this account

# File 'lib/recurly/resources/account.rb', line 63

define_attribute :external_accounts, Array, { :item_type => :ExternalAccount }

#first_name ⇒ String

Returns:

• (String)

# File 'lib/recurly/resources/account.rb', line 67

define_attribute :first_name, String

#has_active_subscription ⇒ Boolean

Returns Indicates if the account has an active subscription.

Returns:

• (Boolean) —

  Indicates if the account has an active subscription.

# File 'lib/recurly/resources/account.rb', line 71

define_attribute :has_active_subscription, :Boolean

#has_canceled_subscription ⇒ Boolean

Returns Indicates if the account has a canceled subscription.

Returns:

• (Boolean) —

  Indicates if the account has a canceled subscription.

# File 'lib/recurly/resources/account.rb', line 75

define_attribute :has_canceled_subscription, :Boolean

#has_future_subscription ⇒ Boolean

Returns Indicates if the account has a future subscription.

Returns:

• (Boolean) —

  Indicates if the account has a future subscription.

# File 'lib/recurly/resources/account.rb', line 79

define_attribute :has_future_subscription, :Boolean

#has_live_subscription ⇒ Boolean

Returns Indicates if the account has a subscription that is either active, canceled, future, or paused.

Returns:

• (Boolean) —

  Indicates if the account has a subscription that is either active, canceled, future, or paused.

# File 'lib/recurly/resources/account.rb', line 83

define_attribute :has_live_subscription, :Boolean

#has_past_due_invoice ⇒ Boolean

Returns Indicates if the account has a past due invoice.

Returns:

• (Boolean) —

  Indicates if the account has a past due invoice.

# File 'lib/recurly/resources/account.rb', line 87

define_attribute :has_past_due_invoice, :Boolean

#has_paused_subscription ⇒ Boolean

Returns Indicates if the account has a paused subscription.

Returns:

• (Boolean) —

  Indicates if the account has a paused subscription.

# File 'lib/recurly/resources/account.rb', line 91

define_attribute :has_paused_subscription, :Boolean

#hosted_login_token ⇒ String

Returns The unique token for automatically logging the account in to the hosted management pages. You may automatically log the user into their hosted management pages by directing the user to: `

Returns:

• (String) —

  The unique token for automatically logging the account in to the hosted management pages. You may automatically log the user into their hosted management pages by directing the user to: `

  
  
  95

  # File 'lib/recurly/resources/account.rb', line 95
  
  define_attribute :hosted_login_token, String

  #id ⇒ String

  Returns:

  • (String)

  # File 'lib/recurly/resources/account.rb', line 99
  
  define_attribute :id, String

  #invoice_template_id ⇒ String

  Returns Unique ID to identify an invoice template. Available when the site is on a Pro or Elite plan. Used to specify if a non-default invoice template will be used to generate invoices for the account. For sites without multiple invoice templates enabled, the default template will always be used.

  Returns:

  • (String) —

    Unique ID to identify an invoice template. Available when the site is on a Pro or Elite plan. Used to specify if a non-default invoice template will be used to generate invoices for the account. For sites without multiple invoice templates enabled, the default template will always be used.

  # File 'lib/recurly/resources/account.rb', line 103
  
  define_attribute :invoice_template_id, String

  #last_name ⇒ String

  Returns:

  • (String)

  # File 'lib/recurly/resources/account.rb', line 107
  
  define_attribute :last_name, String

  #object ⇒ String

  Returns Object type.

  Returns:

  • (String) —

    Object type

  # File 'lib/recurly/resources/account.rb', line 111
  
  define_attribute :object, String

  #override_business_entity_id ⇒ String

  Returns Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.

  Returns:

  • (String) —

    Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.

  # File 'lib/recurly/resources/account.rb', line 115
  
  define_attribute :override_business_entity_id, String

  #parent_account_id ⇒ String

  Returns The UUID of the parent account associated with this account.

  Returns:

  • (String) —

    The UUID of the parent account associated with this account.

  # File 'lib/recurly/resources/account.rb', line 119
  
  define_attribute :parent_account_id, String

  #preferred_locale ⇒ String

  Returns Used to determine the language and locale of emails sent on behalf of the merchant to the customer.

  Returns:

  • (String) —

    Used to determine the language and locale of emails sent on behalf of the merchant to the customer.

  # File 'lib/recurly/resources/account.rb', line 123
  
  define_attribute :preferred_locale, String

  #preferred_time_zone ⇒ String

  Returns The [IANA time zone name](docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names) used to determine the time zone of emails sent on behalf of the merchant to the customer.

  Returns:

  • (String) —

    The [IANA time zone name](docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names) used to determine the time zone of emails sent on behalf of the merchant to the customer.

  # File 'lib/recurly/resources/account.rb', line 127
  
  define_attribute :preferred_time_zone, String

  #shipping_addresses ⇒ Array[ShippingAddress]

  Returns The shipping addresses on the account.

  Returns:

  • (Array[ShippingAddress]) —

    The shipping addresses on the account.

  # File 'lib/recurly/resources/account.rb', line 131
  
  define_attribute :shipping_addresses, Array, { :item_type => :ShippingAddress }

  #state ⇒ String

  Returns Accounts can be either active or inactive.

  Returns:

  • (String) —

    Accounts can be either active or inactive.

  # File 'lib/recurly/resources/account.rb', line 135
  
  define_attribute :state, String

  #tax_exempt ⇒ Boolean

  Returns The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.

  Returns:

  • (Boolean) —

    The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.

  # File 'lib/recurly/resources/account.rb', line 139
  
  define_attribute :tax_exempt, :Boolean

  #updated_at ⇒ DateTime

  Returns When the account was last changed.

  Returns:

  • (DateTime) —

    When the account was last changed.

  # File 'lib/recurly/resources/account.rb', line 143
  
  define_attribute :updated_at, DateTime

  #username ⇒ String

  Returns A secondary value for the account.

  Returns:

  • (String) —

    A secondary value for the account.

  # File 'lib/recurly/resources/account.rb', line 147
  
  define_attribute :username, String

  #vat_number ⇒ String

  Returns The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.

  Returns:

  • (String) —

    The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.

  # File 'lib/recurly/resources/account.rb', line 151
  
  define_attribute :vat_number, String

Generated on Wed Oct 30 22:01:54 2024 by yard 0.9.37 (ruby-2.6.10).