Skip to content

Commit b6bb6d3

Browse files
feat(api): api update
1 parent 866d085 commit b6bb6d3

File tree

7 files changed

+1702
-55
lines changed

7 files changed

+1702
-55
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 126
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-a5a28a58483355d3cc3da7ac5c452d548ee17183324318198052968121ca7dba.yml
3-
openapi_spec_hash: a317931a99e6d4a122919135a0363e40
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-d45078644e5890989174cc450ad8a814913af66bdb43350b63c1b93b98af9efd.yml
3+
openapi_spec_hash: 9750de93e1e074a3e2e27f115422cb77
44
config_hash: bcf82bddb691f6be773ac6cae8c03b9a

src/resources/beta/beta.ts

Lines changed: 238 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,7 @@ export namespace BetaCreatePlanVersionParams {
203203
| Shared.NewPlanScalableMatrixWithTieredPricingPrice
204204
| Shared.NewPlanCumulativeGroupedBulkPrice
205205
| AddPrice.NewPlanCumulativeGroupedAllocationPrice
206+
| AddPrice.NewPlanMinimumPrice
206207
| Shared.NewPlanMinimumCompositePrice
207208
| AddPrice.NewPlanPercentCompositePrice
208209
| AddPrice.NewPlanEventOutputPrice
@@ -747,6 +748,124 @@ export namespace BetaCreatePlanVersionParams {
747748
}
748749
}
749750

