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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
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 class_method_variant, sanitize_id
from typing import ClassVar, List, Optional, cast, overload
from typing_extensions import Literal, NotRequired, Unpack
class PaymentMethodDomain(
CreateableAPIResource["PaymentMethodDomain"],
ListableAPIResource["PaymentMethodDomain"],
UpdateableAPIResource["PaymentMethodDomain"],
):
"""
A payment method domain represents a web domain that you have registered with Stripe.
Stripe Elements use registered payment method domains to control where certain payment methods are shown.
Related guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
"""
OBJECT_NAME: ClassVar[Literal["payment_method_domain"]] = (
"payment_method_domain"
)
class AmazonPay(StripeObject):
class StatusDetails(StripeObject):
error_message: str
"""
The error message associated with the status of the payment method on the domain.
"""
status: Literal["active", "inactive"]
"""
The status of the payment method on the domain.
"""
status_details: Optional[StatusDetails]
"""
Contains additional details about the status of a payment method for a specific payment method domain.
"""
_inner_class_types = {"status_details": StatusDetails}
class ApplePay(StripeObject):
class StatusDetails(StripeObject):
error_message: str
"""
The error message associated with the status of the payment method on the domain.
"""
status: Literal["active", "inactive"]
"""
The status of the payment method on the domain.
"""
status_details: Optional[StatusDetails]
"""
Contains additional details about the status of a payment method for a specific payment method domain.
"""
_inner_class_types = {"status_details": StatusDetails}
class GooglePay(StripeObject):
class StatusDetails(StripeObject):
error_message: str
"""
The error message associated with the status of the payment method on the domain.
"""
status: Literal["active", "inactive"]
"""
The status of the payment method on the domain.
"""
status_details: Optional[StatusDetails]
"""
Contains additional details about the status of a payment method for a specific payment method domain.
"""
_inner_class_types = {"status_details": StatusDetails}
class Link(StripeObject):
class StatusDetails(StripeObject):
error_message: str
"""
The error message associated with the status of the payment method on the domain.
"""
status: Literal["active", "inactive"]
"""
The status of the payment method on the domain.
"""
status_details: Optional[StatusDetails]
"""
Contains additional details about the status of a payment method for a specific payment method domain.
"""
_inner_class_types = {"status_details": StatusDetails}
class Paypal(StripeObject):
class StatusDetails(StripeObject):
error_message: str
"""
The error message associated with the status of the payment method on the domain.
"""
status: Literal["active", "inactive"]
"""
The status of the payment method on the domain.
"""
status_details: Optional[StatusDetails]
"""
Contains additional details about the status of a payment method for a specific payment method domain.
"""
_inner_class_types = {"status_details": StatusDetails}
class CreateParams(RequestOptions):
domain_name: str
"""
The domain name that this payment method domain object represents.
"""
enabled: NotRequired[bool]
"""
Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class ListParams(RequestOptions):
domain_name: NotRequired[str]
"""
The domain name that this payment method domain object represents.
"""
enabled: NotRequired[bool]
"""
Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements or Embedded Checkout
"""
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 ModifyParams(RequestOptions):
enabled: NotRequired[bool]
"""
Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class RetrieveParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class ValidateParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
amazon_pay: AmazonPay
"""
Indicates the status of a specific payment method on a payment method domain.
"""
apple_pay: ApplePay
"""
Indicates the status of a specific payment method on a payment method domain.
"""
created: int
"""
Time at which the object was created. Measured in seconds since the Unix epoch.
"""
domain_name: str
"""
The domain name that this payment method domain object represents.
"""
enabled: bool
"""
Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.
"""
google_pay: GooglePay
"""
Indicates the status of a specific payment method on a payment method domain.
"""
id: str
"""
Unique identifier for the object.
"""
link: Link
"""
Indicates the status of a specific payment method on a payment method domain.
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
object: Literal["payment_method_domain"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
paypal: Paypal
"""
Indicates the status of a specific payment method on a payment method domain.
"""
@classmethod
def create(
cls, **params: Unpack["PaymentMethodDomain.CreateParams"]
) -> "PaymentMethodDomain":
"""
Creates a payment method domain.
"""
return cast(
"PaymentMethodDomain",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
async def create_async(
cls, **params: Unpack["PaymentMethodDomain.CreateParams"]
) -> "PaymentMethodDomain":
"""
Creates a payment method domain.
"""
return cast(
"PaymentMethodDomain",
await cls._static_request_async(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
def list(
cls, **params: Unpack["PaymentMethodDomain.ListParams"]
) -> ListObject["PaymentMethodDomain"]:
"""
Lists the details of existing payment method domains.
"""
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["PaymentMethodDomain.ListParams"]
) -> ListObject["PaymentMethodDomain"]:
"""
Lists the details of existing payment method domains.
"""
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["PaymentMethodDomain.ModifyParams"]
) -> "PaymentMethodDomain":
"""
Updates an existing payment method domain.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"PaymentMethodDomain",
cls._static_request(
"post",
url,
params=params,
),
)
@classmethod
async def modify_async(
cls, id: str, **params: Unpack["PaymentMethodDomain.ModifyParams"]
) -> "PaymentMethodDomain":
"""
Updates an existing payment method domain.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"PaymentMethodDomain",
await cls._static_request_async(
"post",
url,
params=params,
),
)
@classmethod
def retrieve(
cls, id: str, **params: Unpack["PaymentMethodDomain.RetrieveParams"]
) -> "PaymentMethodDomain":
"""
Retrieves the details of an existing payment method domain.
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["PaymentMethodDomain.RetrieveParams"]
) -> "PaymentMethodDomain":
"""
Retrieves the details of an existing payment method domain.
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
@classmethod
def _cls_validate(
cls,
payment_method_domain: str,
**params: Unpack["PaymentMethodDomain.ValidateParams"],
) -> "PaymentMethodDomain":
"""
Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
"""
return cast(
"PaymentMethodDomain",
cls._static_request(
"post",
"/v1/payment_method_domains/{payment_method_domain}/validate".format(
payment_method_domain=sanitize_id(payment_method_domain)
),
params=params,
),
)
@overload
@staticmethod
def validate(
payment_method_domain: str,
**params: Unpack["PaymentMethodDomain.ValidateParams"],
) -> "PaymentMethodDomain":
"""
Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
"""
...
@overload
def validate(
self, **params: Unpack["PaymentMethodDomain.ValidateParams"]
) -> "PaymentMethodDomain":
"""
Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
"""
...
@class_method_variant("_cls_validate")
def validate( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["PaymentMethodDomain.ValidateParams"]
) -> "PaymentMethodDomain":
"""
Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
"""
return cast(
"PaymentMethodDomain",
self._request(
"post",
"/v1/payment_method_domains/{payment_method_domain}/validate".format(
payment_method_domain=sanitize_id(self.get("id"))
),
params=params,
),
)
@classmethod
async def _cls_validate_async(
cls,
payment_method_domain: str,
**params: Unpack["PaymentMethodDomain.ValidateParams"],
) -> "PaymentMethodDomain":
"""
Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
"""
return cast(
"PaymentMethodDomain",
await cls._static_request_async(
"post",
"/v1/payment_method_domains/{payment_method_domain}/validate".format(
payment_method_domain=sanitize_id(payment_method_domain)
),
params=params,
),
)
@overload
@staticmethod
async def validate_async(
payment_method_domain: str,
**params: Unpack["PaymentMethodDomain.ValidateParams"],
) -> "PaymentMethodDomain":
"""
Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
"""
...
@overload
async def validate_async(
self, **params: Unpack["PaymentMethodDomain.ValidateParams"]
) -> "PaymentMethodDomain":
"""
Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
"""
...
@class_method_variant("_cls_validate_async")
async def validate_async( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["PaymentMethodDomain.ValidateParams"]
) -> "PaymentMethodDomain":
"""
Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
"""
return cast(
"PaymentMethodDomain",
await self._request_async(
"post",
"/v1/payment_method_domains/{payment_method_domain}/validate".format(
payment_method_domain=sanitize_id(self.get("id"))
),
params=params,
),
)
_inner_class_types = {
"amazon_pay": AmazonPay,
"apple_pay": ApplePay,
"google_pay": GooglePay,
"link": Link,
"paypal": Paypal,
}
|
