metronome-sdk 1.0.0 → 2.1.0

data/lib/metronome_sdk/models/v1/customers/invoice.rb

@@ -50,8 +50,16 @@ module MetronomeSDK
           # @!attribute billable_status
           #   This field's availability is dependent on your client's configuration.
           #
-          #   @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::BillableStatus, nil]
-          optional :billable_status, enum: -> { MetronomeSDK::V1::Customers::Invoice::BillableStatus }
+          #   @return [Object, nil]
+          optional :billable_status, MetronomeSDK::Internal::Type::Unknown
+
+          # @!attribute constituent_invoices
+          #   Account hierarchy M3 - Required on invoices with type USAGE_CONSOLIDATED. List
+          #   of constituent invoices that were consolidated to create this invoice.
+          #
+          #   @return [Array<MetronomeSDK::Models::V1::Customers::Invoice::ConstituentInvoice>, nil]
+          optional :constituent_invoices,
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice] }
 
           # @!attribute contract_custom_fields
           #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
@@ -121,6 +129,13 @@ module MetronomeSDK
           #   @return [String, nil]
           optional :netsuite_sales_order_id, String
 
+          # @!attribute payer
+          #   Account hierarchy M3 - Required for account hierarchy usage invoices. An object
+          #   containing the contract and customer UUIDs that pay for this invoice.
+          #
+          #   @return [MetronomeSDK::Models::V1::Customers::Invoice::Payer, nil]
+          optional :payer, -> { MetronomeSDK::V1::Customers::Invoice::Payer }
+
           # @!attribute plan_custom_fields
           #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
@@ -160,7 +175,7 @@ module MetronomeSDK
           #   @return [Float, nil]
           optional :subtotal, Float
 
-          # @!method initialize(id:, credit_type:, customer_id:, line_items:, status:, total:, type:, amendment_id: nil, billable_status: nil, contract_custom_fields: nil, contract_id: nil, correction_record: nil, created_at: nil, custom_fields: nil, customer_custom_fields: nil, end_timestamp: nil, external_invoice: nil, invoice_adjustments: nil, issued_at: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, plan_custom_fields: nil, plan_id: nil, plan_name: nil, reseller_royalty: nil, salesforce_opportunity_id: nil, start_timestamp: nil, subtotal: nil)
+          # @!method initialize(id:, credit_type:, customer_id:, line_items:, status:, total:, type:, amendment_id: nil, billable_status: nil, constituent_invoices: nil, contract_custom_fields: nil, contract_id: nil, correction_record: nil, created_at: nil, custom_fields: nil, customer_custom_fields: nil, end_timestamp: nil, external_invoice: nil, invoice_adjustments: nil, issued_at: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, payer: nil, plan_custom_fields: nil, plan_id: nil, plan_name: nil, reseller_royalty: nil, salesforce_opportunity_id: nil, start_timestamp: nil, subtotal: nil)
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V1::Customers::Invoice} for more details.
           #
@@ -180,7 +195,9 @@ module MetronomeSDK
           #
           #   @param amendment_id [String]
           #
-          #   @param billable_status [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::BillableStatus] This field's availability is dependent on your client's configuration.
+          #   @param billable_status [Object] This field's availability is dependent on your client's configuration.
+          #
+          #   @param constituent_invoices [Array<MetronomeSDK::Models::V1::Customers::Invoice::ConstituentInvoice>] Account hierarchy M3 - Required on invoices with type USAGE_CONSOLIDATED. List o
           #
           #   @param contract_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
@@ -206,6 +223,8 @@ module MetronomeSDK
           #
           #   @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
           #
+          #   @param payer [MetronomeSDK::Models::V1::Customers::Invoice::Payer] Account hierarchy M3 - Required for account hierarchy usage invoices. An object
+          #
           #   @param plan_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
           #   @param plan_id [String]
@@ -380,6 +399,14 @@ module MetronomeSDK
             #   @return [String, nil]
             optional :netsuite_item_id, String
 
