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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._coupon import Coupon
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Dict, List, cast
from typing_extensions import Literal, NotRequired, TypedDict
class CouponService(StripeService):
class CreateParams(TypedDict):
amount_off: NotRequired[int]
"""
A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
"""
applies_to: NotRequired["CouponService.CreateParamsAppliesTo"]
"""
A hash containing directions for what this Coupon will apply discounts to.
"""
currency: NotRequired[str]
"""
Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
"""
currency_options: NotRequired[
Dict[str, "CouponService.CreateParamsCurrencyOptions"]
]
"""
Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
"""
duration: NotRequired[Literal["forever", "once", "repeating"]]
"""
Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
"""
duration_in_months: NotRequired[int]
"""
Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
id: NotRequired[str]
"""
Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.
"""
max_redemptions: NotRequired[int]
"""
A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.
"""
metadata: NotRequired["Literal['']|Dict[str, str]"]
"""
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
"""
name: NotRequired[str]
"""
Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
"""
percent_off: NotRequired[float]
"""
A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
"""
redeem_by: NotRequired[int]
"""
Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.
"""
class CreateParamsAppliesTo(TypedDict):
products: NotRequired[List[str]]
"""
An array of Product IDs that this Coupon will apply to.
"""
class CreateParamsCurrencyOptions(TypedDict):
amount_off: int
"""
A positive integer representing the amount to subtract from an invoice total.
"""
class DeleteParams(TypedDict):
pass
class ListParams(TypedDict):
created: NotRequired["CouponService.ListParamsCreated|int"]
"""
A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
"""
ending_before: NotRequired[str]
"""
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
limit: NotRequired[int]
"""
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
"""
starting_after: NotRequired[str]
"""
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
"""
class ListParamsCreated(TypedDict):
gt: NotRequired[int]
"""
Minimum value to filter by (exclusive)
"""
gte: NotRequired[int]
"""
Minimum value to filter by (inclusive)
"""
lt: NotRequired[int]
"""
Maximum value to filter by (exclusive)
"""
lte: NotRequired[int]
"""
Maximum value to filter by (inclusive)
"""
class RetrieveParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class UpdateParams(TypedDict):
currency_options: NotRequired[
Dict[str, "CouponService.UpdateParamsCurrencyOptions"]
]
"""
Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
metadata: NotRequired["Literal['']|Dict[str, str]"]
"""
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
"""
name: NotRequired[str]
"""
Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
"""
class UpdateParamsCurrencyOptions(TypedDict):
amount_off: int
"""
A positive integer representing the amount to subtract from an invoice total.
"""
def delete(
self,
coupon: str,
params: "CouponService.DeleteParams" = {},
options: RequestOptions = {},
) -> Coupon:
"""
You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.
"""
return cast(
Coupon,
self._request(
"delete",
"/v1/coupons/{coupon}".format(coupon=sanitize_id(coupon)),
base_address="api",
params=params,
options=options,
),
)
async def delete_async(
self,
coupon: str,
params: "CouponService.DeleteParams" = {},
options: RequestOptions = {},
) -> Coupon:
"""
You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.
"""
return cast(
Coupon,
await self._request_async(
"delete",
"/v1/coupons/{coupon}".format(coupon=sanitize_id(coupon)),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
coupon: str,
params: "CouponService.RetrieveParams" = {},
options: RequestOptions = {},
) -> Coupon:
"""
Retrieves the coupon with the given ID.
"""
return cast(
Coupon,
self._request(
"get",
"/v1/coupons/{coupon}".format(coupon=sanitize_id(coupon)),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
coupon: str,
params: "CouponService.RetrieveParams" = {},
options: RequestOptions = {},
) -> Coupon:
"""
Retrieves the coupon with the given ID.
"""
return cast(
Coupon,
await self._request_async(
"get",
"/v1/coupons/{coupon}".format(coupon=sanitize_id(coupon)),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
coupon: str,
params: "CouponService.UpdateParams" = {},
options: RequestOptions = {},
) -> Coupon:
"""
Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
"""
return cast(
Coupon,
self._request(
"post",
"/v1/coupons/{coupon}".format(coupon=sanitize_id(coupon)),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
coupon: str,
params: "CouponService.UpdateParams" = {},
options: RequestOptions = {},
) -> Coupon:
"""
Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
"""
return cast(
Coupon,
await self._request_async(
"post",
"/v1/coupons/{coupon}".format(coupon=sanitize_id(coupon)),
base_address="api",
params=params,
options=options,
),
)
def list(
self,
params: "CouponService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[Coupon]:
"""
Returns a list of your coupons.
"""
return cast(
ListObject[Coupon],
self._request(
"get",
"/v1/coupons",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: "CouponService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[Coupon]:
"""
Returns a list of your coupons.
"""
return cast(
ListObject[Coupon],
await self._request_async(
"get",
"/v1/coupons",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "CouponService.CreateParams" = {},
options: RequestOptions = {},
) -> Coupon:
"""
You can create coupons easily via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.
A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice's subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.
"""
return cast(
Coupon,
self._request(
"post",
"/v1/coupons",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "CouponService.CreateParams" = {},
options: RequestOptions = {},
) -> Coupon:
"""
You can create coupons easily via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.
A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice's subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.
"""
return cast(
Coupon,
await self._request_async(
"post",
"/v1/coupons",
base_address="api",
params=params,
options=options,
),
)
|
