recurly 2.17.5 → 4.18.0

data/lib/recurly/resources/shipping_address.rb

@@ -0,0 +1,82 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class ShippingAddress < Resource
+
+      # @!attribute account_id
+      #   @return [String] Account ID
+      define_attribute :account_id, String
+
+      # @!attribute city
+      #   @return [String]
+      define_attribute :city, String
+
+      # @!attribute company
+      #   @return [String]
+      define_attribute :company, String
+
+      # @!attribute country
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
+      define_attribute :country, String
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute email
+      #   @return [String]
+      define_attribute :email, String
+
+      # @!attribute first_name
+      #   @return [String]
+      define_attribute :first_name, String
+
+      # @!attribute id
+      #   @return [String] Shipping Address ID
+      define_attribute :id, String
+
+      # @!attribute last_name
+      #   @return [String]
+      define_attribute :last_name, String
+
+      # @!attribute nickname
+      #   @return [String]
+      define_attribute :nickname, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute phone
+      #   @return [String]
+      define_attribute :phone, String
+
+      # @!attribute postal_code
+      #   @return [String] Zip or postal code.
+      define_attribute :postal_code, String
+
+      # @!attribute region
+      #   @return [String] State or province.
+      define_attribute :region, String
+
+      # @!attribute street1
+      #   @return [String]
+      define_attribute :street1, String
+
+      # @!attribute street2
+      #   @return [String]
+      define_attribute :street2, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] Updated at
+      define_attribute :updated_at, DateTime
+
+      # @!attribute vat_number
+      #   @return [String]
+      define_attribute :vat_number, String
+    end
+  end
+end

data/lib/recurly/resources/shipping_method.rb

@@ -0,0 +1,46 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class ShippingMethod < Resource
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for shipping method.
+      define_attribute :accounting_code, String
+
+      # @!attribute code
+      #   @return [String] The internal name used identify the shipping method.
+      define_attribute :code, String
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute deleted_at
+      #   @return [DateTime] Deleted at
+      define_attribute :deleted_at, DateTime
+
+      # @!attribute id
+      #   @return [String] Shipping Method ID
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] The name of the shipping method displayed to customers.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute tax_code
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are:  - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable
+      define_attribute :tax_code, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/shipping_method_mini.rb

@@ -0,0 +1,26 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class ShippingMethodMini < Resource
+
+      # @!attribute code
+      #   @return [String] The internal name used identify the shipping method.
+      define_attribute :code, String
+
+      # @!attribute id
+      #   @return [String] Shipping Method ID
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] The name of the shipping method displayed to customers.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/resources/site.rb

@@ -0,0 +1,54 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class Site < Resource
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute deleted_at
+      #   @return [DateTime] Deleted at
+      define_attribute :deleted_at, DateTime
+
+      # @!attribute features
+      #   @return [Array[String]] A list of features enabled for the site.
+      define_attribute :features, Array, { :item_type => String }
+
+      # @!attribute id
+      #   @return [String] Site ID
+      define_attribute :id, String
+
+      # @!attribute mode
+      #   @return [String] Mode
+      define_attribute :mode, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute public_api_key
+      #   @return [String] This value is used to configure RecurlyJS to submit tokenized billing information.
+      define_attribute :public_api_key, String
+
+      # @!attribute settings
+      #   @return [Settings]
+      define_attribute :settings, :Settings
+
+      # @!attribute subdomain
+      #   @return [String]
+      define_attribute :subdomain, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] Updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/subscription.rb

