orb-billing 1.17.0 → 1.18.0

data/rbi/orb/models/alert_delete_params.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Orb
+  module Models
+    class AlertDeleteParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias { T.any(Orb::AlertDeleteParams, Orb::Internal::AnyHash) }
+
+      sig { returns(String) }
+      attr_accessor :alert_configuration_id
+
+      sig do
+        params(
+          alert_configuration_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(alert_configuration_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            alert_configuration_id: String,
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/customer_create_portal_session_by_external_id_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Orb
+  module Models
+    class CustomerCreatePortalSessionByExternalIDParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Orb::CustomerCreatePortalSessionByExternalIDParams,
+            Orb::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :external_customer_id
+
+      # Duration in minutes until the portal session expires. Defaults to 60.
+      # Maximum 180.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :expires_in_minutes
+
+      sig { params(expires_in_minutes: Integer).void }
+      attr_writer :expires_in_minutes
+
+      # When true (default), creating this session soft-deletes any other active portal
+      # sessions for the customer. Set to false to allow concurrent sessions — useful
+      # when minting portal links for multiple authenticated end-users at once. The
+      # customer's permanent portal link (if any) is never invalidated by this.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :invalidate_existing
+
+      sig { params(invalidate_existing: T::Boolean).void }
+      attr_writer :invalidate_existing
+
+      sig do
+        params(
+          external_customer_id: String,
+          expires_in_minutes: Integer,
+          invalidate_existing: T::Boolean,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        external_customer_id:,
+        # Duration in minutes until the portal session expires. Defaults to 60.
+        # Maximum 180.
+        expires_in_minutes: nil,
+        # When true (default), creating this session soft-deletes any other active portal
+        # sessions for the customer. Set to false to allow concurrent sessions — useful
+        # when minting portal links for multiple authenticated end-users at once. The
+        # customer's permanent portal link (if any) is never invalidated by this.
+        invalidate_existing: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            external_customer_id: String,
+            expires_in_minutes: Integer,
+            invalidate_existing: T::Boolean,
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/customer_create_portal_session_by_external_id_response.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Orb
+  module Models
+    class CustomerCreatePortalSessionByExternalIDResponse < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Orb::Models::CustomerCreatePortalSessionByExternalIDResponse,
+            Orb::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(String) }
+      attr_accessor :customer_id
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :expires_at
+
+      sig { returns(String) }
+      attr_accessor :url
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          customer_id: String,
+          expires_at: T.nilable(Time),
+          url: String
+        ).returns(T.attached_class)
+      end
+      def self.new(id:, created_at:, customer_id:, expires_at:, url:)
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            customer_id: String,
+            expires_at: T.nilable(Time),
+            url: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/customer_create_portal_session_params.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Orb
+  module Models
+    class CustomerCreatePortalSessionParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::CustomerCreatePortalSessionParams, Orb::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :customer_id
+
+      # Duration in minutes until the portal session expires. Defaults to 60.
+      # Maximum 180.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :expires_in_minutes
+
+      sig { params(expires_in_minutes: Integer).void }
+      attr_writer :expires_in_minutes
+
+      # When true (default), creating this session soft-deletes any other active portal
+      # sessions for the customer. Set to false to allow concurrent sessions — useful
+      # when minting portal links for multiple authenticated end-users at once. The
+      # customer's permanent portal link (if any) is never invalidated by this.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :invalidate_existing
+
+      sig { params(invalidate_existing: T::Boolean).void }
+      attr_writer :invalidate_existing
+
+      sig do
+        params(
+          customer_id: String,
+          expires_in_minutes: Integer,
+          invalidate_existing: T::Boolean,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        customer_id:,
+        # Duration in minutes until the portal session expires. Defaults to 60.
+        # Maximum 180.
+        expires_in_minutes: nil,
+        # When true (default), creating this session soft-deletes any other active portal
+        # sessions for the customer. Set to false to allow concurrent sessions — useful
+        # when minting portal links for multiple authenticated end-users at once. The
+        # customer's permanent portal link (if any) is never invalidated by this.
+        invalidate_existing: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            customer_id: String,
+            expires_in_minutes: Integer,
+            invalidate_existing: T::Boolean,
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/customer_create_portal_session_response.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Orb
+  module Models
+    class CustomerCreatePortalSessionResponse < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Orb::Models::CustomerCreatePortalSessionResponse,
+            Orb::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(String) }
+      attr_accessor :customer_id
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :expires_at
+
+      sig { returns(String) }
+      attr_accessor :url
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          customer_id: String,
+          expires_at: T.nilable(Time),
+          url: String
+        ).returns(T.attached_class)
+      end
+      def self.new(id:, created_at:, customer_id:, expires_at:, url:)
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            customer_id: String,
+            expires_at: T.nilable(Time),
+            url: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/event_ingest_params.rbi

