recurly 4.39.0 → 4.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9834825d05fc3ef9111a875a8fae61f5938d458f8127974130b2655e9c8aeb06
-  data.tar.gz: f206903d330ff561a2acb319410148bcfcd3e5824811f0ef637ddc45d9ee2c8d
+  metadata.gz: 843ef045e84fa504d343018c8ffe5a603ff38f7f2fe7506a4fc6c49b335ede21
+  data.tar.gz: 7ef23498bd6f64129e6ee0381530a3ce68bc280f8814948ee2dbcccee4be8429
 SHA512:
-  metadata.gz: d2ae09ec231a22717cc08f125a0e0c89d1092c7653d04a3ad37abbb66af61589a8ce2ff46a0584d1f749184a4303f2eecb1799e08227bf1f5220e781567ef5b0
-  data.tar.gz: 4af28009963ed13fb24367ef7485bb92372296861af6391fa2555da4e79df605234063041fb568ff6c61dc834e082706ca1534616ad7d5d5ce6ff2a8136d27b9
+  metadata.gz: 0de429f909022b74b0e9e533aa768e3a990b9cef8a7cc9649ebb1c31621b67b83cad24588091c313f2b02b42e45a881771ce54283516a1cd8dc9efb43aee3c8f
+  data.tar.gz: 696b8c39a4d0234878700454d4ff83da034ef2beaed761e09344fd4851dfac563e9cac76341f3089860c40b4cf9e565c6dfef0642085359cba899937f87b6113

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 4.39.0
+current_version = 4.41.0
 parse = (?P<major>\d+)
 	\.(?P<minor>\d+)
 	\.(?P<patch>\d+)

data/CHANGELOG.md

@@ -1,12 +1,24 @@
 # Changelog
 
-## [4.39.0](https://github.com/recurly/recurly-client-ruby/tree/4.39.0) (2023-07-26)
+## [4.41.0](https://github.com/recurly/recurly-client-ruby/tree/4.41.0) (2023-08-10)
 
-[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.38.0...4.39.0)
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.40.0...4.41.0)
 
 
 **Merged Pull Requests**
 
