Class: Recurly::Requests::SubscriptionUpdate

Inherits:

Recurly::Request

• Object
• Recurly::Request
• Recurly::Requests::SubscriptionUpdate

Defined in:

lib/recurly/requests/subscription_update.rb

Instance Attribute Summary

• #auto_renew ⇒ Boolean

  Whether the subscription renews at the end of its term.

• #billing_info_id ⇒ String

  The ‘billing_info_id` is the value that represents a specific billing info for an end customer.

• #collection_method ⇒ String

  Change collection method.

• #custom_fields ⇒ Array[CustomField]

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

• #customer_notes ⇒ String

  Specify custom notes to add or override Customer Notes.

• #gateway_code ⇒ String

  If present, this subscription’s transactions will use the payment gateway with this code.

• #net_terms ⇒ Integer

  Integer paired with ‘Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due.

• #net_terms_type ⇒ String

  Optionally supplied string that may be either ‘net` or `eom` (end-of-month).

• #next_bill_date ⇒ DateTime

  If present, this sets the date the subscription’s next billing period will start (‘current_period_ends_at`).

• #po_number ⇒ String

  For manual invoicing, this identifies the PO number associated with the subscription.

• #price_segment_id ⇒ String

  The price segment ID, e.g.

• #remaining_billing_cycles ⇒ Integer

  The remaining billing cycles in the current term.

• #renewal_billing_cycles ⇒ Integer

  If ‘auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms.

• #revenue_schedule_type ⇒ String

  Revenue schedule type.

• #shipping ⇒ SubscriptionShippingUpdate

  Subscription shipping details.

• #tax_inclusive ⇒ Boolean

  This field is deprecated.

• #terms_and_conditions ⇒ String

  Specify custom notes to add or override Terms and Conditions.

Attributes inherited from Recurly::Request

#attributes

Method Summary

Methods inherited from Recurly::Request

#==, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::RequestCaster

#cast_request

Methods included from Schema::ResourceCaster

#cast

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#auto_renew ⇒ Boolean

# File 'lib/recurly/requests/subscription_update.rb', line 11

define_attribute :auto_renew, :Boolean

#billing_info_id ⇒ String

# File 'lib/recurly/requests/subscription_update.rb', line 15

define_attribute :billing_info_id, String

#collection_method ⇒ String

# File 'lib/recurly/requests/subscription_update.rb', line 19

define_attribute :collection_method, String

#custom_fields ⇒ Array[CustomField]

# File 'lib/recurly/requests/subscription_update.rb', line 23

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

#customer_notes ⇒ String

# File 'lib/recurly/requests/subscription_update.rb', line 27

define_attribute :customer_notes, String

#gateway_code ⇒ String

# File 'lib/recurly/requests/subscription_update.rb', line 31

define_attribute :gateway_code, String

#net_terms ⇒ Integer

# File 'lib/recurly/requests/subscription_update.rb', line 35

define_attribute :net_terms, Integer

#net_terms_type ⇒ String

# File 'lib/recurly/requests/subscription_update.rb', line 39

define_attribute :net_terms_type, String

#next_bill_date ⇒ DateTime

# File 'lib/recurly/requests/subscription_update.rb', line 43

define_attribute :next_bill_date, DateTime

#po_number ⇒ String

# File 'lib/recurly/requests/subscription_update.rb', line 47

define_attribute :po_number, String

#price_segment_id ⇒ String

# File 'lib/recurly/requests/subscription_update.rb', line 51

define_attribute :price_segment_id, String

#remaining_billing_cycles ⇒ Integer

# File 'lib/recurly/requests/subscription_update.rb', line 55

define_attribute :remaining_billing_cycles, Integer

#renewal_billing_cycles ⇒ Integer

# File 'lib/recurly/requests/subscription_update.rb', line 59

define_attribute :renewal_billing_cycles, Integer

#revenue_schedule_type ⇒ String

# File 'lib/recurly/requests/subscription_update.rb', line 63

define_attribute :revenue_schedule_type, String

#shipping ⇒ SubscriptionShippingUpdate

# File 'lib/recurly/requests/subscription_update.rb', line 67

define_attribute :shipping, :SubscriptionShippingUpdate

#tax_inclusive ⇒ Boolean

# File 'lib/recurly/requests/subscription_update.rb', line 71

define_attribute :tax_inclusive, :Boolean

#terms_and_conditions ⇒ String

# File 'lib/recurly/requests/subscription_update.rb', line 75

define_attribute :terms_and_conditions, String