+            # @!attribute origin
+            #   Account hierarchy M3 - Present on line items from invoices with type
+            #   USAGE_CONSOLIDATED. Indicates the original customer, contract, invoice and line
+            #   item from which this line item was copied.
+            #
+            #   @return [MetronomeSDK::Models::V1::Customers::Invoice::LineItem::Origin, nil]
+            optional :origin, -> { MetronomeSDK::V1::Customers::Invoice::LineItem::Origin }
+
             # @!attribute postpaid_commit
             #   Only present for line items paying for a postpaid commit true-up.
             #
@@ -492,7 +519,7 @@ module MetronomeSDK
             #   @return [Float, nil]
             optional :unit_price, Float
 
-            # @!method initialize(credit_type:, name:, total:, type:, applied_commit_or_credit: nil, commit_custom_fields: nil, commit_id: nil, commit_netsuite_item_id: nil, commit_netsuite_sales_order_id: nil, commit_segment_id: nil, commit_type: nil, custom_fields: nil, discount_custom_fields: nil, discount_id: nil, ending_before: nil, group_key: nil, group_value: nil, is_prorated: nil, list_price: nil, metadata: nil, netsuite_invoice_billing_end: nil, netsuite_invoice_billing_start: nil, netsuite_item_id: nil, postpaid_commit: nil, presentation_group_values: nil, pricing_group_values: nil, product_custom_fields: nil, product_id: nil, product_tags: nil, product_type: nil, professional_service_custom_fields: nil, professional_service_id: nil, quantity: nil, reseller_type: nil, scheduled_charge_custom_fields: nil, scheduled_charge_id: nil, starting_at: nil, sub_line_items: nil, subscription_custom_fields: nil, tier: nil, unit_price: nil)
+            # @!method initialize(credit_type:, name:, total:, type:, applied_commit_or_credit: nil, commit_custom_fields: nil, commit_id: nil, commit_netsuite_item_id: nil, commit_netsuite_sales_order_id: nil, commit_segment_id: nil, commit_type: nil, custom_fields: nil, discount_custom_fields: nil, discount_id: nil, ending_before: nil, group_key: nil, group_value: nil, is_prorated: nil, list_price: nil, metadata: nil, netsuite_invoice_billing_end: nil, netsuite_invoice_billing_start: nil, netsuite_item_id: nil, origin: nil, postpaid_commit: nil, presentation_group_values: nil, pricing_group_values: nil, product_custom_fields: nil, product_id: nil, product_tags: nil, product_type: nil, professional_service_custom_fields: nil, professional_service_id: nil, quantity: nil, reseller_type: nil, scheduled_charge_custom_fields: nil, scheduled_charge_id: nil, starting_at: nil, sub_line_items: nil, subscription_custom_fields: nil, tier: nil, unit_price: nil)
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V1::Customers::Invoice::LineItem} for more details.
             #
@@ -542,6 +569,8 @@ module MetronomeSDK
             #
             #   @param netsuite_item_id [String]
             #
+            #   @param origin [MetronomeSDK::Models::V1::Customers::Invoice::LineItem::Origin] Account hierarchy M3 - Present on line items from invoices with type USAGE_CONSO
+            #
             #   @param postpaid_commit [MetronomeSDK::Models::V1::Customers::Invoice::LineItem::PostpaidCommit] Only present for line items paying for a postpaid commit true-up.
             #
             #   @param presentation_group_values [Hash{Symbol=>String, nil}] Includes the presentation group values associated with this line item if present
@@ -611,6 +640,39 @@ module MetronomeSDK
               end
             end
 