@@ -0,0 +1,198 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class Subscription < Resource
+
+      # @!attribute account
+      #   @return [AccountMini] Account mini details
+      define_attribute :account, :AccountMini
+
+      # @!attribute activated_at
+      #   @return [DateTime] Activated at
+      define_attribute :activated_at, DateTime
+
+      # @!attribute active_invoice_id
+      #   @return [String] The invoice ID of the latest invoice created for an active subscription.
+      define_attribute :active_invoice_id, String
+
+      # @!attribute add_ons
+      #   @return [Array[SubscriptionAddOn]] Add-ons
+      define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }
+
+      # @!attribute add_ons_total
+      #   @return [Float] Total price of add-ons
+      define_attribute :add_ons_total, Float
+
+      # @!attribute auto_renew
+      #   @return [Boolean] Whether the subscription renews at the end of its term.
+      define_attribute :auto_renew, :Boolean
+
+      # @!attribute bank_account_authorized_at
+      #   @return [DateTime] Recurring subscriptions paid with ACH will have this attribute set. This timestamp is used for alerting customers to reauthorize in 3 years in accordance with NACHA rules. If a subscription becomes inactive or the billing info is no longer a bank account, this timestamp is cleared.
+      define_attribute :bank_account_authorized_at, DateTime
+
+      # @!attribute billing_info_id
+      #   @return [String] Billing Info ID.
+      define_attribute :billing_info_id, String
+
+      # @!attribute canceled_at
+      #   @return [DateTime] Canceled at
+      define_attribute :canceled_at, DateTime
+
+      # @!attribute collection_method
+      #   @return [String] Collection method
+      define_attribute :collection_method, String
+
+      # @!attribute coupon_redemptions
+      #   @return [Array[CouponRedemptionMini]] Returns subscription level coupon redemptions that are tied to this subscription.
+      define_attribute :coupon_redemptions, Array, { :item_type => :CouponRedemptionMini }
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute current_period_ends_at
+      #   @return [DateTime] Current billing period ends at
+      define_attribute :current_period_ends_at, DateTime
+
+      # @!attribute current_period_started_at
+      #   @return [DateTime] Current billing period started at
+      define_attribute :current_period_started_at, DateTime
+
+      # @!attribute current_term_ends_at
+      #   @return [DateTime] When the term ends. This is calculated by a plan's interval and `total_billing_cycles` in a term. Subscription changes with a `timeframe=renewal` will be applied on this date.
+      define_attribute :current_term_ends_at, DateTime
+
+      # @!attribute current_term_started_at
+      #   @return [DateTime] The start date of the term when the first billing period starts. The subscription term is the length of time that a customer will be committed to a subscription. A term can span multiple billing periods.
+      define_attribute :current_term_started_at, DateTime
+
+      # @!attribute custom_fields
+      #   @return [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.
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
+      # @!attribute customer_notes
+      #   @return [String] Customer notes
+      define_attribute :customer_notes, String
+
+      # @!attribute expiration_reason
+      #   @return [String] Expiration reason
+      define_attribute :expiration_reason, String
+
+      # @!attribute expires_at
+      #   @return [DateTime] Expires at
+      define_attribute :expires_at, DateTime
+
+      # @!attribute gateway_code
+      #   @return [String] If present, this subscription's transactions will use the payment gateway with this code.
+      define_attribute :gateway_code, String
+
+      # @!attribute id
+      #   @return [String] Subscription ID
+      define_attribute :id, String
+
+      # @!attribute net_terms
+      #   @return [Integer] 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.
+      define_attribute :net_terms, Integer
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute paused_at
+      #   @return [DateTime] Null unless subscription is paused or will pause at the end of the current billing period.
+      define_attribute :paused_at, DateTime
+
+      # @!attribute pending_change
+      #   @return [SubscriptionChange] Subscription Change
+      define_attribute :pending_change, :SubscriptionChange
+
+      # @!attribute plan
+      #   @return [PlanMini] Just the important parts.
+      define_attribute :plan, :PlanMini
+
+      # @!attribute po_number
+      #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
+      define_attribute :po_number, String
+
+      # @!attribute quantity
+      #   @return [Integer] Subscription quantity
+      define_attribute :quantity, Integer
+
+      # @!attribute remaining_billing_cycles
+      #   @return [Integer] The remaining billing cycles in the current term.
+      define_attribute :remaining_billing_cycles, Integer
+
+      # @!attribute remaining_pause_cycles
+      #   @return [Integer] Null unless subscription is paused or will pause at the end of the current billing period.
+      define_attribute :remaining_pause_cycles, Integer
+
+      # @!attribute renewal_billing_cycles
+      #   @return [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`.
+      define_attribute :renewal_billing_cycles, Integer
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute shipping
+      #   @return [SubscriptionShipping] Subscription shipping details
+      define_attribute :shipping, :SubscriptionShipping
+
+      # @!attribute state
+      #   @return [String] State
+      define_attribute :state, String
+
+      # @!attribute subtotal
+      #   @return [Float] Estimated total, before tax.
+      define_attribute :subtotal, Float
+
+      # @!attribute tax
+      #   @return [Float] Estimated tax
+      define_attribute :tax, Float
+
+      # @!attribute tax_info
+      #   @return [TaxInfo] Tax info
+      define_attribute :tax_info, :TaxInfo
+
+      # @!attribute terms_and_conditions
+      #   @return [String] Terms and conditions
+      define_attribute :terms_and_conditions, String
+
+      # @!attribute total
+      #   @return [Float] Estimated total
+      define_attribute :total, Float
+
+      # @!attribute total_billing_cycles
+      #   @return [Integer] The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
+      define_attribute :total_billing_cycles, Integer
+
+      # @!attribute trial_ends_at
+      #   @return [DateTime] Trial period ends at
+      define_attribute :trial_ends_at, DateTime
+
+      # @!attribute trial_started_at
+      #   @return [DateTime] Trial period started at
+      define_attribute :trial_started_at, DateTime
+
+      # @!attribute unit_amount
+      #   @return [Float] Subscription unit price
+      define_attribute :unit_amount, Float
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+
+      # @!attribute uuid
+      #   @return [String] The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
+      define_attribute :uuid, String
+    end
+  end
+end

