recurly 4.76.0 → 4.77.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 291cd81b722143bec2a0b2b57499e482c895d81036cda7bda1d7b6d3a808f373
-  data.tar.gz: d1e78b56aa492134c873a2cda000596bf54f8b3da6ff44168d676e2ca3a129dd
+  metadata.gz: 39f517bfc1451d42ff2d1b8b7bcf5b2f0c6deff2ddeaf36a28e60b433b7bf166
+  data.tar.gz: 9fc9d18297e06fba3d530cd421e684ed601695beeb1bfb3865f9e9daf5b2f9ae
 SHA512:
-  metadata.gz: 1fbe21003f2a2f0dcf4d5fb94a0795fab7664df5755f6c6085823ca76ca96a5ea4541700f970002cbefbbdcb380cedaa9b4b29409088d34df807dc501fe50434
-  data.tar.gz: a57e93f4e9eed80b4fa7428b8287f89b314b7c86f7949f3bd8ec0f96ac86ac018f6033b6d7a38c6ab5efe03fa189c36afad1cac78e47891a031027a90fe15e82
+  metadata.gz: 193603f1ee150a01897ea7d40956874e4e0a208e6e6363a1cd5a89fdedb67e0f2f54a441dbdaaefe4b8444888cfaf50c1e7fa22be2c01a02931aade952d402c0
+  data.tar.gz: ac3eb127e95472768420ba6bf751ab8bdc37b770be64475e7f476f5ac725ca72a57d6cb46973286e1f6e0f76cea95533254248d10d937d0bfcb5603f77087f7f

data/.bumpversion.cfg

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

data/.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
       matrix:
         ruby: [2.4, 2.5, 2.6, 2.7, 3.0]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6.0.3
       - name: Setup ruby
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/docs.yml

@@ -8,7 +8,7 @@ jobs:
     name: Publish
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v6.0.3
 
     - uses: ruby/setup-ruby@v1
       with:
@@ -19,7 +19,7 @@ jobs:
 
     - name: Deploy
       if: success()
