feat(api): updates (#189)

Author: stainless-bot

src/orb/resources/prices/prices.py

@@ -32,6 +32,7 @@
     "PriceNewPlanThresholdTotalAmountPrice",
     "PriceNewPlanTieredPackagePrice",
     "PriceNewPlanTieredWithMinimumPrice",
+    "PriceNewPlanUnitWithPercentPrice",
     "PriceNewPlanPackageWithAllocationPrice",
 ]
 
@@ -632,6 +633,45 @@ class PriceNewPlanTieredWithMinimumPrice(TypedDict, total=False):
     """The property used to group this price on an invoice"""
 
 
+class PriceNewPlanUnitWithPercentPrice(TypedDict, total=False):
+    cadence: Required[Literal["annual", "monthly", "quarterly", "one_time"]]
+    """The cadence to bill for this price on."""
+
+    item_id: Required[str]
+    """The id of the item the plan will be associated with."""
+
+    model_type: Required[Literal["unit_with_percent"]]
+
+    name: Required[str]
+    """The name of the price."""
+
+    unit_with_percent_config: Required[Dict[str, object]]
+
+    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.
+    """
+
+    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"""
+
+
 class PriceNewPlanPackageWithAllocationPrice(TypedDict, total=False):
     cadence: Required[Literal["annual", "monthly", "quarterly", "one_time"]]
     """The cadence to bill for this price on."""
@@ -683,5 +723,6 @@ class PriceNewPlanPackageWithAllocationPrice(TypedDict, total=False):
     PriceNewPlanThresholdTotalAmountPrice,
     PriceNewPlanTieredPackagePrice,
     PriceNewPlanTieredWithMinimumPrice,
+    PriceNewPlanUnitWithPercentPrice,
     PriceNewPlanPackageWithAllocationPrice,
 ]

src/orb/types/plan_create_params.py

@@ -84,6 +84,11 @@
     "PackageWithAllocationPriceItem",
     "PackageWithAllocationPriceMaximum",
     "PackageWithAllocationPriceMinimum",
+    "UnitWithPercentPrice",
+    "UnitWithPercentPriceBillableMetric",
+    "UnitWithPercentPriceItem",
+    "UnitWithPercentPriceMaximum",
+    "UnitWithPercentPriceMinimum",
 ]
 
 
@@ -1057,6 +1062,76 @@ class PackageWithAllocationPrice(BaseModel):
     price_type: Literal["usage_price", "fixed_price"]
 
 
+class UnitWithPercentPriceBillableMetric(BaseModel):
+    id: str
+
+
+class UnitWithPercentPriceItem(BaseModel):
+    id: str
+
+    name: str
+
+
+class UnitWithPercentPriceMaximum(BaseModel):
+    applies_to_price_ids: List[str]
+    """List of price_ids that this maximum amount applies to.
+
+    For plan/plan phase maximums, this can be a subset of prices.
+    """
+
+    maximum_amount: str
+    """Maximum amount applied"""
+
+
+class UnitWithPercentPriceMinimum(BaseModel):
+    applies_to_price_ids: List[str]
+    """List of price_ids that this minimum amount applies to.
+
+    For plan/plan phase minimums, this can be a subset of prices.
+    """
+
+    minimum_amount: str
+    """Minimum amount applied"""
+
+
+class UnitWithPercentPrice(BaseModel):
+    id: str
+
+    billable_metric: Optional[UnitWithPercentPriceBillableMetric] = None
+
+    cadence: Literal["one_time", "monthly", "quarterly", "annual"]
+
+    created_at: datetime
+
+    currency: str
+
+    discount: Optional[Discount] = None
+
+    external_price_id: Optional[str] = None
+
+    fixed_price_quantity: Optional[float] = None
+
+    item: UnitWithPercentPriceItem
+
+    maximum: Optional[UnitWithPercentPriceMaximum] = None
+
+    maximum_amount: Optional[str] = None
+
+    minimum: Optional[UnitWithPercentPriceMinimum] = None
+
+    minimum_amount: Optional[str] = None
+
+    price_model_type: Literal["unit_with_percent"] = FieldInfo(alias="model_type")
+
+    name: str
+
+    plan_phase_order: Optional[int] = None
+
+    price_type: Literal["usage_price", "fixed_price"]
+
+    unit_with_percent_config: Dict[str, object]
+
+
 Price = Union[
     UnitPrice,
     PackagePrice,
@@ -1070,4 +1145,5 @@ class PackageWithAllocationPrice(BaseModel):
     TieredPackagePrice,
     TieredWithMinimumPrice,
     PackageWithAllocationPrice,
+    UnitWithPercentPrice,
 ]

src/orb/types/price.py

@@ -32,6 +32,8 @@
     "NewFloatingTieredPackagePrice",
     "NewFloatingTieredWithMinimumPrice",
     "NewFloatingPackageWithAllocationPrice",
