orb-billing 1.48.0 → 1.50.0

data/rbi/orb/models/subscription_list_summary_params.rbi

@@ -0,0 +1,148 @@
+# typed: strong
+
+module Orb
+  module Models
+    class SubscriptionListSummaryParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::SubscriptionListSummaryParams, Orb::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_at_gt
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_at_gte
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_at_lt
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_at_lte
+
+      # Cursor for pagination. This can be populated by the `next_cursor` value returned
+      # from the initial request.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :cursor
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :customer_id
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_customer_id
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_plan_id
+
+      # The number of items to fetch. Defaults to 20.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :plan_id
+
+      sig do
+        returns(T.nilable(Orb::SubscriptionListSummaryParams::Status::OrSymbol))
+      end
+      attr_accessor :status
+
+      sig do
+        params(
+          created_at_gt: T.nilable(Time),
+          created_at_gte: T.nilable(Time),
+          created_at_lt: T.nilable(Time),
+          created_at_lte: T.nilable(Time),
+          cursor: T.nilable(String),
+          customer_id: T.nilable(String),
+          external_customer_id: T.nilable(String),
+          external_plan_id: T.nilable(String),
+          limit: Integer,
+          plan_id: T.nilable(String),
+          status:
+            T.nilable(Orb::SubscriptionListSummaryParams::Status::OrSymbol),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        created_at_gt: nil,
+        created_at_gte: nil,
+        created_at_lt: nil,
+        created_at_lte: nil,
+        # Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # from the initial request.
+        cursor: nil,
+        customer_id: nil,
+        external_customer_id: nil,
+        external_plan_id: nil,
+        # The number of items to fetch. Defaults to 20.
+        limit: nil,
+        plan_id: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            created_at_gt: T.nilable(Time),
+            created_at_gte: T.nilable(Time),
+            created_at_lt: T.nilable(Time),
+            created_at_lte: T.nilable(Time),
+            cursor: T.nilable(String),
+            customer_id: T.nilable(String),
+            external_customer_id: T.nilable(String),
+            external_plan_id: T.nilable(String),
+            limit: Integer,
+            plan_id: T.nilable(String),
+            status:
+              T.nilable(Orb::SubscriptionListSummaryParams::Status::OrSymbol),
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Status
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::SubscriptionListSummaryParams::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(
+            :active,
+            Orb::SubscriptionListSummaryParams::Status::TaggedSymbol
+          )
+        ENDED =
+          T.let(
+            :ended,
+            Orb::SubscriptionListSummaryParams::Status::TaggedSymbol
+          )
+        UPCOMING =
+          T.let(
+            :upcoming,
+            Orb::SubscriptionListSummaryParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::SubscriptionListSummaryParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/subscription_list_summary_response.rbi

@@ -0,0 +1,214 @@
+# typed: strong
+
+module Orb
+  module Models
+    class SubscriptionListSummaryResponse < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Orb::Models::SubscriptionListSummaryResponse,
+            Orb::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(Orb::CustomerMinified) }
+      attr_reader :customer
+
+      sig { params(customer: Orb::CustomerMinified::OrHash).void }
+      attr_writer :customer
+
+      # The date Orb stops billing for this subscription.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :end_date
+
+      # User specified key-value pairs for the resource. If not present, this defaults
+      # to an empty dictionary. Individual keys can be removed by setting the value to
+      # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+      # `null`.
+      sig { returns(T::Hash[Symbol, String]) }
+      attr_accessor :metadata
+
+      # The name of the subscription.
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig do
+        returns(T.nilable(Orb::Models::SubscriptionListSummaryResponse::Plan))
+      end
+      attr_reader :plan
+
+      sig do
+        params(
+          plan:
+            T.nilable(
+              Orb::Models::SubscriptionListSummaryResponse::Plan::OrHash
+            )
+        ).void
+      end
+      attr_writer :plan
+
+      # The date Orb starts billing for this subscription.
+      sig { returns(Time) }
+      attr_accessor :start_date
+
+      sig do
+        returns(
+          Orb::Models::SubscriptionListSummaryResponse::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      # A subscription's own fields, with its plan and customer as references, as listed
+      # by List subscription summaries and carried in standard webhook payloads. Fetch
+      # the subscription for its price intervals, billing periods, plan phases and other
+      # derived fields.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          customer: Orb::CustomerMinified::OrHash,
+          end_date: T.nilable(Time),
+          metadata: T::Hash[Symbol, String],
+          name: String,
+          plan:
+            T.nilable(
+              Orb::Models::SubscriptionListSummaryResponse::Plan::OrHash
+            ),
+          start_date: Time,
+          status: Orb::Models::SubscriptionListSummaryResponse::Status::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        created_at:,
+        customer:,
+        # The date Orb stops billing for this subscription.
+        end_date:,
+        # User specified key-value pairs for the resource. If not present, this defaults
+        # to an empty dictionary. Individual keys can be removed by setting the value to
+        # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+        # `null`.
+        metadata:,
+        # The name of the subscription.
+        name:,
+        plan:,
+        # The date Orb starts billing for this subscription.
+        start_date:,
+        status:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            customer: Orb::CustomerMinified,
+            end_date: T.nilable(Time),
+            metadata: T::Hash[Symbol, String],
+            name: String,
+            plan: T.nilable(Orb::Models::SubscriptionListSummaryResponse::Plan),
+            start_date: Time,
+            status:
+              Orb::Models::SubscriptionListSummaryResponse::Status::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Plan < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::Models::SubscriptionListSummaryResponse::Plan,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :id
+
+        # An optional user-defined ID for this plan resource, used throughout the system
+        # as an alias for this Plan. Use this field to identify a plan by an existing
+        # identifier in your system.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_plan_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        sig do
+          params(
+            id: T.nilable(String),
+            external_plan_id: T.nilable(String),
+            name: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # An optional user-defined ID for this plan resource, used throughout the system
+          # as an alias for this Plan. Use this field to identify a plan by an existing
+          # identifier in your system.
+          external_plan_id:,
+          name:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: T.nilable(String),
+              external_plan_id: T.nilable(String),
+              name: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      module Status
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::Models::SubscriptionListSummaryResponse::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(
+            :active,
+            Orb::Models::SubscriptionListSummaryResponse::Status::TaggedSymbol
+          )
+        ENDED =
+          T.let(
+            :ended,
+            Orb::Models::SubscriptionListSummaryResponse::Status::TaggedSymbol
+          )
+        UPCOMING =
+          T.let(
+            :upcoming,
+            Orb::Models::SubscriptionListSummaryResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::Models::SubscriptionListSummaryResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbi

@@ -612,6 +612,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # The latest `end_date` of the invoice's line items, including any line items
+          # hidden because they have zero quantity. This is `null` when the invoice has no
+          # line items.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # The earliest `start_date` of the invoice's line items, including any line items
+          # hidden because they have zero quantity. This is `null` when the invoice has no
+          # line items.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -697,6 +709,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -927,6 +941,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # The latest `end_date` of the invoice's line items, including any line items
+            # hidden because they have zero quantity. This is `null` when the invoice has no
+            # line items.
+            service_period_end:,
+            # The earliest `start_date` of the invoice's line items, including any line items
+            # hidden because they have zero quantity. This is `null` when the invoice has no
+            # line items.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -986,6 +1008,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbi

@@ -612,6 +612,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # The latest `end_date` of the invoice's line items, including any line items
+          # hidden because they have zero quantity. This is `null` when the invoice has no
+          # line items.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # The earliest `start_date` of the invoice's line items, including any line items
+          # hidden because they have zero quantity. This is `null` when the invoice has no
+          # line items.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -697,6 +709,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -927,6 +941,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # The latest `end_date` of the invoice's line items, including any line items
+            # hidden because they have zero quantity. This is `null` when the invoice has no
+            # line items.
+            service_period_end:,
+            # The earliest `start_date` of the invoice's line items, including any line items
+            # hidden because they have zero quantity. This is `null` when the invoice has no
+            # line items.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -986,6 +1008,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbi

@@ -447,6 +447,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # The latest `end_date` of the invoice's line items, including any line items
+          # hidden because they have zero quantity. This is `null` when the invoice has no
+          # line items.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # The earliest `start_date` of the invoice's line items, including any line items
+          # hidden because they have zero quantity. This is `null` when the invoice has no
+          # line items.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -532,6 +544,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -762,6 +776,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # The latest `end_date` of the invoice's line items, including any line items
+            # hidden because they have zero quantity. This is `null` when the invoice has no
+            # line items.
+            service_period_end:,
+            # The earliest `start_date` of the invoice's line items, including any line items
+            # hidden because they have zero quantity. This is `null` when the invoice has no
+            # line items.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -821,6 +843,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbi

@@ -447,6 +447,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # The latest `end_date` of the invoice's line items, including any line items
+          # hidden because they have zero quantity. This is `null` when the invoice has no
+          # line items.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # The earliest `start_date` of the invoice's line items, including any line items
+          # hidden because they have zero quantity. This is `null` when the invoice has no
+          # line items.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -532,6 +544,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::InvoiceDunningScheduleEndedStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -762,6 +776,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # The latest `end_date` of the invoice's line items, including any line items
+            # hidden because they have zero quantity. This is `null` when the invoice has no
+            # line items.
+            service_period_end:,
+            # The earliest `start_date` of the invoice's line items, including any line items
+            # hidden because they have zero quantity. This is `null` when the invoice has no
+            # line items.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -821,6 +843,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::InvoiceDunningScheduleEndedStandardWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbi

@@ -447,6 +447,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # The latest `end_date` of the invoice's line items, including any line items
+          # hidden because they have zero quantity. This is `null` when the invoice has no
+          # line items.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # The earliest `start_date` of the invoice's line items, including any line items
+          # hidden because they have zero quantity. This is `null` when the invoice has no
+          # line items.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -532,6 +544,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::InvoiceDunningScheduleResetStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -762,6 +776,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # The latest `end_date` of the invoice's line items, including any line items
+            # hidden because they have zero quantity. This is `null` when the invoice has no
+            # line items.
+            service_period_end:,
+            # The earliest `start_date` of the invoice's line items, including any line items
+            # hidden because they have zero quantity. This is `null` when the invoice has no
+            # line items.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -821,6 +843,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::InvoiceDunningScheduleResetStandardWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbi

@@ -447,6 +447,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # The latest `end_date` of the invoice's line items, including any line items
+          # hidden because they have zero quantity. This is `null` when the invoice has no
+          # line items.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # The earliest `start_date` of the invoice's line items, including any line items
+          # hidden because they have zero quantity. This is `null` when the invoice has no
+          # line items.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -532,6 +544,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::InvoiceDunningScheduleStepExecutedStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -762,6 +776,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # The latest `end_date` of the invoice's line items, including any line items
+            # hidden because they have zero quantity. This is `null` when the invoice has no
+            # line items.
+            service_period_end:,
+            # The earliest `start_date` of the invoice's line items, including any line items
+            # hidden because they have zero quantity. This is `null` when the invoice has no
+            # line items.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -821,6 +843,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::InvoiceDunningScheduleStepExecutedStandardWebhookEvent::Invoice::Status::TaggedSymbol,