Class: Recurly::Requests::SubscriptionChangeShippingCreate

Inherits:
Recurly::Request show all
Defined in:
lib/recurly/requests/subscription_change_shipping_create.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

#amountFloat

Returns Assigns the subscription's shipping cost. If this is greater than zero then a `method_id` or `method_code` is required.

Returns:

  • (Float)

    Assigns the subscription's shipping cost. If this is greater than zero then a `method_id` or `method_code` is required.



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

define_attribute :amount, Float

#method_codeString

Returns The code of the shipping method used to deliver the subscription. To remove shipping set this to `null` and the `amount=0`. If `method_id` and `method_code` are both present, `method_id` will be used.

Returns:

  • (String)

    The code of the shipping method used to deliver the subscription. To remove shipping set this to `null` and the `amount=0`. If `method_id` and `method_code` are both present, `method_id` will be used.



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

define_attribute :method_code, String

#method_idString

Returns The id of the shipping method used to deliver the subscription. To remove shipping set this to `null` and the `amount=0`. If `method_id` and `method_code` are both present, `method_id` will be used.

Returns:

  • (String)

    The id of the shipping method used to deliver the subscription. To remove shipping set this to `null` and the `amount=0`. If `method_id` and `method_code` are both present, `method_id` will be used.



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

define_attribute :method_id, String