+            # @see MetronomeSDK::Models::V1::Customers::Invoice::LineItem#origin
+            class Origin < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute contract_id
+              #
+              #   @return [String]
+              required :contract_id, String
+
+              # @!attribute customer_id
+              #
+              #   @return [String]
+              required :customer_id, String
+
+              # @!attribute invoice_id
+              #
+              #   @return [String]
+              required :invoice_id, String
+
+              # @!attribute line_item_id
+              #
+              #   @return [String]
+              required :line_item_id, String
+
+              # @!method initialize(contract_id:, customer_id:, invoice_id:, line_item_id:)
+              #   Account hierarchy M3 - Present on line items from invoices with type
+              #   USAGE_CONSOLIDATED. Indicates the original customer, contract, invoice and line
+              #   item from which this line item was copied.
+              #
+              #   @param contract_id [String]
+              #   @param customer_id [String]
+              #   @param invoice_id [String]
+              #   @param line_item_id [String]
+            end
+
             # @see MetronomeSDK::Models::V1::Customers::Invoice::LineItem#postpaid_commit
             class PostpaidCommit < MetronomeSDK::Internal::Type::BaseModel
               # @!attribute id
@@ -805,17 +867,26 @@ module MetronomeSDK
             end
           end
 
-          # This field's availability is dependent on your client's configuration.
-          #
-          # @see MetronomeSDK::Models::V1::Customers::Invoice#billable_status
-          module BillableStatus
-            extend MetronomeSDK::Internal::Type::Enum
+          class ConstituentInvoice < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute contract_id
+            #
+            #   @return [String]
+            required :contract_id, String
 
-            BILLABLE = :billable
-            UNBILLABLE = :unbillable
+            # @!attribute customer_id
+            #
+            #   @return [String]
+            required :customer_id, String
 
-            # @!method self.values
-            #   @return [Array<Symbol>]
+            # @!attribute invoice_id
+            #
+            #   @return [String]
+            required :invoice_id, String
+
+            # @!method initialize(contract_id:, customer_id:, invoice_id:)
+            #   @param contract_id [String]
+            #   @param customer_id [String]
+            #   @param invoice_id [String]
           end
 
           # @see MetronomeSDK::Models::V1::Customers::Invoice#correction_record
@@ -855,6 +926,12 @@ module MetronomeSDK
               required :billing_provider_type,
                        enum: -> { MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType }
 
+              # @!attribute billing_provider_error
+              #   Error message from the billing provider, if available.
+              #
+              #   @return [String, nil]
+              optional :billing_provider_error, String
+
               # @!attribute external_status
               #
               #   @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus, nil]
@@ -866,16 +943,54 @@ module MetronomeSDK
               #   @return [String, nil]
               optional :invoice_id, String
 
+              # @!attribute invoiced_sub_total
+              #   The subtotal amount invoiced, if available from the billing provider.
+              #
+              #   @return [Float, nil]
+              optional :invoiced_sub_total, Float
+
+              # @!attribute invoiced_total
+              #   The total amount invoiced, if available from the billing provider.
+              #
+              #   @return [Float, nil]
+              optional :invoiced_total, Float
+
               # @!attribute issued_at_timestamp
               #
               #   @return [Time, nil]
               optional :issued_at_timestamp, Time
 
-              # @!method initialize(billing_provider_type:, external_status: nil, invoice_id: nil, issued_at_timestamp: nil)
+              # @!attribute pdf_url
+              #   A URL to the PDF of the invoice, if available from the billing provider.
+              #
+              #   @return [String, nil]
+              optional :pdf_url, String
+
+              # @!attribute tax
+              #   Tax details for the invoice, if available from the billing provider.
+              #
+              #   @return [MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax, nil]
+              optional :tax,
+                       -> { MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax }
+
+              # @!method initialize(billing_provider_type:, billing_provider_error: nil, external_status: nil, invoice_id: nil, invoiced_sub_total: nil, invoiced_total: nil, issued_at_timestamp: nil, pdf_url: nil, tax: nil)
               #   @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType]
+              #
+              #   @param billing_provider_error [String] Error message from the billing provider, if available.
+              #
               #   @param external_status [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus]
+              #
               #   @param invoice_id [String]
+              #
+              #   @param invoiced_sub_total [Float] The subtotal amount invoiced, if available from the billing provider.
+              #
+              #   @param invoiced_total [Float] The total amount invoiced, if available from the billing provider.
+              #
               #   @param issued_at_timestamp [Time]