@@ -17,19 +17,10 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :backfill_id
 
-      # Pending Deprecation: Flag to enable additional debug information in the endpoint
-      # response
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :debug
-
-      sig { params(debug: T::Boolean).void }
-      attr_writer :debug
-
       sig do
         params(
           events: T::Array[Orb::EventIngestParams::Event::OrHash],
           backfill_id: T.nilable(String),
-          debug: T::Boolean,
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -38,9 +29,6 @@ module Orb
         # If this ingestion request is part of a backfill, this parameter ties the
         # ingested events to the backfill
         backfill_id: nil,
-        # Pending Deprecation: Flag to enable additional debug information in the endpoint
-        # response
-        debug: nil,
         request_options: {}
       )
       end
@@ -50,7 +38,6 @@ module Orb
           {
             events: T::Array[Orb::EventIngestParams::Event],
             backfill_id: T.nilable(String),
-            debug: T::Boolean,
             request_options: Orb::RequestOptions
           }
         )

data/rbi/orb/models/event_ingest_response.rbi

@@ -15,30 +15,16 @@ module Orb
       end
       attr_accessor :validation_failed
 
-      sig { returns(T.nilable(Orb::Models::EventIngestResponse::Debug)) }
-      attr_reader :debug
-
-      sig do
-        params(
-          debug: T.nilable(Orb::Models::EventIngestResponse::Debug::OrHash)
-        ).void
-      end
-      attr_writer :debug
-
       sig do
         params(
           validation_failed:
-            T::Array[
-              Orb::Models::EventIngestResponse::ValidationFailed::OrHash
-            ],
-          debug: T.nilable(Orb::Models::EventIngestResponse::Debug::OrHash)
+            T::Array[Orb::Models::EventIngestResponse::ValidationFailed::OrHash]
         ).returns(T.attached_class)
       end
       def self.new(
         # Contains all failing validation events. In the case of a 200, this array will
         # always be empty. This field will always be present.
-        validation_failed:,
-        debug: nil
+        validation_failed:
       )
       end
 
@@ -46,8 +32,7 @@ module Orb
         override.returns(
           {
             validation_failed:
-              T::Array[Orb::Models::EventIngestResponse::ValidationFailed],
-            debug: T.nilable(Orb::Models::EventIngestResponse::Debug)
+              T::Array[Orb::Models::EventIngestResponse::ValidationFailed]
           }
         )
       end
@@ -95,39 +80,6 @@ module Orb
         def to_hash
         end
       end
