metronome-sdk 0.2.0 → 1.0.0

data/rbi/metronome_sdk/models/v1/customers/billing_config_create_params.rbi

@@ -352,6 +352,16 @@ module MetronomeSDK
                 :send_invoice,
                 MetronomeSDK::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod::TaggedSymbol
               )
+            AUTO_CHARGE_PAYMENT_INTENT =
+              T.let(
+                :auto_charge_payment_intent,
+                MetronomeSDK::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod::TaggedSymbol
+              )
+            MANUALLY_CHARGE_PAYMENT_INTENT =
+              T.let(
+                :manually_charge_payment_intent,
+                MetronomeSDK::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod::TaggedSymbol
+              )
 
             sig do
               override.returns(

data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi

@@ -438,6 +438,16 @@ module MetronomeSDK
                   :send_invoice,
                   MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::StripeCollectionMethod::TaggedSymbol
                 )
+              AUTO_CHARGE_PAYMENT_INTENT =
+                T.let(
+                  :auto_charge_payment_intent,
+                  MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::StripeCollectionMethod::TaggedSymbol
+                )
+              MANUALLY_CHARGE_PAYMENT_INTENT =
+                T.let(
+                  :manually_charge_payment_intent,
+                  MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::StripeCollectionMethod::TaggedSymbol
+                )
 
               sig do
                 override.returns(

data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi

@@ -79,6 +79,7 @@ module MetronomeSDK
           sig { params(applicable_product_tags: T::Array[String]).void }
           attr_writer :applicable_product_tags
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :custom_fields
 
@@ -165,22 +166,13 @@ module MetronomeSDK
           # specifiers to contribute to a commit's or credit's drawdown. This field cannot
           # be used together with `applicable_product_ids` or `applicable_product_tags`.
           sig do
-            returns(
-              T.nilable(
-                T::Array[
-                  MetronomeSDK::V1::Customers::CommitCreateParams::Specifier
-                ]
-              )
-            )
+            returns(T.nilable(T::Array[MetronomeSDK::CommitSpecifierInput]))
           end
           attr_reader :specifiers
 
           sig do
             params(
-              specifiers:
-                T::Array[
-                  MetronomeSDK::V1::Customers::CommitCreateParams::Specifier::OrHash
-                ]
+              specifiers: T::Array[MetronomeSDK::CommitSpecifierInput::OrHash]
             ).void
           end
           attr_writer :specifiers
@@ -217,10 +209,7 @@ module MetronomeSDK
               rate_type:
                 MetronomeSDK::V1::Customers::CommitCreateParams::RateType::OrSymbol,
               salesforce_opportunity_id: String,
-              specifiers:
-                T::Array[
-                  MetronomeSDK::V1::Customers::CommitCreateParams::Specifier::OrHash
-                ],
+              specifiers: T::Array[MetronomeSDK::CommitSpecifierInput::OrHash],
               uniqueness_key: String,
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(T.attached_class)
@@ -248,6 +237,7 @@ module MetronomeSDK
             # applicable_product_tags or specifiers are not provided, the commit applies to
             # all products.
             applicable_product_tags: nil,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             custom_fields: nil,
             # Used only in UI/API. It is not exposed to end customers.
             description: nil,
@@ -304,10 +294,7 @@ module MetronomeSDK
                 rate_type:
                   MetronomeSDK::V1::Customers::CommitCreateParams::RateType::OrSymbol,
                 salesforce_opportunity_id: String,
-                specifiers:
-                  T::Array[
-                    MetronomeSDK::V1::Customers::CommitCreateParams::Specifier
-                  ],
+                specifiers: T::Array[MetronomeSDK::CommitSpecifierInput],
                 uniqueness_key: String,
                 request_options: MetronomeSDK::RequestOptions
               }
@@ -469,6 +456,14 @@ module MetronomeSDK
             sig { params(credit_type_id: String).void }
             attr_writer :credit_type_id
 
+            # This field is only applicable to commit invoice schedules. If true, this
+            # schedule will not generate an invoice.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :do_not_invoice
+
+            sig { params(do_not_invoice: T::Boolean).void }
+            attr_writer :do_not_invoice
+
             # Enter the unit price and quantity for the charge or instead only send the
             # amount. If amount is sent, the unit price is assumed to be the amount and
             # quantity is inferred to be 1.