+              #
+              #   @param pdf_url [String] A URL to the PDF of the invoice, if available from the billing provider.
+              #
+              #   @param tax [MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax] Tax details for the invoice, if available from the billing provider.
 
               # @see MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice#billing_provider_type
               module BillingProviderType
@@ -889,6 +1004,7 @@ module MetronomeSDK
                 QUICKBOOKS_ONLINE = :quickbooks_online
                 WORKDAY = :workday
                 GCP_MARKETPLACE = :gcp_marketplace
+                METRONOME = :metronome
 
                 # @!method self.values
                 #   @return [Array<Symbol>]
@@ -913,6 +1029,36 @@ module MetronomeSDK
                 # @!method self.values
                 #   @return [Array<Symbol>]
               end
+
+              # @see MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice#tax
+              class Tax < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute total_tax_amount
+                #   The total tax amount applied to the invoice.
+                #
+                #   @return [Float, nil]
+                optional :total_tax_amount, Float
+
+                # @!attribute total_taxable_amount
+                #   The total taxable amount of the invoice.
+                #
+                #   @return [Float, nil]
+                optional :total_taxable_amount, Float
+
+                # @!attribute transaction_id
+                #   The transaction ID associated with the tax calculation.
+                #
+                #   @return [String, nil]
+                optional :transaction_id, String
+
+                # @!method initialize(total_tax_amount: nil, total_taxable_amount: nil, transaction_id: nil)
+                #   Tax details for the invoice, if available from the billing provider.
+                #
+                #   @param total_tax_amount [Float] The total tax amount applied to the invoice.
+                #
+                #   @param total_taxable_amount [Float] The total taxable amount of the invoice.
+                #
+                #   @param transaction_id [String] The transaction ID associated with the tax calculation.
+              end
             end
           end
 
@@ -924,6 +1070,12 @@ module MetronomeSDK
             required :billing_provider_type,
                      enum: -> { MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::BillingProviderType }
 
+            # @!attribute billing_provider_error
+            #   Error message from the billing provider, if available.
+            #
+            #   @return [String, nil]
+            optional :billing_provider_error, String
+
             # @!attribute external_status
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::ExternalStatus, nil]
@@ -935,16 +1087,53 @@ module MetronomeSDK
             #   @return [String, nil]
             optional :invoice_id, String
 
+            # @!attribute invoiced_sub_total
+            #   The subtotal amount invoiced, if available from the billing provider.
+            #
+            #   @return [Float, nil]
+            optional :invoiced_sub_total, Float
+
+            # @!attribute invoiced_total
+            #   The total amount invoiced, if available from the billing provider.
+            #
+            #   @return [Float, nil]
+            optional :invoiced_total, Float
+
             # @!attribute issued_at_timestamp
             #
             #   @return [Time, nil]
             optional :issued_at_timestamp, Time
 
-            # @!method initialize(billing_provider_type:, external_status: nil, invoice_id: nil, issued_at_timestamp: nil)
+            # @!attribute pdf_url
+            #   A URL to the PDF of the invoice, if available from the billing provider.
+            #
+            #   @return [String, nil]
+            optional :pdf_url, String
+
+            # @!attribute tax
+            #   Tax details for the invoice, if available from the billing provider.
+            #
+            #   @return [MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::Tax, nil]
+            optional :tax, -> { MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::Tax }
+
+            # @!method initialize(billing_provider_type:, billing_provider_error: nil, external_status: nil, invoice_id: nil, invoiced_sub_total: nil, invoiced_total: nil, issued_at_timestamp: nil, pdf_url: nil, tax: nil)
             #   @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::BillingProviderType]
+            #
+            #   @param billing_provider_error [String] Error message from the billing provider, if available.
+            #
             #   @param external_status [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::ExternalStatus]
+            #
             #   @param invoice_id [String]
+            #
+            #   @param invoiced_sub_total [Float] The subtotal amount invoiced, if available from the billing provider.
+            #
+            #   @param invoiced_total [Float] The total amount invoiced, if available from the billing provider.
+            #
             #   @param issued_at_timestamp [Time]
