recurly 2.20.0 → 3.0.0.beta.1

data/lib/recurly/requests/billing_info_create.rb

@@ -0,0 +1,58 @@
+module Recurly
+  module Requests
+    class BillingInfoCreate < Request
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute amazon_billing_agreement_id
+      #   @return [String] Amazon billing agreement ID
+      define_attribute :amazon_billing_agreement_id, String
+
+      # @!attribute company
+      #   @return [String] Company name
+      define_attribute :company, String
+
+      # @!attribute cvv
+      #   @return [String] *STRONGLY RECOMMENDED*
+      define_attribute :cvv, String
+
+      # @!attribute first_name
+      #   @return [String] First name
+      define_attribute :first_name, String
+
+      # @!attribute ip_address
+      #   @return [String] *STRONGLY RECOMMENDED* Customer's IP address when updating their billing information.
+      define_attribute :ip_address, String
+
+      # @!attribute last_name
+      #   @return [String] Last name
+      define_attribute :last_name, String
+
+      # @!attribute month
+      #   @return [String] Expiration month
+      define_attribute :month, String
+
+      # @!attribute number
+      #   @return [String] Credit card number, spaces and dashes are accepted.
+      define_attribute :number, String
+
+      # @!attribute paypal_billing_agreement_id
+      #   @return [String] PayPal billing agreement ID
+      define_attribute :paypal_billing_agreement_id, String
+
+      # @!attribute token_id
+      #   @return [String] A token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token).
+      define_attribute :token_id, String
+
+      # @!attribute vat_number
+      #   @return [String] VAT number
+      define_attribute :vat_number, String
+
+      # @!attribute year
+      #   @return [String] Expiration year
+      define_attribute :year, String
+    end
+  end
+end

data/lib/recurly/requests/coupon_create_only.rb

@@ -0,0 +1,66 @@
+module Recurly
+  module Requests
+    class CouponCreateOnly < Request
+
+      # @!attribute applies_to_all_plans
+      #   @return [Boolean] The coupon is valid for all plans if true. If false then `plans` and `plans_names` will list the applicable plans.
+      define_attribute :applies_to_all_plans, :Boolean
+
+      # @!attribute applies_to_non_plan_charges
+      #   @return [Boolean] The coupon is valid for one-time, non-plan charges if true.
+      define_attribute :applies_to_non_plan_charges, :Boolean
+
+      # @!attribute code
+      #   @return [String] The code the customer enters to redeem the coupon.
+      define_attribute :code, String
+
+      # @!attribute coupon_type
+      #   @return [String] Whether the coupon is "single_code" or "bulk". Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
+      define_attribute :coupon_type, String, {:enum => ["single_code", "bulk"]}
+
+      # @!attribute currencies
+      #   @return [Array[String]] Fixed discount currencies by currency. Required if the coupon type is `fixed`. This parameter should contain the coupon discount values
+      define_attribute :currencies, Array, {:item_type => String}
+
+      # @!attribute discount_percent
+      #   @return [Integer] The percent of the price discounted by the coupon.  Required if `discount_type` is `percent`.
+      define_attribute :discount_percent, Integer
+
+      # @!attribute discount_type
+      #   @return [String] The type of discount provided by the coupon (how the amount discounted is calculated)
+      define_attribute :discount_type, String, {:enum => ["percent", "fixed", "free_trial"]}
+
+      # @!attribute duration
+      #   @return [String] This field does not apply when the discount_type is `free_trial`. - "single_use" coupons applies to the first invoice only. - "temporal" coupons will apply to invoices for the duration determined by the `temporal_unit` and `temporal_amount` attributes. - "forever" coupons will apply to invoices forever.
+      define_attribute :duration, String, {:enum => ["forever", "single_use", "temporal"]}
+
+      # @!attribute free_trial_amount
+      #   @return [Integer] Sets the duration of time the `free_trial_unit` is for. Required if `discount_type` is `free_trial`.
+      define_attribute :free_trial_amount, Integer
+
+      # @!attribute free_trial_unit
+      #   @return [String] Description of the unit of time the coupon is for. Used with `free_trial_amount` to determine the duration of time the coupon is for.  Required if `discount_type` is `free_trial`.
+      define_attribute :free_trial_unit, String, {:enum => ["day", "week", "month"]}
+
+      # @!attribute plan_codes
+      #   @return [Array[String]] List of plan codes to which this coupon applies. See `applies_to_all_plans`
+      define_attribute :plan_codes, Array, {:item_type => String}
+
+      # @!attribute redemption_resource
+      #   @return [String] Whether the discount is for all eligible charges on the account, or only a specific subscription.
+      define_attribute :redemption_resource, String, {:enum => ["account", "subscription"]}
+
+      # @!attribute temporal_amount
+      #   @return [Integer] If `duration` is "temporal" than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
+      define_attribute :temporal_amount, Integer
+
+      # @!attribute temporal_unit
+      #   @return [String] If `duration` is "temporal" than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
+      define_attribute :temporal_unit, String, {:enum => ["day", "week", "month", "year"]}
+
+      # @!attribute unique_code_template
+      #   @return [String] On a bulk coupon, the template from which unique coupon codes are generated. - You must start the template with your coupon_code wrapped in single quotes. - Outside of single quotes, use a 9 for a character that you want to be a random number. - Outside of single quotes, use an "x" for a character that you want to be a random letter. - Outside of single quotes, use an * for a character that you want to be a random number or letter. - Use single quotes ' ' for characters that you want to remain static. These strings can be alphanumeric and may contain a - _ or +. For example: "'abc-'****'-def'"
+      define_attribute :unique_code_template, String
+    end
+  end
+end

