feat(api): add param to backfill create (#247)

Author: stainless-app[bot]

src/orb/resources/prices/prices.py

@@ -1413,6 +1413,11 @@ def schedule_plan_change(
         default for the plan. The request format for price overrides, maximums, and
         minimums are the same as those in [subscription creation](create-subscription).
 
+        ## Scheduling multiple plan changes
+
+        When scheduling multiple plan changes with the same date, the latest plan change
+        on that day takes effect.
+
         ## Prorations for in-advance fees
 
         By default, Orb calculates the prorated difference in any fixed fees when making
@@ -3120,6 +3125,11 @@ async def schedule_plan_change(
         default for the plan. The request format for price overrides, maximums, and
         minimums are the same as those in [subscription creation](create-subscription).
 
+        ## Scheduling multiple plan changes
+
+        When scheduling multiple plan changes with the same date, the latest plan change
+        on that day takes effect.
+
         ## Prorations for in-advance fees
 
         By default, Orb calculates the prorated difference in any fixed fees when making

src/orb/resources/subscriptions.py

@@ -26,6 +26,9 @@ class BackfillCloseResponse(BaseModel):
     If null, this backfill is not scoped to a single customer.
     """
 
+    events_ingested: int
+    """The number of events ingested in this backfill."""
+
     reverted_at: Optional[datetime] = None
     """The time at which this backfill was reverted."""
 

src/orb/types/events/backfill_close_response.py

@@ -26,6 +26,9 @@ class BackfillCreateResponse(BaseModel):
     If null, this backfill is not scoped to a single customer.
     """
 
+    events_ingested: int
+    """The number of events ingested in this backfill."""
+
     reverted_at: Optional[datetime] = None
     """The time at which this backfill was reverted."""
 

src/orb/types/events/backfill_create_response.py

@@ -26,6 +26,9 @@ class BackfillFetchResponse(BaseModel):
     If null, this backfill is not scoped to a single customer.
     """
 
+    events_ingested: int
+    """The number of events ingested in this backfill."""
+
     reverted_at: Optional[datetime] = None
     """The time at which this backfill was reverted."""
 

src/orb/types/events/backfill_fetch_response.py

@@ -26,6 +26,9 @@ class BackfillListResponse(BaseModel):
     If null, this backfill is not scoped to a single customer.
     """
 
+    events_ingested: int
+    """The number of events ingested in this backfill."""
+
     reverted_at: Optional[datetime] = None
     """The time at which this backfill was reverted."""
 

src/orb/types/events/backfill_list_response.py

@@ -26,6 +26,9 @@ class BackfillRevertResponse(BaseModel):
     If null, this backfill is not scoped to a single customer.
     """
 
+    events_ingested: int
+    """The number of events ingested in this backfill."""
+
     reverted_at: Optional[datetime] = None
     """The time at which this backfill was reverted."""
 

src/orb/types/events/backfill_revert_response.py

@@ -105,6 +105,9 @@ class PriceNewPlanUnitPrice(TypedDict, total=False):
     this is true, and in-arrears if this is false.
     """
 
+    conversion_rate: Optional[float]
+    """The per unit conversion 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
@@ -128,7 +131,7 @@ class PriceNewPlanPackagePricePackageConfig(TypedDict, total=False):
     package_amount: Required[str]
     """A currency amount to rate usage by"""
 
-    package_size: Optional[int]
+    package_size: Required[int]
     """An integer amount to represent package size.
 
     For example, 1000 here would divide usage by 1000 before multiplying by
@@ -162,6 +165,9 @@ class PriceNewPlanPackagePrice(TypedDict, total=False):
     this is true, and in-arrears if this is false.
     """
 
+    conversion_rate: Optional[float]
+    """The per unit conversion 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
@@ -230,6 +236,9 @@ class PriceNewPlanMatrixPrice(TypedDict, total=False):
     this is true, and in-arrears if this is false.
     """
 
+    conversion_rate: Optional[float]
+    """The per unit conversion 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
@@ -291,6 +300,9 @@ class PriceNewPlanTieredPrice(TypedDict, total=False):
     this is true, and in-arrears if this is false.
     """
 
+    conversion_rate: Optional[float]
+    """The per unit conversion 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
@@ -358,6 +370,9 @@ class PriceNewPlanTieredBpsPrice(TypedDict, total=False):
     this is true, and in-arrears if this is false.
     """
 
+    conversion_rate: Optional[float]
+    """The per unit conversion 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
@@ -411,6 +426,9 @@ class PriceNewPlanBpsPrice(TypedDict, total=False):
     this is true, and in-arrears if this is false.
     """
 
+    conversion_rate: Optional[float]
+    """The per unit conversion 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
@@ -475,6 +493,9 @@ class PriceNewPlanBulkBpsPrice(TypedDict, total=False):
     this is true, and in-arrears if this is false.
     """
 
+    conversion_rate: Optional[float]
+    """The per unit conversion 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
@@ -533,6 +554,9 @@ class PriceNewPlanBulkPrice(TypedDict, total=False):
     this is true, and in-arrears if this is false.
     """
 
+    conversion_rate: Optional[float]
+    """The per unit conversion 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
@@ -578,6 +602,9 @@ class PriceNewPlanThresholdTotalAmountPrice(TypedDict, total=False):
     this is true, and in-arrears if this is false.
     """
 
+    conversion_rate: Optional[float]
+    """The per unit conversion 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
@@ -623,6 +650,9 @@ class PriceNewPlanTieredPackagePrice(TypedDict, total=False):
     this is true, and in-arrears if this is false.
     """
 
+    conversion_rate: Optional[float]
+    """The per unit conversion 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
@@ -668,6 +698,9 @@ class PriceNewPlanTieredWithMinimumPrice(TypedDict, total=False):
     this is true, and in-arrears if this is false.
     """
 
+    conversion_rate: Optional[float]
+    """The per unit conversion 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
@@ -713,6 +746,9 @@ class PriceNewPlanUnitWithPercentPrice(TypedDict, total=False):
     this is true, and in-arrears if this is false.
     """
 
+    conversion_rate: Optional[float]
+    """The per unit conversion 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
@@ -758,6 +794,9 @@ class PriceNewPlanPackageWithAllocationPrice(TypedDict, total=False):
     this is true, and in-arrears if this is false.
     """
 
+    conversion_rate: Optional[float]
+    """The per unit conversion 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

src/orb/types/plan_create_params.py

@@ -175,6 +175,8 @@ class UnitPrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[UnitPriceCreditAllocation] = None
@@ -250,7 +252,7 @@ class PackagePricePackageConfig(BaseModel):
     package_amount: str
     """A currency amount to rate usage by"""
 
-    package_size: Optional[int] = None
+    package_size: int
     """An integer amount to represent package size.
 
     For example, 1000 here would divide usage by 1000 before multiplying by
@@ -265,6 +267,8 @@ class PackagePrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[PackagePriceCreditAllocation] = None
@@ -366,6 +370,8 @@ class MatrixPrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[MatrixPriceCreditAllocation] = None
@@ -460,6 +466,8 @@ class TieredPrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[TieredPriceCreditAllocation] = None
@@ -560,6 +568,8 @@ class TieredBpsPrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[TieredBpsPriceCreditAllocation] = None
@@ -648,6 +658,8 @@ class BpsPrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[BpsPriceCreditAllocation] = None
@@ -745,6 +757,8 @@ class BulkBpsPrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[BulkBpsPriceCreditAllocation] = None
@@ -836,6 +850,8 @@ class BulkPrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[BulkPriceCreditAllocation] = None
@@ -912,6 +928,8 @@ class ThresholdTotalAmountPrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[ThresholdTotalAmountPriceCreditAllocation] = None
@@ -990,6 +1008,8 @@ class TieredPackagePrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[TieredPackagePriceCreditAllocation] = None
@@ -1068,6 +1088,8 @@ class GroupedTieredPrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[GroupedTieredPriceCreditAllocation] = None
@@ -1146,6 +1168,8 @@ class TieredWithMinimumPrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[TieredWithMinimumPriceCreditAllocation] = None
@@ -1224,6 +1248,8 @@ class TieredPackageWithMinimumPrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[TieredPackageWithMinimumPriceCreditAllocation] = None
@@ -1302,6 +1328,8 @@ class PackageWithAllocationPrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[PackageWithAllocationPriceCreditAllocation] = None
@@ -1380,6 +1408,8 @@ class UnitWithPercentPrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[UnitWithPercentPriceCreditAllocation] = None
@@ -1484,6 +1514,8 @@ class MatrixWithAllocationPrice(BaseModel):
 
     cadence: Literal["one_time", "monthly", "quarterly", "annual"]
 
+    conversion_rate: Optional[float] = None
+
     created_at: datetime
 
     credit_allocation: Optional[MatrixWithAllocationPriceCreditAllocation] = None