751+
export interface NewPlanMinimumPrice {
752+
/**
753+
* The cadence to bill for this price on.
754+
*/
755+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
756+
757+
/**
758+
* The id of the item the price will be associated with.
759+
*/
760+
item_id: string;
761+
762+
/**
763+
* Configuration for minimum pricing
764+
*/
765+
minimum_config: NewPlanMinimumPrice.MinimumConfig;
766+
767+
/**
768+
* The pricing model type
769+
*/
770+
model_type: 'minimum';
771+
772+
/**
773+
* The name of the price.
774+
*/
775+
name: string;
776+
777+
/**
778+
* The id of the billable metric for the price. Only needed if the price is
779+
* usage-based.
780+
*/
781+
billable_metric_id?: string | null;
782+
783+
/**
784+
* If the Price represents a fixed cost, the price will be billed in-advance if
785+
* this is true, and in-arrears if this is false.
786+
*/
787+
billed_in_advance?: boolean | null;
788+
789+
/**
790+
* For custom cadence: specifies the duration of the billing period in days or
791+
* months.
792+
*/
793+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
794+
795+
/**
796+
* The per unit conversion rate of the price currency to the invoicing currency.
797+
*/
798+
conversion_rate?: number | null;
799+
800+
/**
801+
* The configuration for the rate of the price currency to the invoicing currency.
802+
*/
803+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
804+
805+
/**
806+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
807+
* price is billed.
808+
*/
809+
currency?: string | null;
810+
811+
/**
812+
* For dimensional price: specifies a price group and dimension values
813+
*/
814+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
815+
816+
/**
817+
* An alias for the price.
818+
*/
819+
external_price_id?: string | null;
820+
821+
/**
822+
* If the Price represents a fixed cost, this represents the quantity of units
823+
* applied.
824+
*/
825+
fixed_price_quantity?: number | null;
826+
827+
/**
828+
* The property used to group this price on an invoice
829+
*/
830+
invoice_grouping_key?: string | null;
831+
832+
/**
833+
* Within each billing cycle, specifies the cadence at which invoices are produced.
834+
* If unspecified, a single invoice is produced per billing cycle.
835+
*/
836+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
837+
838+
/**
839+
* User-specified key/value pairs for the resource. Individual keys can be removed
840+
* by setting the value to `null`, and the entire metadata mapping can be cleared
841+
* by setting `metadata` to `null`.
842+
*/
843+
metadata?: { [key: string]: string | null } | null;
844+
845+
/**
846+
* A transient ID that can be used to reference this price when adding adjustments
847+
* in the same API call.
848+
*/
849+
reference_id?: string | null;
850+
}
851+
852+
export namespace NewPlanMinimumPrice {
853+
/**
854+
* Configuration for minimum pricing
855+
*/
856+
export interface MinimumConfig {
857+
/**
858+
* The minimum amount to apply
859+
*/
860+
minimum_amount: string;
861+
862+
/**
863+
* If true, subtotals from this price are prorated based on the service period
864+
*/
865+
prorated?: boolean;
866+
}
867+
}
868+
750869
export interface NewPlanPercentCompositePrice {
751870
/**
752871
* The cadence to bill for this price on.
@@ -1081,6 +1200,7 @@ export namespace BetaCreatePlanVersionParams {
10811200
| Shared.NewPlanScalableMatrixWithTieredPricingPrice
10821201
| Shared.NewPlanCumulativeGroupedBulkPrice
10831202
| ReplacePrice.NewPlanCumulativeGroupedAllocationPrice
1203+
| ReplacePrice.NewPlanMinimumPrice
10841204
| Shared.NewPlanMinimumCompositePrice
10851205
| ReplacePrice.NewPlanPercentCompositePrice
10861206
| ReplacePrice.NewPlanEventOutputPrice
@@ -1625,6 +1745,124 @@ export namespace BetaCreatePlanVersionParams {
16251745
}
16261746
}
16271747

1748+
export interface NewPlanMinimumPrice {
1749+
/**
1750+
* The cadence to bill for this price on.
1751+
*/
1752+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1753+
1754+
/**
1755+
* The id of the item the price will be associated with.
1756+
*/
1757+
item_id: string;
1758+
1759+
/**
1760+
* Configuration for minimum pricing
1761+
*/
1762+
minimum_config: NewPlanMinimumPrice.MinimumConfig;
1763+
1764+
/**
1765+
* The pricing model type
1766+
*/
1767+
model_type: 'minimum';
1768+
1769+
/**
1770+
* The name of the price.
1771+
*/
1772+
name: string;
1773+
1774+
/**
1775+
* The id of the billable metric for the price. Only needed if the price is
1776+
* usage-based.
1777+
*/
1778+
billable_metric_id?: string | null;
1779+
1780+
/**
1781+
* If the Price represents a fixed cost, the price will be billed in-advance if
1782+
* this is true, and in-arrears if this is false.
1783+
*/
1784+
billed_in_advance?: boolean | null;
1785+
1786+
/**
1787+
* For custom cadence: specifies the duration of the billing period in days or
1788+
* months.
1789+
*/
1790+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1791+
1792+
/**
1793+
* The per unit conversion rate of the price currency to the invoicing currency.
1794+
*/
1795+
conversion_rate?: number | null;
1796+
1797+
/**
1798+
* The configuration for the rate of the price currency to the invoicing currency.
1799+
*/
1800+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
1801+
1802+
/**
1803+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
1804+
* price is billed.
1805+
*/
1806+
currency?: string | null;
1807+
1808+
/**
1809+
* For dimensional price: specifies a price group and dimension values
1810+
*/
1811+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
1812+
1813+
/**
1814+
* An alias for the price.
1815+
*/
1816+
external_price_id?: string | null;
1817+
1818+
/**
1819+
* If the Price represents a fixed cost, this represents the quantity of units
1820+
* applied.
1821+
*/
1822+
fixed_price_quantity?: number | null;
1823+
1824+
/**
1825+
* The property used to group this price on an invoice
1826+
*/
1827+
invoice_grouping_key?: string | null;
1828+
1829+
/**
1830+
* Within each billing cycle, specifies the cadence at which invoices are produced.
1831+
* If unspecified, a single invoice is produced per billing cycle.
1832+
*/
1833+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1834+
1835+
/**
1836+
* User-specified key/value pairs for the resource. Individual keys can be removed
1837+
* by setting the value to `null`, and the entire metadata mapping can be cleared
1838+
* by setting `metadata` to `null`.
1839+
*/
1840+
metadata?: { [key: string]: string | null } | null;
1841+
1842+
/**
1843+
* A transient ID that can be used to reference this price when adding adjustments
1844+
* in the same API call.
1845+
*/
1846+
reference_id?: string | null;
1847+
}
1848+
1849+
export namespace NewPlanMinimumPrice {
1850+
/**
1851+
* Configuration for minimum pricing
1852+
*/
1853+
export interface MinimumConfig {
1854+
/**
1855+
* The minimum amount to apply
1856+
*/
1857+
minimum_amount: string;
1858+
1859+
/**
1860+
* If true, subtotals from this price are prorated based on the service period
1861+
*/
1862+
prorated?: boolean;
1863+
}
1864+
}
1865+
16281866
export interface NewPlanPercentCompositePrice {
16291867
/**
16301868
* The cadence to bill for this price on.

0 commit comments

Comments
 (0)