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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import Dict, List
from typing_extensions import Literal, NotRequired, TypedDict
class PaymentMethodUpdateParams(TypedDict):
allow_redisplay: NotRequired[Literal["always", "limited", "unspecified"]]
"""
This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
"""
billing_details: NotRequired["PaymentMethodUpdateParamsBillingDetails"]
"""
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
"""
card: NotRequired["PaymentMethodUpdateParamsCard"]
"""
If this is a `card` PaymentMethod, this hash contains the user's card details.
"""
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://docs.stripe.com/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`.
"""
payto: NotRequired["PaymentMethodUpdateParamsPayto"]
"""
If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
"""
us_bank_account: NotRequired["PaymentMethodUpdateParamsUsBankAccount"]
"""
If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
"""
class PaymentMethodUpdateParamsBillingDetails(TypedDict):
address: NotRequired[
"Literal['']|PaymentMethodUpdateParamsBillingDetailsAddress"
]
"""
Billing address.
"""
email: NotRequired["Literal['']|str"]
"""
Email address.
"""
name: NotRequired["Literal['']|str"]
"""
Full name.
"""
phone: NotRequired["Literal['']|str"]
"""
Billing phone number (including extension).
"""
tax_id: NotRequired[str]
"""
Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
"""
class PaymentMethodUpdateParamsBillingDetailsAddress(TypedDict):
city: NotRequired[str]
"""
City, district, suburb, town, or village.
"""
country: NotRequired[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: NotRequired[str]
"""
Address line 1, such as the street, PO Box, or company name.
"""
line2: NotRequired[str]
"""
Address line 2, such as the apartment, suite, unit, or building.
"""
postal_code: NotRequired[str]
"""
ZIP or postal code.
"""
state: NotRequired[str]
"""
State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
"""
class PaymentMethodUpdateParamsCard(TypedDict):
exp_month: NotRequired[int]
"""
Two-digit number representing the card's expiration month.
"""
exp_year: NotRequired[int]
"""
Four-digit number representing the card's expiration year.
"""
networks: NotRequired["PaymentMethodUpdateParamsCardNetworks"]
"""
Contains information about card networks used to process the payment.
"""
class PaymentMethodUpdateParamsCardNetworks(TypedDict):
preferred: NotRequired[
"Literal['']|Literal['cartes_bancaires', 'mastercard', 'visa']"
]
"""
The customer's preferred card network for co-branded cards. Supports `cartes_bancaires`, `mastercard`, or `visa`. Selection of a network that does not apply to the card will be stored as `invalid_preference` on the card.
"""
class PaymentMethodUpdateParamsPayto(TypedDict):
account_number: NotRequired[str]
"""
The account number for the bank account.
"""
bsb_number: NotRequired[str]
"""
Bank-State-Branch number of the bank account.
"""
pay_id: NotRequired[str]
"""
The PayID alias for the bank account.
"""
class PaymentMethodUpdateParamsUsBankAccount(TypedDict):
account_holder_type: NotRequired[Literal["company", "individual"]]
"""
Bank account holder type.
"""
account_type: NotRequired[Literal["checking", "savings"]]
"""
Bank account type.
"""
|