@@ -518,6 +513,7 @@ module MetronomeSDK
             sig do
               params(
                 credit_type_id: String,
+                do_not_invoice: T::Boolean,
                 recurring_schedule:
                   MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::OrHash,
                 schedule_items:
@@ -529,6 +525,9 @@ module MetronomeSDK
             def self.new(
               # Defaults to USD (cents) if not passed.
               credit_type_id: nil,
+              # This field is only applicable to commit invoice schedules. If true, this
+              # schedule will not generate an invoice.
+              do_not_invoice: nil,
               # Enter the unit price and quantity for the charge or instead only send the
               # amount. If amount is sent, the unit price is assumed to be the amount and
               # quantity is inferred to be 1.
@@ -542,6 +541,7 @@ module MetronomeSDK
               override.returns(
                 {
                   credit_type_id: String,
+                  do_not_invoice: T::Boolean,
                   recurring_schedule:
                     MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule,
                   schedule_items:
@@ -866,77 +866,6 @@ module MetronomeSDK
             def self.values
             end
           end
-
-          class Specifier < MetronomeSDK::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  MetronomeSDK::V1::Customers::CommitCreateParams::Specifier,
-                  MetronomeSDK::Internal::AnyHash
-                )
-              end
-
-            sig { returns(T.nilable(T::Hash[Symbol, String])) }
-            attr_reader :presentation_group_values
-
-            sig do
-              params(presentation_group_values: T::Hash[Symbol, String]).void
-            end
-            attr_writer :presentation_group_values
-
-            sig { returns(T.nilable(T::Hash[Symbol, String])) }
-            attr_reader :pricing_group_values
-
-            sig { params(pricing_group_values: T::Hash[Symbol, String]).void }
-            attr_writer :pricing_group_values
-
-            # If provided, the specifier will only apply to the product with the specified ID.
-            sig { returns(T.nilable(String)) }
-            attr_reader :product_id
-
-            sig { params(product_id: String).void }
-            attr_writer :product_id
-
-            # If provided, the specifier will only apply to products with all the specified
-            # tags.
-            sig { returns(T.nilable(T::Array[String])) }
-            attr_reader :product_tags
-
-            sig { params(product_tags: T::Array[String]).void }
-            attr_writer :product_tags
-
-            sig do
-              params(
-                presentation_group_values: T::Hash[Symbol, String],
-                pricing_group_values: T::Hash[Symbol, String],
-                product_id: String,
-                product_tags: T::Array[String]
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              presentation_group_values: nil,
-              pricing_group_values: nil,
-              # If provided, the specifier will only apply to the product with the specified ID.
-              product_id: nil,
-              # If provided, the specifier will only apply to products with all the specified
-              # tags.
-              product_tags: nil
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  presentation_group_values: T::Hash[Symbol, String],
-                  pricing_group_values: T::Hash[Symbol, String],
-                  product_id: String,
-                  product_tags: T::Array[String]
-                }
-              )
-            end
-            def to_hash
-            end
-          end
         end
       end
     end

data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi

@@ -67,6 +67,7 @@ module MetronomeSDK
           sig { params(applicable_product_tags: T::Array[String]).void }
           attr_writer :applicable_product_tags
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :custom_fields
 
@@ -123,22 +124,13 @@ module MetronomeSDK
           # specifiers to contribute to a commit's or credit's drawdown. This field cannot
           # be used together with `applicable_product_ids` or `applicable_product_tags`.
           sig do
-            returns(
-              T.nilable(
-                T::Array[
-                  MetronomeSDK::V1::Customers::CreditCreateParams::Specifier
-                ]
-              )
-            )
+            returns(T.nilable(T::Array[MetronomeSDK::CommitSpecifierInput]))
           end
           attr_reader :specifiers
 
           sig do
             params(
-              specifiers:
-                T::Array[
-                  MetronomeSDK::V1::Customers::CreditCreateParams::Specifier::OrHash
-                ]
+              specifiers: T::Array[MetronomeSDK::CommitSpecifierInput::OrHash]
             ).void
           end
           attr_writer :specifiers
@@ -170,10 +162,7 @@ module MetronomeSDK
               rate_type:
                 MetronomeSDK::V1::Customers::CreditCreateParams::RateType::OrSymbol,
               salesforce_opportunity_id: String,
-              specifiers:
-                T::Array[
-                  MetronomeSDK::V1::Customers::CreditCreateParams::Specifier::OrHash
-                ],
+              specifiers: T::Array[MetronomeSDK::CommitSpecifierInput::OrHash],
               uniqueness_key: String,
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(T.attached_class)
@@ -195,6 +184,7 @@ module MetronomeSDK
             # Which tags the credit applies to. If both applicable_product_ids and
             # applicable_product_tags are not provided, the credit applies to all products.
             applicable_product_tags: nil,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             custom_fields: nil,
             # Used only in UI/API. It is not exposed to end customers.
             description: nil,
@@ -237,10 +227,7 @@ module MetronomeSDK
                 rate_type:
                   MetronomeSDK::V1::Customers::CreditCreateParams::RateType::OrSymbol,
                 salesforce_opportunity_id: String,
-                specifiers:
-                  T::Array[
-                    MetronomeSDK::V1::Customers::CreditCreateParams::Specifier
-                  ],
+                specifiers: T::Array[MetronomeSDK::CommitSpecifierInput],
                 uniqueness_key: String,
                 request_options: MetronomeSDK::RequestOptions
               }
@@ -384,77 +371,6 @@ module MetronomeSDK
             def self.values
             end
           end
-
-          class Specifier < MetronomeSDK::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  MetronomeSDK::V1::Customers::CreditCreateParams::Specifier,
-                  MetronomeSDK::Internal::AnyHash
-                )
-              end
-
-            sig { returns(T.nilable(T::Hash[Symbol, String])) }
-            attr_reader :presentation_group_values
-
-            sig do
-              params(presentation_group_values: T::Hash[Symbol, String]).void
-            end
-            attr_writer :presentation_group_values
-
-            sig { returns(T.nilable(T::Hash[Symbol, String])) }
-            attr_reader :pricing_group_values
-
-            sig { params(pricing_group_values: T::Hash[Symbol, String]).void }
-            attr_writer :pricing_group_values
-
-            # If provided, the specifier will only apply to the product with the specified ID.
-            sig { returns(T.nilable(String)) }
-            attr_reader :product_id
-
-            sig { params(product_id: String).void }
-            attr_writer :product_id
-
-            # If provided, the specifier will only apply to products with all the specified
-            # tags.
-            sig { returns(T.nilable(T::Array[String])) }
-            attr_reader :product_tags
-
-            sig { params(product_tags: T::Array[String]).void }
-            attr_writer :product_tags
-
-            sig do
-              params(
-                presentation_group_values: T::Hash[Symbol, String],
-                pricing_group_values: T::Hash[Symbol, String],
-                product_id: String,
-                product_tags: T::Array[String]
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              presentation_group_values: nil,
-              pricing_group_values: nil,
-              # If provided, the specifier will only apply to the product with the specified ID.
-              product_id: nil,
-              # If provided, the specifier will only apply to products with all the specified
-              # tags.
-              product_tags: nil
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  presentation_group_values: T::Hash[Symbol, String],
-                  pricing_group_values: T::Hash[Symbol, String],
-                  product_id: String,
-                  product_tags: T::Array[String]
-                }
-              )
-            end
-            def to_hash
-            end
-          end
         end
       end
     end