+    "NewFloatingTieredPackageWithMinimumPrice",
+    "NewFloatingUnitWithPercentPrice",
 ]
 
 
@@ -669,6 +671,90 @@ class NewFloatingPackageWithAllocationPrice(TypedDict, total=False):
     """The property used to group this price on an invoice"""
 
 
+class NewFloatingTieredPackageWithMinimumPrice(TypedDict, total=False):
+    cadence: Required[Literal["annual", "monthly", "quarterly", "one_time"]]
+    """The cadence to bill for this price on."""
+
+    currency: Required[str]
+    """An ISO 4217 currency string for which this price is billed in."""
+
+    item_id: Required[str]
+    """The id of the item the plan will be associated with."""
+
+    model_type: Required[Literal["tiered_package_with_minimum"]]
+
+    name: Required[str]
+    """The name of the price."""
+
+    tiered_package_with_minimum_config: Required[Dict[str, object]]
+
+    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.
+    """
+
+    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"""
+
+
+class NewFloatingUnitWithPercentPrice(TypedDict, total=False):
+    cadence: Required[Literal["annual", "monthly", "quarterly", "one_time"]]
+    """The cadence to bill for this price on."""
+
+    currency: Required[str]
+    """An ISO 4217 currency string for which this price is billed in."""
+
+    item_id: Required[str]
+    """The id of the item the plan will be associated with."""
+
+    model_type: Required[Literal["unit_with_percent"]]
+
+    name: Required[str]
+    """The name of the price."""
+
+    unit_with_percent_config: Required[Dict[str, object]]
+
+    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.
+    """
+
+    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"""
+
+
 PriceCreateParams = Union[
     NewFloatingUnitPrice,
     NewFloatingPackagePrice,
@@ -682,4 +768,6 @@ class NewFloatingPackageWithAllocationPrice(TypedDict, total=False):
     NewFloatingTieredPackagePrice,
     NewFloatingTieredWithMinimumPrice,
     NewFloatingPackageWithAllocationPrice,
+    NewFloatingTieredPackageWithMinimumPrice,
+    NewFloatingUnitWithPercentPrice,
 ]

src/orb/types/price_create_params.py

@@ -48,6 +48,8 @@
     "PriceOverrideOverrideTieredWithMinimumPriceDiscount",
     "PriceOverrideOverridePackageWithAllocationPrice",
     "PriceOverrideOverridePackageWithAllocationPriceDiscount",
+    "PriceOverrideOverrideUnitWithPercentPrice",
+    "PriceOverrideOverrideUnitWithPercentPriceDiscount",
 ]
 
 
@@ -813,6 +815,54 @@ class PriceOverrideOverridePackageWithAllocationPrice(TypedDict, total=False):
     """The subscription's override minimum amount for the plan."""
 
 
+class PriceOverrideOverrideUnitWithPercentPriceDiscount(TypedDict, total=False):
+    discount_type: Required[Literal["percentage", "trial", "usage", "amount"]]
+
+    amount_discount: Optional[str]
+    """Only available if discount_type is `amount`."""
+
+    applies_to_price_ids: Optional[List[str]]
+    """List of price_ids that this discount applies to.
+
+    For plan/plan phase discounts, this can be a subset of prices.
+    """
+
+    percentage_discount: Optional[float]
+    """Only available if discount_type is `percentage`.
+
+    This is a number between 0 and 1.
+    """
+
+    trial_amount_discount: Optional[str]
+    """Only available if discount_type is `trial`"""
+
+    usage_discount: Optional[float]
+    """Only available if discount_type is `usage`.
+
+    Number of usage units that this discount is for
+    """
+
+
+class PriceOverrideOverrideUnitWithPercentPrice(TypedDict, total=False):
+    id: Required[str]
+
+    model_type: Required[Literal["unit_with_percent"]]
+
+    unit_with_percent_config: Required[Dict[str, object]]
+
+    discount: Optional[PriceOverrideOverrideUnitWithPercentPriceDiscount]
+    """The subscription's override discount for the plan."""
+
+    fixed_price_quantity: Optional[float]
+    """The starting quantity of the price, if the price is a fixed price."""
+
+    maximum_amount: Optional[str]
+    """The subscription's override maximum amount for the plan."""
+
+    minimum_amount: Optional[str]
+    """The subscription's override minimum amount for the plan."""
+
+
 PriceOverride = Union[
     PriceOverrideOverrideUnitPrice,
     PriceOverrideOverridePackagePrice,
@@ -826,4 +876,5 @@ class PriceOverrideOverridePackageWithAllocationPrice(TypedDict, total=False):
     PriceOverrideOverrideTieredPackagePrice,
     PriceOverrideOverrideTieredWithMinimumPrice,
     PriceOverrideOverridePackageWithAllocationPrice,
+    PriceOverrideOverrideUnitWithPercentPrice,
 ]