data/lib/recurly/resources/subscription_add_on.rb

@@ -0,0 +1,78 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class SubscriptionAddOn < Resource
+
+      # @!attribute add_on
+      #   @return [AddOnMini] Just the important parts.
+      define_attribute :add_on, :AddOnMini
+
+      # @!attribute add_on_source
+      #   @return [String] Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
+      define_attribute :add_on_source, String
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute expired_at
+      #   @return [DateTime] Expired at
+      define_attribute :expired_at, DateTime
+
+      # @!attribute id
+      #   @return [String] Subscription Add-on ID
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute percentage_tiers
+      #   @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier.
+      define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
+
+      # @!attribute quantity
+      #   @return [Integer] Add-on quantity
+      define_attribute :quantity, Integer
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute subscription_id
+      #   @return [String] Subscription ID
+      define_attribute :subscription_id, String
+
+      # @!attribute tier_type
+      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+      define_attribute :tier_type, String
+
+      # @!attribute tiers
+      #   @return [Array[SubscriptionAddOnTier]] If tiers are provided in the request, all existing tiers on the Subscription Add-on will be removed and replaced by the tiers in the request. If add_on.tier_type is tiered or volume and add_on.usage_type is percentage use percentage_tiers instead.  There must be one tier without an `ending_quantity` value which represents the final tier.
+      define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
+
+      # @!attribute unit_amount
+      #   @return [Float] Supports up to 2 decimal places.
+      define_attribute :unit_amount, Float
+
+      # @!attribute unit_amount_decimal
+      #   @return [String] Supports up to 9 decimal places.
+      define_attribute :unit_amount_decimal, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] Updated at
+      define_attribute :updated_at, DateTime
+
+      # @!attribute usage_percentage
+      #   @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if add_on_type is usage and usage_type is percentage.
+      define_attribute :usage_percentage, Float
+
+      # @!attribute usage_timeframe
+      #   @return [String] The time at which usage totals are reset for billing purposes.
+      define_attribute :usage_timeframe, String
+    end
+  end
+end

data/lib/recurly/resources/subscription_add_on_percentage_tier.rb

@@ -0,0 +1,18 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class SubscriptionAddOnPercentageTier < Resource
+
+      # @!attribute ending_amount
+      #   @return [Float] Ending amount for the tier. Allows up to 2 decimal places. Must be left empty if it is the final tier.
+      define_attribute :ending_amount, Float
+
+      # @!attribute usage_percentage
+      #   @return [String] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places represented as a string.
+      define_attribute :usage_percentage, String
+    end
+  end
+end

