@@ -1766,98 +1766,6 @@ def create(
1766
1766
"""
1767
1767
...
1768
1768
1769
- @overload
1770
- def create (
1771
- self ,
1772
- * ,
1773
- cadence : Literal ["annual" , "semi_annual" , "monthly" , "quarterly" , "one_time" , "custom" ],
1774
- currency : str ,
1775
- grouped_with_prorated_minimum_config : Dict [str , object ],
1776
- item_id : str ,
1777
- model_type : Literal ["grouped_with_prorated_minimum" ],
1778
- name : str ,
1779
- billable_metric_id : Optional [str ] | NotGiven = NOT_GIVEN ,
1780
- billed_in_advance : Optional [bool ] | NotGiven = NOT_GIVEN ,
1781
- billing_cycle_configuration : Optional [
1782
- price_create_params .NewFloatingGroupedWithProratedMinimumPriceBillingCycleConfiguration
1783
- ]
1784
- | NotGiven = NOT_GIVEN ,
1785
- conversion_rate : Optional [float ] | NotGiven = NOT_GIVEN ,
1786
- external_price_id : Optional [str ] | NotGiven = NOT_GIVEN ,
1787
- fixed_price_quantity : Optional [float ] | NotGiven = NOT_GIVEN ,
1788
- invoice_grouping_key : Optional [str ] | NotGiven = NOT_GIVEN ,
1789
- invoicing_cycle_configuration : Optional [
1790
- price_create_params .NewFloatingGroupedWithProratedMinimumPriceInvoicingCycleConfiguration
1791
- ]
1792
- | NotGiven = NOT_GIVEN ,
1793
- metadata : Optional [Dict [str , Optional [str ]]] | NotGiven = NOT_GIVEN ,
1794
- # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
1795
- # The extra values given here take precedence over values defined on the client or passed to this method.
1796
- extra_headers : Headers | None = None ,
1797
- extra_query : Query | None = None ,
1798
- extra_body : Body | None = None ,
1799
- timeout : float | httpx .Timeout | None | NotGiven = NOT_GIVEN ,
1800
- idempotency_key : str | None = None ,
1801
- ) -> Price :
1802
- """This endpoint is used to create a [price](../reference/price).
1803
-
1804
- A price created
1805
- using this endpoint is always an add-on, meaning that it’s not associated with a
1806
- specific plan and can instead be individually added to subscriptions, including
1807
- subscriptions on different plans.
1808
-
1809
- An `external_price_id` can be optionally specified as an alias to allow
1810
- ergonomic interaction with prices in the Orb API.
1811
-
1812
- See the [Price resource](../reference/price) for the specification of different
1813
- price model configurations possible in this endpoint.
1814
-
1815
- Args:
1816
- cadence: The cadence to bill for this price on.
1817
-
1818
- currency: An ISO 4217 currency string for which this price is billed in.
1819
-
1820
- item_id: The id of the item the plan will be associated with.
1821
-
1822
- name: The name of the price.
1823
-
1824
- billable_metric_id: The id of the billable metric for the price. Only needed if the price is
1825
- usage-based.
1826
-
1827
- billed_in_advance: If the Price represents a fixed cost, the price will be billed in-advance if
1828
- this is true, and in-arrears if this is false.
1829
-
1830
- billing_cycle_configuration: For custom cadence: specifies the duration of the billing period in days or
1831
- months.
1832
-
1833
- conversion_rate: The per unit conversion rate of the price currency to the invoicing currency.
1834
-
1835
- external_price_id: An alias for the price.
1836
-
1837
- fixed_price_quantity: If the Price represents a fixed cost, this represents the quantity of units
1838
- applied.
1839
-
1840
- invoice_grouping_key: The property used to group this price on an invoice
1841
-
1842
- invoicing_cycle_configuration: Within each billing cycle, specifies the cadence at which invoices are produced.
1843
- If unspecified, a single invoice is produced per billing cycle.
1844
-
1845
- metadata: User-specified key/value pairs for the resource. Individual keys can be removed
1846
- by setting the value to `null`, and the entire metadata mapping can be cleared
1847
- by setting `metadata` to `null`.
1848
-
1849
- extra_headers: Send extra headers
1850
-
1851
- extra_query: Add additional query parameters to the request
1852
-
1853
- extra_body: Add additional JSON properties to the request
1854
-
1855
- timeout: Override the client-level default timeout for this request, in seconds
1856
-
1857
- idempotency_key: Specify a custom idempotency key for this request
1858
- """
1859
- ...
1860
-
1861
1769
@overload
1862
1770
def create (
1863
1771
self ,
@@ -4059,98 +3967,6 @@ async def create(
4059
3967
"""
4060
3968
...
4061
3969
4062
- @overload
4063
- async def create (
4064
- self ,
4065
- * ,
4066
- cadence : Literal ["annual" , "semi_annual" , "monthly" , "quarterly" , "one_time" , "custom" ],
4067
- currency : str ,
4068
- grouped_with_prorated_minimum_config : Dict [str , object ],
4069
- item_id : str ,
4070
- model_type : Literal ["grouped_with_prorated_minimum" ],
4071
- name : str ,
4072
- billable_metric_id : Optional [str ] | NotGiven = NOT_GIVEN ,
4073
- billed_in_advance : Optional [bool ] | NotGiven = NOT_GIVEN ,
4074
- billing_cycle_configuration : Optional [
4075
- price_create_params .NewFloatingGroupedWithProratedMinimumPriceBillingCycleConfiguration
4076
- ]
4077
- | NotGiven = NOT_GIVEN ,
4078
- conversion_rate : Optional [float ] | NotGiven = NOT_GIVEN ,
4079
- external_price_id : Optional [str ] | NotGiven = NOT_GIVEN ,
4080
- fixed_price_quantity : Optional [float ] | NotGiven = NOT_GIVEN ,
4081
- invoice_grouping_key : Optional [str ] | NotGiven = NOT_GIVEN ,
4082
- invoicing_cycle_configuration : Optional [
4083
- price_create_params .NewFloatingGroupedWithProratedMinimumPriceInvoicingCycleConfiguration
4084
- ]
4085
- | NotGiven = NOT_GIVEN ,
4086
- metadata : Optional [Dict [str , Optional [str ]]] | NotGiven = NOT_GIVEN ,
4087
- # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
4088
- # The extra values given here take precedence over values defined on the client or passed to this method.
4089
- extra_headers : Headers | None = None ,
4090
- extra_query : Query | None = None ,
4091
- extra_body : Body | None = None ,
4092
- timeout : float | httpx .Timeout | None | NotGiven = NOT_GIVEN ,
4093
- idempotency_key : str | None = None ,
4094
- ) -> Price :
4095
- """This endpoint is used to create a [price](../reference/price).
4096
-
4097
- A price created
4098
- using this endpoint is always an add-on, meaning that it’s not associated with a
4099
- specific plan and can instead be individually added to subscriptions, including
4100
- subscriptions on different plans.
4101
-
4102
- An `external_price_id` can be optionally specified as an alias to allow
4103
- ergonomic interaction with prices in the Orb API.
4104
-
4105
- See the [Price resource](../reference/price) for the specification of different
4106
- price model configurations possible in this endpoint.
4107
-
4108
- Args:
4109
- cadence: The cadence to bill for this price on.
4110
-
4111
- currency: An ISO 4217 currency string for which this price is billed in.
4112
-
4113
- item_id: The id of the item the plan will be associated with.
4114
-
4115
- name: The name of the price.
4116
-
4117
- billable_metric_id: The id of the billable metric for the price. Only needed if the price is
4118
- usage-based.
4119
-
4120
- billed_in_advance: If the Price represents a fixed cost, the price will be billed in-advance if
4121
- this is true, and in-arrears if this is false.
4122
-
4123
- billing_cycle_configuration: For custom cadence: specifies the duration of the billing period in days or
4124
- months.
4125
-
4126
- conversion_rate: The per unit conversion rate of the price currency to the invoicing currency.
4127
-
4128
- external_price_id: An alias for the price.
4129
-
4130
- fixed_price_quantity: If the Price represents a fixed cost, this represents the quantity of units
4131
- applied.
4132
-
4133
- invoice_grouping_key: The property used to group this price on an invoice
4134
-
4135
- invoicing_cycle_configuration: Within each billing cycle, specifies the cadence at which invoices are produced.
4136
- If unspecified, a single invoice is produced per billing cycle.
4137
-
4138
- metadata: User-specified key/value pairs for the resource. Individual keys can be removed
4139
- by setting the value to `null`, and the entire metadata mapping can be cleared
4140
- by setting `metadata` to `null`.
4141
-
4142
- extra_headers: Send extra headers
4143
-
4144
- extra_query: Add additional query parameters to the request
4145
-
4146
- extra_body: Add additional JSON properties to the request
4147
-
4148
- timeout: Override the client-level default timeout for this request, in seconds
4149
-
4150
- idempotency_key: Specify a custom idempotency key for this request
4151
- """
4152
- ...
4153
-
4154
3970
@overload
4155
3971
async def create (
4156
3972
self ,
0 commit comments