Class: Recurly::Requests::SubscriptionShippingCreate

Inherits:

Recurly::Request

• Object
• Recurly::Request
• Recurly::Requests::SubscriptionShippingCreate

Defined in:

lib/recurly/requests/subscription_shipping_create.rb

Instance Attribute Summary

• #address ⇒ ShippingAddressCreate
• #address_id ⇒ String

  Assign a shipping address from the account's existing shipping addresses.

• #amount ⇒ Float

  Assigns the subscription's shipping cost.

• #method_code ⇒ String

  The code of the shipping method used to deliver the subscription.

• #method_id ⇒ String

  The id of the shipping method used to deliver the subscription.

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

#address ⇒ ShippingAddressCreate

Returns:

• (ShippingAddressCreate)

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

define_attribute :address, :ShippingAddressCreate

#address_id ⇒ String

Returns Assign a shipping address from the account's existing shipping addresses. If `address_id` and `address` are both present, `address` will be used.

Returns:

• (String) —

  Assign a shipping address from the account's existing shipping addresses. If `address_id` and `address` are both present, `address` will be used.

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

define_attribute :address_id, String

#amount ⇒ Float

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.

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

define_attribute :amount, Float

#method_code ⇒ String

Returns The code of the shipping method used to deliver the subscription. 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. If `method_id` and `method_code` are both present, `method_id` will be used.

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

define_attribute :method_code, String

#method_id ⇒ String

Returns The id of the shipping method used to deliver the subscription. 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. If `method_id` and `method_code` are both present, `method_id` will be used.

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

define_attribute :method_id, String