recurly 2.17.0 → 3.14.0

data/lib/recurly/requests/invoice_updatable.rb

@@ -0,0 +1,34 @@
+# 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 InvoiceUpdatable < Request
+
+      # @!attribute address
+      #   @return [InvoiceAddress]
+      define_attribute :address, :InvoiceAddress
+
+      # @!attribute customer_notes
+      #   @return [String] Customer notes are an optional note field.
+      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. Changing Net terms changes due_on, and the invoice could move between past due and pending.
+      define_attribute :net_terms, Integer
+
+      # @!attribute po_number
+      #   @return [String] This identifies the PO number associated with the invoice. Not editable for credit invoices.
+      define_attribute :po_number, String
+
+      # @!attribute terms_and_conditions
+      #   @return [String] Terms and conditions are an optional note field. Not editable for credit invoices.
+      define_attribute :terms_and_conditions, String
+
+      # @!attribute vat_reverse_charge_notes
+      #   @return [String] VAT Reverse Charge Notes are editable only if there was a VAT reverse charge applied to the invoice.
+      define_attribute :vat_reverse_charge_notes, String
+    end
+  end
+end

data/lib/recurly/requests/item_create.rb

@@ -0,0 +1,58 @@
+# 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 ItemCreate < Request
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for invoice line items.
+      define_attribute :accounting_code, String
+
+      # @!attribute avalara_service_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
+      define_attribute :avalara_service_type, Integer
+
+      # @!attribute avalara_transaction_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
+      define_attribute :avalara_transaction_type, Integer
+
+      # @!attribute code
+      #   @return [String] Unique code to identify the item.
+      define_attribute :code, String
+
+      # @!attribute currencies
+      #   @return [Array[Pricing]] Item Pricing
+      define_attribute :currencies, Array, { :item_type => :Pricing }
+
+      # @!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 description
+      #   @return [String] Optional, description.
+      define_attribute :description, String
+
+      # @!attribute external_sku
+      #   @return [String] Optional, stock keeping unit to link the item to other inventory systems.
+      define_attribute :external_sku, String
+
+      # @!attribute name
+      #   @return [String] This name describes your item and will appear on the invoice when it's purchased on a one time basis.
+      define_attribute :name, String
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute tax_code
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+      define_attribute :tax_code, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] `true` exempts tax on the item, `false` applies tax on the item.
+      define_attribute :tax_exempt, :Boolean
+    end
+  end
+end

data/lib/recurly/requests/item_update.rb

@@ -0,0 +1,58 @@
+# 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 ItemUpdate < Request
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for invoice line items.
+      define_attribute :accounting_code, String
+
+      # @!attribute avalara_service_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
+      define_attribute :avalara_service_type, Integer
+
+      # @!attribute avalara_transaction_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
+      define_attribute :avalara_transaction_type, Integer
+
+      # @!attribute code
+      #   @return [String] Unique code to identify the item.
+      define_attribute :code, String
+
+      # @!attribute currencies
+      #   @return [Array[Pricing]] Item Pricing
+      define_attribute :currencies, Array, { :item_type => :Pricing }
+
+      # @!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 description
+      #   @return [String] Optional, description.
+      define_attribute :description, String
+
+      # @!attribute external_sku
+      #   @return [String] Optional, stock keeping unit to link the item to other inventory systems.
+      define_attribute :external_sku, String
+
+      # @!attribute name
+      #   @return [String] This name describes your item and will appear on the invoice when it's purchased on a one time basis.
+      define_attribute :name, String
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute tax_code
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+      define_attribute :tax_code, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] `true` exempts tax on the item, `false` applies tax on the item.
+      define_attribute :tax_exempt, :Boolean
+    end
+  end
+end