data/lib/recurly/requests/coupon_updatable.rb

@@ -0,0 +1,30 @@
+module Recurly
+  module Requests
+    class CouponUpdatable < Request
+
+      # @!attribute hosted_description
+      #   @return [String] This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
+      define_attribute :hosted_description, String
+
+      # @!attribute invoice_description
+      #   @return [String] Description of the coupon on the invoice.
+      define_attribute :invoice_description, String
+
+      # @!attribute max_redemptions
+      #   @return [Integer] A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.
+      define_attribute :max_redemptions, Integer
+
+      # @!attribute max_redemptions_per_account
+      #   @return [Integer] Redemptions per account is the number of times a specific account can redeem the coupon. Set redemptions per account to `1` if you want to keep customers from gaming the system and getting more than one discount from the coupon campaign.
+      define_attribute :max_redemptions_per_account, Integer
+
+      # @!attribute name
+      #   @return [String] The internal name for the coupon.
+      define_attribute :name, String
+
+      # @!attribute redeem_by_date
+      #   @return [String] The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
+      define_attribute :redeem_by_date, String
+    end
+  end
+end

data/lib/recurly/requests/create_account.rb

@@ -0,0 +1,62 @@
+module Recurly
+  module Requests
+    class CreateAccount < Request
+
+      # @!attribute acquisition
+      #   @return [AccountAcquisitionUpdatable]
+      define_attribute :acquisition, :AccountAcquisitionUpdatable
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute billing_info
+      #   @return [BillingInfoCreate]
+      define_attribute :billing_info, :BillingInfoCreate
+
+      # @!attribute cc_emails
+      #   @return [String] Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
+      define_attribute :cc_emails, String
+
+      # @!attribute code
+      #   @return [String] The unique identifier of the account. This cannot be changed once the account is created.
+      define_attribute :code, String
+
+      # @!attribute company
+      #   @return [String]
+      define_attribute :company, String
+
+      # @!attribute email
+      #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
+      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 preferred_locale
+      #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
+      define_attribute :preferred_locale, String, {:enum => ["da-DK", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-NZ", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "hi-IN", "ja-JP", "nl-BE", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "tr-TR", "zh-CN"]}
+
+      # @!attribute shipping_addresses
+      #   @return [Array[ShippingAddressCreate]]
+      define_attribute :shipping_addresses, Array, {:item_type => :ShippingAddressCreate}
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
+      define_attribute :tax_exempt, :Boolean
+
+      # @!attribute username
+      #   @return [String] A secondary value for the account.
+      define_attribute :username, String
+
+      # @!attribute vat_number
+      #   @return [String] The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.
+      define_attribute :vat_number, String
+    end
+  end
+end

data/lib/recurly/requests/create_coupon.rb

@@ -0,0 +1,90 @@
+module Recurly
+  module Requests
+    class CreateCoupon < Request
+
+      # @!attribute applies_to_all_plans
+      #   @return [Boolean] The coupon is valid for all plans if true. If false then `plans` and `plans_names` will list the applicable plans.
+      define_attribute :applies_to_all_plans, :Boolean
+
+      # @!attribute applies_to_non_plan_charges
+      #   @return [Boolean] The coupon is valid for one-time, non-plan charges if true.
+      define_attribute :applies_to_non_plan_charges, :Boolean
+
+      # @!attribute code
+      #   @return [String] The code the customer enters to redeem the coupon.
+      define_attribute :code, String
+
+      # @!attribute coupon_type
+      #   @return [String] Whether the coupon is "single_code" or "bulk". Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
+      define_attribute :coupon_type, String, {:enum => ["single_code", "bulk"]}
+
+      # @!attribute currencies
+      #   @return [Array[String]] Fixed discount currencies by currency. Required if the coupon type is `fixed`. This parameter should contain the coupon discount values
+      define_attribute :currencies, Array, {:item_type => String}
+
+      # @!attribute discount_percent
+      #   @return [Integer] The percent of the price discounted by the coupon.  Required if `discount_type` is `percent`.
+      define_attribute :discount_percent, Integer
+
+      # @!attribute discount_type
+      #   @return [String] The type of discount provided by the coupon (how the amount discounted is calculated)
+      define_attribute :discount_type, String, {:enum => ["percent", "fixed", "free_trial"]}
+
+      # @!attribute duration
+      #   @return [String] This field does not apply when the discount_type is `free_trial`. - "single_use" coupons applies to the first invoice only. - "temporal" coupons will apply to invoices for the duration determined by the `temporal_unit` and `temporal_amount` attributes. - "forever" coupons will apply to invoices forever.
+      define_attribute :duration, String, {:enum => ["forever", "single_use", "temporal"]}
+
+      # @!attribute free_trial_amount
+      #   @return [Integer] Sets the duration of time the `free_trial_unit` is for. Required if `discount_type` is `free_trial`.
+      define_attribute :free_trial_amount, Integer
+
+      # @!attribute free_trial_unit
+      #   @return [String] Description of the unit of time the coupon is for. Used with `free_trial_amount` to determine the duration of time the coupon is for.  Required if `discount_type` is `free_trial`.
+      define_attribute :free_trial_unit, String, {:enum => ["day", "week", "month"]}
+
+      # @!attribute hosted_description
+      #   @return [String] This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
+      define_attribute :hosted_description, String
+
+      # @!attribute invoice_description
+      #   @return [String] Description of the coupon on the invoice.
+      define_attribute :invoice_description, String
+
+      # @!attribute max_redemptions
+      #   @return [Integer] A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.
+      define_attribute :max_redemptions, Integer
+
+      # @!attribute max_redemptions_per_account
+      #   @return [Integer] Redemptions per account is the number of times a specific account can redeem the coupon. Set redemptions per account to `1` if you want to keep customers from gaming the system and getting more than one discount from the coupon campaign.
+      define_attribute :max_redemptions_per_account, Integer
+
+      # @!attribute name
+      #   @return [String] The internal name for the coupon.
+      define_attribute :name, String
+
+      # @!attribute plan_codes
+      #   @return [Array[String]] List of plan codes to which this coupon applies. See `applies_to_all_plans`
+      define_attribute :plan_codes, Array, {:item_type => String}
+
+      # @!attribute redeem_by_date
+      #   @return [String] The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
+      define_attribute :redeem_by_date, String
+
+      # @!attribute redemption_resource
+      #   @return [String] Whether the discount is for all eligible charges on the account, or only a specific subscription.
+      define_attribute :redemption_resource, String, {:enum => ["account", "subscription"]}
+
+      # @!attribute temporal_amount
+      #   @return [Integer] If `duration` is "temporal" than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
+      define_attribute :temporal_amount, Integer
+
+      # @!attribute temporal_unit
+      #   @return [String] If `duration` is "temporal" than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
+      define_attribute :temporal_unit, String, {:enum => ["day", "week", "month", "year"]}
+
+      # @!attribute unique_code_template
+      #   @return [String] On a bulk coupon, the template from which unique coupon codes are generated. - You must start the template with your coupon_code wrapped in single quotes. - Outside of single quotes, use a 9 for a character that you want to be a random number. - Outside of single quotes, use an "x" for a character that you want to be a random letter. - Outside of single quotes, use an * for a character that you want to be a random number or letter. - Use single quotes ' ' for characters that you want to remain static. These strings can be alphanumeric and may contain a - _ or +. For example: "'abc-'****'-def'"
+      define_attribute :unique_code_template, String
+    end
+  end
+end

data/lib/recurly/requests/invoice_create.rb

@@ -0,0 +1,42 @@
+module Recurly
+  module Requests
+    class InvoiceCreate < Request
+
+      # @!attribute charge_customer_notes
+      #   @return [String] This will default to the Customer Notes text specified on the Invoice Settings for charge invoices. Specify custom notes to add or override Customer Notes on charge invoices.
+      define_attribute :charge_customer_notes, String
+
+      # @!attribute collection_method
+      #   @return [String] An automatic invoice means a corresponding transaction is run using the account's billing information at the same time the invoice is created. Manual invoices are created without a corresponding transaction. The merchant must enter a manual payment transaction or have the customer pay the invoice with an automatic method, like credit card, PayPal, Amazon, or ACH bank payment.
+      define_attribute :collection_method, String, {:enum => ["automatic", "manual"]}
+
+      # @!attribute credit_customer_notes
+      #   @return [String] This will default to the Customer Notes text specified on the Invoice Settings for credit invoices. Specify customer notes to add or override Customer Notes on credit invoices.
+      define_attribute :credit_customer_notes, String
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, 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 po_number
+      #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
+      define_attribute :po_number, String
+
+      # @!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.
+      define_attribute :terms_and_conditions, String
+
+      # @!attribute type
+      #   @return [String] Specify a type to limit the type of line items that will be invoiced.
+      define_attribute :type, String, {:enum => ["charge", "credit"]}
+
+      # @!attribute vat_reverse_charge_notes
+      #   @return [String] VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription.
+      define_attribute :vat_reverse_charge_notes, String
+    end
+  end
+end

data/lib/recurly/requests/invoice_refund.rb

@@ -0,0 +1,30 @@
+module Recurly
+  module Requests
+    class InvoiceRefund < Request
+
+      # @!attribute amount
+      #   @return [Integer] The amount to be refunded. The amount will be split between the line items. If no amount is specified, it will default to refunding the total refundable amount on the invoice.
+      define_attribute :amount, Integer
+
+      # @!attribute credit_customer_notes
+      #   @return [String] Used as the Customer Notes on the credit invoice.  This field can only be include when the Credit Invoices feature is enabled.
+      define_attribute :credit_customer_notes, String
+
+      # @!attribute external_refund
+      #   @return [Hash] Indicates that the refund was settled outside of Recurly, and a manual transaction should be created to track it in Recurly.  Required when: - refunding a manually collected charge invoice, and `refund_method` is not `all_credit` - refunding a credit invoice that refunded manually collecting invoices - refunding a credit invoice for a partial amount  This field can only be included when the Credit Invoices feature is enabled.
+      define_attribute :external_refund, Hash
+
+      # @!attribute line_items
+      #   @return [Array[String]] The line items to be refunded. This is required when `type=line_items`.
+      define_attribute :line_items, Array, {:item_type => String}
+
+      # @!attribute refund_method
+      #   @return [String] Indicates how the invoice should be refunded when both a credit and transaction are present on the invoice: - `transaction_first` – Refunds the transaction first, then any amount is issued as credit back to the account. Default value when Credit Invoices feature is enabled. - `credit_first` – Issues credit back to the account first, then refunds any remaining amount back to the transaction. Default value when Credit Invoices feature is not enabled. - `all_credit` – Issues credit to the account for the entire amount of the refund. Only available when the Credit Invoices feature is enabled. - `all_transaction` – Refunds the entire amount back to transactions, using transactions from previous invoices if necessary. Only available when the Credit Invoices feature is enabled.
+      define_attribute :refund_method, String, {:enum => ["transaction_first", "credit_first", "all_credit", "all_transaction"]}
+
+      # @!attribute type
+      #   @return [String] The type of refund. Amount and line items cannot both be specified in the request.
+      define_attribute :type, String, {:enum => ["amount", "line_items"]}
+    end
+  end
+end

data/lib/recurly/requests/line_item_create.rb

@@ -0,0 +1,46 @@
+module Recurly
+  module Requests
+    class LineItemCreate < Request
+
+      # @!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, {:enum => ["general", "service", "promotional"]}
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute description
+      #   @return [String] Description that appears on the invoice.
+      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 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 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 for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of unknown, physical, or digital. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.
+      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.
+      define_attribute :type, String, {:enum => ["charge", "credit"]}
+
+      # @!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`.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/plan_create.rb

@@ -0,0 +1,66 @@
+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[String]] Add Ons
+      define_attribute :add_ons, Array, {:item_type => String}
+
+      # @!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[String]] Pricing
+      define_attribute :currencies, Array, {:item_type => String}
+
+      # @!attribute description
+      #   @return [String] Optional description, not displayed.
+      define_attribute :description, String
+
+      # @!attribute hosted_pages
+      #   @return [Hash] Hosted pages settings
+      define_attribute :hosted_pages, Hash
+
+      # @!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, {:enum => ["days", "months"]}
+
+      # @!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 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 tax_code
+      #   @return [String] Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of 'unknown', 'physical', or 'digital'. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.
+      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_unit
+      #   @return [String] Units for the plan's trial period.
+      define_attribute :trial_unit, String, {:enum => ["days", "months"]}
+    end
+  end
+end

data/lib/recurly/requests/plan_update.rb

@@ -0,0 +1,70 @@
+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[String]] Add Ons
+      define_attribute :add_ons, Array, {:item_type => String}
+
+      # @!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[String]] Pricing
+      define_attribute :currencies, Array, {:item_type => String}
+
+      # @!attribute description
+      #   @return [String] Optional description, not displayed.
+      define_attribute :description, String
+
+      # @!attribute hosted_pages
+      #   @return [Hash] Hosted pages settings
+      define_attribute :hosted_pages, Hash
+
+      # @!attribute [r] id
+      #   @return [String] Plan ID
+      define_attribute :id, String, {:read_only => true}
+
+      # @!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, {:enum => ["days", "months"]}
+
+      # @!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 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 tax_code
+      #   @return [String] Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of 'unknown', 'physical', or 'digital'. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.
+      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_unit
+      #   @return [String] Units for the plan's trial period.
+      define_attribute :trial_unit, String, {:enum => ["days", "months"]}
+    end
+  end
+end

data/lib/recurly/requests/shipping_address_create.rb

@@ -0,0 +1,58 @@
+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