orb-billing 1.29.0 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5a6e4855b8279d4e1a6bdf28f4c400529e61861a120047763a6ffdaed8e5575
-  data.tar.gz: 36fe46e75224e82fb729f71d0d754736174092708fc02b1692600360eff66dc7
+  metadata.gz: d76a05385315f5843ea2bcc7db9a121d5990654a8c9e14b7c0f098f5e001ed6f
+  data.tar.gz: 021e9521889d0a5a3664260e921ab0b0c60bc0298e8abc389d3acdc4f7183e0c
 SHA512:
-  metadata.gz: b6a5c380bac65e5c3636214e5dd68535b327a427ad3b24519af8de62f7426c95a321d492e8ba9940f5426da4df5ac39be566b756f91ba73ea3445aea90450708
-  data.tar.gz: a20cd6d63c5af3f339fbaaba7d3fd549b137a4218f7d6f5ccf9021a74c274ae8beaa6bf2f40f885f23e31267bf03c45cad819a0c329abd281d9de5832f65d5d1
+  metadata.gz: 001d9531a4f619a877596c0162fc5eac4a42f2fb293e3f30750288501122f50226a851f712044daf7e46c16a4ff7ba8d8025916f690e691e3091abc601b63755
+  data.tar.gz: 3085bd9431a9ec2c15e3669a967fdffdeb6f83a39e7c8e77927093c88eb084f93ce5a61d73e387252a7c47e0bec5d38b81552c4f3773b26855bff2d73c3d5828

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.30.0](https://github.com/orbcorp/orb-ruby/compare/v1.29.0...v1.30.0) (2026-09-04)
+
+
+### Features
+
+* **api:** api update ([759c873](https://github.com/orbcorp/orb-ruby/commit/759c8739c8a675a6c34af657ce340388c2e5585f))
+
 ## [1.29.0](https://github.com/orbcorp/orb-ruby/compare/v1.28.1...v1.29.0) (2026-09-03)
 
 

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "orb-billing", "~> 1.29.0"
+gem "orb-billing", "~> 1.30.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/resources/customers/credits/top_ups.rb

@@ -57,7 +57,13 @@ module Orb
           # Some parameter documentations has been truncated, see
           # {Orb::Models::Customers::Credits::TopUpListParams} for more details.
           #
-          # List top-ups
+          # This endpoint returns a list of a customer's active top-ups; a top-up that has
+          # been deactivated is not included. While a top-up is active, the customer's
+          # balance is increased by the top-up amount whenever it falls to the top-up's
+          # threshold.
+          #
+          # The response also includes pagination_metadata, which lets the caller retrieve
+          # the next page of results if they exist.
           #
           # @overload list(customer_id, cursor: nil, limit: nil, request_options: {})
           #
@@ -192,7 +198,13 @@ module Orb
           # Some parameter documentations has been truncated, see
           # {Orb::Models::Customers::Credits::TopUpListByExternalIDParams} for more details.
           #
-          # List top-ups by external ID
+          # This endpoint returns a list of a customer's active top-ups; a top-up that has
+          # been deactivated is not included. While a top-up is active, the customer's
+          # balance is increased by the top-up amount whenever it falls to the top-up's
+          # threshold.
+          #
+          # The response also includes pagination_metadata, which lets the caller retrieve
+          # the next page of results if they exist.
           #
           # @overload list_by_external_id(external_customer_id, cursor: nil, limit: nil, request_options: {})
           #

data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb

@@ -4,7 +4,10 @@ module Orb
   module Resources
     class DimensionalPriceGroups
       class ExternalDimensionalPriceGroupID
-        # Fetch dimensional price group by external ID
+        # This endpoint returns a dimensional price group identified by the external ID
+        # you assigned it, rather than by its Orb ID. A dimensional price group partitions
+        # the result of a billable metric by a set of dimensions, and the prices in the
+        # group specify which partition their usage is derived from.
         #
         # @overload retrieve(external_dimensional_price_group_id, request_options: {})
         #

data/lib/orb/resources/dimensional_price_groups.rb

@@ -46,7 +46,10 @@ module Orb
         )
       end
 
-      # Fetch dimensional price group
+      # This endpoint returns a dimensional price group identified by its ID. A
+      # dimensional price group partitions the result of a billable metric by a set of
+      # dimensions, and the prices in the group specify which partition their usage is
+      # derived from.
       #
       # @overload retrieve(dimensional_price_group_id, request_options: {})
       #
@@ -99,7 +102,13 @@ module Orb
       # Some parameter documentations has been truncated, see
       # {Orb::Models::DimensionalPriceGroupListParams} for more details.
       #
-      # List dimensional price groups
+      # This endpoint returns a list of all dimensional price groups for an account. A
+      # dimensional price group partitions the result of a billable metric by a set of
+      # dimensions, and the prices in the group specify which partition their usage is
+      # derived from.
+      #
+      # The response also includes pagination_metadata, which lets the caller retrieve
+      # the next page of results if they exist.
       #
       # @overload list(cursor: nil, limit: nil, request_options: {})
       #

data/lib/orb/resources/items.rb

@@ -88,7 +88,9 @@ module Orb
         )
       end
 
-      # Archive item
+      # This endpoint archives an item, and cascades to archive every price for that
+      # item that is still active. An item that is already archived cannot be archived
+      # again.
       #
       # @overload archive(item_id, request_options: {})
       #

data/lib/orb/resources/plans/migrations.rb

@@ -8,7 +8,9 @@ module Orb
       # subscription. You can see more about how to configure prices in the
       # [Price resource](/reference/price).
       class Migrations
-        # Fetch migration
+        # This endpoint returns a migration for a plan, identified by its ID. A migration
+        # moves a plan's subscriptions onto a new version of that plan; the response
+        # reports the effective time it is scheduled for and its current status.
         #
         # @overload retrieve(migration_id, plan_id:, request_options: {})
         #

data/lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "1.29.0"
+  VERSION = "1.30.0"
 end

data/rbi/orb/resources/customers/credits/top_ups.rbi

@@ -58,7 +58,13 @@ module Orb
           )
           end
 
