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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
|
# -*- 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._request_options import RequestOptions
from stripe._subscription_schedule import SubscriptionSchedule
from stripe.params._subscription_schedule_cancel_params import (
SubscriptionScheduleCancelParams,
)
from stripe.params._subscription_schedule_create_params import (
SubscriptionScheduleCreateParams,
)
from stripe.params._subscription_schedule_list_params import (
SubscriptionScheduleListParams,
)
from stripe.params._subscription_schedule_release_params import (
SubscriptionScheduleReleaseParams,
)
from stripe.params._subscription_schedule_retrieve_params import (
SubscriptionScheduleRetrieveParams,
)
from stripe.params._subscription_schedule_update_params import (
SubscriptionScheduleUpdateParams,
)
class SubscriptionScheduleService(StripeService):
def list(
self,
params: Optional["SubscriptionScheduleListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[SubscriptionSchedule]":
"""
Retrieves the list of your subscription schedules.
"""
return cast(
"ListObject[SubscriptionSchedule]",
self._request(
"get",
"/v1/subscription_schedules",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["SubscriptionScheduleListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[SubscriptionSchedule]":
"""
Retrieves the list of your subscription schedules.
"""
return cast(
"ListObject[SubscriptionSchedule]",
await self._request_async(
"get",
"/v1/subscription_schedules",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: Optional["SubscriptionScheduleCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SubscriptionSchedule":
"""
Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.
"""
return cast(
"SubscriptionSchedule",
self._request(
"post",
"/v1/subscription_schedules",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: Optional["SubscriptionScheduleCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SubscriptionSchedule":
"""
Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.
"""
return cast(
"SubscriptionSchedule",
await self._request_async(
"post",
"/v1/subscription_schedules",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
schedule: str,
params: Optional["SubscriptionScheduleRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SubscriptionSchedule":
"""
Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.
"""
return cast(
"SubscriptionSchedule",
self._request(
"get",
"/v1/subscription_schedules/{schedule}".format(
schedule=sanitize_id(schedule),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
schedule: str,
params: Optional["SubscriptionScheduleRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SubscriptionSchedule":
"""
Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.
"""
return cast(
"SubscriptionSchedule",
await self._request_async(
"get",
"/v1/subscription_schedules/{schedule}".format(
schedule=sanitize_id(schedule),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
schedule: str,
params: Optional["SubscriptionScheduleUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SubscriptionSchedule":
"""
Updates an existing subscription schedule.
"""
return cast(
"SubscriptionSchedule",
self._request(
"post",
"/v1/subscription_schedules/{schedule}".format(
schedule=sanitize_id(schedule),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
schedule: str,
params: Optional["SubscriptionScheduleUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SubscriptionSchedule":
"""
Updates an existing subscription schedule.
"""
return cast(
"SubscriptionSchedule",
await self._request_async(
"post",
"/v1/subscription_schedules/{schedule}".format(
schedule=sanitize_id(schedule),
),
base_address="api",
params=params,
options=options,
),
)
def cancel(
self,
schedule: str,
params: Optional["SubscriptionScheduleCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SubscriptionSchedule":
"""
Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
"""
return cast(
"SubscriptionSchedule",
self._request(
"post",
"/v1/subscription_schedules/{schedule}/cancel".format(
schedule=sanitize_id(schedule),
),
base_address="api",
params=params,
options=options,
),
)
async def cancel_async(
self,
schedule: str,
params: Optional["SubscriptionScheduleCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SubscriptionSchedule":
"""
Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
"""
return cast(
"SubscriptionSchedule",
await self._request_async(
"post",
"/v1/subscription_schedules/{schedule}/cancel".format(
schedule=sanitize_id(schedule),
),
base_address="api",
params=params,
options=options,
),
)
def release(
self,
schedule: str,
params: Optional["SubscriptionScheduleReleaseParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SubscriptionSchedule":
"""
Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
"""
return cast(
"SubscriptionSchedule",
self._request(
"post",
"/v1/subscription_schedules/{schedule}/release".format(
schedule=sanitize_id(schedule),
),
base_address="api",
params=params,
options=options,
),
)
async def release_async(
self,
schedule: str,
params: Optional["SubscriptionScheduleReleaseParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SubscriptionSchedule":
"""
Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
"""
return cast(
"SubscriptionSchedule",
await self._request_async(
"post",
"/v1/subscription_schedules/{schedule}/release".format(
schedule=sanitize_id(schedule),
),
base_address="api",
params=params,
options=options,
),
)
|