-
-      class Debug < Orb::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Orb::Models::EventIngestResponse::Debug,
-              Orb::Internal::AnyHash
-            )
-          end
-
-        sig { returns(T::Array[String]) }
-        attr_accessor :duplicate
-
-        sig { returns(T::Array[String]) }
-        attr_accessor :ingested
-
-        sig do
-          params(
-            duplicate: T::Array[String],
-            ingested: T::Array[String]
-          ).returns(T.attached_class)
-        end
-        def self.new(duplicate:, ingested:)
-        end
-
-        sig do
-          override.returns(
-            { duplicate: T::Array[String], ingested: T::Array[String] }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/orb/models/invoice_regenerate_invoice_pdf_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Orb
+  module Models
+    class InvoiceRegenerateInvoicePdfParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::InvoiceRegenerateInvoicePdfParams, Orb::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :invoice_id
+
+      sig do
+        params(
+          invoice_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(invoice_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { invoice_id: String, request_options: Orb::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/invoice_regenerate_receipt_pdf_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Orb
+  module Models
+    class InvoiceRegenerateReceiptPdfParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::InvoiceRegenerateReceiptPdfParams, Orb::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :invoice_id
+
+      sig do
+        params(
+          invoice_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(invoice_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { invoice_id: String, request_options: Orb::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models.rbi

@@ -21,6 +21,8 @@ module Orb
   AlertCreateForSubscriptionParams =
     Orb::Models::AlertCreateForSubscriptionParams
 
+  AlertDeleteParams = Orb::Models::AlertDeleteParams
+
   AlertDisableParams = Orb::Models::AlertDisableParams
 
   AlertEnableParams = Orb::Models::AlertEnableParams
@@ -103,6 +105,12 @@ module Orb
 
   CustomerCreateParams = Orb::Models::CustomerCreateParams
 
+  CustomerCreatePortalSessionByExternalIDParams =
+    Orb::Models::CustomerCreatePortalSessionByExternalIDParams
+
+  CustomerCreatePortalSessionParams =
+    Orb::Models::CustomerCreatePortalSessionParams
+
   CustomerDeleteParams = Orb::Models::CustomerDeleteParams
 
   CustomerFetchByExternalIDParams = Orb::Models::CustomerFetchByExternalIDParams
@@ -197,6 +205,12 @@ module Orb
 
   InvoicePayParams = Orb::Models::InvoicePayParams
 
+  InvoiceRegenerateInvoicePdfParams =
+    Orb::Models::InvoiceRegenerateInvoicePdfParams
+
+  InvoiceRegenerateReceiptPdfParams =
+    Orb::Models::InvoiceRegenerateReceiptPdfParams
+
   InvoiceTiny = Orb::Models::InvoiceTiny
 
   InvoiceUpdateParams = Orb::Models::InvoiceUpdateParams

data/rbi/orb/resources/alerts.rbi

@@ -92,6 +92,23 @@ module Orb
       )
       end
 
+      # This endpoint trashes a subscription- or customer-scoped alert. The alert is
+      # soft-deleted: it stops firing immediately and no longer appears in fetch or list
+      # responses, while the underlying record is retained internally for audit.
+      #
+      # Plan-level alerts cannot be trashed via the API — disable them instead
+      # (`POST /v1/alerts/{alert_configuration_id}/disable`). Their removal would need
+      # to be unwound from every subscription the alert was propagated to, which isn't
+      # supported yet.
+      sig do
+        params(
+          alert_configuration_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).void
+      end
+      def delete(alert_configuration_id, request_options: {})
+      end
+
       # This endpoint creates a new alert to monitor a customer's credit balance. There
       # are three types of alerts that can be scoped to customers:
       # `credit_balance_depleted`, `credit_balance_dropped`, and

data/rbi/orb/resources/customers.rbi

@@ -639,6 +639,60 @@ module Orb
       def delete(customer_id, request_options: {})
       end
 
+      # Creates a portal session for the customer, returning a short-lived URL that
+      # provides authenticated access to the customer's billing portal. The session
+      # expires after `expires_in_minutes` (default 60, max 180). By default, creating a
+      # new session invalidates any other active portal sessions for the customer; pass
+      # `invalidate_existing=false` to allow concurrent sessions.
+      sig do
+        params(
+          customer_id: String,
+          expires_in_minutes: Integer,
+          invalidate_existing: T::Boolean,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::CustomerCreatePortalSessionResponse)
+      end
+      def create_portal_session(
+        customer_id,
+        # Duration in minutes until the portal session expires. Defaults to 60.
+        # Maximum 180.
+        expires_in_minutes: nil,
+        # When true (default), creating this session soft-deletes any other active portal
+        # sessions for the customer. Set to false to allow concurrent sessions — useful
+        # when minting portal links for multiple authenticated end-users at once. The
+        # customer's permanent portal link (if any) is never invalidated by this.
+        invalidate_existing: nil,
+        request_options: {}
+      )
+      end
+
+      # Creates a portal session for the customer, returning a short-lived URL that
+      # provides authenticated access to the customer's billing portal. The session
+      # expires after `expires_in_minutes` (default 60, max 180). By default, creating a
+      # new session invalidates any other active portal sessions for the customer; pass
+      # `invalidate_existing=false` to allow concurrent sessions.
+      sig do
+        params(
+          external_customer_id: String,
+          expires_in_minutes: Integer,
+          invalidate_existing: T::Boolean,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::CustomerCreatePortalSessionByExternalIDResponse)
+      end
+      def create_portal_session_by_external_id(
+        external_customer_id,
+        # Duration in minutes until the portal session expires. Defaults to 60.
+        # Maximum 180.
+        expires_in_minutes: nil,
+        # When true (default), creating this session soft-deletes any other active portal
+        # sessions for the customer. Set to false to allow concurrent sessions — useful
+        # when minting portal links for multiple authenticated end-users at once. The
+        # customer's permanent portal link (if any) is never invalidated by this.
+        invalidate_existing: nil,
+        request_options: {}
+      )
+      end
+
       # This endpoint is used to fetch customer details given an identifier. If the
       # `Customer` is in the process of being deleted, only the properties `id` and
       # `deleted: true` will be returned.

data/rbi/orb/resources/events.rbi

@@ -324,7 +324,6 @@ module Orb
         params(
           events: T::Array[Orb::EventIngestParams::Event::OrHash],
           backfill_id: T.nilable(String),
-          debug: T::Boolean,
           request_options: Orb::RequestOptions::OrHash
         ).returns(Orb::Models::EventIngestResponse)
       end
@@ -334,9 +333,6 @@ module Orb
         # Query param: If this ingestion request is part of a backfill, this parameter
         # ties the ingested events to the backfill
         backfill_id: nil,
-        # Query param: Pending Deprecation: Flag to enable additional debug information in
-        # the endpoint response
-        debug: nil,
         request_options: {}
       )
       end

data/rbi/orb/resources/invoices.rbi

@@ -402,6 +402,70 @@ module Orb
       )
       end
 
+      # This endpoint triggers a regeneration of the PDF for a finalized invoice.
+      #
+      # The invoice must be finalized (`issued`, `paid`, `synced`, or `void`) and must
+      # already have an existing PDF. The original PDF is archived (not permanently
+      # deleted) to maintain an audit trail.
+      #
+      # **Important Legal Considerations:**
+      #
+      # Regenerating invoice PDFs may not be permitted in all jurisdictions. Many tax
+      # authorities require that issued invoices remain unmodified. Before using this
+      # endpoint, ensure that:
+      #
+      # - Your local tax regulations permit modification of issued billing documents
+      # - You have a legitimate business reason (e.g., fixing template errors, updating
+      #   branding)
+      # - You maintain proper records of the original PDF (archived automatically by
+      #   Orb)
+      #
+      # Recommended use cases:
+      #
+      # - Correcting template rendering issues
+      # - Applying updated company branding
+      # - Updating customer data that was incorrect at issuance
+      sig do
+        params(
+          invoice_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Invoice)
+      end
+      def regenerate_invoice_pdf(invoice_id, request_options: {})
+      end
+
+      # This endpoint triggers a regeneration of the receipt PDF for a paid invoice.
+      #
+      # The invoice must be in `paid` status and must already have an existing receipt
+      # PDF. The original PDF is archived (not permanently deleted) to maintain an audit
+      # trail.
+      #
+      # **Important Legal Considerations:**
+      #
+      # Regenerating receipt PDFs may not be permitted in all jurisdictions. Many tax
+      # authorities require that issued receipts remain unmodified. Before using this
+      # endpoint, ensure that:
+      #
+      # - Your local tax regulations permit modification of issued billing documents
+      # - You have a legitimate business reason (e.g., fixing template errors, updating
+      #   branding)
+      # - You maintain proper records of the original PDF (archived automatically by
+      #   Orb)
+      #
+      # Recommended use cases:
+      #
+      # - Correcting template rendering issues
+      # - Applying updated company branding
+      # - Updating customer data that was incorrect at issuance
+      sig do
+        params(
+          invoice_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Invoice)
+      end
+      def regenerate_receipt_pdf(invoice_id, request_options: {})
+      end
+
       # This endpoint allows an invoice's status to be set to the `void` status. This
       # can only be done to invoices that are in the `issued` status.
       #