-          # List top-ups
+          # This endpoint returns a list of a customer's active top-ups; a top-up that has
+          # been deactivated is not included. While a top-up is active, the customer's
+          # balance is increased by the top-up amount whenever it falls to the top-up's
+          # threshold.
+          #
+          # The response also includes pagination_metadata, which lets the caller retrieve
+          # the next page of results if they exist.
           sig do
             params(
               customer_id: String,
@@ -163,7 +169,13 @@ module Orb
           )
           end
 
-          # List top-ups by external ID
+          # This endpoint returns a list of a customer's active top-ups; a top-up that has
+          # been deactivated is not included. While a top-up is active, the customer's
+          # balance is increased by the top-up amount whenever it falls to the top-up's
+          # threshold.
+          #
+          # The response also includes pagination_metadata, which lets the caller retrieve
+          # the next page of results if they exist.
           sig do
             params(
               external_customer_id: String,

data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi

@@ -4,7 +4,10 @@ module Orb
   module Resources
     class DimensionalPriceGroups
       class ExternalDimensionalPriceGroupID
-        # Fetch dimensional price group by external ID
+        # This endpoint returns a dimensional price group identified by the external ID
+        # you assigned it, rather than by its Orb ID. A dimensional price group partitions
+        # the result of a billable metric by a set of dimensions, and the prices in the
+        # group specify which partition their usage is derived from.
         sig do
           params(
             external_dimensional_price_group_id: String,

data/rbi/orb/resources/dimensional_price_groups.rbi

@@ -42,7 +42,10 @@ module Orb
       )
       end
 
-      # Fetch dimensional price group
+      # This endpoint returns a dimensional price group identified by its ID. A
+      # dimensional price group partitions the result of a billable metric by a set of
+      # dimensions, and the prices in the group specify which partition their usage is
+      # derived from.
       sig do
         params(
           dimensional_price_group_id: String,
@@ -78,7 +81,13 @@ module Orb
       )
       end
 
-      # List dimensional price groups
+      # This endpoint returns a list of all dimensional price groups for an account. A
+      # dimensional price group partitions the result of a billable metric by a set of
+      # dimensions, and the prices in the group specify which partition their usage is
+      # derived from.
+      #
+      # The response also includes pagination_metadata, which lets the caller retrieve
+      # the next page of results if they exist.
       sig do
         params(
           cursor: T.nilable(String),

data/rbi/orb/resources/items.rbi

@@ -69,7 +69,9 @@ module Orb
       )
       end
 
-      # Archive item
+      # This endpoint archives an item, and cascades to archive every price for that
+      # item that is still active. An item that is already archived cannot be archived
+      # again.
       sig do
         params(
           item_id: String,

data/rbi/orb/resources/plans/migrations.rbi

@@ -8,7 +8,9 @@ module Orb
       # subscription. You can see more about how to configure prices in the
       # [Price resource](/reference/price).
       class Migrations
-        # Fetch migration
+        # This endpoint returns a migration for a plan, identified by its ID. A migration
+        # moves a plan's subscriptions onto a new version of that plan; the response
+        # reports the effective time it is scheduled for and its current status.
         sig do
           params(
             migration_id: String,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orb-billing
 version: !ruby/object:Gem::Version
-  version: 1.29.0
+  version: 1.30.0
 platform: ruby
 authors:
 - Orb