data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi

@@ -570,13 +570,16 @@ module MetronomeSDK
               sig { returns(String) }
               attr_accessor :key
 
-              sig { returns(String) }
-              attr_accessor :value
+              sig { returns(T.nilable(String)) }
+              attr_reader :value
+
+              sig { params(value: String).void }
+              attr_writer :value
 
               sig do
                 params(key: String, value: String).returns(T.attached_class)
               end
-              def self.new(key:, value:)
+              def self.new(key:, value: nil)
               end
 
               sig { override.returns({ key: String, value: String }) }

data/rbi/metronome_sdk/models/v1/customers/invoice.rbi

@@ -63,6 +63,7 @@ module MetronomeSDK
           end
           attr_writer :billable_status
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :contract_custom_fields
 
@@ -104,6 +105,7 @@ module MetronomeSDK
           sig { params(custom_fields: T::Hash[Symbol, T.anything]).void }
           attr_writer :custom_fields
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :customer_custom_fields
 
@@ -175,6 +177,7 @@ module MetronomeSDK
           sig { params(netsuite_sales_order_id: String).void }
           attr_writer :netsuite_sales_order_id
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :plan_custom_fields
 
@@ -284,6 +287,7 @@ module MetronomeSDK
             amendment_id: nil,
             # This field's availability is dependent on your client's configuration.
             billable_status: nil,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             contract_custom_fields: nil,
             contract_id: nil,
             correction_record: nil,
@@ -291,6 +295,7 @@ module MetronomeSDK
             # invoices only.
             created_at: nil,
             custom_fields: nil,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             customer_custom_fields: nil,
             # End of the usage period this invoice covers (UTC)
             end_timestamp: nil,
