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 collapse
-
#add_ons ⇒ Array[SubscriptionAddOnUpdate]
If you provide a value for this field it will replace any existing add-ons.
-
#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 representing the number of days after an invoice's creation that the invoice will become past due.
-
#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.
-
#quantity ⇒ Integer
Optionally override the default quantity of 1.
-
#revenue_schedule_type ⇒ String
Revenue schedule type.
-
#shipping ⇒ SubscriptionChangeShippingCreate
The shipping address can currently only be changed immediately, using SubscriptionUpdate.
-
#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
Method Summary
Methods inherited from Recurly::Request
Methods included from Schema::SchemaFactory
Methods included from Schema::RequestCaster
Methods included from Schema::ResourceCaster
Methods included from Schema::SchemaValidator
#get_did_you_mean, #validate!, #validate_attribute!
Instance Attribute Details
#add_ons ⇒ Array[SubscriptionAddOnUpdate]
Returns If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on''s ID: `“abc123”`. If this value is omitted your existing add-ons will be unaffected. To remove all existing add-ons, this value should be an empty array.' If a subscription add-on's `code` is supplied without the `id`, `“def456”`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request. - If an `id` is passed, any attributes not passed in will pull from the existing subscription add-on - If a `code` is passed, any attributes not passed in will pull from the current values of the plan add-on - Attributes passed in as part of the request will override either of the above scenarios.
11 |
# File 'lib/recurly/requests/subscription_change_create.rb', line 11 define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnUpdate } |
#collection_method ⇒ String
Returns Collection method.
15 |
# File 'lib/recurly/requests/subscription_change_create.rb', line 15 define_attribute :collection_method, String |
#coupon_codes ⇒ Array[String]
Returns A list of coupon_codes to be redeemed on the subscription during the change. Only allowed if timeframe is now and you change something about the subscription that creates an invoice.
19 |
# File 'lib/recurly/requests/subscription_change_create.rb', line 19 define_attribute :coupon_codes, Array, { :item_type => 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.
23 |
# File 'lib/recurly/requests/subscription_change_create.rb', line 23 define_attribute :custom_fields, Array, { :item_type => :CustomField } |
#net_terms ⇒ Integer
Returns Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '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.
27 |
# File 'lib/recurly/requests/subscription_change_create.rb', line 27 define_attribute :net_terms, Integer |
#plan_code ⇒ String
Returns If you want to change to a new plan, you can provide the plan's code or id. If both are provided the `plan_id` will be used.
31 |
# File 'lib/recurly/requests/subscription_change_create.rb', line 31 define_attribute :plan_code, String |
#plan_id ⇒ String
Returns If you want to change to a new plan, you can provide the plan's code or id. If both are provided the `plan_id` will be used.
35 |
# File 'lib/recurly/requests/subscription_change_create.rb', line 35 define_attribute :plan_id, String |
#po_number ⇒ String
Returns For manual invoicing, this identifies the PO number associated with the subscription.
39 |
# File 'lib/recurly/requests/subscription_change_create.rb', line 39 define_attribute :po_number, String |
#quantity ⇒ Integer
Returns Optionally override the default quantity of 1.
43 |
# File 'lib/recurly/requests/subscription_change_create.rb', line 43 define_attribute :quantity, Integer |
#revenue_schedule_type ⇒ String
Returns Revenue schedule type.
47 |
# File 'lib/recurly/requests/subscription_change_create.rb', line 47 define_attribute :revenue_schedule_type, String |
#shipping ⇒ SubscriptionChangeShippingCreate
Returns The shipping address can currently only be changed immediately, using SubscriptionUpdate.
51 |
# File 'lib/recurly/requests/subscription_change_create.rb', line 51 define_attribute :shipping, :SubscriptionChangeShippingCreate |
#timeframe ⇒ String
Returns The timeframe parameter controls when the upgrade or downgrade takes place. The subscription change can occur now, when the subscription is next billed, or when the subscription term ends. Generally, if you're performing an upgrade, you will want the change to occur immediately (now). If you're performing a downgrade, you should set the timeframe to `term_end` or `bill_date` so the change takes effect at a scheduled billing date. The `renewal` timeframe option is accepted as an alias for `term_end`.
55 |
# File 'lib/recurly/requests/subscription_change_create.rb', line 55 define_attribute :timeframe, String |
#transaction_type ⇒ String
Returns An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
59 |
# File 'lib/recurly/requests/subscription_change_create.rb', line 59 define_attribute :transaction_type, String |
#unit_amount ⇒ Float
Returns Optionally, sets custom pricing for the subscription, overriding the plan's default unit amount. The subscription's current currency will be used.
63 |
# File 'lib/recurly/requests/subscription_change_create.rb', line 63 define_attribute :unit_amount, Float |