data/lib/recurly/requests/line_item_create.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 Requests
+    class LineItemCreate < Request
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting Code for the `LineItem`. If `item_code`/`item_id` is part of the request then `accounting_code` must be absent.
+      define_attribute :accounting_code, String
+
+      # @!attribute avalara_service_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the line item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types. If an `Item` is associated to the `LineItem`, then the `avalara_service_type` must be absent.
+      define_attribute :avalara_service_type, Integer
+
+      # @!attribute avalara_transaction_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the line item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types. If an `Item` is associated to the `LineItem`, then the `avalara_transaction_type` must be absent.
+      define_attribute :avalara_transaction_type, Integer
+
+      # @!attribute credit_reason_code
+      #   @return [String] The reason the credit was given when line item is `type=credit`. When the Credit Invoices feature is enabled, the value can be set and will default to `general`. When the Credit Invoices feature is not enabled, the value will always be `null`.
+      define_attribute :credit_reason_code, String
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code. If `item_code`/`item_id` is part of the request then `currency` is optional, if the site has a single default currency. `currency` is required if `item_code`/`item_id` is present, and there are multiple currencies defined on the site. If `item_code`/`item_id` is not present `currency` is required.
+      define_attribute :currency, String
+
+      # @!attribute description
+      #   @return [String] Description that appears on the invoice. If `item_code`/`item_id` is part of the request then `description` must be absent.
+      define_attribute :description, String
+
+      # @!attribute end_date
+      #   @return [DateTime] If this date is provided, it indicates the end of a time range.
+      define_attribute :end_date, DateTime
+
+      # @!attribute item_code
+      #   @return [String] Unique code to identify an item. Avaliable when the Credit Invoices and Subscription Billing Terms features are enabled.
+      define_attribute :item_code, String
+
+      # @!attribute item_id
+      #   @return [String] System-generated unique identifier for an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
+      define_attribute :item_id, String
+
+      # @!attribute origin
+      #   @return [String] Origin `external_gift_card` is allowed if the Gift Cards feature is enabled on your site and `type` is `credit`. Set this value in order to track gift card credits from external gift cards (like InComm). It also skips billing information requirements.  Origin `prepayment` is only allowed if `type` is `charge` and `tax_exempt` is left blank or set to true.  This origin creates a charge and opposite credit on the account to be used for future invoices.
+      define_attribute :origin, String
+
+      # @!attribute product_code
+      #   @return [String] Optional field to track a product code or SKU for the line item. This can be used to later reporting on product purchases. For Vertex tax calculations, this field will be used as the Vertex `product` field. If `item_code`/`item_id` is part of the request then `product_code` must be absent.
+      define_attribute :product_code, String
+
+      # @!attribute quantity
+      #   @return [Integer] This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
+      define_attribute :quantity, Integer
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute start_date
+      #   @return [DateTime] If an end date is present, this is value indicates the beginning of a billing time range. If no end date is present it indicates billing for a specific date. Defaults to the current date-time.
+      define_attribute :start_date, DateTime
+
+      # @!attribute tax_code
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
+      define_attribute :tax_code, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] `true` exempts tax on charges, `false` applies tax on charges. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative line items). Credits are always applied post-tax. Pre-tax discounts should use the Coupons feature.
+      define_attribute :tax_exempt, :Boolean
+
+      # @!attribute type
+      #   @return [String] Line item type. If `item_code`/`item_id` is present then `type` should not be present. If `item_code`/`item_id` is not present then `type` is required.
+      define_attribute :type, String
+
+      # @!attribute unit_amount
+      #   @return [Float] A positive or negative amount with `type=charge` will result in a positive `unit_amount`. A positive or negative amount with `type=credit` will result in a negative `unit_amount`. If `item_code`/`item_id` is present, `unit_amount` can be passed in, to override the `Item`'s `unit_amount`. If `item_code`/`item_id` is not present then `unit_amount` is required.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/line_item_refund.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 LineItemRefund < Request
+
+      # @!attribute id
+      #   @return [String] Line item ID
+      define_attribute :id, String
+
+      # @!attribute prorate
+      #   @return [Boolean] Set to `true` if the line item should be prorated; set to `false` if not. This can only be used on line items that have a start and end date.
+      define_attribute :prorate, :Boolean
+
+      # @!attribute quantity
+      #   @return [Integer] Line item quantity to be refunded.
+      define_attribute :quantity, Integer
+    end
+  end
+end

data/lib/recurly/requests/measured_unit_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 MeasuredUnitCreate < Request
+
+      # @!attribute description
+      #   @return [String] Optional internal description.
+      define_attribute :description, String
+
+      # @!attribute display_name
+      #   @return [String] Display name for the measured unit.
+      define_attribute :display_name, String
+
+      # @!attribute name
+      #   @return [String] Unique internal name of the measured unit on your site.
+      define_attribute :name, String
+    end
+  end
+end

data/lib/recurly/requests/measured_unit_update.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 MeasuredUnitUpdate < Request
+
+      # @!attribute description
+      #   @return [String] Optional internal description.
+      define_attribute :description, String
+
+      # @!attribute display_name
+      #   @return [String] Display name for the measured unit.
+      define_attribute :display_name, String
+
+      # @!attribute name
+      #   @return [String] Unique internal name of the measured unit on your site.
+      define_attribute :name, String
+    end
+  end
+end

data/lib/recurly/requests/plan_create.rb