-      uses: crazy-max/ghaction-github-pages@v1
+      uses: crazy-max/ghaction-github-pages@v5.0.0
       with:
         target_branch: gh-pages
         build_dir: ./doc

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [4.77.0](https://github.com/recurly/recurly-client-ruby/tree/4.77.0) (2026-06-10)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.76.0...4.77.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#958](https://github.com/recurly/recurly-client-ruby/pull/958) ([recurly-integrations](https://github.com/recurly-integrations))
+- ci: Remediate Node.js 20 deprecation in GitHub Actions workflows [#957](https://github.com/recurly/recurly-client-ruby/pull/957) ([jparrabedoya](https://github.com/jparrabedoya))
+
+
+
 ## [4.76.0](https://github.com/recurly/recurly-client-ruby/tree/4.76.0) (2026-05-20)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.75.0...4.76.0)

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.76'
+gem 'recurly', '~> 4.77'
 ```
 
 > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.

data/lib/recurly/client/operations.rb

@@ -3037,6 +3037,20 @@ module Recurly
       post(path, body, Requests::InvoiceRefund, **options)
     end
 
+    # Create an invoice for revenue recovery
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/create_invoice_retry create_invoice_retry api documentation}
+    #
+    # @param body [Requests::RecoveryInvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::RecoveryInvoiceCreate}
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::InvoiceCollection] Returns the new invoices.
+    #
+    def create_invoice_retry(body:, **options)
+      path = "/invoices/recovery"
+      post(path, body, Requests::RecoveryInvoiceCreate, **options)
+    end
+
     # List a site's line items
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_line_items list_line_items api documentation}

data/lib/recurly/requests/coupon_create.rb

@@ -47,7 +47,7 @@ module Recurly
       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`.
+      #   @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`. Use `billing_period` to grant a free trial for a number of billing cycles.
       define_attribute :free_trial_unit, String
 
       # @!attribute hosted_description
@@ -91,7 +91,7 @@ module Recurly
       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. Use "billing_period" to apply the coupon for a fixed number of billing cycles. Requires `redemption_resource=subscription`.
+      #   @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. Use "billing_period" to apply the coupon for a fixed number of billing cycles. Requires `redemption_resource=subscription`. Not compatible with `discount_type=free_trial`; use `free_trial_unit=billing_period` and `free_trial_amount` instead.
       define_attribute :temporal_unit, String
 
       # @!attribute unique_code_template

data/lib/recurly/requests/recovery_account_create.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 RecoveryAccountCreate < Request
+
+      # @!attribute address
+      #   @return [RecoveryAddress]
+      define_attribute :address, :RecoveryAddress
+
+      # @!attribute billing_infos
+      #   @return [Array[RecoveryBillingInfoCreate]] If the premium Wallet feature is enabled, more than one payment method can be associated with an account, and one can be designated as a primary and one as a backup. Without the Wallet feature, only one payment method will be accepted.
+      define_attribute :billing_infos, Array, { :item_type => :RecoveryBillingInfoCreate }
+
+      # @!attribute code
+      #   @return [String] The unique identifier of the account. This cannot be changed once the account is created.
+      define_attribute :code, String
+
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
+      # @!attribute dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
+      # @!attribute email
+      #   @return [String] The email address used for communicating with this customer.
+      define_attribute :email, String
+    end
+  end
+end

data/lib/recurly/requests/recovery_address.rb

@@ -0,0 +1,38 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class RecoveryAddress < Request
+
+      # @!attribute city
+      #   @return [String] City
+      define_attribute :city, String
+
+      # @!attribute country
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
+      define_attribute :country, String
+
+      # @!attribute phone
+      #   @return [String] Phone number
+      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] Street 1
+      define_attribute :street1, String
+
+      # @!attribute street2
+      #   @return [String] Street 2
+      define_attribute :street2, String
+    end
+  end
+end

data/lib/recurly/requests/recovery_billing_info_create.rb

@@ -0,0 +1,54 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class RecoveryBillingInfoCreate < Request
+
+      # @!attribute address
+      #   @return [RecoveryAddress]
+      define_attribute :address, :RecoveryAddress
+
+      # @!attribute backup_payment_method
+      #   @return [Boolean] The `backup_payment_method` field is used to designate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined. All payment methods, including the billing info marked `primary_payment_method` can be set as a backup. An account can have a maximum of 1 backup, if a user sets a different payment method as a backup, the existing backup will no longer be marked as such.
+      define_attribute :backup_payment_method, :Boolean
+
+      # @!attribute company
+      #   @return [String] Company name
+      define_attribute :company, String
+
+      # @!attribute first_name
+      #   @return [String] First name
+      define_attribute :first_name, String
+
+      # @!attribute gateway_code
+      #   @return [String] An identifier for a specific payment gateway.
+      define_attribute :gateway_code, 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 network_transaction_id
+      #   @return [String] Network transaction ID from the previous customer-in-session subscription signup or billing info storage.  - 10-15 alphanumeric characters for Mastercard - 14-15 alphanumeric for Visa - 15 digits for all other brands - 16 alphanumeric characters for Cartes Bancaires, which are processed as Visa or Mastercard
+      define_attribute :network_transaction_id, String
+
+      # @!attribute payment_gateway_references
+      #   @return [Array[PaymentGatewayReferences]] Array of Payment Gateway References, each a reference to a third-party gateway object of varying types.
+      define_attribute :payment_gateway_references, Array, { :item_type => :PaymentGatewayReferences }
+
+      # @!attribute primary_payment_method
+      #   @return [Boolean] The `primary_payment_method` field is used to designate the primary billing info on the account. An account can have a maximum of 1 primary. If a user sets a different payment method as a primary, then the existing primary will no longer be marked as such.
+      define_attribute :primary_payment_method, :Boolean
+
+      # @!attribute transactions
+      #   @return [Array[RecoveryTransactionCreate]] Transactions from previous collection attempts for this payment method.
+      define_attribute :transactions, Array, { :item_type => :RecoveryTransactionCreate }
+    end
+  end
+end

data/lib/recurly/requests/recovery_invoice_create.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 RecoveryInvoiceCreate < Request
+
+      # @!attribute account
+      #   @return [RecoveryAccountCreate]
+      define_attribute :account, :RecoveryAccountCreate
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute due_at
+      #   @return [DateTime] Date invoice was originally due. Must be in the past.
+      define_attribute :due_at, DateTime
+
+      # @!attribute external_recovery_eligible
+      #   @return [Boolean] Must be set to `true` to acknowledge that the invoice is eligible for external recovery. Requests with `false`, omitted, or non-boolean values will be rejected.
+      define_attribute :external_recovery_eligible, :Boolean
+
+      # @!attribute line_items
+      #   @return [Array[RecoveryLineItemCreate]] Line items to include on the invoice. Currency is specified at the root level and must not be included in individual line items.
+      define_attribute :line_items, Array, { :item_type => :RecoveryLineItemCreate }
+
+      # @!attribute po_number
+      #   @return [String] This identifies the PO number associated with the subscription.
+      define_attribute :po_number, String
+    end
+  end
+end

data/lib/recurly/requests/recovery_line_item_create.rb

@@ -0,0 +1,38 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class RecoveryLineItemCreate < Request
+
+      # @!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] Description that appears on the invoice.
+      define_attribute :description, String
+
+      # @!attribute harmonized_system_code
+      #   @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
+      define_attribute :harmonized_system_code, 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.
+      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 tax
+      #   @return [Float] The tax amount for the line item.
+      define_attribute :tax, Float
+
+      # @!attribute unit_amount
+      #   @return [Float] A positive or negative amount will result in a positive `unit_amount`.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/recovery_transaction_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 RecoveryTransactionCreate < Request
+
+      # @!attribute attempted_collection_date
+      #   @return [DateTime] The date the original payment collection was attempted.
+      define_attribute :attempted_collection_date, DateTime
+
+      # @!attribute gateway_error_code
+      #   @return [String] The error code returned by the payment gateway for the original payment collection attempt.
+      define_attribute :gateway_error_code, String
+
+      # @!attribute merchant_advice_code
+      #   @return [String] The advice code returned by the payment gateway for the original payment collection attempt. This field is only applicable for certain gateways.
+      define_attribute :merchant_advice_code, String
+    end
+  end
+end

data/lib/recurly/resources/coupon_discount_trial.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :length, Integer
 
       # @!attribute unit
-      #   @return [String] Temporal unit of the free trial
+      #   @return [String] Temporal unit of the free trial. When `billing_period`, `length` represents the number of billing cycles.
       define_attribute :unit, String
     end
   end

data/lib/recurly/resources/coupon_redemption.rb

@@ -34,6 +34,10 @@ module Recurly
       #   @return [String] Will always be `coupon`.
       define_attribute :object, String
 
+      # @!attribute remaining_duration
+      #   @return [CouponRedemptionRemainingDuration]
+      define_attribute :remaining_duration, :CouponRedemptionRemainingDuration
+
       # @!attribute removed_at
       #   @return [DateTime] The date and time the redemption was removed from the account (un-redeemed).
       define_attribute :removed_at, DateTime

data/lib/recurly/resources/coupon_redemption_mini.rb

@@ -26,8 +26,12 @@ module Recurly
       #   @return [String] Will always be `coupon`.
       define_attribute :object, String
 
+      # @!attribute remaining_duration
+      #   @return [CouponRedemptionRemainingDuration]
+      define_attribute :remaining_duration, :CouponRedemptionRemainingDuration
+
       # @!attribute state
-      #   @return [String] Invoice state
+      #   @return [String] Coupon Redemption state
       define_attribute :state, String
     end
   end

data/lib/recurly/resources/coupon_redemption_remaining_duration.rb

@@ -0,0 +1,18 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class CouponRedemptionRemainingDuration < Resource
+
+      # @!attribute expires_at
+      #   @return [DateTime] Present when `type` is `temporal`. The datetime after which this redemption will no longer apply.
+      define_attribute :expires_at, DateTime
+
+      # @!attribute type
+      #   @return [String] The coupon's duration type. `temporal` includes an `expires_at` timestamp. `forever` and `single_use` have no additional fields.
+      define_attribute :type, String
+    end
+  end
+end

data/lib/recurly/resources/invoice.rb

@@ -34,6 +34,10 @@ module Recurly
       #   @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
 
+      # @!attribute coupon_redemptions
+      #   @return [Array[CouponRedemptionMini]] The coupon redemptions applied to this invoice.
+      define_attribute :coupon_redemptions, Array, { :item_type => :CouponRedemptionMini }
+
       # @!attribute created_at
       #   @return [DateTime] Created at
       define_attribute :created_at, DateTime

data/lib/recurly/resources/line_item.rb

@@ -67,9 +67,13 @@ module Recurly
       define_attribute :destination_tax_address_source, String
 
       # @!attribute discount
-      #   @return [Float] The discount applied to the line item.
+      #   @return [Float] The sum of all discounts applied to the line item.
       define_attribute :discount, Float
 
+      # @!attribute discounts
+      #   @return [Array[LineItemDiscount]] The breakdown of discounts applied to the line item by coupon redemption.
+      define_attribute :discounts, Array, { :item_type => :LineItemDiscount }
+
       # @!attribute end_date
       #   @return [DateTime] If this date is provided, it indicates the end of a time range.
       define_attribute :end_date, DateTime

data/lib/recurly/resources/line_item_discount.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 Resources
+    class LineItemDiscount < Resource
+
+      # @!attribute coupon_id
+      #   @return [String] The ID of the coupon that generated this discount.
+      define_attribute :coupon_id, String
+
+      # @!attribute coupon_redemption_id
+      #   @return [String] The ID of the coupon redemption that generated this discount.
+      define_attribute :coupon_redemption_id, String
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute discount_amount
+      #   @return [Float] The amount discounted on this line item by this coupon redemption.
+      define_attribute :discount_amount, Float
+
+      # @!attribute object
+      #   @return [String] Will always be `line_item_discount`.
+      define_attribute :object, String
+
+      # @!attribute order_applied
+      #   @return [Integer] The order in which this discount was applied when multiple coupons were redeemed.
+      define_attribute :order_applied, Integer
+    end
+  end
+end

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.76.0"
+  VERSION = "4.77.0"
 end

data/openapi/api.yaml

@@ -206,6 +206,7 @@ x-tagGroups:
   - line_item
   - credit_payment
   - transaction
+  - revenue_recovery
 - name: Products and Promotions
   tags:
   - item
@@ -310,6 +311,9 @@ tags:
     subscription is created or renewed or a charge is created on the account, Recurly
     will sum the charges, discount or tax as appropriate, and send the invoice out
     for collection.
+- name: revenue_recovery
+  x-displayName: Revenue Recovery
+  description: Revenue recovery
 - name: line_item
   x-displayName: Line Item
   description: Line items are the charges and credits on your customer's invoices.
@@ -10505,6 +10509,51 @@ paths:
           {\n\t\tfmt.Printf(\"Failed validation: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
           Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfmt.Printf(\"Refunded Invoice:
           %v\", invoice)"
+  "/invoices/recovery":
+    post:
+      tags:
+      - revenue_recovery
+      operationId: create_invoice_retry
+      summary: Create an invoice for revenue recovery
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/RecoveryInvoiceCreate"
+        required: true
+      responses:
+        '201':
+          description: Returns the new invoices.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/InvoiceCollection"
+        '400':
+          description: Bad request, perhaps invalid JSON?
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '404':
+          description: Incorrect site ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '422':
+          description: Invalid parameters, no pending line items, or error running
+            the transaction.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ErrorMayHaveTransaction"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
   "/line_items":
     get:
       tags:
@@ -18621,6 +18670,251 @@ components:
           maxLength: 20
           description: Code that represents a geographic entity (location or object).
             Only returned when Vertex or Avalara for Communications is enabled.
+    RecoveryAddress:
+      type: object
+      properties:
+        phone:
+          type: string
+          title: Phone number
+        street1:
+          type: string
+          title: Street 1
+          maxLength: 50
+        street2:
+          type: string
+          title: Street 2
+          maxLength: 50
+        city:
+          type: string
+          title: City
+        region:
+          type: string
+          title: State/Province
+          description: State or province.
+        postal_code:
+          type: string
+          title: Zip/Postal code
+          description: Zip or postal code.
+        country:
+          type: string
+          title: Country
+          description: Country, 2-letter ISO 3166-1 alpha-2 code.
+    RecoveryInvoiceCreate:
+      type: object
+      properties:
+        currency:
+          type: string
+          title: Currency
+          description: 3-letter ISO 4217 currency code.
+          maxLength: 3
+        due_at:
+          type: string
+          format: date-time
+          title: Due at
+          description: Date invoice was originally due. Must be in the past.
+        po_number:
+          type: string
+          title: Purchase order number
+          description: This identifies the PO number associated with the subscription.
+          maxLength: 50
+        external_recovery_eligible:
+          type: boolean
+          title: External recovery eligible
+          description: Must be set to `true` to acknowledge that the invoice is eligible
+            for external recovery. Requests with `false`, omitted, or non-boolean
+            values will be rejected.
+        account:
+          "$ref": "#/components/schemas/RecoveryAccountCreate"
+        line_items:
+          type: array
+          title: Line items
+          description: Line items to include on the invoice. Currency is specified
+            at the root level and must not be included in individual line items.
+          items:
+            "$ref": "#/components/schemas/RecoveryLineItemCreate"
+      required:
+      - currency
+      - due_at
+      - external_recovery_eligible
+      - account
+      - line_items
+    RecoveryBillingInfoCreate:
+      type: object
+      title: Recovery billing info
+      properties:
+        first_name:
+          type: string
+          title: First name
+          maxLength: 50
+        last_name:
+          type: string
+          title: Last name
+          maxLength: 50
+        company:
+          type: string
+          title: Company name
+          maxLength: 100
+        address:
+          "$ref": "#/components/schemas/RecoveryAddress"
+        ip_address:
+          type: string
+          title: IP address
+          description: "*STRONGLY RECOMMENDED* Customer's IP address when updating
+            their billing information."
+          maxLength: 20
+        gateway_code:
+          type: string
+          title: An identifier for a specific payment gateway.
+          maxLength: 12
+        primary_payment_method:
+          type: boolean
+          title: Primary Payment Method
+          description: The `primary_payment_method` field is used to designate the
+            primary billing info on the account. An account can have a maximum of
+            1 primary. If a user sets a different payment method as a primary, then
+            the existing primary will no longer be marked as such.
+        backup_payment_method:
+          type: boolean
+          description: The `backup_payment_method` field is used to designate a billing
+            info as a backup on the account that will be tried if the initial billing
+            info used for an invoice is declined. All payment methods, including the
+            billing info marked `primary_payment_method` can be set as a backup. An
+            account can have a maximum of 1 backup, if a user sets a different payment
+            method as a backup, the existing backup will no longer be marked as such.
+        payment_gateway_references:
+          type: array
+          description: Array of Payment Gateway References, each a reference to a
+            third-party gateway object of varying types.
+          items:
+            "$ref": "#/components/schemas/PaymentGatewayReferences"
+        network_transaction_id:
+          type: string
+          title: Network Transaction ID
+          description: |
+            Network transaction ID from the previous customer-in-session subscription signup or billing info storage.
+
+            - 10-15 alphanumeric characters for Mastercard
+            - 14-15 alphanumeric for Visa
+            - 15 digits for all other brands
+            - 16 alphanumeric characters for Cartes Bancaires, which are processed as Visa or Mastercard
+          maxLength: 16
+        transactions:
+          type: array
+          title: Transactions
+          description: Transactions from previous collection attempts for this payment
+            method.
+          items:
+            "$ref": "#/components/schemas/RecoveryTransactionCreate"
+      required:
+      - gateway_code
+      - payment_gateway_references
+      - transactions
+    RecoveryAccountCreate:
+      type: object
+      properties:
+        address:
+          "$ref": "#/components/schemas/RecoveryAddress"
+        billing_infos:
+          type: array
+          title: Billing Infos
+          description: If the premium Wallet feature is enabled, more than one payment
+            method can be associated with an account, and one can be designated as
+            a primary and one as a backup. Without the Wallet feature, only one payment
+            method will be accepted.
+          items:
+            "$ref": "#/components/schemas/RecoveryBillingInfoCreate"
+        code:
+          type: string
+          description: The unique identifier of the account. This cannot be changed
+            once the account is created.
+          maxLength: 50
+        email:
+          type: string
+          format: email
+          description: The email address used for communicating with this customer.
+          maxLength: 255
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
+        dunning_campaign_id:
+          type: string
+          title: Dunning Campaign ID
+          description: Unique ID to identify a dunning campaign. Used to specify if
+            a non-default dunning campaign should be assigned to this account. For
+            sites without multiple dunning campaigns enabled, the default dunning
+            campaign will always be used.
+      required:
+      - code
+      - billing_infos
+    RecoveryLineItemCreate:
+      required:
+      - unit_amount
+      type: object
+      title: Recovery line item
+      properties:
+        tax:
+          type: number
+          format: float
+          title: Tax
+          description: The tax amount for the line item.
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
+        harmonized_system_code:
+          type: string
+          title: Harmonized System Code
+          description: The Harmonized System (HS) code is an internationally standardized
+            system of names and numbers to classify traded products. The HS code,
+            sometimes called Commodity Code, is used by customs authorities around
+            the world to identify products when assessing duties and taxes. The HS
+            code may also be referred to as the tariff code or customs code. Values
+            should contain only digits and decimals.
+          maxLength: 25
+          pattern: "^\\d+(\\.\\d+)*$"
+        product_code:
+          type: string
+          title: Product code
+          description: Optional field to track a product code or SKU for the line
+            item. This can be used to later reporting on product purchases.
+          maxLength: 50
+        quantity:
+          type: integer
+          title: Quantity
+          description: This number will be multiplied by the unit amount to compute
+            the subtotal before any discounts or taxes.
+          default: 1
+        description:
+          type: string
+          title: Description
+          description: Description that appears on the invoice.
+          maxLength: 255
+        unit_amount:
+          type: number
+          format: float
+          title: Unit amount
+          description: A positive or negative amount will result in a positive `unit_amount`.
+    RecoveryTransactionCreate:
+      required:
+      - gateway_error_code
+      - attempted_collection_date
+      type: object
+      properties:
+        gateway_error_code:
+          type: string
+          title: Gateway error code
+          description: The error code returned by the payment gateway for the original
+            payment collection attempt.
+          maxLength: 50
+        merchant_advice_code:
+          type: string
+          title: Merchant advice code
+          description: The advice code returned by the payment gateway for the original
+            payment collection attempt. This field is only applicable for certain
+            gateways.
+          maxLength: 2
+        attempted_collection_date:
+          type: string
+          format: date-time
+          title: Attempted collection date
+          description: The date the original payment collection was attempted.
     AddressWithName:
       allOf:
       - "$ref": "#/components/schemas/Address"
@@ -19579,6 +19873,44 @@ components:
         token_id:
           type: string
           description: A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).
+    LineItemDiscount:
+      type: object
+      title: Line item discount
+      description: A discount applied to a line item charge by a coupon redemption.
+      properties:
+        object:
+          type: string
+          title: Object type
+          description: Will always be `line_item_discount`.
+          readOnly: true
+        coupon_id:
+          type: string
+          title: Coupon ID
+          description: The ID of the coupon that generated this discount.
+          readOnly: true
+        coupon_redemption_id:
+          type: string
+          title: Coupon Redemption ID
+          description: The ID of the coupon redemption that generated this discount.
+          readOnly: true
+        order_applied:
+          type: integer
+          title: Order applied
+          description: The order in which this discount was applied when multiple
+            coupons were redeemed.
+          readOnly: true
+        discount_amount:
+          type: number
+          format: float
+          title: Discount amount
+          description: The amount discounted on this line item by this coupon redemption.
+          readOnly: true
+        currency:
+          type: string
+          title: Currency
+          description: 3-letter ISO 4217 currency code.
+          maxLength: 3
+          readOnly: true
     Coupon:
       type: object
       properties:
@@ -19764,7 +20096,8 @@ components:
             title: Free trial unit
             description: 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`.
+              for. Required if `discount_type` is `free_trial`. Use `billing_period`
+              to grant a free trial for a number of billing cycles.
             "$ref": "#/components/schemas/FreeTrialUnitEnum"
           free_trial_amount:
             type: integer
@@ -19842,6 +20175,8 @@ components:
               by `temporal_amount` to define the duration that the coupon will be
               applied to invoices for. Use "billing_period" to apply the coupon for
               a fixed number of billing cycles. Requires `redemption_resource=subscription`.
+              Not compatible with `discount_type=free_trial`; use `free_trial_unit=billing_period`
+              and `free_trial_amount` instead.
             "$ref": "#/components/schemas/TemporalUnitEnum"
           coupon_type:
             title: Coupon type
@@ -19903,7 +20238,8 @@ components:
           properties:
             unit:
               title: Trial unit
-              description: Temporal unit of the free trial
+              description: Temporal unit of the free trial. When `billing_period`,
+                `length` represents the number of billing cycles.
               "$ref": "#/components/schemas/FreeTrialUnitEnum"
             length:
               type: integer
@@ -20016,6 +20352,9 @@ components:
           title: Coupon Redemption state
           default: active
           "$ref": "#/components/schemas/ActiveStateEnum"
+        remaining_duration:
+          readOnly: true
+          "$ref": "#/components/schemas/CouponRedemptionRemainingDuration"
         currency:
           type: string
           title: Currency
@@ -20043,6 +20382,23 @@ components:
           description: The date and time the redemption was removed from the account
             (un-redeemed).
           format: date-time
+    CouponRedemptionRemainingDuration:
+      type: object
+      properties:
+        type:
+          type: string
+          title: Duration Type
+          description: The coupon's duration type. `temporal` includes an `expires_at`
+            timestamp. `forever` and `single_use` have no additional fields.
+          "$ref": "#/components/schemas/CouponDurationEnum"
+          readOnly: true
+        expires_at:
+          type: string
+          title: Expires at
+          format: date-time
+          description: Present when `type` is `temporal`. The datetime after which
+            this redemption will no longer apply.
+          readOnly: true
     CouponRedemptionCreate:
       type: object
       properties:
@@ -20074,8 +20430,11 @@ components:
         coupon:
           "$ref": "#/components/schemas/CouponMini"
         state:
-          title: Invoice state
+          title: Coupon Redemption state
           "$ref": "#/components/schemas/ActiveStateEnum"
+        remaining_duration:
+          readOnly: true
+          "$ref": "#/components/schemas/CouponRedemptionRemainingDuration"
         discounted:
           type: number
           format: float
@@ -20972,6 +21331,12 @@ components:
           format: float
           title: Discount
           description: Total discounts applied to this invoice.
+        coupon_redemptions:
+          type: array
+          title: Coupon Redemptions
+          description: The coupon redemptions applied to this invoice.
+          items:
+            "$ref": "#/components/schemas/CouponRedemptionMini"
         subtotal:
           type: number
           format: float
@@ -21684,7 +22049,14 @@ components:
           type: number
           format: float
           title: Discount
-          description: The discount applied to the line item.
+          description: The sum of all discounts applied to the line item.
+        discounts:
+          type: array
+          title: Discounts
+          description: The breakdown of discounts applied to the line item by coupon
+            redemption.
+          items:
+            "$ref": "#/components/schemas/LineItemDiscount"
         liability_gl_account_code:
           type: string
           title: Accounting code for the ledger account.
@@ -27239,6 +27611,7 @@ components:
       - day
       - month
       - week
+      - billing_period
     RedemptionResourceEnum:
       type: string
       enum:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.76.0
+  version: 4.77.0
 platform: ruby
 authors:
 - Recurly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-20 00:00:00.000000000 Z
+date: 2026-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -231,6 +231,12 @@ files:
 - lib/recurly/requests/pricing.rb
 - lib/recurly/requests/proration_settings.rb
 - lib/recurly/requests/purchase_create.rb
+- lib/recurly/requests/recovery_account_create.rb
+- lib/recurly/requests/recovery_address.rb
+- lib/recurly/requests/recovery_billing_info_create.rb
+- lib/recurly/requests/recovery_invoice_create.rb
+- lib/recurly/requests/recovery_line_item_create.rb
+- lib/recurly/requests/recovery_transaction_create.rb
 - lib/recurly/requests/shipping_address_create.rb
 - lib/recurly/requests/shipping_address_update.rb
 - lib/recurly/requests/shipping_fee_create.rb
@@ -283,6 +289,7 @@ files:
 - lib/recurly/resources/coupon_mini.rb
 - lib/recurly/resources/coupon_redemption.rb
 - lib/recurly/resources/coupon_redemption_mini.rb
+- lib/recurly/resources/coupon_redemption_remaining_duration.rb
 - lib/recurly/resources/credit_application_policy.rb
 - lib/recurly/resources/credit_payment.rb
 - lib/recurly/resources/custom_field.rb
@@ -322,6 +329,7 @@ files:
 - lib/recurly/resources/item.rb
 - lib/recurly/resources/item_mini.rb
 - lib/recurly/resources/line_item.rb
+- lib/recurly/resources/line_item_discount.rb
 - lib/recurly/resources/measured_unit.rb
 - lib/recurly/resources/payment_gateway_references.rb
 - lib/recurly/resources/payment_method.rb
@@ -390,7 +398,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.76.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.77.0
 post_install_message:
 rdoc_options: []
 require_paths: