release: 4.40.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.39.0"
+  ".": "4.40.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 118
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-9e751a2aefff382af949380b5979a80cb02743eca1583cf5146325fb400ba87f.yml
-openapi_spec_hash: 219a1008f47d3293f64f1baebe2d6eb5
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-947253d9be505473c1c2cb0193d2602fa6b017e221f482be3f4f374c6156b350.yml
+openapi_spec_hash: 1b40d1a85b4b846a1c14634fbbc65da3
 config_hash: e6db17547fe854b1c240407cf4c6dc9e

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 4.40.0 (2025-11-16)
+
+Full Changelog: [v4.39.0...v4.40.0](https://github.com/orbcorp/orb-python/compare/v4.39.0...v4.40.0)
+
+### Features
+
+* **api:** api update ([df68e3b](https://github.com/orbcorp/orb-python/commit/df68e3b750cde5f59c8af374a4e7b3cd2a4feb26))
+
 ## 4.39.0 (2025-11-13)
 
 Full Changelog: [v4.38.2...v4.39.0](https://github.com/orbcorp/orb-python/compare/v4.38.2...v4.39.0)

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "orb-billing"
-version = "4.39.0"
+version = "4.40.0"
 description = "The official Python library for the orb API"
 dynamic = ["readme"]
 license = "Apache-2.0"

src/orb/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "orb"
-__version__ = "4.39.0"  # x-release-please-version
+__version__ = "4.40.0"  # x-release-please-version

src/orb/types/beta/external_plan_id_create_plan_version_params.py

@@ -61,6 +61,9 @@
     "AddPricePriceNewPlanGroupedWithMinMaxThresholdsPrice",
     "AddPricePriceNewPlanGroupedWithMinMaxThresholdsPriceGroupedWithMinMaxThresholdsConfig",
     "AddPricePriceNewPlanGroupedWithMinMaxThresholdsPriceConversionRateConfig",
+    "AddPricePriceNewPlanCumulativeGroupedAllocationPrice",
+    "AddPricePriceNewPlanCumulativeGroupedAllocationPriceCumulativeGroupedAllocationConfig",
+    "AddPricePriceNewPlanCumulativeGroupedAllocationPriceConversionRateConfig",
     "AddPricePriceNewPlanPercentCompositePrice",
     "AddPricePriceNewPlanPercentCompositePricePercentConfig",
     "AddPricePriceNewPlanPercentCompositePriceConversionRateConfig",
@@ -85,6 +88,9 @@
     "ReplacePricePriceNewPlanGroupedWithMinMaxThresholdsPrice",
     "ReplacePricePriceNewPlanGroupedWithMinMaxThresholdsPriceGroupedWithMinMaxThresholdsConfig",
     "ReplacePricePriceNewPlanGroupedWithMinMaxThresholdsPriceConversionRateConfig",
+    "ReplacePricePriceNewPlanCumulativeGroupedAllocationPrice",
+    "ReplacePricePriceNewPlanCumulativeGroupedAllocationPriceCumulativeGroupedAllocationConfig",
+    "ReplacePricePriceNewPlanCumulativeGroupedAllocationPriceConversionRateConfig",
     "ReplacePricePriceNewPlanPercentCompositePrice",
     "ReplacePricePriceNewPlanPercentCompositePricePercentConfig",
     "ReplacePricePriceNewPlanPercentCompositePriceConversionRateConfig",
@@ -447,6 +453,108 @@ class AddPricePriceNewPlanGroupedWithMinMaxThresholdsPrice(TypedDict, total=Fals
     """
 
 
+class AddPricePriceNewPlanCumulativeGroupedAllocationPriceCumulativeGroupedAllocationConfig(TypedDict, total=False):
+    cumulative_allocation: Required[str]
+    """The overall allocation across all groups"""
+
+    group_allocation: Required[str]
+    """The allocation per individual group"""
+
+    grouping_key: Required[str]
+    """The event property used to group usage before applying allocations"""
+
+    unit_amount: Required[str]
+    """The amount to charge for each unit outside of the allocation"""
+
+
+AddPricePriceNewPlanCumulativeGroupedAllocationPriceConversionRateConfig: TypeAlias = Union[
+    UnitConversionRateConfig, TieredConversionRateConfig
+]
+
+
+class AddPricePriceNewPlanCumulativeGroupedAllocationPrice(TypedDict, total=False):
+    cadence: Required[Literal["annual", "semi_annual", "monthly", "quarterly", "one_time", "custom"]]
+    """The cadence to bill for this price on."""
+
+    cumulative_grouped_allocation_config: Required[
+        AddPricePriceNewPlanCumulativeGroupedAllocationPriceCumulativeGroupedAllocationConfig
+    ]
+    """Configuration for cumulative_grouped_allocation pricing"""
+
+    item_id: Required[str]
+    """The id of the item the price will be associated with."""
+
+    model_type: Required[Literal["cumulative_grouped_allocation"]]
+    """The pricing model type"""
+
+    name: Required[str]
+    """The name of the price."""
+
+    billable_metric_id: Optional[str]
+    """The id of the billable metric for the price.
+
+    Only needed if the price is usage-based.
+    """
+
+    billed_in_advance: Optional[bool]
+    """
+    If the Price represents a fixed cost, the price will be billed in-advance if
+    this is true, and in-arrears if this is false.
+    """
+
+    billing_cycle_configuration: Optional[NewBillingCycleConfiguration]
+    """
+    For custom cadence: specifies the duration of the billing period in days or
+    months.
+    """
+
+    conversion_rate: Optional[float]
+    """The per unit conversion rate of the price currency to the invoicing currency."""
+
+    conversion_rate_config: Optional[AddPricePriceNewPlanCumulativeGroupedAllocationPriceConversionRateConfig]
+    """The configuration for the rate of the price currency to the invoicing currency."""
+
+    currency: Optional[str]
+    """
+    An ISO 4217 currency string, or custom pricing unit identifier, in which this
+    price is billed.
+    """
+
+    dimensional_price_configuration: Optional[NewDimensionalPriceConfiguration]
+    """For dimensional price: specifies a price group and dimension values"""
+
+    external_price_id: Optional[str]
+    """An alias for the price."""
+
+    fixed_price_quantity: Optional[float]
+    """
+    If the Price represents a fixed cost, this represents the quantity of units
+    applied.
+    """
+
+    invoice_grouping_key: Optional[str]
+    """The property used to group this price on an invoice"""
+
+    invoicing_cycle_configuration: Optional[NewBillingCycleConfiguration]
+    """Within each billing cycle, specifies the cadence at which invoices are produced.
+
+    If unspecified, a single invoice is produced per billing cycle.
+    """
+
+    metadata: Optional[Dict[str, Optional[str]]]
+    """User-specified key/value pairs for the resource.
+
+    Individual keys can be removed by setting the value to `null`, and the entire
+    metadata mapping can be cleared by setting `metadata` to `null`.
+    """
+
+    reference_id: Optional[str]
+    """
+    A transient ID that can be used to reference this price when adding adjustments
+    in the same API call.
+    """
+
+
 class AddPricePriceNewPlanPercentCompositePricePercentConfig(TypedDict, total=False):
     percent: Required[float]
     """What percent of the component subtotals to charge"""
@@ -670,6 +778,7 @@ class AddPricePriceNewPlanEventOutputPrice(TypedDict, total=False):
     NewPlanScalableMatrixWithUnitPricingPrice,
     NewPlanScalableMatrixWithTieredPricingPrice,
     NewPlanCumulativeGroupedBulkPrice,
+    AddPricePriceNewPlanCumulativeGroupedAllocationPrice,
     NewPlanMinimumCompositePrice,
     AddPricePriceNewPlanPercentCompositePrice,
     AddPricePriceNewPlanEventOutputPrice,
@@ -1033,6 +1142,108 @@ class ReplacePricePriceNewPlanGroupedWithMinMaxThresholdsPrice(TypedDict, total=
     """
 
 
+class ReplacePricePriceNewPlanCumulativeGroupedAllocationPriceCumulativeGroupedAllocationConfig(TypedDict, total=False):
+    cumulative_allocation: Required[str]
+    """The overall allocation across all groups"""
+
+    group_allocation: Required[str]
+    """The allocation per individual group"""
+
+    grouping_key: Required[str]
+    """The event property used to group usage before applying allocations"""
+
+    unit_amount: Required[str]
+    """The amount to charge for each unit outside of the allocation"""
+
+
+ReplacePricePriceNewPlanCumulativeGroupedAllocationPriceConversionRateConfig: TypeAlias = Union[
+    UnitConversionRateConfig, TieredConversionRateConfig
+]
+
+
+class ReplacePricePriceNewPlanCumulativeGroupedAllocationPrice(TypedDict, total=False):
+    cadence: Required[Literal["annual", "semi_annual", "monthly", "quarterly", "one_time", "custom"]]
+    """The cadence to bill for this price on."""
+
+    cumulative_grouped_allocation_config: Required[
+        ReplacePricePriceNewPlanCumulativeGroupedAllocationPriceCumulativeGroupedAllocationConfig
+    ]
+    """Configuration for cumulative_grouped_allocation pricing"""
+
+    item_id: Required[str]
+    """The id of the item the price will be associated with."""
+
+    model_type: Required[Literal["cumulative_grouped_allocation"]]
+    """The pricing model type"""
+
+    name: Required[str]
+    """The name of the price."""
+
+    billable_metric_id: Optional[str]
+    """The id of the billable metric for the price.
+
+    Only needed if the price is usage-based.
+    """
+
+    billed_in_advance: Optional[bool]
+    """
+    If the Price represents a fixed cost, the price will be billed in-advance if
+    this is true, and in-arrears if this is false.
+    """
+
+    billing_cycle_configuration: Optional[NewBillingCycleConfiguration]
+    """
+    For custom cadence: specifies the duration of the billing period in days or
+    months.
+    """
+
+    conversion_rate: Optional[float]
+    """The per unit conversion rate of the price currency to the invoicing currency."""
+
+    conversion_rate_config: Optional[ReplacePricePriceNewPlanCumulativeGroupedAllocationPriceConversionRateConfig]
+    """The configuration for the rate of the price currency to the invoicing currency."""
+
+    currency: Optional[str]
+    """
+    An ISO 4217 currency string, or custom pricing unit identifier, in which this
+    price is billed.
+    """
+
+    dimensional_price_configuration: Optional[NewDimensionalPriceConfiguration]
+    """For dimensional price: specifies a price group and dimension values"""
+
+    external_price_id: Optional[str]
+    """An alias for the price."""
+
+    fixed_price_quantity: Optional[float]
+    """
+    If the Price represents a fixed cost, this represents the quantity of units
+    applied.
+    """
+
+    invoice_grouping_key: Optional[str]
+    """The property used to group this price on an invoice"""
+
+    invoicing_cycle_configuration: Optional[NewBillingCycleConfiguration]
+    """Within each billing cycle, specifies the cadence at which invoices are produced.
+
+    If unspecified, a single invoice is produced per billing cycle.
+    """
+
+    metadata: Optional[Dict[str, Optional[str]]]
+    """User-specified key/value pairs for the resource.
+
+    Individual keys can be removed by setting the value to `null`, and the entire
+    metadata mapping can be cleared by setting `metadata` to `null`.
+    """
+
+    reference_id: Optional[str]
+    """
+    A transient ID that can be used to reference this price when adding adjustments
+    in the same API call.
+    """
+
+
 class ReplacePricePriceNewPlanPercentCompositePricePercentConfig(TypedDict, total=False):
     percent: Required[float]
     """What percent of the component subtotals to charge"""
@@ -1256,6 +1467,7 @@ class ReplacePricePriceNewPlanEventOutputPrice(TypedDict, total=False):
     NewPlanScalableMatrixWithUnitPricingPrice,
     NewPlanScalableMatrixWithTieredPricingPrice,
     NewPlanCumulativeGroupedBulkPrice,
+    ReplacePricePriceNewPlanCumulativeGroupedAllocationPrice,
     NewPlanMinimumCompositePrice,
     ReplacePricePriceNewPlanPercentCompositePrice,
     ReplacePricePriceNewPlanEventOutputPrice,