@@ -0,0 +1,98 @@
+# 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 PlanCreate < Request
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for invoice line items for the plan. If no value is provided, it defaults to plan's code.
+      define_attribute :accounting_code, String
+
+      # @!attribute add_ons
+      #   @return [Array[AddOnCreate]] Add Ons
+      define_attribute :add_ons, Array, { :item_type => :AddOnCreate }
+
+      # @!attribute allow_any_item_on_subscriptions
+      #   @return [Boolean] Used to determine whether items can be assigned as add-ons to individual subscriptions. If `true`, items can be assigned as add-ons to individual subscription add-ons. If `false`, only plan add-ons can be used.
+      define_attribute :allow_any_item_on_subscriptions, :Boolean
+
+      # @!attribute auto_renew
+      #   @return [Boolean] Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
+      define_attribute :auto_renew, :Boolean
+
+      # @!attribute avalara_service_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
+      define_attribute :avalara_service_type, Integer
+
+      # @!attribute avalara_transaction_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
+      define_attribute :avalara_transaction_type, Integer
+
+      # @!attribute code
+      #   @return [String] Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.
+      define_attribute :code, String
+
+      # @!attribute currencies
+      #   @return [Array[PlanPricing]] Pricing
+      define_attribute :currencies, Array, { :item_type => :PlanPricing }
+
+      # @!attribute description
+      #   @return [String] Optional description, not displayed.
+      define_attribute :description, String
+
+      # @!attribute hosted_pages
+      #   @return [PlanHostedPages] Hosted pages settings
+      define_attribute :hosted_pages, :PlanHostedPages
+
+      # @!attribute interval_length
+      #   @return [Integer] Length of the plan's billing interval in `interval_unit`.
+      define_attribute :interval_length, Integer
+
+      # @!attribute interval_unit
+      #   @return [String] Unit for the plan's billing interval.
+      define_attribute :interval_unit, String
+
+      # @!attribute name
+      #   @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
+      define_attribute :name, String
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute setup_fee_accounting_code
+      #   @return [String] Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.
+      define_attribute :setup_fee_accounting_code, String
+
+      # @!attribute setup_fee_revenue_schedule_type
+      #   @return [String] Setup fee revenue schedule type
+      define_attribute :setup_fee_revenue_schedule_type, String
+
+      # @!attribute tax_code
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
+      define_attribute :tax_code, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] `true` exempts tax on the plan, `false` applies tax on the plan.
+      define_attribute :tax_exempt, :Boolean
+
+      # @!attribute total_billing_cycles
+      #   @return [Integer] Automatically terminate plans after a defined number of billing cycles.
+      define_attribute :total_billing_cycles, Integer
+
+      # @!attribute trial_length
+      #   @return [Integer] Length of plan's trial period in `trial_units`. `0` means `no trial`.
+      define_attribute :trial_length, Integer
+
+      # @!attribute trial_requires_billing_info
+      #   @return [Boolean] Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.
+      define_attribute :trial_requires_billing_info, :Boolean
+
+      # @!attribute trial_unit
+      #   @return [String] Units for the plan's trial period.
+      define_attribute :trial_unit, String
+    end
+  end
+end

data/lib/recurly/requests/plan_hosted_pages.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 PlanHostedPages < Request
+
+      # @!attribute bypass_confirmation
+      #   @return [Boolean] If `true`, the customer will be sent directly to your `success_url` after a successful signup, bypassing Recurly's hosted confirmation page.
+      define_attribute :bypass_confirmation, :Boolean
+
+      # @!attribute cancel_url
+      #   @return [String] URL to redirect to on canceled signup on the hosted payment pages.
+      define_attribute :cancel_url, String
+
+      # @!attribute display_quantity
+      #   @return [Boolean] Determines if the quantity field is displayed on the hosted pages for the plan.
+      define_attribute :display_quantity, :Boolean
+
+      # @!attribute success_url
+      #   @return [String] URL to redirect to after signup on the hosted payment pages.
+      define_attribute :success_url, String
+    end
+  end
+end

data/lib/recurly/requests/plan_pricing.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 PlanPricing < Request
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute setup_fee
+      #   @return [Float] Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.
+      define_attribute :setup_fee, Float
+
+      # @!attribute unit_amount
+      #   @return [Float] Unit price
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/plan_update.rb