+            #
+            #   @param pdf_url [String] A URL to the PDF of the invoice, if available from the billing provider.
+            #
+            #   @param tax [MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::Tax] Tax details for the invoice, if available from the billing provider.
 
             # @see MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice#billing_provider_type
             module BillingProviderType
@@ -958,6 +1147,7 @@ module MetronomeSDK
               QUICKBOOKS_ONLINE = :quickbooks_online
               WORKDAY = :workday
               GCP_MARKETPLACE = :gcp_marketplace
+              METRONOME = :metronome
 
               # @!method self.values
               #   @return [Array<Symbol>]
@@ -982,6 +1172,36 @@ module MetronomeSDK
               # @!method self.values
               #   @return [Array<Symbol>]
             end
+
+            # @see MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice#tax
+            class Tax < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute total_tax_amount
+              #   The total tax amount applied to the invoice.
+              #
+              #   @return [Float, nil]
+              optional :total_tax_amount, Float
+
+              # @!attribute total_taxable_amount
+              #   The total taxable amount of the invoice.
+              #
+              #   @return [Float, nil]
+              optional :total_taxable_amount, Float
+
+              # @!attribute transaction_id
+              #   The transaction ID associated with the tax calculation.
+              #
+              #   @return [String, nil]
+              optional :transaction_id, String
+
+              # @!method initialize(total_tax_amount: nil, total_taxable_amount: nil, transaction_id: nil)
+              #   Tax details for the invoice, if available from the billing provider.
+              #
+              #   @param total_tax_amount [Float] The total tax amount applied to the invoice.
+              #
+              #   @param total_taxable_amount [Float] The total taxable amount of the invoice.
+              #
+              #   @param transaction_id [String] The transaction ID associated with the tax calculation.
+            end
           end
 
           class InvoiceAdjustment < MetronomeSDK::Internal::Type::BaseModel
@@ -1023,6 +1243,26 @@ module MetronomeSDK
             #   @param credit_grant_id [String]
           end
 
+          # @see MetronomeSDK::Models::V1::Customers::Invoice#payer
+          class Payer < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute contract_id
+            #
+            #   @return [String]
+            required :contract_id, String
+
+            # @!attribute customer_id
+            #
+            #   @return [String]
+            required :customer_id, String
+
+            # @!method initialize(contract_id:, customer_id:)
+            #   Account hierarchy M3 - Required for account hierarchy usage invoices. An object
+            #   containing the contract and customer UUIDs that pay for this invoice.
+            #
+            #   @param contract_id [String]
+            #   @param customer_id [String]
+          end
+
           # @see MetronomeSDK::Models::V1::Customers::Invoice#reseller_royalty
           class ResellerRoyalty < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute fraction