@@ -301,6 +306,7 @@ module MetronomeSDK
             net_payment_terms_days: nil,
             # This field's availability is dependent on your client's configuration.
             netsuite_sales_order_id: nil,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             plan_custom_fields: nil,
             plan_id: nil,
             plan_name: nil,
@@ -384,6 +390,32 @@ module MetronomeSDK
             sig { returns(Float) }
             attr_accessor :total
 
+            # The type of line item.
+            #
+            # - `scheduled`: Line item is associated with a scheduled charge. View the
+            #   scheduled_charge_id on the line item.
+            # - `commit_purchase`: Line item is associated with a payment for a prepaid
+            #   commit. View the commit_id on the line item.
+            # - `usage`: Line item is associated with a usage product or composite product.
+            #   View the product_id on the line item to determine which product.
+            # - `subscription`: Line item is associated with a subscription. e.g. monthly
+            #   recurring payment for an in-advance subscription.
+            # - `applied_commit_or_credit`: On metronome invoices, applied commits and credits
+            #   are associated with their own line items. These line items have negative
+            #   totals. Use the applied_commit_or_credit object on the line item to understand
+            #   the id of the applied commit or credit, and its type. Note that the
+            #   application of a postpaid commit is associated with a line item, but the total
+            #   on the line item is not included in the invoice's total as postpaid commits
+            #   are paid in-arrears.
+            # - `cpu_conversion`: Line item converting between a custom pricing unit and fiat
+            #   currency, using the conversion rate set on the rate card. This line item will
+            #   appear when there are products priced in custom pricing units, and there is
+            #   insufficient prepaid commit/credit in that custom pricing unit to fully cover
+            #   the spend. Then, the outstanding spend in custom pricing units will be
+            #   converted to fiat currency using a cpu_conversion line item.
+            sig { returns(String) }
+            attr_accessor :type
+
             # Details about the credit or commit that was applied to this line item. Only
             # present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`
             # types.
@@ -404,6 +436,7 @@ module MetronomeSDK
             end
             attr_writer :applied_commit_or_credit
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :commit_custom_fields
 
@@ -446,12 +479,14 @@ module MetronomeSDK
             sig { params(commit_type: String).void }
             attr_writer :commit_type
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :custom_fields
 
             sig { params(custom_fields: T::Hash[Symbol, String]).void }
             attr_writer :custom_fields
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :discount_custom_fields
 
@@ -561,6 +596,7 @@ module MetronomeSDK
             sig { params(pricing_group_values: T::Hash[Symbol, String]).void }
             attr_writer :pricing_group_values
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :product_custom_fields
 
@@ -592,6 +628,7 @@ module MetronomeSDK
             sig { params(product_type: String).void }
             attr_writer :product_type
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :professional_service_custom_fields
 
@@ -632,6 +669,7 @@ module MetronomeSDK
             end
             attr_writer :reseller_type
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :scheduled_charge_custom_fields
 
@@ -677,6 +715,7 @@ module MetronomeSDK
             end
             attr_writer :sub_line_items
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :subscription_custom_fields
 
@@ -713,6 +752,7 @@ module MetronomeSDK
                 credit_type: MetronomeSDK::CreditTypeData::OrHash,
                 name: String,
                 total: Float,
+                type: String,
                 applied_commit_or_credit:
                   MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::OrHash,
                 commit_custom_fields: T::Hash[Symbol, String],
@@ -763,10 +803,35 @@ module MetronomeSDK
               credit_type:,
               name:,
               total:,
+              # The type of line item.
+              #
+              # - `scheduled`: Line item is associated with a scheduled charge. View the
+              #   scheduled_charge_id on the line item.
+              # - `commit_purchase`: Line item is associated with a payment for a prepaid
+              #   commit. View the commit_id on the line item.
+              # - `usage`: Line item is associated with a usage product or composite product.
+              #   View the product_id on the line item to determine which product.
+              # - `subscription`: Line item is associated with a subscription. e.g. monthly
+              #   recurring payment for an in-advance subscription.
+              # - `applied_commit_or_credit`: On metronome invoices, applied commits and credits
+              #   are associated with their own line items. These line items have negative
+              #   totals. Use the applied_commit_or_credit object on the line item to understand
+              #   the id of the applied commit or credit, and its type. Note that the
+              #   application of a postpaid commit is associated with a line item, but the total
+              #   on the line item is not included in the invoice's total as postpaid commits
+              #   are paid in-arrears.
+              # - `cpu_conversion`: Line item converting between a custom pricing unit and fiat
+              #   currency, using the conversion rate set on the rate card. This line item will
+              #   appear when there are products priced in custom pricing units, and there is
+              #   insufficient prepaid commit/credit in that custom pricing unit to fully cover
+              #   the spend. Then, the outstanding spend in custom pricing units will be
+              #   converted to fiat currency using a cpu_conversion line item.
+              type:,
               # Details about the credit or commit that was applied to this line item. Only
               # present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`
               # types.
               applied_commit_or_credit: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               commit_custom_fields: nil,
               # For line items with product of `USAGE`, `SUBSCRIPTION`, or `COMPOSITE` types,
               # the ID of the credit or commit that was applied to this line item. For line
