metronome-sdk 2.0.0 → 2.2.0

data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi

@@ -4076,6 +4076,12 @@ module MetronomeSDK
             sig { returns(T.nilable(T::Array[String])) }
             attr_accessor :applicable_product_tags
 
+            sig { returns(T.nilable(String)) }
+            attr_reader :description
+
+            sig { params(description: String).void }
+            attr_writer :description
+
             # Optional configuration for commit hierarchy access control
             sig do
               returns(T.nilable(MetronomeSDK::CommitHierarchyConfiguration))
@@ -4166,6 +4172,7 @@ module MetronomeSDK
                   MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit::AccessSchedule::OrHash,
                 applicable_product_ids: T.nilable(T::Array[String]),
                 applicable_product_tags: T.nilable(T::Array[String]),
+                description: String,
                 hierarchy_configuration:
                   MetronomeSDK::CommitHierarchyConfiguration::OrHash,
                 invoice_schedule:
@@ -4194,6 +4201,7 @@ module MetronomeSDK
               # applicable_product_tags or specifiers are not provided, the commit applies to
               # all products.
               applicable_product_tags: nil,
+              description: nil,
               # Optional configuration for commit hierarchy access control
               hierarchy_configuration: nil,
               invoice_schedule: nil,
@@ -4224,6 +4232,7 @@ module MetronomeSDK
                     MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit::AccessSchedule,
                   applicable_product_ids: T.nilable(T::Array[String]),
                   applicable_product_tags: T.nilable(T::Array[String]),
+                  description: String,
                   hierarchy_configuration:
                     MetronomeSDK::CommitHierarchyConfiguration,
                   invoice_schedule:
@@ -4822,6 +4831,12 @@ module MetronomeSDK
             end
             attr_writer :access_schedule
 
+            sig { returns(T.nilable(String)) }
+            attr_reader :description
+
+            sig { params(description: String).void }
+            attr_writer :description
+
             # Optional configuration for credit hierarchy access control
             sig do
               returns(T.nilable(MetronomeSDK::CommitHierarchyConfiguration))
@@ -4876,6 +4891,7 @@ module MetronomeSDK
                 id: String,
                 access_schedule:
                   MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCredit::AccessSchedule::OrHash,
+                description: String,
                 hierarchy_configuration:
                   MetronomeSDK::CommitHierarchyConfiguration::OrHash,
                 name: String,
@@ -4889,6 +4905,7 @@ module MetronomeSDK
             def self.new(
               id:,
               access_schedule: nil,
+              description: nil,
               # Optional configuration for credit hierarchy access control
               hierarchy_configuration: nil,
               name: nil,
@@ -4908,6 +4925,7 @@ module MetronomeSDK
                   id: String,
                   access_schedule:
                     MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCredit::AccessSchedule,
+                  description: String,
                   hierarchy_configuration:
                     MetronomeSDK::CommitHierarchyConfiguration,
                   name: String,
@@ -6717,6 +6735,24 @@ module MetronomeSDK
             end
             attr_writer :quantity_updates
 
+            # Manage subscription seats for subscriptions in SEAT_BASED mode.
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates
+                )
+              )
+            end
+            attr_reader :seat_updates
+
+            sig do
+              params(
+                seat_updates:
+                  MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::OrHash
+              ).void
+            end
+            attr_writer :seat_updates
+
             sig do
               params(
                 id: String,
@@ -6724,10 +6760,18 @@ module MetronomeSDK
                 quantity_updates:
                   T::Array[
                     MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::QuantityUpdate::OrHash
-                  ]
+                  ],
+                seat_updates:
+                  MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::OrHash
               ).returns(T.attached_class)
             end
-            def self.new(id:, ending_before: nil, quantity_updates: nil)
+            def self.new(
+              id:,
+              ending_before: nil,
+              quantity_updates: nil,
+              # Manage subscription seats for subscriptions in SEAT_BASED mode.
+              seat_updates: nil
+            )
             end
 
             sig do
@@ -6738,7 +6782,9 @@ module MetronomeSDK
                   quantity_updates:
                     T::Array[
                       MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::QuantityUpdate
-                    ]
+                    ],
+                  seat_updates:
+                    MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates
                 }
               )
             end