data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_pdf_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Invoices#retrieve_pdf
+        class InvoiceRetrievePdfParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!attribute invoice_id
+          #
+          #   @return [String]
+          required :invoice_id, String
+
+          # @!method initialize(customer_id:, invoice_id:, request_options: {})
+          #   @param customer_id [String]
+          #   @param invoice_id [String]
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/payment.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#list
+      class Payment < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount
+        #
+        #   @return [Float, nil]
+        optional :amount, Float
+
+        # @!attribute amount_paid
+        #
+        #   @return [Float, nil]
+        optional :amount_paid, Float
+
+        # @!attribute contract_id
+        #
+        #   @return [String, nil]
+        optional :contract_id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute customer_id
+        #
+        #   @return [String, nil]
+        optional :customer_id, String
+
+        # @!attribute error_message
+        #
+        #   @return [String, nil]
+        optional :error_message, String
+
+        # @!attribute fiat_credit_type
+        #
+        #   @return [MetronomeSDK::Models::CreditTypeData, nil]
+        optional :fiat_credit_type, -> { MetronomeSDK::CreditTypeData }
+
+        # @!attribute invoice_id
+        #
+        #   @return [String, nil]
+        optional :invoice_id, String
+
+        # @!attribute payment_gateway
+        #
+        #   @return [MetronomeSDK::Models::V1::Payment::PaymentGateway, nil]
+        optional :payment_gateway, -> { MetronomeSDK::V1::Payment::PaymentGateway }
+
+        # @!attribute status
+        #
+        #   @return [Symbol, MetronomeSDK::Models::V1::PaymentStatus, nil]
+        optional :status, enum: -> { MetronomeSDK::V1::PaymentStatus }
+
+        # @!attribute updated_at
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time
+
+        # @!method initialize(id:, amount: nil, amount_paid: nil, contract_id: nil, created_at: nil, customer_id: nil, error_message: nil, fiat_credit_type: nil, invoice_id: nil, payment_gateway: nil, status: nil, updated_at: nil)
+        #   @param id [String]
+        #   @param amount [Float]
+        #   @param amount_paid [Float]
+        #   @param contract_id [String]
+        #   @param created_at [Time]
+        #   @param customer_id [String]
+        #   @param error_message [String]
+        #   @param fiat_credit_type [MetronomeSDK::Models::CreditTypeData]
+        #   @param invoice_id [String]
+        #   @param payment_gateway [MetronomeSDK::Models::V1::Payment::PaymentGateway]
+        #   @param status [Symbol, MetronomeSDK::Models::V1::PaymentStatus]
+        #   @param updated_at [Time]
+
+        # @see MetronomeSDK::Models::V1::Payment#payment_gateway
+        class PaymentGateway < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute stripe
+          #
+          #   @return [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe]
+          required :stripe, -> { MetronomeSDK::V1::Payment::PaymentGateway::Stripe }
+
+          # @!attribute type
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::Payment::PaymentGateway::Type]
+          required :type, enum: -> { MetronomeSDK::V1::Payment::PaymentGateway::Type }
+
+          # @!method initialize(stripe:, type:)
+          #   @param stripe [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe]
+          #   @param type [Symbol, MetronomeSDK::Models::V1::Payment::PaymentGateway::Type]
+
+          # @see MetronomeSDK::Models::V1::Payment::PaymentGateway#stripe
+          class Stripe < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute payment_intent_id
+            #
+            #   @return [String]
+            required :payment_intent_id, String
+
+            # @!attribute error
+            #
+            #   @return [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe::Error, nil]
+            optional :error, -> { MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error }
+
+            # @!attribute payment_method_id
+            #
+            #   @return [String, nil]
+            optional :payment_method_id, String
+
+            # @!method initialize(payment_intent_id:, error: nil, payment_method_id: nil)
+            #   @param payment_intent_id [String]
+            #   @param error [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe::Error]
+            #   @param payment_method_id [String]
+
+            # @see MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe#error
+            class Error < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute code
+              #
+              #   @return [String, nil]
+              optional :code, String
+
+              # @!attribute decline_code
+              #
+              #   @return [String, nil]
+              optional :decline_code, String
+
+              # @!attribute type
+              #
+              #   @return [String, nil]
+              optional :type, String
+
+              # @!method initialize(code: nil, decline_code: nil, type: nil)
+              #   @param code [String]
+              #   @param decline_code [String]
+              #   @param type [String]
+            end
+          end
+
+          # @see MetronomeSDK::Models::V1::Payment::PaymentGateway#type
+          module Type
+            extend MetronomeSDK::Internal::Type::Enum
+
+            STRIPE = :stripe
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/payment_attempt_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#attempt
+      class PaymentAttemptParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute invoice_id
+        #
+        #   @return [String]
+        required :invoice_id, String
+
+        # @!method initialize(customer_id:, invoice_id:, request_options: {})
+        #   @param customer_id [String]
+        #   @param invoice_id [String]
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/payment_attempt_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#attempt
+      class PaymentAttemptResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [MetronomeSDK::Models::V1::Payment]
+        required :data, -> { MetronomeSDK::V1::Payment }
+
+        # @!method initialize(data:)
+        #   @param data [MetronomeSDK::Models::V1::Payment]
+      end
+    end
+  end
+end