@@ -779,7 +844,9 @@ module MetronomeSDK
               # `PrepaidCommit` (for commit types `PREPAID` and `CREDIT`) or `PostpaidCommit`
               # (for commit type `POSTPAID`).
               commit_type: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               custom_fields: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               discount_custom_fields: nil,
               # ID of the discount applied to this line item.
               discount_id: nil,
@@ -807,6 +874,7 @@ module MetronomeSDK
               # Includes the pricing group values associated with this line item if dimensional
               # pricing is used.
               pricing_group_values: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               product_custom_fields: nil,
               # ID of the product associated with the line item.
               product_id: nil,
@@ -818,17 +886,20 @@ module MetronomeSDK
               # `CompositeProductListItem` (for `COMPOSITE` type products). For scheduled
               # charges, commit and credit payments, the value is `FixedProductListItem`.
               product_type: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               professional_service_custom_fields: nil,
               professional_service_id: nil,
               # The quantity associated with the line item.
               quantity: nil,
               reseller_type: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               scheduled_charge_custom_fields: nil,
               # ID of scheduled charge.
               scheduled_charge_id: nil,
               # The line item's start date (inclusive).
               starting_at: nil,
               sub_line_items: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               subscription_custom_fields: nil,
               # Populated if the line item has a tiered price.
               tier: nil,
@@ -843,6 +914,7 @@ module MetronomeSDK
                   credit_type: MetronomeSDK::CreditTypeData,
                   name: String,
                   total: Float,
+                  type: String,
                   applied_commit_or_credit:
                     MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit,
                   commit_custom_fields: T::Hash[Symbol, String],
@@ -1051,6 +1123,7 @@ module MetronomeSDK
                   )
                 end
 
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               sig { returns(T::Hash[Symbol, String]) }
               attr_accessor :custom_fields
 
@@ -1156,6 +1229,7 @@ module MetronomeSDK
                 ).returns(T.attached_class)
               end
               def self.new(
+                # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
                 custom_fields:,
                 name:,
                 quantity:,
@@ -1895,6 +1969,7 @@ module MetronomeSDK
             sig { returns(Float) }
             attr_accessor :total
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :credit_grant_custom_fields
 
@@ -1922,6 +1997,7 @@ module MetronomeSDK
               credit_type:,
               name:,
               total:,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               credit_grant_custom_fields: nil,
               credit_grant_id: nil
             )

data/rbi/metronome_sdk/models/v1/customers/plan_list_response.rbi

@@ -17,6 +17,7 @@ module MetronomeSDK
           sig { returns(String) }
           attr_accessor :id
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T::Hash[Symbol, String]) }
           attr_accessor :custom_fields
 
@@ -79,6 +80,7 @@ module MetronomeSDK
           def self.new(
             # the ID of the customer plan
             id:,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             custom_fields:,
             plan_description:,
             # the ID of the plan

data/rbi/metronome_sdk/models/v1/plan_detail.rbi

@@ -12,6 +12,7 @@ module MetronomeSDK
         sig { returns(String) }
         attr_accessor :id
 
+        # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         sig { returns(T::Hash[Symbol, String]) }
         attr_accessor :custom_fields
 
@@ -81,6 +82,7 @@ module MetronomeSDK
         end
         def self.new(
           id:,
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           custom_fields:,
           name:,
           credit_grants: nil,

data/rbi/metronome_sdk/models/v1/plan_list_charges_response.rbi

@@ -28,6 +28,7 @@ module MetronomeSDK
         sig { params(credit_type: MetronomeSDK::CreditTypeData::OrHash).void }
         attr_writer :credit_type
 
+        # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         sig { returns(T::Hash[Symbol, String]) }
         attr_accessor :custom_fields
 
@@ -112,6 +113,7 @@ module MetronomeSDK
           id:,
           charge_type:,
           credit_type:,
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           custom_fields:,
           name:,
           prices:,