Class: Recurly::Requests::SubscriptionChangeCreate

Inherits:

Recurly::Request

• Object
• Recurly::Request
• Recurly::Requests::SubscriptionChangeCreate

Defined in:

lib/recurly/requests/subscription_change_create.rb

Instance Attribute Summary

• #add_ons ⇒ Array[SubscriptionAddOnUpdate]

  If you provide a value for this field it will replace any existing add-ons.

• #billing_info ⇒ SubscriptionChangeBillingInfoCreate
• #business_entity_code ⇒ String

  The ‘business_entity_code` is the value that represents a specific business entity for an end customer.

• #business_entity_id ⇒ String

  The ‘business_entity_id` is the value that represents a specific business entity for an end customer.

• #collection_method ⇒ String

  Collection method.

• #coupon_codes ⇒ Array[String]

  A list of coupon_codes to be redeemed on the subscription during the change.

• #custom_fields ⇒ Array[CustomField]

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

• #net_terms ⇒ Integer

  Integer normally 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).

• #plan_code ⇒ String

  If you want to change to a new plan, you can provide the plan’s code or id.

• #plan_id ⇒ String

  If you want to change to a new plan, you can provide the plan’s code or id.

• #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.

• #proration_settings ⇒ ProrationSettings

  Allows you to control how any resulting charges and credits will be calculated and prorated.

• #quantity ⇒ Integer

  Optionally override the default quantity of 1.

• #ramp_intervals ⇒ Array[SubscriptionRampInterval]

  The new set of ramp intervals for the subscription.

• #revenue_schedule_type ⇒ String

  Revenue schedule type.

• #shipping ⇒ SubscriptionChangeShippingCreate

  Shipping addresses are tied to a customer’s account.

• #tax_inclusive ⇒ Boolean

  This field is deprecated.

• #timeframe ⇒ String

  The timeframe parameter controls when the upgrade or downgrade takes place.

• #transaction_type ⇒ String

  An optional type designation for the payment gateway transaction created by this request.

• #unit_amount ⇒ Float

  Optionally, sets custom pricing for the subscription, overriding the plan’s default unit amount.

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

#add_ons ⇒ Array[SubscriptionAddOnUpdate]

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

define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnUpdate }

#billing_info ⇒ SubscriptionChangeBillingInfoCreate

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

define_attribute :billing_info, :SubscriptionChangeBillingInfoCreate

#business_entity_code ⇒ String

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

define_attribute :business_entity_code, String

#business_entity_id ⇒ String

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

define_attribute :business_entity_id, String

#collection_method ⇒ String

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

define_attribute :collection_method, String

#coupon_codes ⇒ Array[String]

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

define_attribute :coupon_codes, Array, { :item_type => String }

#custom_fields ⇒ Array[CustomField]

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

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

#net_terms ⇒ Integer

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

define_attribute :net_terms, Integer

#net_terms_type ⇒ String

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

define_attribute :net_terms_type, String

#plan_code ⇒ String

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

define_attribute :plan_code, String

#plan_id ⇒ String

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

define_attribute :plan_id, String

#po_number ⇒ String

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

define_attribute :po_number, String

#price_segment_id ⇒ String

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

define_attribute :price_segment_id, String

#proration_settings ⇒ ProrationSettings

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

define_attribute :proration_settings, :ProrationSettings

#quantity ⇒ Integer

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

define_attribute :quantity, Integer

#ramp_intervals ⇒ Array[SubscriptionRampInterval]

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

define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampInterval }

#revenue_schedule_type ⇒ String

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

define_attribute :revenue_schedule_type, String

#shipping ⇒ SubscriptionChangeShippingCreate

# File 'lib/recurly/requests/subscription_change_create.rb', line 79

define_attribute :shipping, :SubscriptionChangeShippingCreate

#tax_inclusive ⇒ Boolean

# File 'lib/recurly/requests/subscription_change_create.rb', line 83

define_attribute :tax_inclusive, :Boolean

#timeframe ⇒ String

# File 'lib/recurly/requests/subscription_change_create.rb', line 87

define_attribute :timeframe, String

#transaction_type ⇒ String

# File 'lib/recurly/requests/subscription_change_create.rb', line 91

define_attribute :transaction_type, String

#unit_amount ⇒ Float

# File 'lib/recurly/requests/subscription_change_create.rb', line 95

define_attribute :unit_amount, Float