release: 5.28.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "5.27.0"
+  ".": "5.28.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 118
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-5b9152241ebdd0d2f3fd536784f33721d24a5c4a59e75cab366a3dcb36552d3d.yml
-openapi_spec_hash: b40061d10bbe1ebab8998bddd1827cf8
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-f2b97a2c3e41f618dc8955ed325092320ff2170a7d7a9a26a31dc235c969b657.yml
+openapi_spec_hash: 64548564dc8ce80ef3ad38fc8cb56b30
 config_hash: dd4343ce95871032ef6e0735a4ca038c

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 5.28.0 (2025-11-05)
+
+Full Changelog: [v5.27.0...v5.28.0](https://github.com/orbcorp/orb-node/compare/v5.27.0...v5.28.0)
+
+### Features
+
+* **api:** api update ([c6adfcd](https://github.com/orbcorp/orb-node/commit/c6adfcddb900c27adf353be1ef0cbd932cb68da3))
+
 ## 5.27.0 (2025-11-04)
 
 Full Changelog: [v5.26.0...v5.27.0](https://github.com/orbcorp/orb-node/compare/v5.26.0...v5.27.0)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "orb-billing",
-  "version": "5.27.0",
+  "version": "5.28.0",
   "description": "The official TypeScript library for the Orb API",
   "author": "Orb <[email protected]>",
   "types": "dist/index.d.ts",

src/resources/shared.ts

@@ -14182,6 +14182,13 @@ export interface PriceInterval {
    */
   billing_cycle_day: number;
 
+  /**
+   * For in-arrears prices. If true, and the price interval ends mid-cycle, the final
+   * line item will be deferred to the next scheduled invoice instead of being billed
+   * mid-cycle.
+   */
+  can_defer_billing: boolean;
+
   /**
    * The end of the current billing period. This is an exclusive timestamp, such that
    * the instant returned is exactly the end of the billing period. Set to null if
@@ -14341,6 +14348,11 @@ export interface TieredConfig {
    * Tiers for rating based on total usage quantities into the specified tier
    */
   tiers: Array<Tier>;
+
+  /**
+   * If true, subtotals from this price are prorated based on the service period
+   */
+  prorated?: boolean;
 }
 
 export interface TieredConversionRateConfig {
@@ -14403,6 +14415,11 @@ export interface UnitConfig {
    * Rate per unit of usage
    */
   unit_amount: string;
+
+  /**
+   * If true, subtotals from this price are prorated based on the service period
+   */
+  prorated?: boolean;
 }
 
 export interface UnitConversionRateConfig {

src/resources/subscriptions.ts

@@ -6480,6 +6480,13 @@ export interface SubscriptionPriceIntervalsParams {
    */
   allow_invoice_credit_or_void?: boolean | null;
 
+  /**
+   * If true, ending an in-arrears price interval mid-cycle will defer billing the
+   * final line itemuntil the next scheduled invoice. If false, it will be billed on
+   * its end date. If not provided, behaviorwill follow account default.
+   */
+  can_defer_billing?: boolean | null;
+
   /**
    * A list of price intervals to edit on the subscription.
    */
@@ -7182,6 +7189,13 @@ export namespace SubscriptionPriceIntervalsParams {
      */
     billing_cycle_day?: number | null;
 
+    /**
+     * If true, ending an in-arrears price interval mid-cycle will defer billing the
+     * final line itemuntil the next scheduled invoice. If false, it will be billed on
+     * its end date. If not provided, behaviorwill follow account default.
+     */
+    can_defer_billing?: boolean | null;
+
     /**
      * The updated end date of this price interval. If not specified, the end date will
      * not be updated.

src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.27.0'; // x-release-please-version
+export const VERSION = '5.28.0'; // x-release-please-version

tests/api-resources/beta/beta.test.ts

@@ -55,7 +55,7 @@ describe('resource beta', () => {
             item_id: 'item_id',
             model_type: 'unit',
             name: 'Annual fee',
-            unit_config: { unit_amount: 'unit_amount' },
+            unit_config: { unit_amount: 'unit_amount', prorated: true },
             billable_metric_id: 'billable_metric_id',
             billed_in_advance: true,
             billing_cycle_configuration: { duration: 0, duration_unit: 'day' },
@@ -115,7 +115,7 @@ describe('resource beta', () => {
             item_id: 'item_id',
             model_type: 'unit',
             name: 'Annual fee',
-            unit_config: { unit_amount: 'unit_amount' },
+            unit_config: { unit_amount: 'unit_amount', prorated: true },
             billable_metric_id: 'billable_metric_id',
             billed_in_advance: true,
             billing_cycle_configuration: { duration: 0, duration_unit: 'day' },

tests/api-resources/beta/external-plan-id.test.ts

@@ -55,7 +55,7 @@ describe('resource externalPlanId', () => {
             item_id: 'item_id',
             model_type: 'unit',
             name: 'Annual fee',
-            unit_config: { unit_amount: 'unit_amount' },
+            unit_config: { unit_amount: 'unit_amount', prorated: true },
             billable_metric_id: 'billable_metric_id',
             billed_in_advance: true,
             billing_cycle_configuration: { duration: 0, duration_unit: 'day' },
@@ -115,7 +115,7 @@ describe('resource externalPlanId', () => {
             item_id: 'item_id',
             model_type: 'unit',
             name: 'Annual fee',
-            unit_config: { unit_amount: 'unit_amount' },
+            unit_config: { unit_amount: 'unit_amount', prorated: true },
             billable_metric_id: 'billable_metric_id',
             billed_in_advance: true,
             billing_cycle_configuration: { duration: 0, duration_unit: 'day' },

tests/api-resources/invoices.test.ts

@@ -46,7 +46,7 @@ describe('resource invoices', () => {
           name: 'Line Item Name',
           quantity: 1,
           start_date: '2023-09-22',
-          unit_config: { unit_amount: 'unit_amount' },
+          unit_config: { unit_amount: 'unit_amount', prorated: true },
         },
       ],
       customer_id: '4khy3nwzktxv7',

tests/api-resources/plans/plans.test.ts

@@ -40,7 +40,7 @@ describe('resource plans', () => {
             item_id: 'item_id',
             model_type: 'unit',
             name: 'Annual fee',
-            unit_config: { unit_amount: 'unit_amount' },
+            unit_config: { unit_amount: 'unit_amount', prorated: true },
             billable_metric_id: 'billable_metric_id',
             billed_in_advance: true,
             billing_cycle_configuration: { duration: 0, duration_unit: 'day' },

tests/api-resources/prices/prices.test.ts

@@ -34,7 +34,7 @@ describe('resource prices', () => {
       item_id: 'item_id',
       model_type: 'unit',
       name: 'Annual fee',
-      unit_config: { unit_amount: 'unit_amount' },
+      unit_config: { unit_amount: 'unit_amount', prorated: true },
       billable_metric_id: 'billable_metric_id',
       billed_in_advance: true,
       billing_cycle_configuration: { duration: 0, duration_unit: 'day' },
@@ -143,7 +143,7 @@ describe('resource prices', () => {
             item_id: 'item_id',
             model_type: 'unit',
             name: 'Annual fee',
-            unit_config: { unit_amount: 'unit_amount' },
+            unit_config: { unit_amount: 'unit_amount', prorated: true },
             billable_metric_id: 'billable_metric_id',
             billed_in_advance: true,
             billing_cycle_configuration: { duration: 0, duration_unit: 'day' },
@@ -209,7 +209,7 @@ describe('resource prices', () => {
             item_id: 'item_id',
             model_type: 'unit',
             name: 'Annual fee',
-            unit_config: { unit_amount: 'unit_amount' },
+            unit_config: { unit_amount: 'unit_amount', prorated: true },
             billable_metric_id: 'billable_metric_id',
             billed_in_advance: true,
             billing_cycle_configuration: { duration: 0, duration_unit: 'day' },

tests/api-resources/subscriptions.test.ts

@@ -320,7 +320,7 @@ describe('resource subscriptions', () => {
             item_id: 'item_id',
             model_type: 'unit',
             name: 'Annual fee',
-            unit_config: { unit_amount: 'unit_amount' },
+            unit_config: { unit_amount: 'unit_amount', prorated: true },
             billable_metric_id: 'billable_metric_id',
             billed_in_advance: true,
             billing_cycle_configuration: { duration: 0, duration_unit: 'day' },
@@ -409,7 +409,7 @@ describe('resource subscriptions', () => {
             item_id: 'item_id',
             model_type: 'unit',
             name: 'Annual fee',
-            unit_config: { unit_amount: 'unit_amount' },
+            unit_config: { unit_amount: 'unit_amount', prorated: true },
             billable_metric_id: 'billable_metric_id',
             billed_in_advance: true,
             billing_cycle_configuration: { duration: 0, duration_unit: 'day' },