recurly 2.17.0 → 3.14.0

data/lib/recurly/requests/shipping_address_create.rb

@@ -0,0 +1,62 @@
+# 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 Requests
+    class ShippingAddressCreate < Request
+
+      # @!attribute city
+      #   @return [String]
+      define_attribute :city, String
+
+      # @!attribute company
+      #   @return [String]
+      define_attribute :company, String
+
+      # @!attribute country
+      #   @return [String] Country, 2-letter ISO code.
+      define_attribute :country, String
+
+      # @!attribute email
+      #   @return [String]
+      define_attribute :email, String
+
+      # @!attribute first_name
+      #   @return [String]
+      define_attribute :first_name, String
+
+      # @!attribute last_name
+      #   @return [String]
+      define_attribute :last_name, String
+
+      # @!attribute nickname
+      #   @return [String]
+      define_attribute :nickname, 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 vat_number
+      #   @return [String]
+      define_attribute :vat_number, String
+    end
+  end
+end

data/lib/recurly/requests/shipping_address_update.rb

@@ -0,0 +1,66 @@
+# 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 Requests
+    class ShippingAddressUpdate < Request
+
+      # @!attribute city
+      #   @return [String]
+      define_attribute :city, String
+
+      # @!attribute company
+      #   @return [String]
+      define_attribute :company, String
+
+      # @!attribute country
+      #   @return [String] Country, 2-letter ISO code.
+      define_attribute :country, String
+
+      # @!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 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 vat_number
+      #   @return [String]
+      define_attribute :vat_number, String
+    end
+  end
+end

data/lib/recurly/requests/shipping_fee_create.rb

@@ -0,0 +1,22 @@
+# 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 Requests
+    class ShippingFeeCreate < Request
+
+      # @!attribute amount
+      #   @return [Float] This is priced in the purchase's currency.
+      define_attribute :amount, Float
+
+      # @!attribute method_code
+      #   @return [String] The code of the shipping method used to deliver the purchase. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_code, String
+
+      # @!attribute method_id
+      #   @return [String] The id of the shipping method used to deliver the purchase. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_id, String
+    end
+  end
+end

data/lib/recurly/requests/shipping_method_create.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 Requests
+    class ShippingMethodCreate < Request
+
+      # @!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 name
+      #   @return [String] The name of the shipping method displayed to customers.
+      define_attribute :name, 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
+    end
+  end
+end

data/lib/recurly/requests/shipping_method_update.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 Requests
+    class ShippingMethodUpdate < Request
+
+      # @!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 name
+      #   @return [String] The name of the shipping method displayed to customers.
+      define_attribute :name, 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
+    end
+  end
+end

data/lib/recurly/requests/shipping_purchase.rb

@@ -0,0 +1,22 @@
+# 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 Requests
+    class ShippingPurchase < Request
+
+      # @!attribute address
+      #   @return [ShippingAddressCreate]
+      define_attribute :address, :ShippingAddressCreate
+
+      # @!attribute address_id
+      #   @return [String] Assign a shipping address from the account's existing shipping addresses. If this and `address` are both present, `address` will take precedence.
+      define_attribute :address_id, String
+
+      # @!attribute fees
+      #   @return [Array[ShippingFeeCreate]] A list of shipping fees to be created as charges with the purchase.
+      define_attribute :fees, Array, { :item_type => :ShippingFeeCreate }
+    end
+  end
+end

data/lib/recurly/requests/subscription_add_on_create.rb

@@ -0,0 +1,38 @@
+# 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 Requests
+    class SubscriptionAddOnCreate < Request
+
+      # @!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 code
+      #   @return [String] If `add_on_source` is set to `plan_add_on` or left blank, then plan's add-on `code` should be used. If `add_on_source` is set to `item`, then the `code` from the associated item should be used.
+      define_attribute :code, String
+
+      # @!attribute quantity
+      #   @return [Integer] Quantity
+      define_attribute :quantity, Integer
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute tiers
+      #   @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier with an `ending_quantity` of 999999999 which is the default if not provided. 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 :tiers, Array, { :item_type => :SubscriptionAddOnTier }
+
+      # @!attribute unit_amount
+      #   @return [Float] * Optionally, override the add-on's default unit amount. * If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount` must be absent.
+      define_attribute :unit_amount, Float
+
+      # @!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. Must be omitted otherwise. `usage_percentage` does not support tiers. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
+      define_attribute :usage_percentage, Float
+    end
+  end
+end

data/lib/recurly/requests/subscription_add_on_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 Requests
+    class SubscriptionAddOnTier < Request
+
+      # @!attribute ending_quantity
+      #   @return [Integer] Ending quantity
+      define_attribute :ending_quantity, Integer
+
+      # @!attribute unit_amount
+      #   @return [Float] Unit amount
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/subscription_add_on_update.rb