data/lib/recurly/resources/subscription_add_on_tier.rb

@@ -0,0 +1,26 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class SubscriptionAddOnTier < Resource
+
+      # @!attribute ending_quantity
+      #   @return [Integer] Ending quantity for the tier.  This represents a unit amount for unit-priced add ons. Must be left empty if it is the final tier.
+      define_attribute :ending_quantity, Integer
+
+      # @!attribute unit_amount
+      #   @return [Float] Allows up to 2 decimal places. Optionally, override the tiers' default unit amount. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
+      define_attribute :unit_amount, Float
+
+      # @!attribute unit_amount_decimal
+      #   @return [String] Allows up to 9 decimal places.  Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
+      define_attribute :unit_amount_decimal, String
+
+      # @!attribute usage_percentage
+      #   @return [String] (deprecated) -- Use the percentage_tiers object instead.
+      define_attribute :usage_percentage, String
+    end
+  end
+end

data/lib/recurly/resources/subscription_change.rb

@@ -0,0 +1,82 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class SubscriptionChange < Resource
+
+      # @!attribute activate_at
+      #   @return [DateTime] Activated at
+      define_attribute :activate_at, DateTime
+
+      # @!attribute activated
+      #   @return [Boolean] Returns `true` if the subscription change is activated.
+      define_attribute :activated, :Boolean
+
+      # @!attribute add_ons
+      #   @return [Array[SubscriptionAddOn]] These add-ons will be used when the subscription renews.
+      define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }
+
+      # @!attribute billing_info
+      #   @return [SubscriptionChangeBillingInfo] Accept nested attributes for three_d_secure_action_result_token_id
+      define_attribute :billing_info, :SubscriptionChangeBillingInfo
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute custom_fields
+      #   @return [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.
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
+      # @!attribute deleted_at
+      #   @return [DateTime] Deleted at
+      define_attribute :deleted_at, DateTime
+
+      # @!attribute id
+      #   @return [String] The ID of the Subscription Change.
+      define_attribute :id, String
+
+      # @!attribute invoice_collection
+      #   @return [InvoiceCollection] Invoice Collection
+      define_attribute :invoice_collection, :InvoiceCollection
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute plan
+      #   @return [PlanMini] Just the important parts.
+      define_attribute :plan, :PlanMini
+
+      # @!attribute quantity
+      #   @return [Integer] Subscription quantity
+      define_attribute :quantity, Integer
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute shipping
+      #   @return [SubscriptionShipping] Subscription shipping details
+      define_attribute :shipping, :SubscriptionShipping
+
+      # @!attribute subscription_id
+      #   @return [String] The ID of the subscription that is going to be changed.
+      define_attribute :subscription_id, String
+
+      # @!attribute tax_inclusive
+      #   @return [Boolean] This field is deprecated. Please do not use it.
+      define_attribute :tax_inclusive, :Boolean
+
+      # @!attribute unit_amount
+      #   @return [Float] Unit amount
+      define_attribute :unit_amount, Float
+
+      # @!attribute updated_at
+      #   @return [DateTime] Updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/subscription_change_billing_info.rb

@@ -0,0 +1,14 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class SubscriptionChangeBillingInfo < Resource
+
+      # @!attribute three_d_secure_action_result_token_id
+      #   @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
+      define_attribute :three_d_secure_action_result_token_id, String
+    end
+  end
+end

data/lib/recurly/resources/subscription_shipping.rb

@@ -0,0 +1,26 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class SubscriptionShipping < Resource
+
+      # @!attribute address
+      #   @return [ShippingAddress]
+      define_attribute :address, :ShippingAddress
+
+      # @!attribute amount
+      #   @return [Float] Subscription's shipping cost
+      define_attribute :amount, Float
+
+      # @!attribute method
+      #   @return [ShippingMethodMini]
+      define_attribute :method, :ShippingMethodMini
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+    end
+  end
+end