recurly 4.65.0 → 4.66.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2eff66410b1aee2ef302ab1b35dbe355ef69e69d5c82ffb88e3e111b96ed589
-  data.tar.gz: a481d2e74e67ad8fcaa78a938bbdaaf6e86e6519f99350fffd3e245f54270f10
+  metadata.gz: 77ba4ba0c1fdf8abde591f11cf95bd727ff60e279e806f66d6d5cb11462f2bdf
+  data.tar.gz: 29c17176e6dd1228a30716b0e92306ebd76ef87a41c40f1be38a82a60a6b1cfc
 SHA512:
-  metadata.gz: 0a9d62924b675a5f8c417f3d2a5a622bbeb7bd6789781e8eb169b84c2ec6feb18f3068b388365626c6743b549af065a5b3c46b0004923d568766d5a667bf296c
-  data.tar.gz: 14f3346e00aa13044267a72752f6b9e1e880cac5c97b9a8b4330ec9160474dbe10a97df35bc60c31fc9b91a7175921485742138d37f89352b7a8ef06e6881e12
+  metadata.gz: 22a4d56b96b2c7e635b504bd08574a4314c389d7154ff281aa346e62e705aea538f7b4700836b3048353fbfbc1884824d289e06e17a09ca57567165969929791
+  data.tar.gz: 437441e666c9dd8b0d03de3df2f11cb4da5332674c58f472867359899fc219211c8f70343ca40fd1eae606008db49b52b7b5da7afa31f2195d95729e84cc0b68

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [4.66.0](https://github.com/recurly/recurly-client-ruby/tree/4.66.0) (2025-07-22)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.65.0...4.66.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#933](https://github.com/recurly/recurly-client-ruby/pull/933) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.65.0](https://github.com/recurly/recurly-client-ruby/tree/4.65.0) (2025-07-09)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.64.0...4.65.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.65'
+gem 'recurly', '~> 4.66'
 ```
 
 > *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

@@ -2566,7 +2566,7 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice get_invoice api documentation}
     #
-    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
+    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
     # @param params [Hash] Optional query string parameters:
     #
     # @return [Resources::Invoice] An invoice.
@@ -2589,7 +2589,7 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/update_invoice update_invoice api documentation}
     #
-    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
+    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
     # @param body [Requests::InvoiceUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceUpdate}
     # @param params [Hash] Optional query string parameters:
     #
@@ -2617,7 +2617,7 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice_pdf get_invoice_pdf api documentation}
     #
-    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
+    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
     # @param params [Hash] Optional query string parameters:
     #
     # @return [Resources::BinaryFile] An invoice as a PDF.
@@ -2643,7 +2643,7 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/apply_credit_balance apply_credit_balance api documentation}
     #
-    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
+    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
     # @param params [Hash] Optional query string parameters:
     #        :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
     #
@@ -2667,7 +2667,7 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/collect_invoice collect_invoice api documentation}
     #
-    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
+    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
     # @param params [Hash] Optional query string parameters:
     #        :body [Requests::InvoiceCollect] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCollect}
     #
@@ -2691,7 +2691,7 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_failed mark_invoice_failed api documentation}
     #
-    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
+    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
     # @param params [Hash] Optional query string parameters:
     #
     # @return [Resources::Invoice] The updated invoice.
@@ -2714,7 +2714,7 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_successful mark_invoice_successful api documentation}
     #
-    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
+    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
     # @param params [Hash] Optional query string parameters:
     #
     # @return [Resources::Invoice] The updated invoice.
@@ -2737,7 +2737,7 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/reopen_invoice reopen_invoice api documentation}
     #
-    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
+    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
     # @param params [Hash] Optional query string parameters:
     #
     # @return [Resources::Invoice] The updated invoice.
@@ -2760,7 +2760,7 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/void_invoice void_invoice api documentation}
     #
-    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
+    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
     # @param params [Hash] Optional query string parameters:
     #
     # @return [Resources::Invoice] The updated invoice.
@@ -2783,7 +2783,7 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/record_external_transaction record_external_transaction api documentation}
     #
-    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
+    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
     # @param body [Requests::ExternalTransaction] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ExternalTransaction}
     # @param params [Hash] Optional query string parameters:
     #
@@ -2798,7 +2798,7 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_line_items list_invoice_line_items api documentation}
     #
-    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
+    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
     # @param params [Hash] Optional query string parameters:
     #        :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
@@ -2850,7 +2850,7 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documentation}
     #
-    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
+    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
     # @param params [Hash] Optional query string parameters:
     #        :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
@@ -2897,7 +2897,7 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_related_invoices list_related_invoices api documentation}
     #
-    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
+    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
     # @param params [Hash] Optional query string parameters:
     #
     # @return [Pager<Resources::Invoice>] A list of the credit or charge invoices associated with the invoice.
@@ -2922,7 +2922,7 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/refund_invoice refund_invoice api documentation}
     #
-    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
+    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
     # @param body [Requests::InvoiceRefund] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceRefund}
     # @param params [Hash] Optional query string parameters:
     #
@@ -3376,6 +3376,47 @@ module Recurly
       delete(path, **options)
     end
 
+    # List a site's price segments
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_price_segments list_price_segments api documentation}
+    #
+    # @param params [Hash] Optional query string parameters:
+    #        :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
+    #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
+    #
+    #   *Important notes:*
+    #
+    #   * The +ids+ parameter cannot be used with any other ordering or filtering
+    #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
+    #   * Invalid or unknown IDs will be ignored, so you should check that the
+    #     results correspond to your request.
+    #   * Records are returned in an arbitrary order. Since results are all
+    #     returned at once you can sort the records yourself.
+    #
+    #        :limit [Integer] Limit number of records 1-200.
+    #        :order [String] Sort order.
+    #
+    # @return [Pager<Resources::PriceSegment>] A list of price segments.
+    #
+    def list_price_segments(**options)
+      path = "/price_segments"
+      pager(path, **options)
+    end
+
+    # Fetch a price segment
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/get_price_segment get_price_segment api documentation}
+    #
+    # @param price_segment_id [String] The price segment ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::PriceSegment] A price segment.
+    #
+    def get_price_segment(price_segment_id:, **options)
+      path = interpolate_path("/price_segments/{price_segment_id}", price_segment_id: price_segment_id)
+      get(path, **options)
+    end
+
     # List a site's add-ons
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_add_ons list_add_ons api documentation}

data/lib/recurly/requests/plan_create.rb

@@ -35,7 +35,7 @@ module Recurly
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[PlanPricing]] Pricing
+      #   @return [Array[PlanPricing]] Required only when `pricing_model` is `'fixed'`.
       define_attribute :currencies, Array, { :item_type => :PlanPricing }
 
       # @!attribute custom_fields
@@ -110,6 +110,10 @@ module Recurly
       #   @return [String] Setup fee revenue schedule type
       define_attribute :setup_fee_revenue_schedule_type, String
 
+      # @!attribute setup_fees
+      #   @return [Array[PlanSetupPricingCreate]] Setup Fees
+      define_attribute :setup_fees, Array, { :item_type => :PlanSetupPricingCreate }
+
       # @!attribute tax_code
       #   @return [String] Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.
       define_attribute :tax_code, String
@@ -119,7 +123,7 @@ module Recurly
       define_attribute :tax_exempt, :Boolean
 
       # @!attribute total_billing_cycles
-      #   @return [Integer] Automatically terminate plans after a defined number of billing cycles.
+      #   @return [Integer] Automatically terminate subscriptions after a defined number of billing cycles. Number of billing cycles before the plan automatically stops renewing, defaults to `null` for continuous, automatic renewal.
       define_attribute :total_billing_cycles, Integer
 
       # @!attribute trial_length

data/lib/recurly/requests/plan_pricing.rb

@@ -10,8 +10,12 @@ module Recurly
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String
 
+      # @!attribute price_segment_id
+      #   @return [String] The price segment ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For requests, the code can also be used. Use prefix `code-`, e.g. `code-gold`.
+      define_attribute :price_segment_id, String
+
       # @!attribute setup_fee
-      #   @return [Float] Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.
+      #   @return [Float] This field is deprecated, please use top level `setup_fees` instead. Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.
       define_attribute :setup_fee, Float
 
       # @!attribute tax_inclusive
@@ -19,7 +23,7 @@ module Recurly
       define_attribute :tax_inclusive, :Boolean
 
       # @!attribute unit_amount
-      #   @return [Float] This field should not be sent when the pricing model is 'ramp'.
+      #   @return [Float] This field should not be sent when the pricing model is `'ramp'`.
       define_attribute :unit_amount, Float
     end
   end

data/lib/recurly/requests/plan_ramp_pricing.rb

@@ -10,6 +10,10 @@ module Recurly
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String
 
+      # @!attribute price_segment_id
+      #   @return [String] The price segment ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For requests, the code can also be used. Use prefix `code-`, e.g. `code-gold`.
+      define_attribute :price_segment_id, String
+
       # @!attribute unit_amount
       #   @return [Float] Represents the price for the Ramp Interval.
       define_attribute :unit_amount, Float

data/lib/recurly/requests/plan_setup_pricing_create.rb

@@ -0,0 +1,18 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class PlanSetupPricingCreate < Request
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute unit_amount
+      #   @return [Float] Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/plan_update.rb

@@ -31,7 +31,7 @@ module Recurly
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[PlanPricing]] Optional when the pricing model is 'ramp'.
+      #   @return [Array[PlanPricing]] Required only when `pricing_model` is `'fixed'`.
       define_attribute :currencies, Array, { :item_type => :PlanPricing }
 
       # @!attribute custom_fields
@@ -51,7 +51,7 @@ module Recurly
       define_attribute :hosted_pages, :PlanHostedPages
 
       # @!attribute id
-      #   @return [String] Plan ID
+      #   @return [String] This field has no effect on the request/response.
       define_attribute :id, String
 
       # @!attribute liability_gl_account_id
@@ -98,6 +98,10 @@ module Recurly
       #   @return [String] Setup fee revenue schedule type
       define_attribute :setup_fee_revenue_schedule_type, String
 
+      # @!attribute setup_fees
+      #   @return [Array[PlanSetupPricingCreate]] Setup Fees
+      define_attribute :setup_fees, Array, { :item_type => :PlanSetupPricingCreate }
+
       # @!attribute tax_code
       #   @return [String] Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.
       define_attribute :tax_code, String
@@ -107,7 +111,7 @@ module Recurly
       define_attribute :tax_exempt, :Boolean
 
       # @!attribute total_billing_cycles
-      #   @return [Integer] Automatically terminate plans after a defined number of billing cycles.
+      #   @return [Integer] Automatically terminate subscriptions after a defined number of billing cycles. Number of billing cycles before the plan automatically stops renewing, defaults to `null` for continuous, automatic renewal.
       define_attribute :total_billing_cycles, Integer
 
       # @!attribute trial_length

data/lib/recurly/requests/pricing.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :tax_inclusive, :Boolean
 
       # @!attribute unit_amount
-      #   @return [Float] Unit price
+      #   @return [Float]
       define_attribute :unit_amount, Float
     end
   end

data/lib/recurly/requests/subscription_change_create.rb

@@ -54,6 +54,10 @@ module Recurly
       #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
       define_attribute :po_number, String
 
+      # @!attribute price_segment_id
+      #   @return [String] The price segment ID, e.g. `e28zov4fw0v2`.
+      define_attribute :price_segment_id, String
+
       # @!attribute proration_settings
       #   @return [ProrationSettings] Allows you to control how any resulting charges and credits will be calculated and prorated.
       define_attribute :proration_settings, :ProrationSettings

data/lib/recurly/requests/subscription_create.rb

@@ -90,6 +90,10 @@ module Recurly
       #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
       define_attribute :po_number, String
 
+      # @!attribute price_segment_id
+      #   @return [String] The price segment ID, e.g. `e28zov4fw0v2`.
+      define_attribute :price_segment_id, String
+
       # @!attribute quantity
       #   @return [Integer] Optionally override the default quantity of 1.
       define_attribute :quantity, Integer

data/lib/recurly/requests/subscription_purchase.rb

@@ -34,6 +34,10 @@ module Recurly
       #   @return [String] Plan ID
       define_attribute :plan_id, String
 
+      # @!attribute price_segment_id
+      #   @return [String] The price segment ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For requests, the code can also be used. Use prefix `code-`, e.g. `code-gold`.
+      define_attribute :price_segment_id, String
+
       # @!attribute quantity
       #   @return [Integer] Optionally override the default quantity of 1.
       define_attribute :quantity, Integer

data/lib/recurly/requests/subscription_update.rb

@@ -46,6 +46,10 @@ module Recurly
       #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
       define_attribute :po_number, String
 
+      # @!attribute price_segment_id
+      #   @return [String] The price segment ID, e.g. `e28zov4fw0v2`.
+      define_attribute :price_segment_id, String
+
       # @!attribute remaining_billing_cycles
       #   @return [Integer] The remaining billing cycles in the current term.
       define_attribute :remaining_billing_cycles, Integer

data/lib/recurly/resources/plan.rb

@@ -35,7 +35,7 @@ module Recurly
       define_attribute :created_at, DateTime
 
       # @!attribute currencies
-      #   @return [Array[PlanPricing]] Pricing
+      #   @return [Array[PlanPricing]] Present only when `pricing_model` is `'fixed'`.
       define_attribute :currencies, Array, { :item_type => :PlanPricing }
 
       # @!attribute custom_fields
@@ -70,6 +70,10 @@ module Recurly
       #   @return [String] Unit for the plan's billing interval.
       define_attribute :interval_unit, String
 
+      # @!attribute liability_gl_account_id
+      #   @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
+      define_attribute :liability_gl_account_id, String
+
       # @!attribute name
       #   @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
       define_attribute :name, String
@@ -78,6 +82,10 @@ module Recurly
       #   @return [String] Object type
       define_attribute :object, String
 
+      # @!attribute performance_obligation_id
+      #   @return [String] The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
+      define_attribute :performance_obligation_id, String
+
       # @!attribute pricing_model
       #   @return [String] A fixed pricing model has the same price for each billing period. A ramp pricing model defines a set of Ramp Intervals, where a subscription changes price on a specified cadence of billing periods. The price change could be an increase or decrease.
       define_attribute :pricing_model, String
@@ -86,6 +94,10 @@ module Recurly
       #   @return [Array[PlanRampInterval]] Ramp Intervals
       define_attribute :ramp_intervals, Array, { :item_type => :PlanRampInterval }
 
+      # @!attribute revenue_gl_account_id
+      #   @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
+      define_attribute :revenue_gl_account_id, String
+
       # @!attribute revenue_schedule_type
       #   @return [String] Revenue schedule type
       define_attribute :revenue_schedule_type, String
@@ -94,10 +106,26 @@ module Recurly
       #   @return [String] Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.
       define_attribute :setup_fee_accounting_code, String
 
+      # @!attribute setup_fee_liability_gl_account_id
+      #   @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
+      define_attribute :setup_fee_liability_gl_account_id, String
+
+      # @!attribute setup_fee_performance_obligation_id
+      #   @return [String] The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
+      define_attribute :setup_fee_performance_obligation_id, String
+
+      # @!attribute setup_fee_revenue_gl_account_id
+      #   @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
+      define_attribute :setup_fee_revenue_gl_account_id, String
+
       # @!attribute setup_fee_revenue_schedule_type
       #   @return [String] Setup fee revenue schedule type
       define_attribute :setup_fee_revenue_schedule_type, String
 
+      # @!attribute setup_fees
+      #   @return [Array[PlanSetupPricing]] Setup Fees
+      define_attribute :setup_fees, Array, { :item_type => :PlanSetupPricing }
+
       # @!attribute state
       #   @return [String] The current state of the plan.
       define_attribute :state, String

data/lib/recurly/resources/plan_pricing.rb

@@ -10,8 +10,12 @@ module Recurly
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String
 
+      # @!attribute price_segment_id
+      #   @return [String] The price segment ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For requests, the code can also be used. Use prefix `code-`, e.g. `code-gold`.
+      define_attribute :price_segment_id, String
+
       # @!attribute setup_fee
-      #   @return [Float] Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.
+      #   @return [Float] This field is deprecated, please use top level `setup_fees` instead. Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.
       define_attribute :setup_fee, Float
 
       # @!attribute tax_inclusive
@@ -19,7 +23,7 @@ module Recurly
       define_attribute :tax_inclusive, :Boolean
 
       # @!attribute unit_amount
-      #   @return [Float] This field should not be sent when the pricing model is 'ramp'.
+      #   @return [Float] This field should not be sent when the pricing model is `'ramp'`.
       define_attribute :unit_amount, Float
     end
   end

data/lib/recurly/resources/plan_ramp_pricing.rb

@@ -10,6 +10,10 @@ module Recurly
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String
 
+      # @!attribute price_segment_id
+      #   @return [String] The price segment ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For requests, the code can also be used. Use prefix `code-`, e.g. `code-gold`.
+      define_attribute :price_segment_id, String
+
       # @!attribute unit_amount
       #   @return [Float] Represents the price for the Ramp Interval.
       define_attribute :unit_amount, Float

data/lib/recurly/resources/plan_setup_pricing.rb

@@ -0,0 +1,18 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class PlanSetupPricing < Resource
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute unit_amount
+      #   @return [Float] Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/resources/price_segment.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 Resources
+    class PriceSegment < Resource
+
+      # @!attribute code
+      #   @return [String] The price segment code, e.g. `my-price-segment`.
+      define_attribute :code, String
+
+      # @!attribute id
+      #   @return [String] The price segment ID, e.g. `e28zov4fw0v2`.
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/resources/pricing.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :tax_inclusive, :Boolean
 
       # @!attribute unit_amount
-      #   @return [Float] Unit price
+      #   @return [Float]
       define_attribute :unit_amount, Float
     end
   end

data/lib/recurly/resources/subscription.rb

@@ -138,6 +138,10 @@ module Recurly
       #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
       define_attribute :po_number, String
 
+      # @!attribute price_segment_id
+      #   @return [String] The price segment ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For requests, the code can also be used. Use prefix `code-`, e.g. `code-gold`.
+      define_attribute :price_segment_id, String
+
       # @!attribute quantity
       #   @return [Integer] Subscription quantity
       define_attribute :quantity, Integer

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.65.0"
+  VERSION = "4.66.0"
 end