@@ -0,0 +1,42 @@
+# 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 Requests
+    class SubscriptionAddOnUpdate < Request
+
+      # @!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 code
+      #   @return [String] If a code is provided without an id, the subscription add-on attributes will be set to the current value for those attributes on the plan add-on unless provided in the request. If `add_on_source` is set to `plan_add_on` or left blank, then plan's add-on `code` should be used. If `add_on_source` is set to `item`, then the `code` from the associated item should be used.
+      define_attribute :code, String
+
+      # @!attribute id
+      #   @return [String] When an id is provided, the existing subscription add-on attributes will persist unless overridden in the request.
+      define_attribute :id, String
+
+      # @!attribute quantity
+      #   @return [Integer] Quantity
+      define_attribute :quantity, Integer
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute tiers
+      #   @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier with an `ending_quantity` of 999999999 which is the default if not provided.
+      define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
+
+      # @!attribute unit_amount
+      #   @return [Float] Optionally, override the add-on's default unit amount.
+      define_attribute :unit_amount, Float
+
+      # @!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
+    end
+  end
+end

data/lib/recurly/requests/subscription_cancel.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 Requests
+    class SubscriptionCancel < Request
+
+      # @!attribute timeframe
+      #   @return [String] The timeframe parameter controls when the expiration takes place. The `bill_date` timeframe causes the subscription to expire when the subscription is scheduled to bill next. The `term_end` timeframe causes the subscription to continue to bill until the end of the subscription term, then expire.
+      define_attribute :timeframe, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_change_create.rb

@@ -0,0 +1,66 @@
+# 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 Requests
+    class SubscriptionChangeCreate < Request
+
+      # @!attribute add_ons
+      #   @return [Array[SubscriptionAddOnUpdate]] If this value is omitted your existing add-ons will be removed. 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: `{"id": "abc123"}`.  If a subscription add-on's `code` is supplied without the `id`, `{"code": "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
+      define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnUpdate }
+
+      # @!attribute collection_method
+      #   @return [String] Collection method
+      define_attribute :collection_method, String
+
+      # @!attribute coupon_codes
+      #   @return [Array[String]] 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.
+      define_attribute :coupon_codes, Array, { :item_type => String }
+
+      # @!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 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 plan_code
+      #   @return [String] 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.
+      define_attribute :plan_code, String
+
+      # @!attribute plan_id
+      #   @return [String] 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.
+      define_attribute :plan_id, String
+
+      # @!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] Optionally override the default quantity of 1.
+      define_attribute :quantity, Integer
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute shipping
+      #   @return [SubscriptionChangeShippingCreate] The shipping address can currently only be changed immediately, using SubscriptionUpdate.
+      define_attribute :shipping, :SubscriptionChangeShippingCreate
+
+      # @!attribute timeframe
+      #   @return [String] 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`.
+      define_attribute :timeframe, String
+
+      # @!attribute transaction_type
+      #   @return [String] 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.
+      define_attribute :transaction_type, String
+
+      # @!attribute unit_amount
+      #   @return [Float] Optionally, sets custom pricing for the subscription, overriding the plan's default unit amount. The subscription's current currency will be used.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/subscription_change_shipping_create.rb

@@ -0,0 +1,22 @@
+# 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 Requests
+    class SubscriptionChangeShippingCreate < Request
+
+      # @!attribute amount
+      #   @return [Float] Assigns the subscription's shipping cost. If this is greater than zero then a `method_id` or `method_code` is required.
+      define_attribute :amount, Float
+
+      # @!attribute method_code
+      #   @return [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.
+      define_attribute :method_code, String
+
+      # @!attribute method_id
+      #   @return [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.
+      define_attribute :method_id, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_create.rb

@@ -0,0 +1,106 @@
+# 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 Requests
+    class SubscriptionCreate < Request
+
+      # @!attribute account
+      #   @return [AccountCreate]
+      define_attribute :account, :AccountCreate
+
+      # @!attribute add_ons
+      #   @return [Array[SubscriptionAddOnCreate]] Add-ons
+      define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnCreate }
+
+      # @!attribute auto_renew
+      #   @return [Boolean] Whether the subscription renews at the end of its term.
+      define_attribute :auto_renew, :Boolean
+
+      # @!attribute collection_method
+      #   @return [String] Collection method
+      define_attribute :collection_method, String
+
+      # @!attribute coupon_code
+      #   @return [String] Optional coupon code to redeem on the account and discount the subscription. Please note, the subscription request will fail if the coupon is invalid.
+      define_attribute :coupon_code, String
+
+      # @!attribute credit_customer_notes
+      #   @return [String] If there are pending credits on the account that will be invoiced during the subscription creation, these will be used as the Customer Notes on the credit invoice.
+      define_attribute :credit_customer_notes, String
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!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] This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.
+      define_attribute :customer_notes, 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 next_bill_date
+      #   @return [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. The initial invoice will be prorated for the period between the subscription's activation date and the billing period end date. Subsequent periods will be based off the plan interval. For a subscription with a trial period, this will change when the trial expires.
+      define_attribute :next_bill_date, DateTime
+
+      # @!attribute plan_code
+      #   @return [String] You must provide either a `plan_code` or `plan_id`. If both are provided the `plan_id` will be used.
+      define_attribute :plan_code, String
+
+      # @!attribute plan_id
+      #   @return [String] You must provide either a `plan_code` or `plan_id`. If both are provided the `plan_id` will be used.
+      define_attribute :plan_id, String
+
+      # @!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] Optionally override the default quantity of 1.
+      define_attribute :quantity, 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 [SubscriptionShippingCreate] Create a shipping address on the account and assign it to the subscription.
+      define_attribute :shipping, :SubscriptionShippingCreate
+
+      # @!attribute starts_at
+      #   @return [DateTime] If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
+      define_attribute :starts_at, DateTime
+
+      # @!attribute terms_and_conditions
+      #   @return [String] This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.
+      define_attribute :terms_and_conditions, String
+
+      # @!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 transaction_type
+      #   @return [String] 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.
+      define_attribute :transaction_type, String
+
+      # @!attribute trial_ends_at
+      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. The date must be in the future.
+      define_attribute :trial_ends_at, DateTime
+
+      # @!attribute unit_amount
+      #   @return [Float] Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/subscription_pause.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 Requests
+    class SubscriptionPause < Request
+
+      # @!attribute remaining_pause_cycles
+      #   @return [Integer] Number of billing cycles to pause the subscriptions.
+      define_attribute :remaining_pause_cycles, Integer
+    end
+  end
+end

data/lib/recurly/requests/subscription_purchase.rb

@@ -0,0 +1,66 @@
+# 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 Requests
+    class SubscriptionPurchase < Request
+
+      # @!attribute add_ons
+      #   @return [Array[SubscriptionAddOnCreate]] Add-ons
+      define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnCreate }
+
+      # @!attribute auto_renew
+      #   @return [Boolean] Whether the subscription renews at the end of its term.
+      define_attribute :auto_renew, :Boolean
+
+      # @!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 next_bill_date
+      #   @return [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. The initial invoice will be prorated for the period between the subscription's activation date and the billing period end date. Subsequent periods will be based off the plan interval. For a subscription with a trial period, this will change when the trial expires.
+      define_attribute :next_bill_date, DateTime
+
+      # @!attribute plan_code
+      #   @return [String] Plan code
+      define_attribute :plan_code, String
+
+      # @!attribute plan_id
+      #   @return [String] Plan ID
+      define_attribute :plan_id, String
+
+      # @!attribute quantity
+      #   @return [Integer] Optionally override the default quantity of 1.
+      define_attribute :quantity, 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 [SubscriptionShippingPurchase] Create a shipping address on the account and assign it to the subscription.
+      define_attribute :shipping, :SubscriptionShippingPurchase
+
+      # @!attribute starts_at
+      #   @return [DateTime] If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
+      define_attribute :starts_at, DateTime
+
+      # @!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] If set, overrides the default trial behavior for the subscription. The date must be in the future.
+      define_attribute :trial_ends_at, DateTime
+
+      # @!attribute unit_amount
+      #   @return [Float] Override the unit amount of the subscription plan by setting this value in cents. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/subscription_shipping_create.rb

@@ -0,0 +1,30 @@
+# 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 Requests
+    class SubscriptionShippingCreate < Request
+
+      # @!attribute address
+      #   @return [ShippingAddressCreate]
+      define_attribute :address, :ShippingAddressCreate
+
+      # @!attribute address_id
+      #   @return [String] Assign a shipping address from the account's existing shipping addresses. If `address_id` and `address` are both present, `address` will be used.
+      define_attribute :address_id, String
+
+      # @!attribute amount
+      #   @return [Float] Assigns the subscription's shipping cost. If this is greater than zero then a `method_id` or `method_code` is required.
+      define_attribute :amount, Float
+
+      # @!attribute method_code
+      #   @return [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.
+      define_attribute :method_code, String
+
+      # @!attribute method_id
+      #   @return [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.
+      define_attribute :method_id, String
+    end
+  end
+end