+- Generated Latest Changes for v2021-02-25 (action_result) [#864](https://github.com/recurly/recurly-client-ruby/pull/864) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.40.0](https://github.com/recurly/recurly-client-ruby/tree/4.40.0) (2023-07-27)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.38.0...4.40.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (Ramp Dates, Net Terms, Invoice Business Entity) [#860](https://github.com/recurly/recurly-client-ruby/pull/860) ([recurly-integrations](https://github.com/recurly-integrations))
 - Generated Latest Changes for v2021-02-25 (App Management - External Subscriptions) [#859](https://github.com/recurly/recurly-client-ruby/pull/859) ([recurly-integrations](https://github.com/recurly-integrations))
 
 

data/GETTING_STARTED.md

@@ -5,7 +5,7 @@ This repository houses the official ruby client for Recurly's V3 API.
 In your Gemfile, add `recurly` as a dependency.
 
 ```ruby
-gem 'recurly', '~> 4.39'
+gem 'recurly', '~> 4.41'
 ```
 
 > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.

data/lib/recurly/requests/gateway_attributes.rb

@@ -7,7 +7,7 @@ module Recurly
     class GatewayAttributes < Request
 
       # @!attribute account_reference
-      #   @return [String] Used by Adyen gateways. The Shopper Reference value used when the external token was created. Must be used in conjunction with gateway_token and gateway_code.
+      #   @return [String] Used by Adyen and Braintree gateways. For Adyen the Shopper Reference value used when the external token was created. Must be used in conjunction with gateway_token and gateway_code. For Braintree the PayPal PayerID is populated in the response.
       define_attribute :account_reference, String
     end
   end

data/lib/recurly/requests/invoice_create.rb

@@ -23,9 +23,13 @@ module Recurly
       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.
+      #   @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For any value, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due.  For example:  If an invoice is due `net 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. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.  When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
       define_attribute :net_terms, Integer
 
+      # @!attribute net_terms_type
+      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.  This field is only available when the EOM Net Terms feature is enabled.
+      define_attribute :net_terms_type, String
+
       # @!attribute po_number
       #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
       define_attribute :po_number, String

data/lib/recurly/requests/purchase_create.rb

@@ -47,9 +47,13 @@ module Recurly
       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.
+      #   @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For any value, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due.  For example:  If an invoice is due `net 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. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.  When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
       define_attribute :net_terms, Integer
 
+      # @!attribute net_terms_type
+      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.  This field is only available when the EOM Net Terms feature is enabled.
+      define_attribute :net_terms_type, String
+
       # @!attribute po_number
       #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
       define_attribute :po_number, String

data/lib/recurly/requests/subscription_change_create.rb

@@ -27,9 +27,13 @@ module Recurly
       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.
+      #   @return [Integer] Integer normally paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. During a subscription change, it's not necessary to provide both the `Net Terms Type` and `Net Terms` parameters.  For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
       define_attribute :net_terms, Integer
 
+      # @!attribute net_terms_type
+      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.  This field is only available when the EOM Net Terms feature is enabled.
+      define_attribute :net_terms_type, String
+
       # @!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

data/lib/recurly/requests/subscription_create.rb

@@ -51,9 +51,13 @@ module Recurly
       define_attribute :gift_card_redemption_code, 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.
+      #   @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For any value, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due.  For example:  If an invoice is due `net 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. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.  When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
       define_attribute :net_terms, Integer
 
+      # @!attribute net_terms_type
+      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.  This field is only available when the EOM Net Terms feature is enabled.
+      define_attribute :net_terms_type, String
+
       # @!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

data/lib/recurly/requests/subscription_update.rb

@@ -31,9 +31,13 @@ module Recurly
       define_attribute :gateway_code, 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.
+      #   @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For any value, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due.  For example:  If an invoice is due `net 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. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.  When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
       define_attribute :net_terms, Integer
 
+      # @!attribute net_terms_type
+      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.  This field is only available when the EOM Net Terms feature is enabled.
+      define_attribute :net_terms_type, String
+
       # @!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. For a subscription in a trial period, this will change when the trial expires. This parameter is useful for postponement of a subscription to change its billing date without proration.
       define_attribute :next_bill_date, DateTime

data/lib/recurly/resources/gateway_attributes.rb

@@ -7,7 +7,7 @@ module Recurly
     class GatewayAttributes < Resource
 
       # @!attribute account_reference
-      #   @return [String] Used by Adyen gateways. The Shopper Reference value used when the external token was created.
+      #   @return [String] Used by Adyen and Braintree gateways. For Adyen the Shopper Reference value used when the external token was created. For Braintree the PayPal PayerID is populated in the response.
       define_attribute :account_reference, String
     end
   end

data/lib/recurly/resources/invoice.rb

@@ -83,9 +83,13 @@ module Recurly
       define_attribute :line_items, Array, { :item_type => :LineItem }
 
       # @!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.
+      #   @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For any value, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due.  For example:  If an invoice is due `net 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. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.  When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
       define_attribute :net_terms, Integer
 
+      # @!attribute net_terms_type
+      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.  This field is only available when the EOM Net Terms feature is enabled.
+      define_attribute :net_terms_type, String
+
       # @!attribute number
       #   @return [String] If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001). Non-EU invoices will continue to use the site-level invoice number sequence.
       define_attribute :number, String

data/lib/recurly/resources/invoice_mini.rb

@@ -6,6 +6,10 @@ module Recurly
   module Resources
     class InvoiceMini < Resource
 
+      # @!attribute business_entity_id
+      #   @return [String] Unique ID to identify the business entity assigned to the invoice. Available when the `Multiple Business Entities` feature is enabled.
+      define_attribute :business_entity_id, String
+
       # @!attribute id
       #   @return [String] Invoice ID
       define_attribute :id, String

data/lib/recurly/resources/subscription.rb

@@ -10,6 +10,10 @@ module Recurly
       #   @return [AccountMini] Account mini details
       define_attribute :account, :AccountMini
 
+      # @!attribute action_result
+      #   @return [Hash] Action result params to be used in Recurly-JS to complete a payment when using asynchronous payment methods, e.g., Boleto, iDEAL and Sofort.
+      define_attribute :action_result, Hash
+
       # @!attribute activated_at
       #   @return [DateTime] Activated at
       define_attribute :activated_at, DateTime
@@ -103,9 +107,13 @@ module Recurly
       define_attribute :id, String
 
       # @!attribute net_terms
-      #   @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+      #   @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For any value, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due.  For example:  If an invoice is due `net 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. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.  When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
       define_attribute :net_terms, Integer
 
+      # @!attribute net_terms_type
+      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.  This field is only available when the EOM Net Terms feature is enabled.
+      define_attribute :net_terms_type, String
+
       # @!attribute object
       #   @return [String] Object type
       define_attribute :object, String

data/lib/recurly/resources/subscription_ramp_interval_response.rb

@@ -6,6 +6,10 @@ module Recurly
   module Resources
     class SubscriptionRampIntervalResponse < Resource
 
+      # @!attribute ending_on
+      #   @return [DateTime] Date the ramp interval ends
+      define_attribute :ending_on, DateTime
+
       # @!attribute remaining_billing_cycles
       #   @return [Integer] Represents how many billing cycles are left in a ramp interval.
       define_attribute :remaining_billing_cycles, Integer
@@ -14,6 +18,10 @@ module Recurly
       #   @return [Integer] Represents the billing cycle where a ramp interval starts.
       define_attribute :starting_billing_cycle, Integer
 
+      # @!attribute starting_on
+      #   @return [DateTime] Date the ramp interval starts
+      define_attribute :starting_on, DateTime
+
       # @!attribute unit_amount
       #   @return [Float] Represents the price for the ramp interval.
       define_attribute :unit_amount, Float

data/lib/recurly/resources/transaction.rb

@@ -10,6 +10,10 @@ module Recurly
       #   @return [AccountMini] Account mini details
       define_attribute :account, :AccountMini
 
+      # @!attribute action_result
+      #   @return [Hash] Action result params to be used in Recurly-JS to complete a payment when using asynchronous payment methods, e.g., Boleto, iDEAL and Sofort.
+      define_attribute :action_result, Hash
+
       # @!attribute amount
       #   @return [Float] Total transaction amount sent to the payment gateway.
       define_attribute :amount, Float

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.39.0"
+  VERSION = "4.41.0"
 end

data/openapi/api.yaml

@@ -15202,7 +15202,7 @@ paths:
 
         Use for **Adyen HPP** and **Online Banking** transaction requests.
         This runs the validations but not the transactions.
-        The API request allows the inclusion of one of the following fields: **external_hpp_type** with `'adyen'` and **online_banking_payment_type** with `'ideal'` or `'sofort'` in the **billing_info** object.
+        The API request allows the inclusion of the following field: **external_hpp_type** with `'adyen'` in the **billing_info** object.
 
         For additional information regarding shipping fees, please see https://docs.recurly.com/docs/shipping
 
@@ -18204,9 +18204,10 @@ components:
           properties:
             account_reference:
               type: string
-              description: Used by Adyen gateways. The Shopper Reference value used
-                when the external token was created. Must be used in conjunction with
-                gateway_token and gateway_code.
+              description: Used by Adyen and Braintree gateways. For Adyen the Shopper
+                Reference value used when the external token was created. Must be
+                used in conjunction with gateway_token and gateway_code. For Braintree
+                the PayPal PayerID is populated in the response.
               maxLength: 264
         amazon_billing_agreement_id:
           type: string
@@ -18291,6 +18292,7 @@ components:
           "$ref": "#/components/schemas/ExternalHppTypeEnum"
         online_banking_payment_type:
           "$ref": "#/components/schemas/OnlineBankingPaymentTypeEnum"
+          deprecated: true
         card_type:
           "$ref": "#/components/schemas/CardTypeEnum"
     BillingInfoVerify:
@@ -19332,13 +19334,24 @@ components:
         net_terms:
           type: integer
           title: Net terms
-          description: 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.
+          description: |-
+            Integer paired with `Net Terms Type` and representing the number
+            of days past the current date (for `net` Net Terms Type) or days after
+            the last day of the current month (for `eom` Net Terms Type) that the
+            invoice will become past due. For any value, an additional 24 hours is
+            added to ensure the customer has the entire last day to make payment before
+            becoming past due.  For example:
+
+            If an invoice is due `net 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.
+            If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
+
+            When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
+            For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
           minimum: 0
           default: 0
+        net_terms_type:
+          "$ref": "#/components/schemas/NetTermsTypeEnum"
         address:
           "$ref": "#/components/schemas/InvoiceAddress"
         shipping_address:
@@ -19516,13 +19529,24 @@ components:
         net_terms:
           type: integer
           title: Net terms
-          description: 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.
-          default: 0
+          description: |-
+            Integer paired with `Net Terms Type` and representing the number
+            of days past the current date (for `net` Net Terms Type) or days after
+            the last day of the current month (for `eom` Net Terms Type) that the
+            invoice will become past due. For any value, an additional 24 hours is
+            added to ensure the customer has the entire last day to make payment before
+            becoming past due.  For example:
+
+            If an invoice is due `net 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.
+            If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
+
+            When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
+            For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
           minimum: 0
+          default: 0
+        net_terms_type:
+          "$ref": "#/components/schemas/NetTermsTypeEnum"
         po_number:
           type: string
           title: Purchase order number
@@ -19629,6 +19653,11 @@ components:
         number:
           type: string
           title: Invoice number
+        business_entity_id:
+          type: string
+          title: Business Entity ID
+          description: Unique ID to identify the business entity assigned to the invoice.
+            Available when the `Multiple Business Entities` feature is enabled.
         type:
           title: Invoice type
           "$ref": "#/components/schemas/InvoiceTypeEnum"
@@ -21600,13 +21629,24 @@ components:
         net_terms:
           type: integer
           title: Net terms
-          description: 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.
+          description: |-
+            Integer paired with `Net Terms Type` and representing the number
+            of days past the current date (for `net` Net Terms Type) or days after
+            the last day of the current month (for `eom` Net Terms Type) that the
+            invoice will become past due. For any value, an additional 24 hours is
+            added to ensure the customer has the entire last day to make payment before
+            becoming past due.  For example:
+
+            If an invoice is due `net 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.
+            If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
+
+            When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
+            For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
           minimum: 0
           default: 0
+        net_terms_type:
+          "$ref": "#/components/schemas/NetTermsTypeEnum"
         terms_and_conditions:
           type: string
           title: Terms and conditions
@@ -21673,6 +21713,12 @@ components:
           format: date-time
           description: When the subscription was converted from a gift card.
           title: Converted at
+        action_result:
+          type: object
+          description: Action result params to be used in Recurly-JS to complete a
+            payment when using asynchronous payment methods, e.g., Boleto, iDEAL and
+            Sofort.
+          title: Action result
     SubscriptionAddOn:
       type: object
       title: Subscription Add-on
@@ -22162,13 +22208,17 @@ components:
         net_terms:
           type: integer
           title: Net terms
-          description: 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.
+          description: |-
+            Integer normally paired with `Net Terms Type` and representing the number of days past
+            the current date (for `net` Net Terms Type) or days after the last day of the current
+            month (for `eom` Net Terms Type) that the invoice will become past due. During a subscription
+            change, it's not necessary to provide both the `Net Terms Type` and `Net Terms` parameters.
+
+            For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
           minimum: 0
           default: 0
+        net_terms_type:
+          "$ref": "#/components/schemas/NetTermsTypeEnum"
         transaction_type:
           description: An optional type designation for the payment gateway transaction
             created by this request. Supports 'moto' value, which is the acronym for
@@ -22373,13 +22423,24 @@ components:
         net_terms:
           type: integer
           title: Net terms
-          description: 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.
+          description: |-
+            Integer paired with `Net Terms Type` and representing the number
+            of days past the current date (for `net` Net Terms Type) or days after
+            the last day of the current month (for `eom` Net Terms Type) that the
+            invoice will become past due. For any value, an additional 24 hours is
+            added to ensure the customer has the entire last day to make payment before
+            becoming past due.  For example:
+
+            If an invoice is due `net 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.
+            If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
+
+            When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
+            For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
           minimum: 0
           default: 0
+        net_terms_type:
+          "$ref": "#/components/schemas/NetTermsTypeEnum"
         transaction_type:
           description: An optional type designation for the payment gateway transaction
             created by this request. Supports 'moto' value, which is the acronym for
@@ -22549,13 +22610,24 @@ components:
         net_terms:
           type: integer
           title: Terms that the subscription is due on
-          description: 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.
+          description: |-
+            Integer paired with `Net Terms Type` and representing the number
+            of days past the current date (for `net` Net Terms Type) or days after
+            the last day of the current month (for `eom` Net Terms Type) that the
+            invoice will become past due. For any value, an additional 24 hours is
+            added to ensure the customer has the entire last day to make payment before
+            becoming past due.  For example:
+
+            If an invoice is due `net 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.
+            If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
+
+            When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
+            For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
           minimum: 0
           default: 0
+        net_terms_type:
+          "$ref": "#/components/schemas/NetTermsTypeEnum"
         gateway_code:
           type: string
           title: Gateway Code
@@ -22694,6 +22766,14 @@ components:
         remaining_billing_cycles:
           type: integer
           description: Represents how many billing cycles are left in a ramp interval.
+        starting_on:
+          type: string
+          format: date-time
+          title: Date the ramp interval starts
+        ending_on:
+          type: string
+          format: date-time
+          title: Date the ramp interval ends
         unit_amount:
           type: number
           format: float
@@ -22954,6 +23034,12 @@ components:
           format: date-time
           title: Collected at, or if not collected yet, the time the transaction was
             created.
+        action_result:
+          type: object
+          description: Action result params to be used in Recurly-JS to complete a
+            payment when using asynchronous payment methods, e.g., Boleto, iDEAL and
+            Sofort.
+          title: Action result
     ExternalTransaction:
       type: object
       properties:
@@ -23253,13 +23339,24 @@ components:
         net_terms:
           type: integer
           title: Net terms
-          description: 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.
+          description: |-
+            Integer paired with `Net Terms Type` and representing the number
+            of days past the current date (for `net` Net Terms Type) or days after
+            the last day of the current month (for `eom` Net Terms Type) that the
+            invoice will become past due. For any value, an additional 24 hours is
+            added to ensure the customer has the entire last day to make payment before
+            becoming past due.  For example:
+
+            If an invoice is due `net 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.
+            If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
+
+            When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
+            For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
           minimum: 0
           default: 0
+        net_terms_type:
+          "$ref": "#/components/schemas/NetTermsTypeEnum"
         terms_and_conditions:
           type: string
           title: Terms and conditions
@@ -24065,8 +24162,9 @@ components:
           properties:
             account_reference:
               type: string
-              description: Used by Adyen gateways. The Shopper Reference value used
-                when the external token was created.
+              description: Used by Adyen and Braintree gateways. For Adyen the Shopper
+                Reference value used when the external token was created. For Braintree
+                the PayPal PayerID is populated in the response.
               maxLength: 264
         billing_agreement_id:
           type: string
@@ -24798,6 +24896,19 @@ components:
       - at_range_start
       - evenly
       - never
+    NetTermsTypeEnum:
+      type: string
+      title: Net Terms Type
+      description: |
+        Optionally supplied string that may be either `net` or `eom` (end-of-month).
+        When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date.
+        When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.
+
+        This field is only available when the EOM Net Terms feature is enabled.
+      enum:
+      - net
+      - eom
+      default: net
     InvoiceTypeEnum:
       type: string
       enum:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.39.0
+  version: 4.41.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-26 00:00:00.000000000 Z
+date: 2023-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -345,7 +345,7 @@ metadata:
   changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
   documentation_uri: https://recurly.github.io/recurly-client-ruby/
   homepage_uri: https://github.com/recurly/recurly-client-ruby
-  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.39.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.41.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -361,7 +361,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: The ruby client for Recurly's V3 API