1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._list_object import ListObject
from stripe._price import Price
from stripe._request_options import RequestOptions
from stripe._search_result_object import SearchResultObject
from stripe.params._price_create_params import PriceCreateParams
from stripe.params._price_list_params import PriceListParams
from stripe.params._price_retrieve_params import PriceRetrieveParams
from stripe.params._price_search_params import PriceSearchParams
from stripe.params._price_update_params import PriceUpdateParams
class PriceService(StripeService):
def list(
self,
params: Optional["PriceListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Price]":
"""
Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
"""
return cast(
"ListObject[Price]",
self._request(
"get",
"/v1/prices",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["PriceListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Price]":
"""
Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
"""
return cast(
"ListObject[Price]",
await self._request_async(
"get",
"/v1/prices",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "PriceCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Price":
"""
Creates a new [Price for an existing <a href="https://docs.stripe.com/api/products">Product](https://docs.stripe.com/api/prices). The Price can be recurring or one-time.
"""
return cast(
"Price",
self._request(
"post",
"/v1/prices",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "PriceCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Price":
"""
Creates a new [Price for an existing <a href="https://docs.stripe.com/api/products">Product](https://docs.stripe.com/api/prices). The Price can be recurring or one-time.
"""
return cast(
"Price",
await self._request_async(
"post",
"/v1/prices",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
price: str,
params: Optional["PriceRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Price":
"""
Retrieves the price with the given ID.
"""
return cast(
"Price",
self._request(
"get",
"/v1/prices/{price}".format(price=sanitize_id(price)),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
price: str,
params: Optional["PriceRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Price":
"""
Retrieves the price with the given ID.
"""
return cast(
"Price",
await self._request_async(
"get",
"/v1/prices/{price}".format(price=sanitize_id(price)),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
price: str,
params: Optional["PriceUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Price":
"""
Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
"""
return cast(
"Price",
self._request(
"post",
"/v1/prices/{price}".format(price=sanitize_id(price)),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
price: str,
params: Optional["PriceUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Price":
"""
Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
"""
return cast(
"Price",
await self._request_async(
"post",
"/v1/prices/{price}".format(price=sanitize_id(price)),
base_address="api",
params=params,
options=options,
),
)
def search(
self,
params: "PriceSearchParams",
options: Optional["RequestOptions"] = None,
) -> "SearchResultObject[Price]":
"""
Search for prices you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
to an hour behind during outages. Search functionality is not available to merchants in India.
"""
return cast(
"SearchResultObject[Price]",
self._request(
"get",
"/v1/prices/search",
base_address="api",
params=params,
options=options,
),
)
async def search_async(
self,
params: "PriceSearchParams",
options: Optional["RequestOptions"] = None,
) -> "SearchResultObject[Price]":
"""
Search for prices you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
to an hour behind during outages. Search functionality is not available to merchants in India.
"""
return cast(
"SearchResultObject[Price]",
await self._request_async(
"get",
"/v1/prices/search",
base_address="api",
params=params,
options=options,
),
)
|