@@ -0,0 +1,94 @@
+# 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 PlanUpdate < Request
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for invoice line items for the plan. If no value is provided, it defaults to plan's code.
+      define_attribute :accounting_code, String
+
+      # @!attribute add_ons
+      #   @return [Array[AddOnCreate]] Add Ons
+      define_attribute :add_ons, Array, { :item_type => :AddOnCreate }
+
+      # @!attribute allow_any_item_on_subscriptions
+      #   @return [Boolean] Used to determine whether items can be assigned as add-ons to individual subscriptions. If `true`, items can be assigned as add-ons to individual subscription add-ons. If `false`, only plan add-ons can be used.
+      define_attribute :allow_any_item_on_subscriptions, :Boolean
+
+      # @!attribute auto_renew
+      #   @return [Boolean] Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
+      define_attribute :auto_renew, :Boolean
+
+      # @!attribute avalara_service_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
+      define_attribute :avalara_service_type, Integer
+
+      # @!attribute avalara_transaction_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
+      define_attribute :avalara_transaction_type, Integer
+
+      # @!attribute code
+      #   @return [String] Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.
+      define_attribute :code, String
+
+      # @!attribute currencies
+      #   @return [Array[PlanPricing]] Pricing
+      define_attribute :currencies, Array, { :item_type => :PlanPricing }
+
+      # @!attribute description
+      #   @return [String] Optional description, not displayed.
+      define_attribute :description, String
+
+      # @!attribute hosted_pages
+      #   @return [PlanHostedPages] Hosted pages settings
+      define_attribute :hosted_pages, :PlanHostedPages
+
+      # @!attribute id
+      #   @return [String] Plan ID
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
+      define_attribute :name, String
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute setup_fee_accounting_code
+      #   @return [String] Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.
+      define_attribute :setup_fee_accounting_code, String
+
+      # @!attribute setup_fee_revenue_schedule_type
+      #   @return [String] Setup fee revenue schedule type
+      define_attribute :setup_fee_revenue_schedule_type, String
+
+      # @!attribute tax_code
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
+      define_attribute :tax_code, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] `true` exempts tax on the plan, `false` applies tax on the plan.
+      define_attribute :tax_exempt, :Boolean
+
+      # @!attribute total_billing_cycles
+      #   @return [Integer] Automatically terminate plans after a defined number of billing cycles.
+      define_attribute :total_billing_cycles, Integer
+
+      # @!attribute trial_length
+      #   @return [Integer] Length of plan's trial period in `trial_units`. `0` means `no trial`.
+      define_attribute :trial_length, Integer
+
+      # @!attribute trial_requires_billing_info
+      #   @return [Boolean] Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.
+      define_attribute :trial_requires_billing_info, :Boolean
+
+      # @!attribute trial_unit
+      #   @return [String] Units for the plan's trial period.
+      define_attribute :trial_unit, String
+    end
+  end
+end

data/lib/recurly/requests/pricing.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 Pricing < Request
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute unit_amount
+      #   @return [Float] Unit price
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/purchase_create.rb

@@ -0,0 +1,74 @@
+# 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 PurchaseCreate < Request
+
+      # @!attribute account
+      #   @return [AccountPurchase]
+      define_attribute :account, :AccountPurchase
+
+      # @!attribute collection_method
+      #   @return [String] Must be set to manual in order to preview a purchase for an Account that does not have payment information associated with the Billing Info.
+      define_attribute :collection_method, String
+
+      # @!attribute coupon_codes
+      #   @return [Array[String]] A list of coupon_codes to be redeemed on the subscription or account during the purchase.
+      define_attribute :coupon_codes, Array, { :item_type => String }
+
+      # @!attribute credit_customer_notes
+      #   @return [String] Notes to be put on the credit invoice resulting from credits in the purchase, if any.
+      define_attribute :credit_customer_notes, String
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute customer_notes
+      #   @return [String] Customer notes
+      define_attribute :customer_notes, String
+
+      # @!attribute gateway_code
+      #   @return [String] The default payment gateway identifier to be used for the purchase transaction.  This will also be applied as the default for any subscriptions included in the purchase request.
+      define_attribute :gateway_code, String
+
+      # @!attribute gift_card_redemption_code
+      #   @return [String] A gift card redemption code to be redeemed on the purchase invoice.
+      define_attribute :gift_card_redemption_code, String
+
+      # @!attribute line_items
+      #   @return [Array[LineItemCreate]] A list of one time charges or credits to be created with the purchase.
+      define_attribute :line_items, Array, { :item_type => :LineItemCreate }
+
+      # @!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 po_number
+      #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
+      define_attribute :po_number, String
+
+      # @!attribute shipping
+      #   @return [ShippingPurchase]
+      define_attribute :shipping, :ShippingPurchase
+
+      # @!attribute subscriptions
+      #   @return [Array[SubscriptionPurchase]] A list of subscriptions to be created with the purchase.
+      define_attribute :subscriptions, Array, { :item_type => :SubscriptionPurchase }
+
+      # @!attribute terms_and_conditions
+      #   @return [String] Terms and conditions to be put on the purchase invoice.
+      define_attribute :terms_and_conditions, 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 vat_reverse_charge_notes
+      #   @return [String] VAT reverse charge notes for cross border European tax settlement.
+      define_attribute :vat_reverse_charge_notes, String
+    end
+  end
+end