@@ -6787,6 +6833,324 @@ module MetronomeSDK
               def to_hash
               end
             end
+
+            class SeatUpdates < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              # Adds seat IDs to the subscription. If there are unassigned seats, the new seat
+              # IDs will fill these unassigned seats and not increase the total subscription
+              # quantity. Otherwise, if there are more new seat IDs than unassigned seats, the
+              # total subscription quantity will increase.
+              sig do
+                returns(
+                  T.nilable(
+                    T::Array[
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddSeatID
+                    ]
+                  )
+                )
+              end
+              attr_reader :add_seat_ids
+
+              sig do
+                params(
+                  add_seat_ids:
+                    T::Array[
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddSeatID::OrHash
+                    ]
+                ).void
+              end
+              attr_writer :add_seat_ids
+
+              # Adds unassigned seats to the subscription. This will increase the total
+              # subscription quantity.
+              sig do
+                returns(
+                  T.nilable(
+                    T::Array[
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddUnassignedSeat
+                    ]
+                  )
+                )
+              end
+              attr_reader :add_unassigned_seats
+
+              sig do
+                params(
+                  add_unassigned_seats:
+                    T::Array[
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddUnassignedSeat::OrHash
+                    ]
+                ).void
+              end
+              attr_writer :add_unassigned_seats
+
+              # Removes seat IDs from the subscription, if possible. If a seat ID is removed,
+              # the total subscription quantity will decrease. Otherwise, if the seat ID is not
+              # found on the subscription, this is a no-op.
+              sig do
+                returns(
+                  T.nilable(
+                    T::Array[
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveSeatID
+                    ]
+                  )
+                )
+              end
+              attr_reader :remove_seat_ids
+
+              sig do
+                params(
+                  remove_seat_ids:
+                    T::Array[
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveSeatID::OrHash
+                    ]
+                ).void
+              end
+              attr_writer :remove_seat_ids
+
+              # Removes unassigned seats from the subscription. This will decrease the total
+              # subscription quantity if there are are unassigned seats.
+              sig do
+                returns(
+                  T.nilable(
+                    T::Array[
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveUnassignedSeat
+                    ]
+                  )
+                )
+              end
+              attr_reader :remove_unassigned_seats
+
+              sig do
+                params(
+                  remove_unassigned_seats:
+                    T::Array[
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveUnassignedSeat::OrHash
+                    ]
+                ).void
+              end
+              attr_writer :remove_unassigned_seats
+
+              # Manage subscription seats for subscriptions in SEAT_BASED mode.
+              sig do
+                params(
+                  add_seat_ids:
+                    T::Array[
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddSeatID::OrHash
+                    ],
+                  add_unassigned_seats:
+                    T::Array[
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddUnassignedSeat::OrHash
+                    ],
+                  remove_seat_ids:
+                    T::Array[
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveSeatID::OrHash
+                    ],
+                  remove_unassigned_seats:
+                    T::Array[
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveUnassignedSeat::OrHash
+                    ]
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Adds seat IDs to the subscription. If there are unassigned seats, the new seat
+                # IDs will fill these unassigned seats and not increase the total subscription
+                # quantity. Otherwise, if there are more new seat IDs than unassigned seats, the
+                # total subscription quantity will increase.
+                add_seat_ids: nil,
+                # Adds unassigned seats to the subscription. This will increase the total
+                # subscription quantity.
+                add_unassigned_seats: nil,
+                # Removes seat IDs from the subscription, if possible. If a seat ID is removed,
+                # the total subscription quantity will decrease. Otherwise, if the seat ID is not
+                # found on the subscription, this is a no-op.
+                remove_seat_ids: nil,
+                # Removes unassigned seats from the subscription. This will decrease the total
+                # subscription quantity if there are are unassigned seats.
+                remove_unassigned_seats: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    add_seat_ids:
+                      T::Array[
+                        MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddSeatID
+                      ],
+                    add_unassigned_seats:
+                      T::Array[
+                        MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddUnassignedSeat
+                      ],
+                    remove_seat_ids:
+                      T::Array[
+                        MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveSeatID
+                      ],
+                    remove_unassigned_seats:
+                      T::Array[
+                        MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveUnassignedSeat
+                      ]
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              class AddSeatID < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddSeatID,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                sig { returns(T::Array[String]) }
+                attr_accessor :seat_ids
+
+                # Assigned seats will be added/removed starting at this date.
+                sig { returns(Time) }
+                attr_accessor :starting_at
+
+                sig do
+                  params(seat_ids: T::Array[String], starting_at: Time).returns(
+                    T.attached_class
+                  )
+                end
+                def self.new(
+                  seat_ids:,
+                  # Assigned seats will be added/removed starting at this date.
+                  starting_at:
+                )
+                end
+
+                sig do
+                  override.returns(
+                    { seat_ids: T::Array[String], starting_at: Time }
+                  )
+                end
+                def to_hash
+                end
+              end
+
+              class AddUnassignedSeat < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddUnassignedSeat,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                # The number of unassigned seats on the subscription will increase/decrease by
+                # this delta. Must be greater than 0.
+                sig { returns(Float) }
+                attr_accessor :quantity
+
+                # Unassigned seats will be updated starting at this date.
+                sig { returns(Time) }
+                attr_accessor :starting_at
+
+                sig do
+                  params(quantity: Float, starting_at: Time).returns(
+                    T.attached_class
+                  )
+                end
+                def self.new(
+                  # The number of unassigned seats on the subscription will increase/decrease by
+                  # this delta. Must be greater than 0.
+                  quantity:,
+                  # Unassigned seats will be updated starting at this date.
+                  starting_at:
+                )
+                end
+
+                sig { override.returns({ quantity: Float, starting_at: Time }) }
+                def to_hash
+                end
+              end
+
+              class RemoveSeatID < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveSeatID,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                sig { returns(T::Array[String]) }
+                attr_accessor :seat_ids
+
+                # Assigned seats will be added/removed starting at this date.
+                sig { returns(Time) }
+                attr_accessor :starting_at
+
+                sig do
+                  params(seat_ids: T::Array[String], starting_at: Time).returns(
+                    T.attached_class
+                  )
+                end
+                def self.new(
+                  seat_ids:,
+                  # Assigned seats will be added/removed starting at this date.
+                  starting_at:
+                )
+                end
+
+                sig do
+                  override.returns(
+                    { seat_ids: T::Array[String], starting_at: Time }
+                  )
+                end
+                def to_hash
+                end
+              end
+
+              class RemoveUnassignedSeat < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveUnassignedSeat,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                # The number of unassigned seats on the subscription will increase/decrease by
+                # this delta. Must be greater than 0.
+                sig { returns(Float) }
+                attr_accessor :quantity
+
+                # Unassigned seats will be updated starting at this date.
+                sig { returns(Time) }
+                attr_accessor :starting_at
+
+                sig do
+                  params(quantity: Float, starting_at: Time).returns(
+                    T.attached_class
+                  )
+                end
+                def self.new(
+                  # The number of unassigned seats on the subscription will increase/decrease by
+                  # this delta. Must be greater than 0.
+                  quantity:,
+                  # Unassigned seats will be updated starting at this date.
+                  starting_at:
+                )
+                end
+
+                sig { override.returns({ quantity: Float, starting_at: Time }) }
+                def to_hash
+                end
+              end
+            end
           end
         end
       end

data/rbi/metronome_sdk/resources/v1/alerts.rbi

@@ -68,6 +68,8 @@ module MetronomeSDK
               T::Array[MetronomeSDK::V1::AlertCreateParams::GroupValue::OrHash],
             invoice_types_filter: T::Array[String],
             plan_id: String,
+            seat_filter:
+              MetronomeSDK::V1::AlertCreateParams::SeatFilter::OrHash,
             uniqueness_key: String,
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(MetronomeSDK::Models::V1::AlertCreateResponse)
@@ -112,6 +114,9 @@ module MetronomeSDK
           # If provided, will create this threshold notification for this specific plan. To
           # create a notification for all customers, do not specify a `plan_id`.
           plan_id: nil,
+          # Required for `low_remaining_seat_balance_reached` notifications. The alert is
+          # scoped to this seat group key-value pair.
+          seat_filter: nil,
           # Prevents the creation of duplicates. If a request to create a record is made
           # with a previously used uniqueness key, a new record will not be created and the
           # request will fail with a 409 error.

data/rbi/metronome_sdk/resources/v1/contracts.rbi

@@ -184,6 +184,8 @@ module MetronomeSDK
               T::Array[
                 MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty::OrHash
               ],
+            revenue_system_configuration:
+              MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::OrHash,
             salesforce_opportunity_id: String,
             scheduled_charges:
               T::Array[
@@ -246,6 +248,9 @@ module MetronomeSDK
           recurring_credits: nil,
           # This field's availability is dependent on your client's configuration.
           reseller_royalties: nil,
+          # The revenue system configuration associated with a contract. Provide either an
+          # ID or the provider and delivery method.
+          revenue_system_configuration: nil,
           # This field's availability is dependent on your client's configuration.
           salesforce_opportunity_id: nil,
           scheduled_charges: nil,
@@ -363,6 +368,7 @@ module MetronomeSDK
             reason: String,
             segment_id: String,
             contract_id: String,
+            per_group_amounts: T::Hash[Symbol, Float],
             timestamp: Time,
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).void
@@ -380,6 +386,9 @@ module MetronomeSDK
           segment_id:,
           # ID of the contract to update. Leave blank to update a customer level balance.
           contract_id: nil,
+          # If using individually configured commits/credits attached to seat managed
+          # subscriptions, the amount to add for each seat. Must sum to total amount.
+          per_group_amounts: nil,
           # RFC 3339 timestamp indicating when the manual adjustment takes place. If not
           # provided, it will default to the start of the segment.
           timestamp: nil,
@@ -389,7 +398,7 @@ module MetronomeSDK
 
         # Amendments will be replaced by Contract editing. New clients should implement
         # using the `editContract` endpoint. Read more about the migration to contract
-        # editing [here](https://docs.metronome.com/migrate-amendments-to-edits/) and
+        # editing [here](/guides/implement-metronome/migrate-amendments-to-edits/) and
         # reach out to your Metronome representative for more details. Once contract
         # editing is enabled, access to this endpoint will be removed.
         sig do
@@ -553,6 +562,7 @@ module MetronomeSDK
             id: String,
             covering_date: Time,
             effective_before: Time,
+            exclude_zero_balances: T::Boolean,
             include_archived: T::Boolean,
             include_balance: T::Boolean,
             include_contract_balances: T::Boolean,
@@ -574,6 +584,8 @@ module MetronomeSDK
           covering_date: nil,
           # Include only balances that have any access before the provided date (exclusive)
           effective_before: nil,
+          # Exclude balances with zero amounts from the response.
+          exclude_zero_balances: nil,
           # Include archived credits and credits from archived contracts.
           include_archived: nil,
           # Include the balance of credits and commits in the response. Setting this flag

data/rbi/metronome_sdk/resources/v1/credit_grants.rbi

@@ -4,7 +4,8 @@ module MetronomeSDK
   module Resources
     class V1
       class CreditGrants
-        # Create a new credit grant
+        # Create a new credit grant. This is a Plans (deprecated) endpoint. New clients
+        # should implement using Contracts.
         sig do
           params(
             customer_id: String,
@@ -65,7 +66,8 @@ module MetronomeSDK
         )
         end
 
-        # List credit grants. This list does not included voided grants.
+        # List credit grants. This list does not included voided grants. This is a Plans
+        # (deprecated) endpoint. New clients should implement using Contracts.
         sig do
           params(
             limit: Integer,
@@ -105,7 +107,8 @@ module MetronomeSDK
         )
         end
 
-        # Edit an existing credit grant
+        # Edit an existing credit grant. This is a Plans (deprecated) endpoint. New
+        # clients should implement using Contracts.
         sig do
           params(
             id: String,
@@ -130,7 +133,8 @@ module MetronomeSDK
 
         # Fetches a list of credit ledger entries. Returns lists of ledgers per customer.
         # Ledger entries are returned in chronological order. Ledger entries associated
-        # with voided credit grants are not included.
+        # with voided credit grants are not included. This is a Plans (deprecated)
+        # endpoint. New clients should implement using Contracts.
         sig do
           params(
             next_page: String,
@@ -170,7 +174,8 @@ module MetronomeSDK
         )
         end
 
-        # Void a credit grant
+        # Void a credit grant. This is a Plans (deprecated) endpoint. New clients should
+        # implement using Contracts.
         sig do
           params(
             id: String,

data/rbi/metronome_sdk/resources/v1/customers/alerts.rbi

@@ -70,6 +70,8 @@ module MetronomeSDK
                 ],
               plans_or_contracts:
                 MetronomeSDK::V1::Customers::AlertRetrieveParams::PlansOrContracts::OrSymbol,
+              seat_filter:
+                MetronomeSDK::V1::Customers::AlertRetrieveParams::SeatFilter::OrHash,
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(
               MetronomeSDK::Models::V1::Customers::AlertRetrieveResponse
@@ -86,6 +88,9 @@ module MetronomeSDK
             # When parallel threshold notifications are enabled during migration, this flag
             # denotes whether to fetch notifications for plans or contracts.
             plans_or_contracts: nil,
+            # Only allowed for `low_remaining_seat_balance_reached` notifications. This
+            # filters alerts by the seat group key-value pair.
+            seat_filter: nil,
             request_options: {}
           )
           end

data/rbi/metronome_sdk/resources/v1/customers/billing_config.rbi

@@ -5,13 +5,16 @@ module MetronomeSDK
     class V1
       class Customers
         class BillingConfig
-          # Set the billing configuration for a given customer.
+          # Set the billing configuration for a given customer. This is a Plans (deprecated)
+          # endpoint. New clients should implement using Contracts.
           sig do
             params(
               customer_id: String,
               billing_provider_type:
                 MetronomeSDK::V1::Customers::BillingConfigCreateParams::BillingProviderType::OrSymbol,
               billing_provider_customer_id: String,
+              aws_customer_account_id: String,
+              aws_customer_id: String,
               aws_product_code: String,
               aws_region:
                 MetronomeSDK::V1::Customers::BillingConfigCreateParams::AwsRegion::OrSymbol,
@@ -29,16 +32,22 @@ module MetronomeSDK
             # the subscription ID.
             billing_provider_customer_id:,
             # Body param:
+            aws_customer_account_id: nil,
+            # Body param:
+            aws_customer_id: nil,
+            # Body param:
             aws_product_code: nil,
             # Body param:
             aws_region: nil,
-            # Body param:
+            # Body param: The collection method for the customer's invoices. NOTE:
+            # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
             stripe_collection_method: nil,
             request_options: {}
           )
           end
 
-          # Fetch the billing configuration for the given customer.
+          # Fetch the billing configuration for the given customer. This is a Plans
+          # (deprecated) endpoint. New clients should implement using Contracts.
           sig do
             params(
               customer_id: String,
@@ -58,7 +67,8 @@ module MetronomeSDK
           end
 
           # Delete the billing configuration for a given customer. Note: this is unsupported
-          # for Azure and AWS Marketplace customers.
+          # for Azure and AWS Marketplace customers. This is a Plans (deprecated) endpoint.
+          # New clients should implement using Contracts.
           sig do
             params(
               customer_id: String,

data/rbi/metronome_sdk/resources/v1/customers/commits.rbi

@@ -34,7 +34,8 @@ module MetronomeSDK
           # #### Billing configuration:
           #
           # - invoice_contract_id is required for postpaid commits and for prepaid commits
-          #   with billing (only optional for free prepaid commits)
+          #   with billing (only optional for free prepaid commits) unless do_not_invoice is
+          #   set to true
           # - For postpaid commits: access_schedule and invoice_schedule must have matching
           #   amounts
           # - For postpaid commits: only one schedule item is allowed in both schedules.
@@ -123,7 +124,7 @@ module MetronomeSDK
             description: nil,
             # The contract that this commit will be billed on. This is required for "POSTPAID"
             # commits and for "PREPAID" commits unless there is no invoice schedule above
-            # (i.e., the commit is 'free').
+            # (i.e., the commit is 'free'), or if do_not_invoice is set to true.
             invoice_contract_id: nil,
             # Required for "POSTPAID" commits: the true up invoice will be generated at this
             # time and only one schedule item is allowed; the total must match

data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi

@@ -159,7 +159,8 @@ module MetronomeSDK
           )
           end
 
-          # Add a one time charge to the specified invoice
+          # Add a one time charge to the specified invoice. This is a Plans (deprecated)
+          # endpoint. New clients should implement using Contracts.
           sig do
             params(
               customer_id: String,