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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
from stripe._expandable_field import ExpandableField
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._request_options import RequestOptions
from stripe._stripe_object import StripeObject
from stripe._updateable_api_resource import UpdateableAPIResource
from stripe._util import sanitize_id
from typing import ClassVar, Dict, List, Optional, cast
from typing_extensions import (
Literal,
NotRequired,
TypedDict,
Unpack,
TYPE_CHECKING,
)
if TYPE_CHECKING:
from stripe._coupon import Coupon
from stripe._customer import Customer
class PromotionCode(
CreateableAPIResource["PromotionCode"],
ListableAPIResource["PromotionCode"],
UpdateableAPIResource["PromotionCode"],
):
"""
A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons). It can be used to
create multiple codes for a single coupon.
"""
OBJECT_NAME: ClassVar[Literal["promotion_code"]] = "promotion_code"
class Restrictions(StripeObject):
class CurrencyOptions(StripeObject):
minimum_amount: int
"""
Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
"""
currency_options: Optional[Dict[str, CurrencyOptions]]
"""
Promotion code restrictions defined in each available currency option. 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).
"""
first_time_transaction: bool
"""
A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
"""
minimum_amount: Optional[int]
"""
Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
"""
minimum_amount_currency: Optional[str]
"""
Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount
"""
_inner_class_types = {"currency_options": CurrencyOptions}
_inner_class_dicts = ["currency_options"]
class CreateParams(RequestOptions):
active: NotRequired[bool]
"""
Whether the promotion code is currently active.
"""
code: NotRequired[str]
"""
The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).
If left blank, we will generate one automatically.
"""
coupon: str
"""
The coupon for this promotion code.
"""
customer: NotRequired[str]
"""
The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
expires_at: NotRequired[int]
"""
The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`.
"""
max_redemptions: NotRequired[int]
"""
A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`.
"""
metadata: NotRequired[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`.
"""
restrictions: NotRequired["PromotionCode.CreateParamsRestrictions"]
"""
Settings that restrict the redemption of the promotion code.
"""
class CreateParamsRestrictions(TypedDict):
currency_options: NotRequired[
Dict[str, "PromotionCode.CreateParamsRestrictionsCurrencyOptions"]
]
"""
Promotion codes defined in each available currency option. 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).
"""
first_time_transaction: NotRequired[bool]
"""
A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
"""
minimum_amount: NotRequired[int]
"""
Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
"""
minimum_amount_currency: NotRequired[str]
"""
Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount
"""
class CreateParamsRestrictionsCurrencyOptions(TypedDict):
minimum_amount: NotRequired[int]
"""
Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
"""
class ListParams(RequestOptions):
active: NotRequired[bool]
"""
Filter promotion codes by whether they are active.
"""
code: NotRequired[str]
"""
Only return promotion codes that have this case-insensitive code.
"""
coupon: NotRequired[str]
"""
Only return promotion codes for this coupon.
"""
created: NotRequired["PromotionCode.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.
"""
customer: NotRequired[str]
"""
Only return promotion codes that are restricted to this customer.
"""
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 ModifyParams(RequestOptions):
active: NotRequired[bool]
"""
Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable.
"""
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`.
"""
restrictions: NotRequired["PromotionCode.ModifyParamsRestrictions"]
"""
Settings that restrict the redemption of the promotion code.
"""
class ModifyParamsRestrictions(TypedDict):
currency_options: NotRequired[
Dict[str, "PromotionCode.ModifyParamsRestrictionsCurrencyOptions"]
]
"""
Promotion codes defined in each available currency option. 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).
"""
class ModifyParamsRestrictionsCurrencyOptions(TypedDict):
minimum_amount: NotRequired[int]
"""
Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
"""
class RetrieveParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
active: bool
"""
Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
"""
code: str
"""
The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).
"""
coupon: "Coupon"
"""
A coupon contains information about a percent-off or amount-off discount you
might want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),
[checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).
"""
created: int
"""
Time at which the object was created. Measured in seconds since the Unix epoch.
"""
customer: Optional[ExpandableField["Customer"]]
"""
The customer that this promotion code can be used by.
"""
expires_at: Optional[int]
"""
Date at which the promotion code can no longer be redeemed.
"""
id: str
"""
Unique identifier for the object.
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
max_redemptions: Optional[int]
"""
Maximum number of times this promotion code can be redeemed.
"""
metadata: Optional[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.
"""
object: Literal["promotion_code"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
restrictions: Restrictions
times_redeemed: int
"""
Number of times this promotion code has been used.
"""
@classmethod
def create(
cls, **params: Unpack["PromotionCode.CreateParams"]
) -> "PromotionCode":
"""
A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
"""
return cast(
"PromotionCode",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
async def create_async(
cls, **params: Unpack["PromotionCode.CreateParams"]
) -> "PromotionCode":
"""
A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
"""
return cast(
"PromotionCode",
await cls._static_request_async(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
def list(
cls, **params: Unpack["PromotionCode.ListParams"]
) -> ListObject["PromotionCode"]:
"""
Returns a list of your promotion codes.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
async def list_async(
cls, **params: Unpack["PromotionCode.ListParams"]
) -> ListObject["PromotionCode"]:
"""
Returns a list of your promotion codes.
"""
result = await cls._static_request_async(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
def modify(
cls, id: str, **params: Unpack["PromotionCode.ModifyParams"]
) -> "PromotionCode":
"""
Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"PromotionCode",
cls._static_request(
"post",
url,
params=params,
),
)
@classmethod
async def modify_async(
cls, id: str, **params: Unpack["PromotionCode.ModifyParams"]
) -> "PromotionCode":
"""
Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"PromotionCode",
await cls._static_request_async(
"post",
url,
params=params,
),
)
@classmethod
def retrieve(
cls, id: str, **params: Unpack["PromotionCode.RetrieveParams"]
) -> "PromotionCode":
"""
Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://stripe.com/docs/api/promotion_codes/list) with the desired code.
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["PromotionCode.RetrieveParams"]
) -> "PromotionCode":
"""
Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://stripe.com/docs/api/promotion_codes/list) with the desired code.
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
_inner_class_types = {"restrictions": Restrictions}
|
