Class: Recurly::Requests::SubscriptionUpdate

Inherits:
Recurly::Request show all
Defined in:
lib/recurly/requests/subscription_update.rb

Instance Attribute Summary collapse

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

Returns Whether the subscription renews at the end of its term.

Returns:

  • (Boolean) —

    Whether the subscription renews at the end of its term.



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

define_attribute :auto_renew, :Boolean

#billing_info_id ⇒ String

Returns The ‘billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.

Returns:

  • (String) —

    The ‘billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.



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

define_attribute :billing_info_id, String

#collection_method ⇒ String

Returns Change collection method.

Returns:

  • (String) —

    Change collection method



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

define_attribute :collection_method, String

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



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

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

#customer_notes ⇒ String

Returns Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.

Returns:

  • (String) —

    Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.



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

define_attribute :customer_notes, String

#gateway_code ⇒ String

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

Returns:

  • (String) —

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



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

define_attribute :gateway_code, String

#net_terms ⇒ Integer

Returns 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. For any value, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due ’On Receipt’ and will become past due 24 hours after it’s created. If an invoice is due ‘net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information please visit our docs page (docs.recurly.com/docs/manual-payments#section-collection-terms).

Returns:

  • (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. For any value, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due ’On Receipt’ and will become past due 24 hours after it’s created. If an invoice is due ‘net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information please visit our docs page (docs.recurly.com/docs/manual-payments#section-collection-terms)



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

define_attribute :net_terms, Integer

#net_terms_type ⇒ String

Returns Optionally supplied string that may be either ‘net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month. This field is only available when the EOM Net Terms feature is enabled.

Returns:

  • (String) —

    Optionally supplied string that may be either ‘net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month. This field is only available when the EOM Net Terms feature is enabled.



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

define_attribute :net_terms_type, String

#next_bill_date ⇒ DateTime

Returns If present, this sets the date the subscription’s next billing period will start (‘current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. For a subscription in a trial period, this will change when the trial expires. This parameter is useful for postponement of a subscription to change its billing date without proration.

Returns:

  • (DateTime) —

    If present, this sets the date the subscription’s next billing period will start (‘current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. For a subscription in a trial period, this will change when the trial expires. This parameter is useful for postponement of a subscription to change its billing date without proration.



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

define_attribute :next_bill_date, DateTime

#po_number ⇒ String

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

Returns:

  • (String) —

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



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

define_attribute :po_number, String

#remaining_billing_cycles ⇒ Integer

Returns The remaining billing cycles in the current term.

Returns:

  • (Integer) —

    The remaining billing cycles in the current term.



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

define_attribute :remaining_billing_cycles, Integer

#renewal_billing_cycles ⇒ Integer

Returns If ‘auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan’s ‘total_billing_cycles`.

Returns:

  • (Integer) —

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



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

define_attribute :renewal_billing_cycles, Integer

#revenue_schedule_type ⇒ String

Returns Revenue schedule type.

Returns:

  • (String) —

    Revenue schedule type



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

define_attribute :revenue_schedule_type, String

#shipping ⇒ SubscriptionShippingUpdate

Returns Subscription shipping details.

Returns:



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

define_attribute :shipping, :SubscriptionShippingUpdate

#tax_inclusive ⇒ Boolean

Returns This field is deprecated. Please do not use it.

Returns:

  • (Boolean) —

    This field is deprecated. Please do not use it.



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

define_attribute :tax_inclusive, :Boolean

#terms_and_conditions ⇒ String

Returns Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.

Returns:

  • (String) —

    Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.



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

define_attribute :terms_and_conditions, String