From b81c60a936d0352263d54e49bd8752ee77d9c78e Mon Sep 17 00:00:00 2001 From: Ramya Rao Date: Thu, 28 Mar 2024 13:01:32 -0700 Subject: [PATCH] Fix unneccessary quotes --- stripe/_account.py | 782 +++--- stripe/_account_capability_service.py | 8 +- stripe/_account_external_account_service.py | 76 +- stripe/_account_link.py | 10 +- stripe/_account_link_service.py | 10 +- stripe/_account_login_link_service.py | 2 +- stripe/_account_notice.py | 16 +- stripe/_account_notice_service.py | 16 +- stripe/_account_person_service.py | 252 +- stripe/_account_service.py | 828 +++--- stripe/_account_session.py | 20 +- stripe/_account_session_service.py | 20 +- stripe/_apple_pay_domain.py | 14 +- stripe/_apple_pay_domain_service.py | 14 +- stripe/_application_fee.py | 44 +- stripe/_application_fee_refund_service.py | 18 +- stripe/_application_fee_service.py | 20 +- stripe/_balance.py | 2 +- stripe/_balance_service.py | 2 +- stripe/_balance_transaction.py | 26 +- stripe/_balance_transaction_service.py | 26 +- stripe/_charge.py | 528 ++-- stripe/_charge_service.py | 514 ++-- stripe/_confirmation_token.py | 139 +- stripe/_confirmation_token_service.py | 2 +- stripe/_country_spec.py | 10 +- stripe/_country_spec_service.py | 10 +- stripe/_coupon.py | 48 +- stripe/_coupon_service.py | 48 +- stripe/_credit_note.py | 179 +- stripe/_credit_note_line_item_service.py | 8 +- stripe/_credit_note_preview_lines_service.py | 51 +- stripe/_credit_note_service.py | 120 +- stripe/_customer.py | 322 +-- .../_customer_balance_transaction_service.py | 18 +- stripe/_customer_cash_balance_service.py | 6 +- ...stomer_cash_balance_transaction_service.py | 10 +- .../_customer_funding_instructions_service.py | 4 +- stripe/_customer_payment_method_service.py | 50 +- stripe/_customer_payment_source_service.py | 66 +- stripe/_customer_service.py | 156 +- stripe/_customer_session.py | 10 +- stripe/_customer_session_service.py | 10 +- stripe/_customer_tax_id_service.py | 12 +- stripe/_dispute.py | 88 +- stripe/_dispute_service.py | 88 +- stripe/_ephemeral_key.py | 2 +- stripe/_ephemeral_key_service.py | 12 +- stripe/_event.py | 24 +- stripe/_event_service.py | 24 +- stripe/_exchange_rate.py | 10 +- stripe/_exchange_rate_service.py | 10 +- stripe/_file.py | 40 +- stripe/_file_link.py | 28 +- stripe/_file_link_service.py | 28 +- stripe/_file_service.py | 40 +- stripe/_invoice.py | 1540 +++++------ stripe/_invoice_item.py | 94 +- stripe/_invoice_item_service.py | 94 +- stripe/_invoice_line_item.py | 58 +- stripe/_invoice_line_item_service.py | 66 +- stripe/_invoice_payment_service.py | 10 +- stripe/_invoice_service.py | 1152 +++++---- stripe/_invoice_upcoming_lines_service.py | 386 +-- stripe/_mandate.py | 2 +- stripe/_mandate_service.py | 2 +- stripe/_margin.py | 28 +- stripe/_margin_service.py | 28 +- stripe/_order.py | 540 ++-- stripe/_order_line_item_service.py | 8 +- stripe/_order_service.py | 532 ++-- stripe/_payment_intent.py | 2234 ++++++++++------ stripe/_payment_intent_service.py | 2258 +++++++++++------ stripe/_payment_link.py | 180 +- stripe/_payment_link_line_item_service.py | 8 +- stripe/_payment_link_service.py | 172 +- stripe/_payment_method.py | 259 +- stripe/_payment_method_configuration.py | 160 +- .../_payment_method_configuration_service.py | 160 +- stripe/_payment_method_domain.py | 24 +- stripe/_payment_method_domain_service.py | 24 +- stripe/_payment_method_service.py | 259 +- stripe/_payout.py | 52 +- stripe/_payout_service.py | 52 +- stripe/_plan.py | 80 +- stripe/_plan_service.py | 80 +- stripe/_price.py | 162 +- stripe/_price_service.py | 162 +- stripe/_product.py | 118 +- stripe/_product_feature_service.py | 10 +- stripe/_product_service.py | 113 +- stripe/_promotion_code.py | 58 +- stripe/_promotion_code_service.py | 64 +- stripe/_quote.py | 550 ++-- ...ote_computed_upfront_line_items_service.py | 8 +- stripe/_quote_line_item_service.py | 8 +- stripe/_quote_line_service.py | 8 +- stripe/_quote_phase.py | 18 +- stripe/_quote_phase_line_item_service.py | 8 +- stripe/_quote_phase_service.py | 10 +- stripe/_quote_preview_invoice_service.py | 8 +- ...e_preview_subscription_schedule_service.py | 8 +- stripe/_quote_service.py | 510 ++-- stripe/_refund.py | 50 +- stripe/_refund_service.py | 48 +- stripe/_review.py | 20 +- stripe/_review_service.py | 20 +- stripe/_setup_attempt.py | 16 +- stripe/_setup_attempt_service.py | 16 +- stripe/_setup_intent.py | 807 ++++-- stripe/_setup_intent_service.py | 807 ++++-- stripe/_shipping_rate.py | 48 +- stripe/_shipping_rate_service.py | 54 +- stripe/_source.py | 186 +- stripe/_source_service.py | 180 +- stripe/_source_transaction_service.py | 8 +- stripe/_subscription.py | 407 +-- stripe/_subscription_item.py | 104 +- stripe/_subscription_item_service.py | 92 +- ..._subscription_item_usage_record_service.py | 4 +- ...ption_item_usage_record_summary_service.py | 8 +- stripe/_subscription_schedule.py | 424 ++-- stripe/_subscription_schedule_service.py | 428 ++-- stripe/_subscription_service.py | 407 +-- stripe/_tax_code.py | 10 +- stripe/_tax_code_service.py | 10 +- stripe/_tax_id.py | 20 +- stripe/_tax_id_service.py | 20 +- stripe/_tax_rate.py | 82 +- stripe/_tax_rate_service.py | 82 +- stripe/_token.py | 330 +-- stripe/_token_service.py | 330 +-- stripe/_topup.py | 44 +- stripe/_topup_service.py | 44 +- stripe/_transfer.py | 60 +- stripe/_transfer_reversal_service.py | 20 +- stripe/_transfer_service.py | 40 +- stripe/_webhook_endpoint.py | 393 ++- stripe/_webhook_endpoint_service.py | 393 ++- stripe/apps/_secret.py | 24 +- stripe/apps/_secret_service.py | 24 +- stripe/billing/_meter.py | 34 +- stripe/billing/_meter_event.py | 4 +- stripe/billing/_meter_event_adjustment.py | 4 +- .../_meter_event_adjustment_service.py | 4 +- stripe/billing/_meter_event_service.py | 4 +- .../billing/_meter_event_summary_service.py | 10 +- stripe/billing/_meter_service.py | 24 +- stripe/billing_portal/_configuration.py | 48 +- .../billing_portal/_configuration_service.py | 48 +- stripe/billing_portal/_session.py | 72 +- stripe/billing_portal/_session_service.py | 72 +- stripe/capital/_financing_offer.py | 35 +- stripe/capital/_financing_offer_service.py | 35 +- stripe/capital/_financing_summary.py | 2 +- stripe/capital/_financing_summary_service.py | 2 +- stripe/capital/_financing_transaction.py | 18 +- .../capital/_financing_transaction_service.py | 18 +- stripe/checkout/_session.py | 465 ++-- stripe/checkout/_session_line_item_service.py | 8 +- stripe/checkout/_session_service.py | 457 ++-- stripe/climate/_order.py | 26 +- stripe/climate/_order_service.py | 26 +- stripe/climate/_product.py | 10 +- stripe/climate/_product_service.py | 10 +- stripe/climate/_supplier.py | 10 +- stripe/climate/_supplier_service.py | 10 +- stripe/entitlements/_active_entitlement.py | 8 +- .../_active_entitlement_service.py | 8 +- stripe/entitlements/_feature.py | 12 +- stripe/entitlements/_feature_service.py | 12 +- stripe/financial_connections/_account.py | 40 +- .../_account_inferred_balance_service.py | 8 +- .../_account_owner_service.py | 8 +- .../financial_connections/_account_service.py | 24 +- stripe/financial_connections/_session.py | 21 +- .../financial_connections/_session_service.py | 21 +- stripe/financial_connections/_transaction.py | 18 +- .../_transaction_service.py | 18 +- stripe/forwarding/_request.py | 24 +- stripe/forwarding/_request_service.py | 24 +- stripe/gift_cards/_card.py | 26 +- stripe/gift_cards/_card_service.py | 26 +- stripe/gift_cards/_transaction.py | 32 +- stripe/gift_cards/_transaction_service.py | 32 +- stripe/identity/_verification_report.py | 24 +- .../identity/_verification_report_service.py | 24 +- stripe/identity/_verification_session.py | 56 +- .../identity/_verification_session_service.py | 56 +- stripe/issuing/_authorization.py | 441 +++- stripe/issuing/_authorization_service.py | 32 +- stripe/issuing/_card.py | 1900 +++++++++++++- stripe/issuing/_card_service.py | 1892 +++++++++++++- stripe/issuing/_cardholder.py | 1896 +++++++++++++- stripe/issuing/_cardholder_service.py | 1896 +++++++++++++- stripe/issuing/_credit_underwriting_record.py | 54 +- .../_credit_underwriting_record_service.py | 54 +- stripe/issuing/_dispute.py | 60 +- stripe/issuing/_dispute_service.py | 60 +- stripe/issuing/_personalization_design.py | 69 +- .../_personalization_design_service.py | 38 +- stripe/issuing/_physical_bundle.py | 14 +- stripe/issuing/_physical_bundle_service.py | 14 +- stripe/issuing/_token.py | 22 +- stripe/issuing/_token_service.py | 22 +- stripe/issuing/_transaction.py | 774 +++++- stripe/issuing/_transaction_service.py | 26 +- stripe/radar/_early_fraud_warning.py | 22 +- stripe/radar/_early_fraud_warning_service.py | 22 +- stripe/radar/_value_list.py | 47 +- stripe/radar/_value_list_item.py | 22 +- stripe/radar/_value_list_item_service.py | 22 +- stripe/radar/_value_list_service.py | 47 +- stripe/reporting/_report_run.py | 674 ++++- stripe/reporting/_report_run_service.py | 674 ++++- stripe/reporting/_report_type.py | 4 +- stripe/reporting/_report_type_service.py | 4 +- stripe/sigma/_scheduled_query_run.py | 10 +- stripe/sigma/_scheduled_query_run_service.py | 10 +- stripe/tax/_calculation.py | 40 +- stripe/tax/_calculation_line_item_service.py | 8 +- stripe/tax/_calculation_service.py | 32 +- stripe/tax/_form.py | 20 +- stripe/tax/_form_service.py | 20 +- stripe/tax/_registration.py | 18 +- stripe/tax/_registration_service.py | 18 +- stripe/tax/_settings.py | 20 +- stripe/tax/_settings_service.py | 20 +- stripe/tax/_transaction.py | 26 +- stripe/tax/_transaction_line_item_service.py | 8 +- stripe/tax/_transaction_service.py | 18 +- stripe/terminal/_configuration.py | 188 +- stripe/terminal/_configuration_service.py | 188 +- stripe/terminal/_connection_token.py | 4 +- stripe/terminal/_connection_token_service.py | 4 +- stripe/terminal/_location.py | 40 +- stripe/terminal/_location_service.py | 40 +- stripe/terminal/_reader.py | 101 +- stripe/terminal/_reader_service.py | 91 +- .../_confirmation_token_service.py | 137 +- stripe/test_helpers/_customer_service.py | 4 +- stripe/test_helpers/_refund_service.py | 2 +- stripe/test_helpers/_test_clock.py | 16 +- stripe/test_helpers/_test_clock_service.py | 16 +- .../issuing/_authorization_service.py | 411 ++- stripe/test_helpers/issuing/_card_service.py | 8 +- .../_personalization_design_service.py | 31 +- .../issuing/_transaction_service.py | 750 +++++- .../test_helpers/terminal/_reader_service.py | 10 +- .../treasury/_inbound_transfer_service.py | 22 +- .../treasury/_outbound_payment_service.py | 19 +- .../treasury/_outbound_transfer_service.py | 19 +- .../treasury/_received_credit_service.py | 12 +- .../treasury/_received_debit_service.py | 12 +- stripe/treasury/_credit_reversal.py | 18 +- stripe/treasury/_credit_reversal_service.py | 18 +- stripe/treasury/_debit_reversal.py | 20 +- stripe/treasury/_debit_reversal_service.py | 20 +- stripe/treasury/_financial_account.py | 38 +- .../_financial_account_features_service.py | 8 +- stripe/treasury/_financial_account_service.py | 34 +- stripe/treasury/_inbound_transfer.py | 49 +- stripe/treasury/_inbound_transfer_service.py | 22 +- stripe/treasury/_outbound_payment.py | 90 +- stripe/treasury/_outbound_payment_service.py | 66 +- stripe/treasury/_outbound_transfer.py | 52 +- stripe/treasury/_outbound_transfer_service.py | 28 +- stripe/treasury/_received_credit.py | 24 +- stripe/treasury/_received_credit_service.py | 12 +- stripe/treasury/_received_debit.py | 24 +- stripe/treasury/_received_debit_service.py | 12 +- stripe/treasury/_transaction.py | 30 +- stripe/treasury/_transaction_entry.py | 30 +- stripe/treasury/_transaction_entry_service.py | 30 +- stripe/treasury/_transaction_service.py | 30 +- 275 files changed, 27185 insertions(+), 11989 deletions(-) diff --git a/stripe/_account.py b/stripe/_account.py index 5ea98b2e7..fee27e654 100644 --- a/stripe/_account.py +++ b/stripe/_account.py @@ -1109,11 +1109,11 @@ class TosAcceptance(StripeObject): """ class CreateExternalAccountParams(RequestOptions): - default_for_currency: NotRequired["bool"] + default_for_currency: NotRequired[bool] """ When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1126,18 +1126,18 @@ class CreateExternalAccountParams(RequestOptions): """ Please refer to full [documentation](https://stripe.com/docs/api) instead. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ class CreateExternalAccountParamsBankAccount(TypedDict): object: Literal["bank_account"] - account_holder_name: NotRequired["str"] + account_holder_name: NotRequired[str] """ The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object. """ - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object. """ @@ -1149,47 +1149,47 @@ class CreateExternalAccountParamsBankAccount(TypedDict): """ The country in which the bank account is located. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts) """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ The routing number, sort code, or other country-appropriateinstitution number for the bank account. For US bank accounts, this is required and should bethe ACH routing number, not the wire routing number. If you are providing an IBAN for`account_number`, this field is not required. """ class CreateExternalAccountParamsCard(TypedDict): object: Literal["card"] - address_city: NotRequired["str"] - address_country: NotRequired["str"] - address_line1: NotRequired["str"] - address_line2: NotRequired["str"] - address_state: NotRequired["str"] - address_zip: NotRequired["str"] - currency: NotRequired["str"] - cvc: NotRequired["str"] + address_city: NotRequired[str] + address_country: NotRequired[str] + address_line1: NotRequired[str] + address_line2: NotRequired[str] + address_state: NotRequired[str] + address_zip: NotRequired[str] + currency: NotRequired[str] + cvc: NotRequired[str] exp_month: int exp_year: int - name: NotRequired["str"] + name: NotRequired[str] number: str - metadata: NotRequired["Dict[str, str]"] + 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. """ class CreateExternalAccountParamsCardToken(TypedDict): object: Literal["card"] - currency: NotRequired["str"] + currency: NotRequired[str] token: str class CreateLoginLinkParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CreateParams(RequestOptions): - account_token: NotRequired["str"] + account_token: NotRequired[str] """ An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. """ @@ -1198,7 +1198,7 @@ class CreateParams(RequestOptions): Business information about the account. """ business_type: NotRequired[ - "Literal['company', 'government_entity', 'individual', 'non_profit']" + Literal["company", "government_entity", "individual", "non_profit"] ] """ The business type. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts. @@ -1215,11 +1215,11 @@ class CreateParams(RequestOptions): """ The configuration of the account when `type` is not provided. """ - country: NotRequired["str"] + country: NotRequired[str] """ The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported. """ - default_currency: NotRequired["str"] + default_currency: NotRequired[str] """ Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). """ @@ -1227,11 +1227,11 @@ class CreateParams(RequestOptions): """ Documents that may be submitted to satisfy various informational requests. """ - email: NotRequired["str"] + email: NotRequired[str] """ The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1259,18 +1259,18 @@ class CreateParams(RequestOptions): """ Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance) This property can only be updated for Custom accounts. """ - type: NotRequired["Literal['custom', 'express', 'standard']"] + type: NotRequired[Literal["custom", "express", "standard"]] """ The type of Stripe account to create. May be one of `custom`, `express` or `standard`. """ class CreateParamsBankAccount(TypedDict): object: Literal["bank_account"] - account_holder_name: NotRequired["str"] + account_holder_name: NotRequired[str] """ The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object. """ - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object. """ @@ -1282,11 +1282,11 @@ class CreateParamsBankAccount(TypedDict): """ The country in which the bank account is located. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts) """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ The routing number, sort code, or other country-appropriateinstitution number for the bank account. For US bank accounts, this is required and should bethe ACH routing number, not the wire routing number. If you are providing an IBAN for`account_number`, this field is not required. """ @@ -1298,11 +1298,11 @@ class CreateParamsBusinessProfile(TypedDict): """ The applicant's gross annual revenue for its preceding fiscal year. """ - estimated_worker_count: NotRequired["int"] + estimated_worker_count: NotRequired[int] """ An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. """ - mcc: NotRequired["str"] + mcc: NotRequired[str] """ [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. """ @@ -1312,11 +1312,11 @@ class CreateParamsBusinessProfile(TypedDict): """ An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India. """ - name: NotRequired["str"] + name: NotRequired[str] """ The customer-facing business name. """ - product_description: NotRequired["str"] + product_description: NotRequired[str] """ Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes. """ @@ -1326,11 +1326,11 @@ class CreateParamsBusinessProfile(TypedDict): """ A publicly available mailing address for sending support issues to. """ - support_email: NotRequired["str"] + support_email: NotRequired[str] """ A publicly available email address for sending support issues to. """ - support_phone: NotRequired["str"] + support_phone: NotRequired[str] """ A publicly available phone number to call with support issues. """ @@ -1338,7 +1338,7 @@ class CreateParamsBusinessProfile(TypedDict): """ A publicly available website for handling support issues. """ - url: NotRequired["str"] + url: NotRequired[str] """ The business's publicly available website. """ @@ -1368,27 +1368,27 @@ class CreateParamsBusinessProfileMonthlyEstimatedRevenue(TypedDict): """ class CreateParamsBusinessProfileSupportAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1644,280 +1644,280 @@ class CreateParamsCapabilities(TypedDict): """ class CreateParamsCapabilitiesAcssDebitPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesAffirmPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesAfterpayClearpayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesAuBecsDebitPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesBacsDebitPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesBancontactPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesBankTransferPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesBlikPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesBoletoPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesCardIssuing(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesCardPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesCartesBancairesPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesCashappPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesEpsPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesFpxPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesGiropayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesGrabpayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesIdealPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesIndiaInternationalPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesJcbPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesKlarnaPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesKonbiniPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesLegacyPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesLinkPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesMobilepayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesOxxoPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesP24Payments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesPaynowPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesPaypalPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesPaytoPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesPromptpayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesRevolutPayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesSepaDebitPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesSofortPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesSwishPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesTaxReportingUs1099K(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesTaxReportingUs1099Misc(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesTransfers(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesTreasury(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesTwintPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesUsBankAccountAchPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesZipPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCard(TypedDict): object: Literal["card"] - address_city: NotRequired["str"] - address_country: NotRequired["str"] - address_line1: NotRequired["str"] - address_line2: NotRequired["str"] - address_state: NotRequired["str"] - address_zip: NotRequired["str"] - currency: NotRequired["str"] - cvc: NotRequired["str"] + address_city: NotRequired[str] + address_country: NotRequired[str] + address_line1: NotRequired[str] + address_line2: NotRequired[str] + address_state: NotRequired[str] + address_zip: NotRequired[str] + currency: NotRequired[str] + cvc: NotRequired[str] exp_month: int exp_year: int - name: NotRequired["str"] + name: NotRequired[str] number: str - metadata: NotRequired["Dict[str, str]"] + 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. """ - default_for_currency: NotRequired["bool"] + default_for_currency: NotRequired[bool] class CreateParamsCardToken(TypedDict): object: Literal["card"] - currency: NotRequired["str"] + currency: NotRequired[str] token: str class CreateParamsCompany(TypedDict): @@ -1933,35 +1933,35 @@ class CreateParamsCompany(TypedDict): """ The Kanji variation of the company's primary address (Japan only). """ - directors_provided: NotRequired["bool"] + directors_provided: NotRequired[bool] """ Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided. """ - executives_provided: NotRequired["bool"] + executives_provided: NotRequired[bool] """ Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` requirement. """ - export_license_id: NotRequired["str"] + export_license_id: NotRequired[str] """ The export license ID number of the company, also referred as Import Export Code (India only). """ - export_purpose_code: NotRequired["str"] + export_purpose_code: NotRequired[str] """ The purpose code to use for export transactions (India only). """ - name: NotRequired["str"] + name: NotRequired[str] """ The company's legal name. """ - name_kana: NotRequired["str"] + name_kana: NotRequired[str] """ The Kana variation of the company's legal name (Japan only). """ - name_kanji: NotRequired["str"] + name_kanji: NotRequired[str] """ The Kanji variation of the company's legal name (Japan only). """ - owners_provided: NotRequired["bool"] + owners_provided: NotRequired[bool] """ Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.owner` requirement. """ @@ -1971,11 +1971,11 @@ class CreateParamsCompany(TypedDict): """ This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The company's phone number (used for verification). """ - registration_number: NotRequired["str"] + registration_number: NotRequired[str] """ The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong). """ @@ -1985,15 +1985,15 @@ class CreateParamsCompany(TypedDict): """ The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value. """ - tax_id: NotRequired["str"] + tax_id: NotRequired[str] """ The business ID number of the company, as appropriate for the company's country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.) """ - tax_id_registrar: NotRequired["str"] + tax_id_registrar: NotRequired[str] """ The jurisdiction in which the `tax_id` is registered (Germany-based companies only). """ - vat_id: NotRequired["str"] + vat_id: NotRequired[str] """ The VAT number of the company. """ @@ -2003,101 +2003,101 @@ class CreateParamsCompany(TypedDict): """ class CreateParamsCompanyAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsCompanyAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreateParamsCompanyAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreateParamsCompanyOwnershipDeclaration(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the beneficial owner attestation was made. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the beneficial owner attestation was made. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the beneficial owner attestation was made. """ @@ -2111,11 +2111,11 @@ class CreateParamsCompanyVerification(TypedDict): """ class CreateParamsCompanyVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ @@ -2135,17 +2135,17 @@ class CreateParamsControllerApplication(TypedDict): """ Whether the controller is liable for losses on this account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances). """ - onboarding_owner: NotRequired["bool"] + onboarding_owner: NotRequired[bool] """ Whether the controller owns onboarding for this account. """ - pricing_controls: NotRequired["bool"] + pricing_controls: NotRequired[bool] """ Whether the controller has pricing controls for this account. """ class CreateParamsControllerDashboard(TypedDict): - type: NotRequired["Literal['express', 'full', 'none']"] + type: NotRequired[Literal["express", "full", "none"]] """ Whether this account should have access to the full Stripe Dashboard (`full`), to the Express Dashboard (`express`), or to no dashboard (`none`). Defaults to `full`. """ @@ -2195,43 +2195,43 @@ class CreateParamsDocuments(TypedDict): """ class CreateParamsDocumentsBankAccountOwnershipVerification(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsDocumentsCompanyLicense(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsDocumentsCompanyMemorandumOfAssociation(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsDocumentsCompanyMinisterialDecree(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsDocumentsCompanyRegistrationVerification(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsDocumentsCompanyTaxIdVerification(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsDocumentsProofOfRegistration(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ @@ -2255,19 +2255,19 @@ class CreateParamsIndividual(TypedDict): """ The individual's date of birth. """ - email: NotRequired["str"] + email: NotRequired[str] """ The individual's email address. """ - first_name: NotRequired["str"] + first_name: NotRequired[str] """ The individual's first name. """ - first_name_kana: NotRequired["str"] + first_name_kana: NotRequired[str] """ The Kana variation of the the individual's first name (Japan only). """ - first_name_kanji: NotRequired["str"] + first_name_kanji: NotRequired[str] """ The Kanji variation of the individual's first name (Japan only). """ @@ -2275,31 +2275,31 @@ class CreateParamsIndividual(TypedDict): """ A list of alternate names or aliases that the individual is known by. """ - gender: NotRequired["str"] + gender: NotRequired[str] """ The individual's gender (International regulations require either "male" or "female"). """ - id_number: NotRequired["str"] + id_number: NotRequired[str] """ The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - id_number_secondary: NotRequired["str"] + id_number_secondary: NotRequired[str] """ The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - last_name: NotRequired["str"] + last_name: NotRequired[str] """ The individual's last name. """ - last_name_kana: NotRequired["str"] + last_name_kana: NotRequired[str] """ The Kana variation of the individual's last name (Japan only). """ - last_name_kanji: NotRequired["str"] + last_name_kanji: NotRequired[str] """ The Kanji variation of the individual's last name (Japan only). """ - maiden_name: NotRequired["str"] + maiden_name: NotRequired[str] """ The individual's maiden name. """ @@ -2307,11 +2307,11 @@ class CreateParamsIndividual(TypedDict): """ 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`. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The individual's phone number. """ - political_exposure: NotRequired["Literal['existing', 'none']"] + political_exposure: NotRequired[Literal["existing", "none"]] """ Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. """ @@ -2325,7 +2325,7 @@ class CreateParamsIndividual(TypedDict): """ Describes the person's relationship to the account. """ - ssn_last_4: NotRequired["str"] + ssn_last_4: NotRequired[str] """ The last four digits of the individual's Social Security Number (U.S. only). """ @@ -2335,87 +2335,87 @@ class CreateParamsIndividual(TypedDict): """ class CreateParamsIndividualAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsIndividualAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreateParamsIndividualAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ @@ -2435,41 +2435,41 @@ class CreateParamsIndividualDob(TypedDict): """ class CreateParamsIndividualRegisteredAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsIndividualRelationship(TypedDict): - director: NotRequired["bool"] + director: NotRequired[bool] """ Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. """ - executive: NotRequired["bool"] + executive: NotRequired[bool] """ Whether the person has significant responsibility to control, manage, or direct the organization. """ - owner: NotRequired["bool"] + owner: NotRequired[bool] """ Whether the person is an owner of the account's legal entity. """ @@ -2477,7 +2477,7 @@ class CreateParamsIndividualRelationship(TypedDict): """ The percent owned by the person of the account's legal entity. """ - title: NotRequired["str"] + title: NotRequired[str] """ The person's title (e.g., CEO, Support Engineer). """ @@ -2497,21 +2497,21 @@ class CreateParamsIndividualVerification(TypedDict): """ class CreateParamsIndividualVerificationAdditionalDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class CreateParamsIndividualVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ @@ -2553,25 +2553,25 @@ class CreateParamsSettings(TypedDict): """ class CreateParamsSettingsBacsDebitPayments(TypedDict): - display_name: NotRequired["str"] + display_name: NotRequired[str] """ The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free. """ class CreateParamsSettingsBranding(TypedDict): - icon: NotRequired["str"] + icon: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px. """ - logo: NotRequired["str"] + logo: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px. """ - primary_color: NotRequired["str"] + primary_color: NotRequired[str] """ A CSS hex color value representing the primary branding color for this account. """ - secondary_color: NotRequired["str"] + secondary_color: NotRequired[str] """ A CSS hex color value representing the secondary branding color for this account. """ @@ -2585,11 +2585,11 @@ class CreateParamsSettingsCardIssuing(TypedDict): """ class CreateParamsSettingsCardIssuingTosAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the account representative accepted the service agreement. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the account representative accepted the service agreement. """ @@ -2605,7 +2605,7 @@ class CreateParamsSettingsCardPayments(TypedDict): """ Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge. """ - statement_descriptor_prefix: NotRequired["str"] + statement_descriptor_prefix: NotRequired[str] """ The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion. """ @@ -2619,31 +2619,31 @@ class CreateParamsSettingsCardPayments(TypedDict): """ class CreateParamsSettingsCardPaymentsDeclineOn(TypedDict): - avs_failure: NotRequired["bool"] + avs_failure: NotRequired[bool] """ Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification. """ - cvc_failure: NotRequired["bool"] + cvc_failure: NotRequired[bool] """ Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification. """ class CreateParamsSettingsPayments(TypedDict): - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. """ - statement_descriptor_kana: NotRequired["str"] + statement_descriptor_kana: NotRequired[str] """ The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). """ - statement_descriptor_kanji: NotRequired["str"] + statement_descriptor_kanji: NotRequired[str] """ The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). """ class CreateParamsSettingsPayouts(TypedDict): - debit_negative_balances: NotRequired["bool"] + debit_negative_balances: NotRequired[bool] """ A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances). """ @@ -2651,7 +2651,7 @@ class CreateParamsSettingsPayouts(TypedDict): """ Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. """ @@ -2661,25 +2661,31 @@ class CreateParamsSettingsPayoutsSchedule(TypedDict): """ The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://stripe.com/docs/connect/manage-payout-schedule). """ - interval: NotRequired[ - "Literal['daily', 'manual', 'monthly', 'weekly']" - ] + interval: NotRequired[Literal["daily", "manual", "monthly", "weekly"]] """ How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`. """ - monthly_anchor: NotRequired["int"] + monthly_anchor: NotRequired[int] """ The day of the month when available funds are paid out, specified as a number between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`. """ weekly_anchor: NotRequired[ - "Literal['friday', 'monday', 'saturday', 'sunday', 'thursday', 'tuesday', 'wednesday']" + Literal[ + "friday", + "monday", + "saturday", + "sunday", + "thursday", + "tuesday", + "wednesday", + ] ] """ The day of the week when available funds are paid out, specified as `monday`, `tuesday`, etc. (required and applicable only if `interval` is `weekly`.) """ class CreateParamsSettingsTaxForms(TypedDict): - consented_to_paperless_delivery: NotRequired["bool"] + consented_to_paperless_delivery: NotRequired[bool] """ Whether the account opted out of receiving their tax forms by postal delivery. """ @@ -2693,11 +2699,11 @@ class CreateParamsSettingsTreasury(TypedDict): """ class CreateParamsSettingsTreasuryTosAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the account representative accepted the service agreement. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the account representative accepted the service agreement. """ @@ -2707,19 +2713,19 @@ class CreateParamsSettingsTreasuryTosAcceptance(TypedDict): """ class CreateParamsTosAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the account representative accepted their service agreement. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the account representative accepted their service agreement. """ - service_agreement: NotRequired["str"] + service_agreement: NotRequired[str] """ The user's service agreement type. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the account representative accepted their service agreement. """ @@ -2751,23 +2757,23 @@ class CreatePersonParams(RequestOptions): """ Documents that may be submitted to satisfy various informational requests. """ - email: NotRequired["str"] + email: NotRequired[str] """ The person's email address. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - first_name: NotRequired["str"] + first_name: NotRequired[str] """ The person's first name. """ - first_name_kana: NotRequired["str"] + first_name_kana: NotRequired[str] """ The Kana variation of the person's first name (Japan only). """ - first_name_kanji: NotRequired["str"] + first_name_kanji: NotRequired[str] """ The Kanji variation of the person's first name (Japan only). """ @@ -2775,31 +2781,31 @@ class CreatePersonParams(RequestOptions): """ A list of alternate names or aliases that the person is known by. """ - gender: NotRequired["str"] + gender: NotRequired[str] """ The person's gender (International regulations require either "male" or "female"). """ - id_number: NotRequired["str"] + id_number: NotRequired[str] """ The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - id_number_secondary: NotRequired["str"] + id_number_secondary: NotRequired[str] """ The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - last_name: NotRequired["str"] + last_name: NotRequired[str] """ The person's last name. """ - last_name_kana: NotRequired["str"] + last_name_kana: NotRequired[str] """ The Kana variation of the person's last name (Japan only). """ - last_name_kanji: NotRequired["str"] + last_name_kanji: NotRequired[str] """ The Kanji variation of the person's last name (Japan only). """ - maiden_name: NotRequired["str"] + maiden_name: NotRequired[str] """ The person's maiden name. """ @@ -2807,19 +2813,19 @@ class CreatePersonParams(RequestOptions): """ 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`. """ - nationality: NotRequired["str"] + nationality: NotRequired[str] """ The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. """ - person_token: NotRequired["str"] + person_token: NotRequired[str] """ A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The person's phone number. """ - political_exposure: NotRequired["str"] + political_exposure: NotRequired[str] """ Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. """ @@ -2833,7 +2839,7 @@ class CreatePersonParams(RequestOptions): """ The relationship that this person has with the account's legal entity. """ - ssn_last_4: NotRequired["str"] + ssn_last_4: NotRequired[str] """ The last four digits of the person's Social Security number (U.S. only). """ @@ -2851,11 +2857,11 @@ class CreatePersonParamsAdditionalTosAcceptances(TypedDict): """ class CreatePersonParamsAdditionalTosAcceptancesAccount(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the account representative accepted the service agreement. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the account representative accepted the service agreement. """ @@ -2865,87 +2871,87 @@ class CreatePersonParamsAdditionalTosAcceptancesAccount(TypedDict): """ class CreatePersonParamsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreatePersonParamsAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreatePersonParamsAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ @@ -2981,63 +2987,63 @@ class CreatePersonParamsDocuments(TypedDict): """ class CreatePersonParamsDocumentsCompanyAuthorization(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreatePersonParamsDocumentsPassport(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreatePersonParamsDocumentsVisa(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreatePersonParamsRegisteredAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreatePersonParamsRelationship(TypedDict): - director: NotRequired["bool"] + director: NotRequired[bool] """ Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. """ - executive: NotRequired["bool"] + executive: NotRequired[bool] """ Whether the person has significant responsibility to control, manage, or direct the organization. """ - legal_guardian: NotRequired["bool"] + legal_guardian: NotRequired[bool] """ Whether the person is the legal guardian of the account's representative. """ - owner: NotRequired["bool"] + owner: NotRequired[bool] """ Whether the person is an owner of the account's legal entity. """ @@ -3045,11 +3051,11 @@ class CreatePersonParamsRelationship(TypedDict): """ The percent owned by the person of the account's legal entity. """ - representative: NotRequired["bool"] + representative: NotRequired[bool] """ Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account. """ - title: NotRequired["str"] + title: NotRequired[str] """ The person's title (e.g., CEO, Support Engineer). """ @@ -3067,21 +3073,21 @@ class CreatePersonParamsVerification(TypedDict): """ class CreatePersonParamsVerificationAdditionalDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class CreatePersonParamsVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ @@ -3096,29 +3102,29 @@ class DeletePersonParams(RequestOptions): pass class ListCapabilitiesParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListExternalAccountsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - object: NotRequired["Literal['bank_account', 'card']"] + object: NotRequired[Literal["bank_account", "card"]] """ Filter external accounts according to a particular object type. """ - starting_after: NotRequired["str"] + 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. """ @@ -3128,51 +3134,51 @@ class ListParams(RequestOptions): """ Only return connected accounts that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListPersonsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -3180,39 +3186,39 @@ class ListPersonsParams(RequestOptions): """ Filters on the list of people returned based on the person's relationship to the account's company. """ - starting_after: NotRequired["str"] + 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 ListPersonsParamsRelationship(TypedDict): - director: NotRequired["bool"] + director: NotRequired[bool] """ A filter on the list of people returned based on whether these people are directors of the account's company. """ - executive: NotRequired["bool"] + executive: NotRequired[bool] """ A filter on the list of people returned based on whether these people are executives of the account's company. """ - legal_guardian: NotRequired["bool"] + legal_guardian: NotRequired[bool] """ A filter on the list of people returned based on whether these people are legal guardians of the account's representative. """ - owner: NotRequired["bool"] + owner: NotRequired[bool] """ A filter on the list of people returned based on whether these people are owners of the account's company. """ - representative: NotRequired["bool"] + representative: NotRequired[bool] """ A filter on the list of people returned based on whether these people are the representative of the account's company. """ class ModifyCapabilityParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - requested: NotRequired["bool"] + requested: NotRequired[bool] """ To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the `requirements` arrays. @@ -3220,7 +3226,7 @@ class ModifyCapabilityParams(RequestOptions): """ class ModifyExternalAccountParams(RequestOptions): - account_holder_name: NotRequired["str"] + account_holder_name: NotRequired[str] """ The name of the person or business that owns the bank account. """ @@ -3231,36 +3237,36 @@ class ModifyExternalAccountParams(RequestOptions): The type of entity that holds the account. This can be either `individual` or `company`. """ account_type: NotRequired[ - "Literal['checking', 'futsu', 'savings', 'toza']" + Literal["checking", "futsu", "savings", "toza"] ] """ The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. """ - address_city: NotRequired["str"] + address_city: NotRequired[str] """ City/District/Suburb/Town/Village. """ - address_country: NotRequired["str"] + address_country: NotRequired[str] """ Billing address country, if provided when creating card. """ - address_line1: NotRequired["str"] + address_line1: NotRequired[str] """ Address line 1 (Street address/PO Box/Company name). """ - address_line2: NotRequired["str"] + address_line2: NotRequired[str] """ Address line 2 (Apartment/Suite/Unit/Building). """ - address_state: NotRequired["str"] + address_state: NotRequired[str] """ State/County/Province/Region. """ - address_zip: NotRequired["str"] + address_zip: NotRequired[str] """ ZIP or postal code. """ - default_for_currency: NotRequired["bool"] + default_for_currency: NotRequired[bool] """ When set to true, this becomes the default external account for its currency. """ @@ -3268,15 +3274,15 @@ class ModifyExternalAccountParams(RequestOptions): """ Documents that may be submitted to satisfy various informational requests. """ - exp_month: NotRequired["str"] + exp_month: NotRequired[str] """ Two digit number representing the card's expiration month. """ - exp_year: NotRequired["str"] + exp_year: NotRequired[str] """ Four digit number representing the card's expiration year. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -3284,7 +3290,7 @@ class ModifyExternalAccountParams(RequestOptions): """ 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: NotRequired[str] """ Cardholder name. """ @@ -3300,7 +3306,7 @@ class ModifyExternalAccountParamsDocuments(TypedDict): class ModifyExternalAccountParamsDocumentsBankAccountOwnershipVerification( TypedDict, ): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ @@ -3332,23 +3338,23 @@ class ModifyPersonParams(RequestOptions): """ Documents that may be submitted to satisfy various informational requests. """ - email: NotRequired["str"] + email: NotRequired[str] """ The person's email address. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - first_name: NotRequired["str"] + first_name: NotRequired[str] """ The person's first name. """ - first_name_kana: NotRequired["str"] + first_name_kana: NotRequired[str] """ The Kana variation of the person's first name (Japan only). """ - first_name_kanji: NotRequired["str"] + first_name_kanji: NotRequired[str] """ The Kanji variation of the person's first name (Japan only). """ @@ -3356,31 +3362,31 @@ class ModifyPersonParams(RequestOptions): """ A list of alternate names or aliases that the person is known by. """ - gender: NotRequired["str"] + gender: NotRequired[str] """ The person's gender (International regulations require either "male" or "female"). """ - id_number: NotRequired["str"] + id_number: NotRequired[str] """ The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - id_number_secondary: NotRequired["str"] + id_number_secondary: NotRequired[str] """ The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - last_name: NotRequired["str"] + last_name: NotRequired[str] """ The person's last name. """ - last_name_kana: NotRequired["str"] + last_name_kana: NotRequired[str] """ The Kana variation of the person's last name (Japan only). """ - last_name_kanji: NotRequired["str"] + last_name_kanji: NotRequired[str] """ The Kanji variation of the person's last name (Japan only). """ - maiden_name: NotRequired["str"] + maiden_name: NotRequired[str] """ The person's maiden name. """ @@ -3388,19 +3394,19 @@ class ModifyPersonParams(RequestOptions): """ 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`. """ - nationality: NotRequired["str"] + nationality: NotRequired[str] """ The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. """ - person_token: NotRequired["str"] + person_token: NotRequired[str] """ A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The person's phone number. """ - political_exposure: NotRequired["str"] + political_exposure: NotRequired[str] """ Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. """ @@ -3414,7 +3420,7 @@ class ModifyPersonParams(RequestOptions): """ The relationship that this person has with the account's legal entity. """ - ssn_last_4: NotRequired["str"] + ssn_last_4: NotRequired[str] """ The last four digits of the person's Social Security number (U.S. only). """ @@ -3432,11 +3438,11 @@ class ModifyPersonParamsAdditionalTosAcceptances(TypedDict): """ class ModifyPersonParamsAdditionalTosAcceptancesAccount(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the account representative accepted the service agreement. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the account representative accepted the service agreement. """ @@ -3446,87 +3452,87 @@ class ModifyPersonParamsAdditionalTosAcceptancesAccount(TypedDict): """ class ModifyPersonParamsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ModifyPersonParamsAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class ModifyPersonParamsAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ @@ -3562,63 +3568,63 @@ class ModifyPersonParamsDocuments(TypedDict): """ class ModifyPersonParamsDocumentsCompanyAuthorization(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class ModifyPersonParamsDocumentsPassport(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class ModifyPersonParamsDocumentsVisa(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class ModifyPersonParamsRegisteredAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ModifyPersonParamsRelationship(TypedDict): - director: NotRequired["bool"] + director: NotRequired[bool] """ Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. """ - executive: NotRequired["bool"] + executive: NotRequired[bool] """ Whether the person has significant responsibility to control, manage, or direct the organization. """ - legal_guardian: NotRequired["bool"] + legal_guardian: NotRequired[bool] """ Whether the person is the legal guardian of the account's representative. """ - owner: NotRequired["bool"] + owner: NotRequired[bool] """ Whether the person is an owner of the account's legal entity. """ @@ -3626,11 +3632,11 @@ class ModifyPersonParamsRelationship(TypedDict): """ The percent owned by the person of the account's legal entity. """ - representative: NotRequired["bool"] + representative: NotRequired[bool] """ Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account. """ - title: NotRequired["str"] + title: NotRequired[str] """ The person's title (e.g., CEO, Support Engineer). """ @@ -3648,35 +3654,35 @@ class ModifyPersonParamsVerification(TypedDict): """ class ModifyPersonParamsVerificationAdditionalDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class ModifyPersonParamsVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class PersonsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -3684,35 +3690,35 @@ class PersonsParams(RequestOptions): """ Filters on the list of people returned based on the person's relationship to the account's company. """ - starting_after: NotRequired["str"] + 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 PersonsParamsRelationship(TypedDict): - director: NotRequired["bool"] + director: NotRequired[bool] """ A filter on the list of people returned based on whether these people are directors of the account's company. """ - executive: NotRequired["bool"] + executive: NotRequired[bool] """ A filter on the list of people returned based on whether these people are executives of the account's company. """ - legal_guardian: NotRequired["bool"] + legal_guardian: NotRequired[bool] """ A filter on the list of people returned based on whether these people are legal guardians of the account's representative. """ - owner: NotRequired["bool"] + owner: NotRequired[bool] """ A filter on the list of people returned based on whether these people are owners of the account's company. """ - representative: NotRequired["bool"] + representative: NotRequired[bool] """ A filter on the list of people returned based on whether these people are the representative of the account's company. """ class RejectParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -3722,19 +3728,19 @@ class RejectParams(RequestOptions): """ class RetrieveCapabilityParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveExternalAccountParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrievePersonParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_account_capability_service.py b/stripe/_account_capability_service.py index bedd1f38f..c2deeefe8 100644 --- a/stripe/_account_capability_service.py +++ b/stripe/_account_capability_service.py @@ -11,23 +11,23 @@ class AccountCapabilityService(StripeService): class ListParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - requested: NotRequired["bool"] + requested: NotRequired[bool] """ To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the `requirements` arrays. diff --git a/stripe/_account_external_account_service.py b/stripe/_account_external_account_service.py index c9bde3b52..139a4dab0 100644 --- a/stripe/_account_external_account_service.py +++ b/stripe/_account_external_account_service.py @@ -12,11 +12,11 @@ class AccountExternalAccountService(StripeService): class CreateParams(TypedDict): - default_for_currency: NotRequired["bool"] + default_for_currency: NotRequired[bool] """ When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -29,18 +29,18 @@ class CreateParams(TypedDict): """ Please refer to full [documentation](https://stripe.com/docs/api) instead. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ class CreateParamsBankAccount(TypedDict): object: Literal["bank_account"] - account_holder_name: NotRequired["str"] + account_holder_name: NotRequired[str] """ The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object. """ - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object. """ @@ -52,72 +52,72 @@ class CreateParamsBankAccount(TypedDict): """ The country in which the bank account is located. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts) """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ The routing number, sort code, or other country-appropriateinstitution number for the bank account. For US bank accounts, this is required and should bethe ACH routing number, not the wire routing number. If you are providing an IBAN for`account_number`, this field is not required. """ class CreateParamsCard(TypedDict): object: Literal["card"] - address_city: NotRequired["str"] - address_country: NotRequired["str"] - address_line1: NotRequired["str"] - address_line2: NotRequired["str"] - address_state: NotRequired["str"] - address_zip: NotRequired["str"] - currency: NotRequired["str"] - cvc: NotRequired["str"] + address_city: NotRequired[str] + address_country: NotRequired[str] + address_line1: NotRequired[str] + address_line2: NotRequired[str] + address_state: NotRequired[str] + address_zip: NotRequired[str] + currency: NotRequired[str] + cvc: NotRequired[str] exp_month: int exp_year: int - name: NotRequired["str"] + name: NotRequired[str] number: str - metadata: NotRequired["Dict[str, str]"] + 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. """ class CreateParamsCardToken(TypedDict): object: Literal["card"] - currency: NotRequired["str"] + currency: NotRequired[str] token: str class DeleteParams(TypedDict): pass class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - object: NotRequired["Literal['bank_account', 'card']"] + object: NotRequired[Literal["bank_account", "card"]] """ Filter external accounts according to a particular object type. """ - starting_after: NotRequired["str"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - account_holder_name: NotRequired["str"] + account_holder_name: NotRequired[str] """ The name of the person or business that owns the bank account. """ @@ -128,36 +128,36 @@ class UpdateParams(TypedDict): The type of entity that holds the account. This can be either `individual` or `company`. """ account_type: NotRequired[ - "Literal['checking', 'futsu', 'savings', 'toza']" + Literal["checking", "futsu", "savings", "toza"] ] """ The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. """ - address_city: NotRequired["str"] + address_city: NotRequired[str] """ City/District/Suburb/Town/Village. """ - address_country: NotRequired["str"] + address_country: NotRequired[str] """ Billing address country, if provided when creating card. """ - address_line1: NotRequired["str"] + address_line1: NotRequired[str] """ Address line 1 (Street address/PO Box/Company name). """ - address_line2: NotRequired["str"] + address_line2: NotRequired[str] """ Address line 2 (Apartment/Suite/Unit/Building). """ - address_state: NotRequired["str"] + address_state: NotRequired[str] """ State/County/Province/Region. """ - address_zip: NotRequired["str"] + address_zip: NotRequired[str] """ ZIP or postal code. """ - default_for_currency: NotRequired["bool"] + default_for_currency: NotRequired[bool] """ When set to true, this becomes the default external account for its currency. """ @@ -167,15 +167,15 @@ class UpdateParams(TypedDict): """ Documents that may be submitted to satisfy various informational requests. """ - exp_month: NotRequired["str"] + exp_month: NotRequired[str] """ Two digit number representing the card's expiration month. """ - exp_year: NotRequired["str"] + exp_year: NotRequired[str] """ Four digit number representing the card's expiration year. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -183,7 +183,7 @@ class UpdateParams(TypedDict): """ 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: NotRequired[str] """ Cardholder name. """ @@ -197,7 +197,7 @@ class UpdateParamsDocuments(TypedDict): """ class UpdateParamsDocumentsBankAccountOwnershipVerification(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ diff --git a/stripe/_account_link.py b/stripe/_account_link.py index fe7b33bd6..eeb466cfc 100644 --- a/stripe/_account_link.py +++ b/stripe/_account_link.py @@ -21,7 +21,7 @@ class CreateParams(RequestOptions): """ The identifier of the account to create an account link for. """ - collect: NotRequired["Literal['currently_due', 'eventually_due']"] + collect: NotRequired[Literal["currently_due", "eventually_due"]] """ The collect parameter is deprecated. Use `collection_options` instead. """ @@ -31,15 +31,15 @@ class CreateParams(RequestOptions): """ Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - refresh_url: NotRequired["str"] + refresh_url: NotRequired[str] """ The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL that the user will be redirected to upon leaving or completing the linked flow. """ @@ -58,7 +58,7 @@ class CreateParamsCollectionOptions(TypedDict): """ Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify `collection_options`, the default value is `currently_due`. """ - future_requirements: NotRequired["Literal['include', 'omit']"] + future_requirements: NotRequired[Literal["include", "omit"]] """ Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`. """ diff --git a/stripe/_account_link_service.py b/stripe/_account_link_service.py index 848b3ae2e..1cdccd997 100644 --- a/stripe/_account_link_service.py +++ b/stripe/_account_link_service.py @@ -13,7 +13,7 @@ class CreateParams(TypedDict): """ The identifier of the account to create an account link for. """ - collect: NotRequired["Literal['currently_due', 'eventually_due']"] + collect: NotRequired[Literal["currently_due", "eventually_due"]] """ The collect parameter is deprecated. Use `collection_options` instead. """ @@ -23,15 +23,15 @@ class CreateParams(TypedDict): """ Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - refresh_url: NotRequired["str"] + refresh_url: NotRequired[str] """ The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL that the user will be redirected to upon leaving or completing the linked flow. """ @@ -50,7 +50,7 @@ class CreateParamsCollectionOptions(TypedDict): """ Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify `collection_options`, the default value is `currently_due`. """ - future_requirements: NotRequired["Literal['include', 'omit']"] + future_requirements: NotRequired[Literal["include", "omit"]] """ Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`. """ diff --git a/stripe/_account_login_link_service.py b/stripe/_account_login_link_service.py index 4d02fcd52..21a66ca38 100644 --- a/stripe/_account_login_link_service.py +++ b/stripe/_account_login_link_service.py @@ -10,7 +10,7 @@ class AccountLoginLinkService(StripeService): class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_account_notice.py b/stripe/_account_notice.py index 404124b8f..af9551dbf 100644 --- a/stripe/_account_notice.py +++ b/stripe/_account_notice.py @@ -51,23 +51,23 @@ class LinkedObjects(StripeObject): """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - sent: NotRequired["bool"] + sent: NotRequired[bool] """ Set to false to only return unsent AccountNotices. """ - starting_after: NotRequired["str"] + 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. """ @@ -77,11 +77,11 @@ class ModifyParams(RequestOptions): """ Information about the email you sent. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -105,7 +105,7 @@ class ModifyParamsEmail(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_account_notice_service.py b/stripe/_account_notice_service.py index 7f0964781..64877ae00 100644 --- a/stripe/_account_notice_service.py +++ b/stripe/_account_notice_service.py @@ -11,29 +11,29 @@ class AccountNoticeService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - sent: NotRequired["bool"] + sent: NotRequired[bool] """ Set to false to only return unsent AccountNotices. """ - starting_after: NotRequired["str"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -43,11 +43,11 @@ class UpdateParams(TypedDict): """ Information about the email you sent. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ diff --git a/stripe/_account_person_service.py b/stripe/_account_person_service.py index 174351e19..4ec1741f2 100644 --- a/stripe/_account_person_service.py +++ b/stripe/_account_person_service.py @@ -41,23 +41,23 @@ class CreateParams(TypedDict): """ Documents that may be submitted to satisfy various informational requests. """ - email: NotRequired["str"] + email: NotRequired[str] """ The person's email address. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - first_name: NotRequired["str"] + first_name: NotRequired[str] """ The person's first name. """ - first_name_kana: NotRequired["str"] + first_name_kana: NotRequired[str] """ The Kana variation of the person's first name (Japan only). """ - first_name_kanji: NotRequired["str"] + first_name_kanji: NotRequired[str] """ The Kanji variation of the person's first name (Japan only). """ @@ -65,31 +65,31 @@ class CreateParams(TypedDict): """ A list of alternate names or aliases that the person is known by. """ - gender: NotRequired["str"] + gender: NotRequired[str] """ The person's gender (International regulations require either "male" or "female"). """ - id_number: NotRequired["str"] + id_number: NotRequired[str] """ The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - id_number_secondary: NotRequired["str"] + id_number_secondary: NotRequired[str] """ The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - last_name: NotRequired["str"] + last_name: NotRequired[str] """ The person's last name. """ - last_name_kana: NotRequired["str"] + last_name_kana: NotRequired[str] """ The Kana variation of the person's last name (Japan only). """ - last_name_kanji: NotRequired["str"] + last_name_kanji: NotRequired[str] """ The Kanji variation of the person's last name (Japan only). """ - maiden_name: NotRequired["str"] + maiden_name: NotRequired[str] """ The person's maiden name. """ @@ -97,19 +97,19 @@ class CreateParams(TypedDict): """ 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`. """ - nationality: NotRequired["str"] + nationality: NotRequired[str] """ The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. """ - person_token: NotRequired["str"] + person_token: NotRequired[str] """ A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The person's phone number. """ - political_exposure: NotRequired["str"] + political_exposure: NotRequired[str] """ Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. """ @@ -125,7 +125,7 @@ class CreateParams(TypedDict): """ The relationship that this person has with the account's legal entity. """ - ssn_last_4: NotRequired["str"] + ssn_last_4: NotRequired[str] """ The last four digits of the person's Social Security number (U.S. only). """ @@ -145,11 +145,11 @@ class CreateParamsAdditionalTosAcceptances(TypedDict): """ class CreateParamsAdditionalTosAcceptancesAccount(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the account representative accepted the service agreement. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the account representative accepted the service agreement. """ @@ -159,87 +159,87 @@ class CreateParamsAdditionalTosAcceptancesAccount(TypedDict): """ class CreateParamsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreateParamsAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ @@ -277,63 +277,63 @@ class CreateParamsDocuments(TypedDict): """ class CreateParamsDocumentsCompanyAuthorization(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsDocumentsPassport(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsDocumentsVisa(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsRegisteredAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsRelationship(TypedDict): - director: NotRequired["bool"] + director: NotRequired[bool] """ Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. """ - executive: NotRequired["bool"] + executive: NotRequired[bool] """ Whether the person has significant responsibility to control, manage, or direct the organization. """ - legal_guardian: NotRequired["bool"] + legal_guardian: NotRequired[bool] """ Whether the person is the legal guardian of the account's representative. """ - owner: NotRequired["bool"] + owner: NotRequired[bool] """ Whether the person is an owner of the account's legal entity. """ @@ -341,11 +341,11 @@ class CreateParamsRelationship(TypedDict): """ The percent owned by the person of the account's legal entity. """ - representative: NotRequired["bool"] + representative: NotRequired[bool] """ Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account. """ - title: NotRequired["str"] + title: NotRequired[str] """ The person's title (e.g., CEO, Support Engineer). """ @@ -365,21 +365,21 @@ class CreateParamsVerification(TypedDict): """ class CreateParamsVerificationAdditionalDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class CreateParamsVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ @@ -388,15 +388,15 @@ class DeleteParams(TypedDict): pass class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -406,35 +406,35 @@ class ListParams(TypedDict): """ Filters on the list of people returned based on the person's relationship to the account's company. """ - starting_after: NotRequired["str"] + 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 ListParamsRelationship(TypedDict): - director: NotRequired["bool"] + director: NotRequired[bool] """ A filter on the list of people returned based on whether these people are directors of the account's company. """ - executive: NotRequired["bool"] + executive: NotRequired[bool] """ A filter on the list of people returned based on whether these people are executives of the account's company. """ - legal_guardian: NotRequired["bool"] + legal_guardian: NotRequired[bool] """ A filter on the list of people returned based on whether these people are legal guardians of the account's representative. """ - owner: NotRequired["bool"] + owner: NotRequired[bool] """ A filter on the list of people returned based on whether these people are owners of the account's company. """ - representative: NotRequired["bool"] + representative: NotRequired[bool] """ A filter on the list of people returned based on whether these people are the representative of the account's company. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -470,23 +470,23 @@ class UpdateParams(TypedDict): """ Documents that may be submitted to satisfy various informational requests. """ - email: NotRequired["str"] + email: NotRequired[str] """ The person's email address. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - first_name: NotRequired["str"] + first_name: NotRequired[str] """ The person's first name. """ - first_name_kana: NotRequired["str"] + first_name_kana: NotRequired[str] """ The Kana variation of the person's first name (Japan only). """ - first_name_kanji: NotRequired["str"] + first_name_kanji: NotRequired[str] """ The Kanji variation of the person's first name (Japan only). """ @@ -494,31 +494,31 @@ class UpdateParams(TypedDict): """ A list of alternate names or aliases that the person is known by. """ - gender: NotRequired["str"] + gender: NotRequired[str] """ The person's gender (International regulations require either "male" or "female"). """ - id_number: NotRequired["str"] + id_number: NotRequired[str] """ The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - id_number_secondary: NotRequired["str"] + id_number_secondary: NotRequired[str] """ The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - last_name: NotRequired["str"] + last_name: NotRequired[str] """ The person's last name. """ - last_name_kana: NotRequired["str"] + last_name_kana: NotRequired[str] """ The Kana variation of the person's last name (Japan only). """ - last_name_kanji: NotRequired["str"] + last_name_kanji: NotRequired[str] """ The Kanji variation of the person's last name (Japan only). """ - maiden_name: NotRequired["str"] + maiden_name: NotRequired[str] """ The person's maiden name. """ @@ -526,19 +526,19 @@ class UpdateParams(TypedDict): """ 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`. """ - nationality: NotRequired["str"] + nationality: NotRequired[str] """ The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. """ - person_token: NotRequired["str"] + person_token: NotRequired[str] """ A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The person's phone number. """ - political_exposure: NotRequired["str"] + political_exposure: NotRequired[str] """ Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. """ @@ -554,7 +554,7 @@ class UpdateParams(TypedDict): """ The relationship that this person has with the account's legal entity. """ - ssn_last_4: NotRequired["str"] + ssn_last_4: NotRequired[str] """ The last four digits of the person's Social Security number (U.S. only). """ @@ -574,11 +574,11 @@ class UpdateParamsAdditionalTosAcceptances(TypedDict): """ class UpdateParamsAdditionalTosAcceptancesAccount(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the account representative accepted the service agreement. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the account representative accepted the service agreement. """ @@ -588,87 +588,87 @@ class UpdateParamsAdditionalTosAcceptancesAccount(TypedDict): """ class UpdateParamsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class UpdateParamsAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class UpdateParamsAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ @@ -706,63 +706,63 @@ class UpdateParamsDocuments(TypedDict): """ class UpdateParamsDocumentsCompanyAuthorization(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class UpdateParamsDocumentsPassport(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class UpdateParamsDocumentsVisa(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class UpdateParamsRegisteredAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class UpdateParamsRelationship(TypedDict): - director: NotRequired["bool"] + director: NotRequired[bool] """ Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. """ - executive: NotRequired["bool"] + executive: NotRequired[bool] """ Whether the person has significant responsibility to control, manage, or direct the organization. """ - legal_guardian: NotRequired["bool"] + legal_guardian: NotRequired[bool] """ Whether the person is the legal guardian of the account's representative. """ - owner: NotRequired["bool"] + owner: NotRequired[bool] """ Whether the person is an owner of the account's legal entity. """ @@ -770,11 +770,11 @@ class UpdateParamsRelationship(TypedDict): """ The percent owned by the person of the account's legal entity. """ - representative: NotRequired["bool"] + representative: NotRequired[bool] """ Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account. """ - title: NotRequired["str"] + title: NotRequired[str] """ The person's title (e.g., CEO, Support Engineer). """ @@ -794,21 +794,21 @@ class UpdateParamsVerification(TypedDict): """ class UpdateParamsVerificationAdditionalDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class UpdateParamsVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ diff --git a/stripe/_account_service.py b/stripe/_account_service.py index 679a1c893..c724dd71e 100644 --- a/stripe/_account_service.py +++ b/stripe/_account_service.py @@ -24,7 +24,7 @@ def __init__(self, requestor): self.persons = AccountPersonService(self._requestor) class CreateParams(TypedDict): - account_token: NotRequired["str"] + account_token: NotRequired[str] """ An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. """ @@ -35,7 +35,7 @@ class CreateParams(TypedDict): Business information about the account. """ business_type: NotRequired[ - "Literal['company', 'government_entity', 'individual', 'non_profit']" + Literal["company", "government_entity", "individual", "non_profit"] ] """ The business type. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts. @@ -52,11 +52,11 @@ class CreateParams(TypedDict): """ The configuration of the account when `type` is not provided. """ - country: NotRequired["str"] + country: NotRequired[str] """ The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported. """ - default_currency: NotRequired["str"] + default_currency: NotRequired[str] """ Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). """ @@ -64,11 +64,11 @@ class CreateParams(TypedDict): """ Documents that may be submitted to satisfy various informational requests. """ - email: NotRequired["str"] + email: NotRequired[str] """ The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -96,18 +96,18 @@ class CreateParams(TypedDict): """ Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance) This property can only be updated for Custom accounts. """ - type: NotRequired["Literal['custom', 'express', 'standard']"] + type: NotRequired[Literal["custom", "express", "standard"]] """ The type of Stripe account to create. May be one of `custom`, `express` or `standard`. """ class CreateParamsBankAccount(TypedDict): object: Literal["bank_account"] - account_holder_name: NotRequired["str"] + account_holder_name: NotRequired[str] """ The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object. """ - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object. """ @@ -119,11 +119,11 @@ class CreateParamsBankAccount(TypedDict): """ The country in which the bank account is located. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts) """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ The routing number, sort code, or other country-appropriateinstitution number for the bank account. For US bank accounts, this is required and should bethe ACH routing number, not the wire routing number. If you are providing an IBAN for`account_number`, this field is not required. """ @@ -135,11 +135,11 @@ class CreateParamsBusinessProfile(TypedDict): """ The applicant's gross annual revenue for its preceding fiscal year. """ - estimated_worker_count: NotRequired["int"] + estimated_worker_count: NotRequired[int] """ An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. """ - mcc: NotRequired["str"] + mcc: NotRequired[str] """ [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. """ @@ -149,11 +149,11 @@ class CreateParamsBusinessProfile(TypedDict): """ An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India. """ - name: NotRequired["str"] + name: NotRequired[str] """ The customer-facing business name. """ - product_description: NotRequired["str"] + product_description: NotRequired[str] """ Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes. """ @@ -163,11 +163,11 @@ class CreateParamsBusinessProfile(TypedDict): """ A publicly available mailing address for sending support issues to. """ - support_email: NotRequired["str"] + support_email: NotRequired[str] """ A publicly available email address for sending support issues to. """ - support_phone: NotRequired["str"] + support_phone: NotRequired[str] """ A publicly available phone number to call with support issues. """ @@ -175,7 +175,7 @@ class CreateParamsBusinessProfile(TypedDict): """ A publicly available website for handling support issues. """ - url: NotRequired["str"] + url: NotRequired[str] """ The business's publicly available website. """ @@ -205,27 +205,27 @@ class CreateParamsBusinessProfileMonthlyEstimatedRevenue(TypedDict): """ class CreateParamsBusinessProfileSupportAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -485,280 +485,280 @@ class CreateParamsCapabilities(TypedDict): """ class CreateParamsCapabilitiesAcssDebitPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesAffirmPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesAfterpayClearpayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesAuBecsDebitPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesBacsDebitPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesBancontactPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesBankTransferPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesBlikPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesBoletoPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesCardIssuing(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesCardPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesCartesBancairesPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesCashappPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesEpsPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesFpxPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesGiropayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesGrabpayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesIdealPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesIndiaInternationalPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesJcbPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesKlarnaPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesKonbiniPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesLegacyPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesLinkPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesMobilepayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesOxxoPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesP24Payments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesPaynowPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesPaypalPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesPaytoPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesPromptpayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesRevolutPayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesSepaDebitPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesSofortPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesSwishPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesTaxReportingUs1099K(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesTaxReportingUs1099Misc(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesTransfers(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesTreasury(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesTwintPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesUsBankAccountAchPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCapabilitiesZipPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class CreateParamsCard(TypedDict): object: Literal["card"] - address_city: NotRequired["str"] - address_country: NotRequired["str"] - address_line1: NotRequired["str"] - address_line2: NotRequired["str"] - address_state: NotRequired["str"] - address_zip: NotRequired["str"] - currency: NotRequired["str"] - cvc: NotRequired["str"] + address_city: NotRequired[str] + address_country: NotRequired[str] + address_line1: NotRequired[str] + address_line2: NotRequired[str] + address_state: NotRequired[str] + address_zip: NotRequired[str] + currency: NotRequired[str] + cvc: NotRequired[str] exp_month: int exp_year: int - name: NotRequired["str"] + name: NotRequired[str] number: str - metadata: NotRequired["Dict[str, str]"] + 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. """ - default_for_currency: NotRequired["bool"] + default_for_currency: NotRequired[bool] class CreateParamsCardToken(TypedDict): object: Literal["card"] - currency: NotRequired["str"] + currency: NotRequired[str] token: str class CreateParamsCompany(TypedDict): @@ -778,35 +778,35 @@ class CreateParamsCompany(TypedDict): """ The Kanji variation of the company's primary address (Japan only). """ - directors_provided: NotRequired["bool"] + directors_provided: NotRequired[bool] """ Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided. """ - executives_provided: NotRequired["bool"] + executives_provided: NotRequired[bool] """ Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` requirement. """ - export_license_id: NotRequired["str"] + export_license_id: NotRequired[str] """ The export license ID number of the company, also referred as Import Export Code (India only). """ - export_purpose_code: NotRequired["str"] + export_purpose_code: NotRequired[str] """ The purpose code to use for export transactions (India only). """ - name: NotRequired["str"] + name: NotRequired[str] """ The company's legal name. """ - name_kana: NotRequired["str"] + name_kana: NotRequired[str] """ The Kana variation of the company's legal name (Japan only). """ - name_kanji: NotRequired["str"] + name_kanji: NotRequired[str] """ The Kanji variation of the company's legal name (Japan only). """ - owners_provided: NotRequired["bool"] + owners_provided: NotRequired[bool] """ Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.owner` requirement. """ @@ -816,11 +816,11 @@ class CreateParamsCompany(TypedDict): """ This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The company's phone number (used for verification). """ - registration_number: NotRequired["str"] + registration_number: NotRequired[str] """ The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong). """ @@ -830,15 +830,15 @@ class CreateParamsCompany(TypedDict): """ The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value. """ - tax_id: NotRequired["str"] + tax_id: NotRequired[str] """ The business ID number of the company, as appropriate for the company's country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.) """ - tax_id_registrar: NotRequired["str"] + tax_id_registrar: NotRequired[str] """ The jurisdiction in which the `tax_id` is registered (Germany-based companies only). """ - vat_id: NotRequired["str"] + vat_id: NotRequired[str] """ The VAT number of the company. """ @@ -850,101 +850,101 @@ class CreateParamsCompany(TypedDict): """ class CreateParamsCompanyAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsCompanyAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreateParamsCompanyAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreateParamsCompanyOwnershipDeclaration(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the beneficial owner attestation was made. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the beneficial owner attestation was made. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the beneficial owner attestation was made. """ @@ -958,11 +958,11 @@ class CreateParamsCompanyVerification(TypedDict): """ class CreateParamsCompanyVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ @@ -986,17 +986,17 @@ class CreateParamsControllerApplication(TypedDict): """ Whether the controller is liable for losses on this account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances). """ - onboarding_owner: NotRequired["bool"] + onboarding_owner: NotRequired[bool] """ Whether the controller owns onboarding for this account. """ - pricing_controls: NotRequired["bool"] + pricing_controls: NotRequired[bool] """ Whether the controller has pricing controls for this account. """ class CreateParamsControllerDashboard(TypedDict): - type: NotRequired["Literal['express', 'full', 'none']"] + type: NotRequired[Literal["express", "full", "none"]] """ Whether this account should have access to the full Stripe Dashboard (`full`), to the Express Dashboard (`express`), or to no dashboard (`none`). Defaults to `full`. """ @@ -1046,43 +1046,43 @@ class CreateParamsDocuments(TypedDict): """ class CreateParamsDocumentsBankAccountOwnershipVerification(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsDocumentsCompanyLicense(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsDocumentsCompanyMemorandumOfAssociation(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsDocumentsCompanyMinisterialDecree(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsDocumentsCompanyRegistrationVerification(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsDocumentsCompanyTaxIdVerification(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsDocumentsProofOfRegistration(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ @@ -1110,19 +1110,19 @@ class CreateParamsIndividual(TypedDict): """ The individual's date of birth. """ - email: NotRequired["str"] + email: NotRequired[str] """ The individual's email address. """ - first_name: NotRequired["str"] + first_name: NotRequired[str] """ The individual's first name. """ - first_name_kana: NotRequired["str"] + first_name_kana: NotRequired[str] """ The Kana variation of the the individual's first name (Japan only). """ - first_name_kanji: NotRequired["str"] + first_name_kanji: NotRequired[str] """ The Kanji variation of the individual's first name (Japan only). """ @@ -1130,31 +1130,31 @@ class CreateParamsIndividual(TypedDict): """ A list of alternate names or aliases that the individual is known by. """ - gender: NotRequired["str"] + gender: NotRequired[str] """ The individual's gender (International regulations require either "male" or "female"). """ - id_number: NotRequired["str"] + id_number: NotRequired[str] """ The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - id_number_secondary: NotRequired["str"] + id_number_secondary: NotRequired[str] """ The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - last_name: NotRequired["str"] + last_name: NotRequired[str] """ The individual's last name. """ - last_name_kana: NotRequired["str"] + last_name_kana: NotRequired[str] """ The Kana variation of the individual's last name (Japan only). """ - last_name_kanji: NotRequired["str"] + last_name_kanji: NotRequired[str] """ The Kanji variation of the individual's last name (Japan only). """ - maiden_name: NotRequired["str"] + maiden_name: NotRequired[str] """ The individual's maiden name. """ @@ -1162,11 +1162,11 @@ class CreateParamsIndividual(TypedDict): """ 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`. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The individual's phone number. """ - political_exposure: NotRequired["Literal['existing', 'none']"] + political_exposure: NotRequired[Literal["existing", "none"]] """ Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. """ @@ -1182,7 +1182,7 @@ class CreateParamsIndividual(TypedDict): """ Describes the person's relationship to the account. """ - ssn_last_4: NotRequired["str"] + ssn_last_4: NotRequired[str] """ The last four digits of the individual's Social Security Number (U.S. only). """ @@ -1194,87 +1194,87 @@ class CreateParamsIndividual(TypedDict): """ class CreateParamsIndividualAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsIndividualAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreateParamsIndividualAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ @@ -1294,41 +1294,41 @@ class CreateParamsIndividualDob(TypedDict): """ class CreateParamsIndividualRegisteredAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsIndividualRelationship(TypedDict): - director: NotRequired["bool"] + director: NotRequired[bool] """ Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. """ - executive: NotRequired["bool"] + executive: NotRequired[bool] """ Whether the person has significant responsibility to control, manage, or direct the organization. """ - owner: NotRequired["bool"] + owner: NotRequired[bool] """ Whether the person is an owner of the account's legal entity. """ @@ -1336,7 +1336,7 @@ class CreateParamsIndividualRelationship(TypedDict): """ The percent owned by the person of the account's legal entity. """ - title: NotRequired["str"] + title: NotRequired[str] """ The person's title (e.g., CEO, Support Engineer). """ @@ -1356,21 +1356,21 @@ class CreateParamsIndividualVerification(TypedDict): """ class CreateParamsIndividualVerificationAdditionalDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class CreateParamsIndividualVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ @@ -1416,25 +1416,25 @@ class CreateParamsSettings(TypedDict): """ class CreateParamsSettingsBacsDebitPayments(TypedDict): - display_name: NotRequired["str"] + display_name: NotRequired[str] """ The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free. """ class CreateParamsSettingsBranding(TypedDict): - icon: NotRequired["str"] + icon: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px. """ - logo: NotRequired["str"] + logo: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px. """ - primary_color: NotRequired["str"] + primary_color: NotRequired[str] """ A CSS hex color value representing the primary branding color for this account. """ - secondary_color: NotRequired["str"] + secondary_color: NotRequired[str] """ A CSS hex color value representing the secondary branding color for this account. """ @@ -1448,11 +1448,11 @@ class CreateParamsSettingsCardIssuing(TypedDict): """ class CreateParamsSettingsCardIssuingTosAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the account representative accepted the service agreement. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the account representative accepted the service agreement. """ @@ -1468,7 +1468,7 @@ class CreateParamsSettingsCardPayments(TypedDict): """ Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge. """ - statement_descriptor_prefix: NotRequired["str"] + statement_descriptor_prefix: NotRequired[str] """ The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion. """ @@ -1482,31 +1482,31 @@ class CreateParamsSettingsCardPayments(TypedDict): """ class CreateParamsSettingsCardPaymentsDeclineOn(TypedDict): - avs_failure: NotRequired["bool"] + avs_failure: NotRequired[bool] """ Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification. """ - cvc_failure: NotRequired["bool"] + cvc_failure: NotRequired[bool] """ Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification. """ class CreateParamsSettingsPayments(TypedDict): - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. """ - statement_descriptor_kana: NotRequired["str"] + statement_descriptor_kana: NotRequired[str] """ The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). """ - statement_descriptor_kanji: NotRequired["str"] + statement_descriptor_kanji: NotRequired[str] """ The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). """ class CreateParamsSettingsPayouts(TypedDict): - debit_negative_balances: NotRequired["bool"] + debit_negative_balances: NotRequired[bool] """ A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances). """ @@ -1516,7 +1516,7 @@ class CreateParamsSettingsPayouts(TypedDict): """ Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. """ @@ -1526,25 +1526,31 @@ class CreateParamsSettingsPayoutsSchedule(TypedDict): """ The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://stripe.com/docs/connect/manage-payout-schedule). """ - interval: NotRequired[ - "Literal['daily', 'manual', 'monthly', 'weekly']" - ] + interval: NotRequired[Literal["daily", "manual", "monthly", "weekly"]] """ How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`. """ - monthly_anchor: NotRequired["int"] + monthly_anchor: NotRequired[int] """ The day of the month when available funds are paid out, specified as a number between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`. """ weekly_anchor: NotRequired[ - "Literal['friday', 'monday', 'saturday', 'sunday', 'thursday', 'tuesday', 'wednesday']" + Literal[ + "friday", + "monday", + "saturday", + "sunday", + "thursday", + "tuesday", + "wednesday", + ] ] """ The day of the week when available funds are paid out, specified as `monday`, `tuesday`, etc. (required and applicable only if `interval` is `weekly`.) """ class CreateParamsSettingsTaxForms(TypedDict): - consented_to_paperless_delivery: NotRequired["bool"] + consented_to_paperless_delivery: NotRequired[bool] """ Whether the account opted out of receiving their tax forms by postal delivery. """ @@ -1558,11 +1564,11 @@ class CreateParamsSettingsTreasury(TypedDict): """ class CreateParamsSettingsTreasuryTosAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the account representative accepted the service agreement. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the account representative accepted the service agreement. """ @@ -1572,19 +1578,19 @@ class CreateParamsSettingsTreasuryTosAcceptance(TypedDict): """ class CreateParamsTosAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the account representative accepted their service agreement. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the account representative accepted their service agreement. """ - service_agreement: NotRequired["str"] + service_agreement: NotRequired[str] """ The user's service agreement type. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the account representative accepted their service agreement. """ @@ -1597,43 +1603,43 @@ class ListParams(TypedDict): """ Only return connected accounts that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RejectParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1643,19 +1649,19 @@ class RejectParams(TypedDict): """ class RetrieveCurrentParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - account_token: NotRequired["str"] + account_token: NotRequired[str] """ An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. """ @@ -1666,7 +1672,7 @@ class UpdateParams(TypedDict): Business information about the account. """ business_type: NotRequired[ - "Literal['company', 'government_entity', 'individual', 'non_profit']" + Literal["company", "government_entity", "individual", "non_profit"] ] """ The business type. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts. @@ -1679,7 +1685,7 @@ class UpdateParams(TypedDict): """ Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts. """ - default_currency: NotRequired["str"] + default_currency: NotRequired[str] """ Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). """ @@ -1687,11 +1693,11 @@ class UpdateParams(TypedDict): """ Documents that may be submitted to satisfy various informational requests. """ - email: NotRequired["str"] + email: NotRequired[str] """ The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1722,11 +1728,11 @@ class UpdateParams(TypedDict): class UpdateParamsBankAccount(TypedDict): object: Literal["bank_account"] - account_holder_name: NotRequired["str"] + account_holder_name: NotRequired[str] """ The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object. """ - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object. """ @@ -1738,11 +1744,11 @@ class UpdateParamsBankAccount(TypedDict): """ The country in which the bank account is located. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts) """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ The routing number, sort code, or other country-appropriateinstitution number for the bank account. For US bank accounts, this is required and should bethe ACH routing number, not the wire routing number. If you are providing an IBAN for`account_number`, this field is not required. """ @@ -1754,11 +1760,11 @@ class UpdateParamsBusinessProfile(TypedDict): """ The applicant's gross annual revenue for its preceding fiscal year. """ - estimated_worker_count: NotRequired["int"] + estimated_worker_count: NotRequired[int] """ An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. """ - mcc: NotRequired["str"] + mcc: NotRequired[str] """ [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. """ @@ -1768,11 +1774,11 @@ class UpdateParamsBusinessProfile(TypedDict): """ An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India. """ - name: NotRequired["str"] + name: NotRequired[str] """ The customer-facing business name. """ - product_description: NotRequired["str"] + product_description: NotRequired[str] """ Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes. """ @@ -1782,11 +1788,11 @@ class UpdateParamsBusinessProfile(TypedDict): """ A publicly available mailing address for sending support issues to. """ - support_email: NotRequired["str"] + support_email: NotRequired[str] """ A publicly available email address for sending support issues to. """ - support_phone: NotRequired["str"] + support_phone: NotRequired[str] """ A publicly available phone number to call with support issues. """ @@ -1794,7 +1800,7 @@ class UpdateParamsBusinessProfile(TypedDict): """ A publicly available website for handling support issues. """ - url: NotRequired["str"] + url: NotRequired[str] """ The business's publicly available website. """ @@ -1824,27 +1830,27 @@ class UpdateParamsBusinessProfileMonthlyEstimatedRevenue(TypedDict): """ class UpdateParamsBusinessProfileSupportAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -2104,280 +2110,280 @@ class UpdateParamsCapabilities(TypedDict): """ class UpdateParamsCapabilitiesAcssDebitPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesAffirmPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesAfterpayClearpayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesAuBecsDebitPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesBacsDebitPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesBancontactPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesBankTransferPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesBlikPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesBoletoPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesCardIssuing(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesCardPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesCartesBancairesPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesCashappPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesEpsPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesFpxPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesGiropayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesGrabpayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesIdealPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesIndiaInternationalPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesJcbPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesKlarnaPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesKonbiniPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesLegacyPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesLinkPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesMobilepayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesOxxoPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesP24Payments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesPaynowPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesPaypalPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesPaytoPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesPromptpayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesRevolutPayPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesSepaDebitPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesSofortPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesSwishPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesTaxReportingUs1099K(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesTaxReportingUs1099Misc(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesTransfers(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesTreasury(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesTwintPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesUsBankAccountAchPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCapabilitiesZipPayments(TypedDict): - requested: NotRequired["bool"] + requested: NotRequired[bool] """ Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. """ class UpdateParamsCard(TypedDict): object: Literal["card"] - address_city: NotRequired["str"] - address_country: NotRequired["str"] - address_line1: NotRequired["str"] - address_line2: NotRequired["str"] - address_state: NotRequired["str"] - address_zip: NotRequired["str"] - currency: NotRequired["str"] - cvc: NotRequired["str"] + address_city: NotRequired[str] + address_country: NotRequired[str] + address_line1: NotRequired[str] + address_line2: NotRequired[str] + address_state: NotRequired[str] + address_zip: NotRequired[str] + currency: NotRequired[str] + cvc: NotRequired[str] exp_month: int exp_year: int - name: NotRequired["str"] + name: NotRequired[str] number: str - metadata: NotRequired["Dict[str, str]"] + 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. """ - default_for_currency: NotRequired["bool"] + default_for_currency: NotRequired[bool] class UpdateParamsCardToken(TypedDict): object: Literal["card"] - currency: NotRequired["str"] + currency: NotRequired[str] token: str class UpdateParamsCompany(TypedDict): @@ -2397,35 +2403,35 @@ class UpdateParamsCompany(TypedDict): """ The Kanji variation of the company's primary address (Japan only). """ - directors_provided: NotRequired["bool"] + directors_provided: NotRequired[bool] """ Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided. """ - executives_provided: NotRequired["bool"] + executives_provided: NotRequired[bool] """ Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` requirement. """ - export_license_id: NotRequired["str"] + export_license_id: NotRequired[str] """ The export license ID number of the company, also referred as Import Export Code (India only). """ - export_purpose_code: NotRequired["str"] + export_purpose_code: NotRequired[str] """ The purpose code to use for export transactions (India only). """ - name: NotRequired["str"] + name: NotRequired[str] """ The company's legal name. """ - name_kana: NotRequired["str"] + name_kana: NotRequired[str] """ The Kana variation of the company's legal name (Japan only). """ - name_kanji: NotRequired["str"] + name_kanji: NotRequired[str] """ The Kanji variation of the company's legal name (Japan only). """ - owners_provided: NotRequired["bool"] + owners_provided: NotRequired[bool] """ Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.owner` requirement. """ @@ -2435,11 +2441,11 @@ class UpdateParamsCompany(TypedDict): """ This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The company's phone number (used for verification). """ - registration_number: NotRequired["str"] + registration_number: NotRequired[str] """ The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong). """ @@ -2449,15 +2455,15 @@ class UpdateParamsCompany(TypedDict): """ The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value. """ - tax_id: NotRequired["str"] + tax_id: NotRequired[str] """ The business ID number of the company, as appropriate for the company's country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.) """ - tax_id_registrar: NotRequired["str"] + tax_id_registrar: NotRequired[str] """ The jurisdiction in which the `tax_id` is registered (Germany-based companies only). """ - vat_id: NotRequired["str"] + vat_id: NotRequired[str] """ The VAT number of the company. """ @@ -2469,101 +2475,101 @@ class UpdateParamsCompany(TypedDict): """ class UpdateParamsCompanyAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class UpdateParamsCompanyAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class UpdateParamsCompanyAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class UpdateParamsCompanyOwnershipDeclaration(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the beneficial owner attestation was made. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the beneficial owner attestation was made. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the beneficial owner attestation was made. """ @@ -2577,11 +2583,11 @@ class UpdateParamsCompanyVerification(TypedDict): """ class UpdateParamsCompanyVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ @@ -2631,43 +2637,43 @@ class UpdateParamsDocuments(TypedDict): """ class UpdateParamsDocumentsBankAccountOwnershipVerification(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class UpdateParamsDocumentsCompanyLicense(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class UpdateParamsDocumentsCompanyMemorandumOfAssociation(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class UpdateParamsDocumentsCompanyMinisterialDecree(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class UpdateParamsDocumentsCompanyRegistrationVerification(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class UpdateParamsDocumentsCompanyTaxIdVerification(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class UpdateParamsDocumentsProofOfRegistration(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ @@ -2695,19 +2701,19 @@ class UpdateParamsIndividual(TypedDict): """ The individual's date of birth. """ - email: NotRequired["str"] + email: NotRequired[str] """ The individual's email address. """ - first_name: NotRequired["str"] + first_name: NotRequired[str] """ The individual's first name. """ - first_name_kana: NotRequired["str"] + first_name_kana: NotRequired[str] """ The Kana variation of the the individual's first name (Japan only). """ - first_name_kanji: NotRequired["str"] + first_name_kanji: NotRequired[str] """ The Kanji variation of the individual's first name (Japan only). """ @@ -2715,31 +2721,31 @@ class UpdateParamsIndividual(TypedDict): """ A list of alternate names or aliases that the individual is known by. """ - gender: NotRequired["str"] + gender: NotRequired[str] """ The individual's gender (International regulations require either "male" or "female"). """ - id_number: NotRequired["str"] + id_number: NotRequired[str] """ The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - id_number_secondary: NotRequired["str"] + id_number_secondary: NotRequired[str] """ The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - last_name: NotRequired["str"] + last_name: NotRequired[str] """ The individual's last name. """ - last_name_kana: NotRequired["str"] + last_name_kana: NotRequired[str] """ The Kana variation of the individual's last name (Japan only). """ - last_name_kanji: NotRequired["str"] + last_name_kanji: NotRequired[str] """ The Kanji variation of the individual's last name (Japan only). """ - maiden_name: NotRequired["str"] + maiden_name: NotRequired[str] """ The individual's maiden name. """ @@ -2747,11 +2753,11 @@ class UpdateParamsIndividual(TypedDict): """ 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`. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The individual's phone number. """ - political_exposure: NotRequired["Literal['existing', 'none']"] + political_exposure: NotRequired[Literal["existing", "none"]] """ Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. """ @@ -2767,7 +2773,7 @@ class UpdateParamsIndividual(TypedDict): """ Describes the person's relationship to the account. """ - ssn_last_4: NotRequired["str"] + ssn_last_4: NotRequired[str] """ The last four digits of the individual's Social Security Number (U.S. only). """ @@ -2779,87 +2785,87 @@ class UpdateParamsIndividual(TypedDict): """ class UpdateParamsIndividualAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class UpdateParamsIndividualAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class UpdateParamsIndividualAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ @@ -2879,41 +2885,41 @@ class UpdateParamsIndividualDob(TypedDict): """ class UpdateParamsIndividualRegisteredAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class UpdateParamsIndividualRelationship(TypedDict): - director: NotRequired["bool"] + director: NotRequired[bool] """ Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. """ - executive: NotRequired["bool"] + executive: NotRequired[bool] """ Whether the person has significant responsibility to control, manage, or direct the organization. """ - owner: NotRequired["bool"] + owner: NotRequired[bool] """ Whether the person is an owner of the account's legal entity. """ @@ -2921,7 +2927,7 @@ class UpdateParamsIndividualRelationship(TypedDict): """ The percent owned by the person of the account's legal entity. """ - title: NotRequired["str"] + title: NotRequired[str] """ The person's title (e.g., CEO, Support Engineer). """ @@ -2941,21 +2947,21 @@ class UpdateParamsIndividualVerification(TypedDict): """ class UpdateParamsIndividualVerificationAdditionalDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class UpdateParamsIndividualVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ @@ -3005,25 +3011,25 @@ class UpdateParamsSettings(TypedDict): """ class UpdateParamsSettingsBacsDebitPayments(TypedDict): - display_name: NotRequired["str"] + display_name: NotRequired[str] """ The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free. """ class UpdateParamsSettingsBranding(TypedDict): - icon: NotRequired["str"] + icon: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px. """ - logo: NotRequired["str"] + logo: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px. """ - primary_color: NotRequired["str"] + primary_color: NotRequired[str] """ A CSS hex color value representing the primary branding color for this account. """ - secondary_color: NotRequired["str"] + secondary_color: NotRequired[str] """ A CSS hex color value representing the secondary branding color for this account. """ @@ -3037,11 +3043,11 @@ class UpdateParamsSettingsCardIssuing(TypedDict): """ class UpdateParamsSettingsCardIssuingTosAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the account representative accepted the service agreement. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the account representative accepted the service agreement. """ @@ -3057,7 +3063,7 @@ class UpdateParamsSettingsCardPayments(TypedDict): """ Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge. """ - statement_descriptor_prefix: NotRequired["str"] + statement_descriptor_prefix: NotRequired[str] """ The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion. """ @@ -3071,11 +3077,11 @@ class UpdateParamsSettingsCardPayments(TypedDict): """ class UpdateParamsSettingsCardPaymentsDeclineOn(TypedDict): - avs_failure: NotRequired["bool"] + avs_failure: NotRequired[bool] """ Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification. """ - cvc_failure: NotRequired["bool"] + cvc_failure: NotRequired[bool] """ Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification. """ @@ -3087,21 +3093,21 @@ class UpdateParamsSettingsInvoices(TypedDict): """ class UpdateParamsSettingsPayments(TypedDict): - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. """ - statement_descriptor_kana: NotRequired["str"] + statement_descriptor_kana: NotRequired[str] """ The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). """ - statement_descriptor_kanji: NotRequired["str"] + statement_descriptor_kanji: NotRequired[str] """ The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). """ class UpdateParamsSettingsPayouts(TypedDict): - debit_negative_balances: NotRequired["bool"] + debit_negative_balances: NotRequired[bool] """ A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances). """ @@ -3111,7 +3117,7 @@ class UpdateParamsSettingsPayouts(TypedDict): """ Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. """ @@ -3121,25 +3127,31 @@ class UpdateParamsSettingsPayoutsSchedule(TypedDict): """ The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://stripe.com/docs/connect/manage-payout-schedule). """ - interval: NotRequired[ - "Literal['daily', 'manual', 'monthly', 'weekly']" - ] + interval: NotRequired[Literal["daily", "manual", "monthly", "weekly"]] """ How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`. """ - monthly_anchor: NotRequired["int"] + monthly_anchor: NotRequired[int] """ The day of the month when available funds are paid out, specified as a number between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`. """ weekly_anchor: NotRequired[ - "Literal['friday', 'monday', 'saturday', 'sunday', 'thursday', 'tuesday', 'wednesday']" + Literal[ + "friday", + "monday", + "saturday", + "sunday", + "thursday", + "tuesday", + "wednesday", + ] ] """ The day of the week when available funds are paid out, specified as `monday`, `tuesday`, etc. (required and applicable only if `interval` is `weekly`.) """ class UpdateParamsSettingsTaxForms(TypedDict): - consented_to_paperless_delivery: NotRequired["bool"] + consented_to_paperless_delivery: NotRequired[bool] """ Whether the account opted out of receiving their tax forms by postal delivery. """ @@ -3153,11 +3165,11 @@ class UpdateParamsSettingsTreasury(TypedDict): """ class UpdateParamsSettingsTreasuryTosAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the account representative accepted the service agreement. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the account representative accepted the service agreement. """ @@ -3167,19 +3179,19 @@ class UpdateParamsSettingsTreasuryTosAcceptance(TypedDict): """ class UpdateParamsTosAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the account representative accepted their service agreement. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the account representative accepted their service agreement. """ - service_agreement: NotRequired["str"] + service_agreement: NotRequired[str] """ The user's service agreement type. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the account representative accepted their service agreement. """ diff --git a/stripe/_account_session.py b/stripe/_account_session.py index c66136ad6..331276950 100644 --- a/stripe/_account_session.py +++ b/stripe/_account_session.py @@ -144,7 +144,7 @@ class CreateParams(RequestOptions): """ Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -238,15 +238,15 @@ class CreateParamsComponentsPaymentDetails(TypedDict): """ class CreateParamsComponentsPaymentDetailsFeatures(TypedDict): - capture_payments: NotRequired["bool"] + capture_payments: NotRequired[bool] """ Whether to allow capturing and cancelling payment intents. This is `true` by default. """ - dispute_management: NotRequired["bool"] + dispute_management: NotRequired[bool] """ Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. """ - refund_management: NotRequired["bool"] + refund_management: NotRequired[bool] """ Whether to allow sending refunds. This is `true` by default. """ @@ -264,15 +264,15 @@ class CreateParamsComponentsPayments(TypedDict): """ class CreateParamsComponentsPaymentsFeatures(TypedDict): - capture_payments: NotRequired["bool"] + capture_payments: NotRequired[bool] """ Whether to allow capturing and cancelling payment intents. This is `true` by default. """ - dispute_management: NotRequired["bool"] + dispute_management: NotRequired[bool] """ Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. """ - refund_management: NotRequired["bool"] + refund_management: NotRequired[bool] """ Whether to allow sending refunds. This is `true` by default. """ @@ -290,15 +290,15 @@ class CreateParamsComponentsPayouts(TypedDict): """ class CreateParamsComponentsPayoutsFeatures(TypedDict): - edit_payout_schedule: NotRequired["bool"] + edit_payout_schedule: NotRequired[bool] """ Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise. """ - instant_payouts: NotRequired["bool"] + instant_payouts: NotRequired[bool] """ Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise. """ - standard_payouts: NotRequired["bool"] + standard_payouts: NotRequired[bool] """ Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise. """ diff --git a/stripe/_account_session_service.py b/stripe/_account_session_service.py index 7ac49c62a..82f4236f9 100644 --- a/stripe/_account_session_service.py +++ b/stripe/_account_session_service.py @@ -17,7 +17,7 @@ class CreateParams(TypedDict): """ Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -115,15 +115,15 @@ class CreateParamsComponentsPaymentDetails(TypedDict): """ class CreateParamsComponentsPaymentDetailsFeatures(TypedDict): - capture_payments: NotRequired["bool"] + capture_payments: NotRequired[bool] """ Whether to allow capturing and cancelling payment intents. This is `true` by default. """ - dispute_management: NotRequired["bool"] + dispute_management: NotRequired[bool] """ Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. """ - refund_management: NotRequired["bool"] + refund_management: NotRequired[bool] """ Whether to allow sending refunds. This is `true` by default. """ @@ -141,15 +141,15 @@ class CreateParamsComponentsPayments(TypedDict): """ class CreateParamsComponentsPaymentsFeatures(TypedDict): - capture_payments: NotRequired["bool"] + capture_payments: NotRequired[bool] """ Whether to allow capturing and cancelling payment intents. This is `true` by default. """ - dispute_management: NotRequired["bool"] + dispute_management: NotRequired[bool] """ Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. """ - refund_management: NotRequired["bool"] + refund_management: NotRequired[bool] """ Whether to allow sending refunds. This is `true` by default. """ @@ -167,15 +167,15 @@ class CreateParamsComponentsPayouts(TypedDict): """ class CreateParamsComponentsPayoutsFeatures(TypedDict): - edit_payout_schedule: NotRequired["bool"] + edit_payout_schedule: NotRequired[bool] """ Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise. """ - instant_payouts: NotRequired["bool"] + instant_payouts: NotRequired[bool] """ Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise. """ - standard_payouts: NotRequired["bool"] + standard_payouts: NotRequired[bool] """ Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise. """ diff --git a/stripe/_apple_pay_domain.py b/stripe/_apple_pay_domain.py index 2d01cebc3..254841b3f 100644 --- a/stripe/_apple_pay_domain.py +++ b/stripe/_apple_pay_domain.py @@ -19,7 +19,7 @@ class ApplePayDomain( class CreateParams(RequestOptions): domain_name: str - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -28,26 +28,26 @@ class DeleteParams(RequestOptions): pass class ListParams(RequestOptions): - domain_name: NotRequired["str"] - ending_before: NotRequired["str"] + domain_name: NotRequired[str] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_apple_pay_domain_service.py b/stripe/_apple_pay_domain_service.py index 3b6818cda..112d8da00 100644 --- a/stripe/_apple_pay_domain_service.py +++ b/stripe/_apple_pay_domain_service.py @@ -12,7 +12,7 @@ class ApplePayDomainService(StripeService): class CreateParams(TypedDict): domain_name: str - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -21,26 +21,26 @@ class DeleteParams(TypedDict): pass class ListParams(TypedDict): - domain_name: NotRequired["str"] - ending_before: NotRequired["str"] + domain_name: NotRequired[str] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_application_fee.py b/stripe/_application_fee.py index 61c36da64..d0f617b5a 100644 --- a/stripe/_application_fee.py +++ b/stripe/_application_fee.py @@ -28,21 +28,21 @@ class ApplicationFee(ListableAPIResource["ApplicationFee"]): OBJECT_NAME: ClassVar[Literal["application_fee"]] = "application_fee" class CreateRefundParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ A positive integer, in _cents (or local equivalent)_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ class ListParams(RequestOptions): - charge: NotRequired["str"] + charge: NotRequired[str] """ Only return application fees for the charge specified by this charge ID. """ @@ -50,61 +50,61 @@ class ListParams(RequestOptions): """ Only return applications fees that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListRefundsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 ModifyRefundParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -114,27 +114,27 @@ class ModifyRefundParams(RequestOptions): """ class RefundParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ A positive integer, in _cents (or local equivalent)_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveRefundParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_application_fee_refund_service.py b/stripe/_application_fee_refund_service.py index c012873e7..4f620585e 100644 --- a/stripe/_application_fee_refund_service.py +++ b/stripe/_application_fee_refund_service.py @@ -11,45 +11,45 @@ class ApplicationFeeRefundService(StripeService): class CreateParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ A positive integer, in _cents (or local equivalent)_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_application_fee_service.py b/stripe/_application_fee_service.py index ca337b84b..b3db0ae8b 100644 --- a/stripe/_application_fee_service.py +++ b/stripe/_application_fee_service.py @@ -16,7 +16,7 @@ def __init__(self, requestor): self.refunds = ApplicationFeeRefundService(self._requestor) class ListParams(TypedDict): - charge: NotRequired["str"] + charge: NotRequired[str] """ Only return application fees for the charge specified by this charge ID. """ @@ -24,43 +24,43 @@ class ListParams(TypedDict): """ Only return applications fees that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_balance.py b/stripe/_balance.py index 309ef756d..50b24f8e2 100644 --- a/stripe/_balance.py +++ b/stripe/_balance.py @@ -162,7 +162,7 @@ class SourceTypes(StripeObject): _inner_class_types = {"source_types": SourceTypes} class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_balance_service.py b/stripe/_balance_service.py index 917a94f1a..7220f5030 100644 --- a/stripe/_balance_service.py +++ b/stripe/_balance_service.py @@ -9,7 +9,7 @@ class BalanceService(StripeService): class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_balance_transaction.py b/stripe/_balance_transaction.py index 0a54283fb..71c433385 100644 --- a/stripe/_balance_transaction.py +++ b/stripe/_balance_transaction.py @@ -75,59 +75,59 @@ class ListParams(RequestOptions): """ Only return transactions that were created during the given date interval. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - payout: NotRequired["str"] + payout: NotRequired[str] """ For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. """ - source: NotRequired["str"] + source: NotRequired[str] """ Only returns the original transaction. """ - starting_after: NotRequired["str"] + 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. """ - type: NotRequired["str"] + type: NotRequired[str] """ Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_balance_transaction_service.py b/stripe/_balance_transaction_service.py index 2ffc34378..d6abe402c 100644 --- a/stripe/_balance_transaction_service.py +++ b/stripe/_balance_transaction_service.py @@ -15,59 +15,59 @@ class ListParams(TypedDict): """ Only return transactions that were created during the given date interval. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - payout: NotRequired["str"] + payout: NotRequired[str] """ For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. """ - source: NotRequired["str"] + source: NotRequired[str] """ Only returns the original transaction. """ - starting_after: NotRequired["str"] + 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. """ - type: NotRequired["str"] + type: NotRequired[str] """ Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_charge.py b/stripe/_charge.py index b7095f09d..78ce64923 100644 --- a/stripe/_charge.py +++ b/stripe/_charge.py @@ -1647,6 +1647,10 @@ class UsBankAccount(StripeObject): """ Last four digits of the bank account number. """ + mandate: Optional[ExpandableField["Mandate"]] + """ + ID of the mandate used to make this payment. + """ payment_reference: Optional[str] """ Reference number to locate ACH payments with customer's bank. @@ -1832,19 +1836,19 @@ class TransferData(StripeObject): """ class CaptureParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. """ - application_fee: NotRequired["int"] + application_fee: NotRequired[int] """ An application fee to add on to this charge. """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ An application fee amount to add on to this charge, which must be less than or equal to the original amount. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1852,15 +1856,15 @@ class CaptureParams(RequestOptions): """ Provides industry-specific information about the charge. """ - receipt_email: NotRequired["str"] + receipt_email: NotRequired[str] """ The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers' statements. Must contain at least one letter, maximum 22 characters. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. """ @@ -1868,7 +1872,7 @@ class CaptureParams(RequestOptions): """ An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. """ @@ -1910,23 +1914,23 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): """ The booking number associated with the car rental. """ - car_class_code: NotRequired["str"] + car_class_code: NotRequired[str] """ Class code of the car. """ - car_make: NotRequired["str"] + car_make: NotRequired[str] """ Make of the car. """ - car_model: NotRequired["str"] + car_model: NotRequired[str] """ Model of the car. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the rental car company. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the car rental company. """ @@ -1941,18 +1945,26 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): Delivery details for this purchase. """ drivers: NotRequired[ - "List[Charge.CaptureParamsPaymentDetailsCarRentalDriver]" + List["Charge.CaptureParamsPaymentDetailsCarRentalDriver"] ] """ The details of the passengers in the travel reservation """ extra_charges: NotRequired[ - "List[Literal['extra_mileage', 'gas', 'late_return', 'one_way_service', 'parking_violation']]" + List[ + Literal[ + "extra_mileage", + "gas", + "late_return", + "one_way_service", + "parking_violation", + ] + ] ] """ List of additional charges being billed. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep nor cancel their booking. """ @@ -1966,15 +1978,15 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): """ Car pick-up time. Measured in seconds since the Unix epoch. """ - rate_amount: NotRequired["int"] + rate_amount: NotRequired[int] """ Rental rate. """ - rate_interval: NotRequired["Literal['day', 'month', 'week']"] + rate_interval: NotRequired[Literal["day", "month", "week"]] """ The frequency at which the rate amount is applied. One of `day`, `week` or `month` """ - renter_name: NotRequired["str"] + renter_name: NotRequired[str] """ The name of the person or entity renting the car. """ @@ -1988,7 +2000,7 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): """ Car return time. Measured in seconds since the Unix epoch. """ - tax_exempt: NotRequired["bool"] + tax_exempt: NotRequired[bool] """ Indicates whether the goods or services are tax-exempt or tax is not collected. """ @@ -2000,7 +2012,7 @@ class CaptureParamsPaymentDetailsCarRentalAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsCarRentalDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -2012,15 +2024,15 @@ class CaptureParamsPaymentDetailsCarRentalDelivery(TypedDict): """ class CaptureParamsPaymentDetailsCarRentalDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -2032,59 +2044,59 @@ class CaptureParamsPaymentDetailsCarRentalDriver(TypedDict): """ class CaptureParamsPaymentDetailsCarRentalPickupAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CaptureParamsPaymentDetailsCarRentalReturnAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CaptureParamsPaymentDetailsEventDetails(TypedDict): - access_controlled_venue: NotRequired["bool"] + access_controlled_venue: NotRequired[bool] """ Indicates if the tickets are digitally checked when entering the venue. """ @@ -2100,7 +2112,7 @@ class CaptureParamsPaymentDetailsEventDetails(TypedDict): """ Affiliate details for this purchase. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the company """ @@ -2110,11 +2122,11 @@ class CaptureParamsPaymentDetailsEventDetails(TypedDict): """ Delivery details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Event end time. Measured in seconds since the Unix epoch. """ - genre: NotRequired["str"] + genre: NotRequired[str] """ Type of the event entertainment (concert, sports event etc) """ @@ -2122,33 +2134,33 @@ class CaptureParamsPaymentDetailsEventDetails(TypedDict): """ The name of the event. """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Event start time. Measured in seconds since the Unix epoch. """ class CaptureParamsPaymentDetailsEventDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -2160,7 +2172,7 @@ class CaptureParamsPaymentDetailsEventDetailsAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsEventDetailsDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -2172,15 +2184,15 @@ class CaptureParamsPaymentDetailsEventDetailsDelivery(TypedDict): """ class CaptureParamsPaymentDetailsEventDetailsDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -2192,11 +2204,11 @@ class CaptureParamsPaymentDetailsFlight(TypedDict): """ Affiliate details for this purchase. """ - agency_number: NotRequired["str"] + agency_number: NotRequired[str] """ The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket. """ @@ -2206,12 +2218,12 @@ class CaptureParamsPaymentDetailsFlight(TypedDict): """ Delivery details for this purchase. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the person or entity on the reservation. """ passengers: NotRequired[ - "List[Charge.CaptureParamsPaymentDetailsFlightPassenger]" + List["Charge.CaptureParamsPaymentDetailsFlightPassenger"] ] """ The details of the passengers in the travel reservation. @@ -2220,7 +2232,7 @@ class CaptureParamsPaymentDetailsFlight(TypedDict): """ The individual flight segments associated with the trip. """ - ticket_number: NotRequired["str"] + ticket_number: NotRequired[str] """ The ticket number associated with the travel reservation. """ @@ -2232,7 +2244,7 @@ class CaptureParamsPaymentDetailsFlightAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsFlightDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -2244,15 +2256,15 @@ class CaptureParamsPaymentDetailsFlightDelivery(TypedDict): """ class CaptureParamsPaymentDetailsFlightDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -2264,19 +2276,19 @@ class CaptureParamsPaymentDetailsFlightPassenger(TypedDict): """ class CaptureParamsPaymentDetailsFlightSegment(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The flight segment amount. """ - arrival_airport: NotRequired["str"] + arrival_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the arrival airport. """ - arrives_at: NotRequired["int"] + arrives_at: NotRequired[int] """ The arrival time for the flight segment. Measured in seconds since the Unix epoch. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment. """ @@ -2284,16 +2296,16 @@ class CaptureParamsPaymentDetailsFlightSegment(TypedDict): """ The departure time for the flight segment. Measured in seconds since the Unix epoch. """ - departure_airport: NotRequired["str"] + departure_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the departure airport. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number associated with the segment """ service_class: NotRequired[ - "Literal['business', 'economy', 'first', 'premium_economy']" + Literal["business", "economy", "first", "premium_economy"] ] """ The fare class for the segment. @@ -2306,7 +2318,7 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): """ The lodging location's address. """ - adults: NotRequired["int"] + adults: NotRequired[int] """ The number of adults on the booking """ @@ -2316,11 +2328,11 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): """ Affiliate details for this purchase. """ - booking_number: NotRequired["str"] + booking_number: NotRequired[str] """ The booking number associated with the lodging reservation. """ - category: NotRequired["Literal['hotel', 'vacation_rental']"] + category: NotRequired[Literal["hotel", "vacation_rental"]] """ The lodging category """ @@ -2332,11 +2344,11 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): """ Lodging check-out time. Measured in seconds since the Unix epoch. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the lodging company. """ - daily_room_rate_amount: NotRequired["int"] + daily_room_rate_amount: NotRequired[int] """ The daily lodging room rate. """ @@ -2347,76 +2359,85 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): Delivery details for this purchase. """ extra_charges: NotRequired[ - "List[Literal['gift_shop', 'laundry', 'mini_bar', 'other', 'restaurant', 'telephone']]" + List[ + Literal[ + "gift_shop", + "laundry", + "mini_bar", + "other", + "restaurant", + "telephone", + ] + ] ] """ List of additional charges being billed. """ - fire_safety_act_compliance: NotRequired["bool"] + fire_safety_act_compliance: NotRequired[bool] """ Indicates whether the lodging location is compliant with the Fire Safety Act. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the lodging location. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep their booking while failing to cancel the reservation. """ - number_of_rooms: NotRequired["int"] + number_of_rooms: NotRequired[int] """ The number of rooms on the booking """ passengers: NotRequired[ - "List[Charge.CaptureParamsPaymentDetailsLodgingPassenger]" + List["Charge.CaptureParamsPaymentDetailsLodgingPassenger"] ] """ The details of the passengers in the travel reservation """ - property_phone_number: NotRequired["str"] + property_phone_number: NotRequired[str] """ The phone number of the lodging location. """ - room_class: NotRequired["str"] + room_class: NotRequired[str] """ The room class for this purchase. """ - room_nights: NotRequired["int"] + room_nights: NotRequired[int] """ The number of room nights """ - total_room_tax_amount: NotRequired["int"] + total_room_tax_amount: NotRequired[int] """ The total tax amount associating with the room reservation. """ - total_tax_amount: NotRequired["int"] + total_tax_amount: NotRequired[int] """ The total tax amount """ class CaptureParamsPaymentDetailsLodgingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -2428,7 +2449,7 @@ class CaptureParamsPaymentDetailsLodgingAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsLodgingDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -2440,15 +2461,15 @@ class CaptureParamsPaymentDetailsLodgingDelivery(TypedDict): """ class CaptureParamsPaymentDetailsLodgingDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -2466,7 +2487,7 @@ class CaptureParamsPaymentDetailsSubscription(TypedDict): """ Affiliate details for this purchase. """ - auto_renewal: NotRequired["bool"] + auto_renewal: NotRequired[bool] """ Info whether the subscription will be auto renewed upon expiry. """ @@ -2476,7 +2497,7 @@ class CaptureParamsPaymentDetailsSubscription(TypedDict): """ Subscription billing details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Subscription end time. Measured in seconds since the Unix epoch. """ @@ -2484,7 +2505,7 @@ class CaptureParamsPaymentDetailsSubscription(TypedDict): """ Name of the product on subscription. e.g. Apple Music Subscription """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Subscription start time. Measured in seconds since the Unix epoch. """ @@ -2506,39 +2527,39 @@ class CaptureParamsPaymentDetailsSubscriptionBillingInterval(TypedDict): """ class CaptureParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. """ class CreateParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). """ - application_fee: NotRequired["int"] - application_fee_amount: NotRequired["int"] + application_fee: NotRequired[int] + application_fee_amount: NotRequired[int] """ A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). """ - capture: NotRequired["bool"] + capture: NotRequired[bool] """ Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of an existing customer that will be charged in this request. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. """ destination: NotRequired["Charge.CreateParamsDestination"] - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -2546,7 +2567,7 @@ class CreateParams(RequestOptions): """ 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`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). """ @@ -2554,7 +2575,7 @@ class CreateParams(RequestOptions): """ Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. """ - receipt_email: NotRequired["str"] + receipt_email: NotRequired[str] """ The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). """ @@ -2562,15 +2583,15 @@ class CreateParams(RequestOptions): """ Shipping information for the charge. Helps prevent fraud on charges for physical goods. """ - source: NotRequired["str"] + source: NotRequired[str] """ A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers' statements. Must contain at least one letter, maximum 22 characters. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. """ @@ -2578,7 +2599,7 @@ class CreateParams(RequestOptions): """ An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options). """ @@ -2588,13 +2609,13 @@ class CreateParamsDestination(TypedDict): """ ID of an existing, connected Stripe account. """ - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount to transfer to the destination account without creating an `Application Fee` object. Cannot be combined with the `application_fee` parameter. Must be less than or equal to the charge amount. """ class CreateParamsRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -2604,7 +2625,7 @@ class CreateParamsShipping(TypedDict): """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ @@ -2612,43 +2633,43 @@ class CreateParamsShipping(TypedDict): """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class CreateParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. """ @@ -2662,81 +2683,81 @@ class ListParams(RequestOptions): """ Only return charges that were created during the given date interval. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return charges for the customer specified by this customer ID. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - payment_intent: NotRequired["str"] + payment_intent: NotRequired[str] """ Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID. """ - starting_after: NotRequired["str"] + 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. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ Only return charges for this transfer group. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListRefundsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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): - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -2752,7 +2773,7 @@ class ModifyParams(RequestOptions): """ Provides industry-specific information about the charge. """ - receipt_email: NotRequired["str"] + receipt_email: NotRequired[str] """ This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address. """ @@ -2760,7 +2781,7 @@ class ModifyParams(RequestOptions): """ Shipping information for the charge. Helps prevent fraud on charges for physical goods. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. """ @@ -2808,23 +2829,23 @@ class ModifyParamsPaymentDetailsCarRental(TypedDict): """ The booking number associated with the car rental. """ - car_class_code: NotRequired["str"] + car_class_code: NotRequired[str] """ Class code of the car. """ - car_make: NotRequired["str"] + car_make: NotRequired[str] """ Make of the car. """ - car_model: NotRequired["str"] + car_model: NotRequired[str] """ Model of the car. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the rental car company. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the car rental company. """ @@ -2839,18 +2860,26 @@ class ModifyParamsPaymentDetailsCarRental(TypedDict): Delivery details for this purchase. """ drivers: NotRequired[ - "List[Charge.ModifyParamsPaymentDetailsCarRentalDriver]" + List["Charge.ModifyParamsPaymentDetailsCarRentalDriver"] ] """ The details of the passengers in the travel reservation """ extra_charges: NotRequired[ - "List[Literal['extra_mileage', 'gas', 'late_return', 'one_way_service', 'parking_violation']]" + List[ + Literal[ + "extra_mileage", + "gas", + "late_return", + "one_way_service", + "parking_violation", + ] + ] ] """ List of additional charges being billed. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep nor cancel their booking. """ @@ -2864,15 +2893,15 @@ class ModifyParamsPaymentDetailsCarRental(TypedDict): """ Car pick-up time. Measured in seconds since the Unix epoch. """ - rate_amount: NotRequired["int"] + rate_amount: NotRequired[int] """ Rental rate. """ - rate_interval: NotRequired["Literal['day', 'month', 'week']"] + rate_interval: NotRequired[Literal["day", "month", "week"]] """ The frequency at which the rate amount is applied. One of `day`, `week` or `month` """ - renter_name: NotRequired["str"] + renter_name: NotRequired[str] """ The name of the person or entity renting the car. """ @@ -2886,7 +2915,7 @@ class ModifyParamsPaymentDetailsCarRental(TypedDict): """ Car return time. Measured in seconds since the Unix epoch. """ - tax_exempt: NotRequired["bool"] + tax_exempt: NotRequired[bool] """ Indicates whether the goods or services are tax-exempt or tax is not collected. """ @@ -2898,7 +2927,7 @@ class ModifyParamsPaymentDetailsCarRentalAffiliate(TypedDict): """ class ModifyParamsPaymentDetailsCarRentalDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -2910,15 +2939,15 @@ class ModifyParamsPaymentDetailsCarRentalDelivery(TypedDict): """ class ModifyParamsPaymentDetailsCarRentalDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -2930,59 +2959,59 @@ class ModifyParamsPaymentDetailsCarRentalDriver(TypedDict): """ class ModifyParamsPaymentDetailsCarRentalPickupAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ModifyParamsPaymentDetailsCarRentalReturnAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ModifyParamsPaymentDetailsEventDetails(TypedDict): - access_controlled_venue: NotRequired["bool"] + access_controlled_venue: NotRequired[bool] """ Indicates if the tickets are digitally checked when entering the venue. """ @@ -2998,7 +3027,7 @@ class ModifyParamsPaymentDetailsEventDetails(TypedDict): """ Affiliate details for this purchase. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the company """ @@ -3008,11 +3037,11 @@ class ModifyParamsPaymentDetailsEventDetails(TypedDict): """ Delivery details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Event end time. Measured in seconds since the Unix epoch. """ - genre: NotRequired["str"] + genre: NotRequired[str] """ Type of the event entertainment (concert, sports event etc) """ @@ -3020,33 +3049,33 @@ class ModifyParamsPaymentDetailsEventDetails(TypedDict): """ The name of the event. """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Event start time. Measured in seconds since the Unix epoch. """ class ModifyParamsPaymentDetailsEventDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -3058,7 +3087,7 @@ class ModifyParamsPaymentDetailsEventDetailsAffiliate(TypedDict): """ class ModifyParamsPaymentDetailsEventDetailsDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -3070,15 +3099,15 @@ class ModifyParamsPaymentDetailsEventDetailsDelivery(TypedDict): """ class ModifyParamsPaymentDetailsEventDetailsDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -3090,11 +3119,11 @@ class ModifyParamsPaymentDetailsFlight(TypedDict): """ Affiliate details for this purchase. """ - agency_number: NotRequired["str"] + agency_number: NotRequired[str] """ The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket. """ @@ -3104,12 +3133,12 @@ class ModifyParamsPaymentDetailsFlight(TypedDict): """ Delivery details for this purchase. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the person or entity on the reservation. """ passengers: NotRequired[ - "List[Charge.ModifyParamsPaymentDetailsFlightPassenger]" + List["Charge.ModifyParamsPaymentDetailsFlightPassenger"] ] """ The details of the passengers in the travel reservation. @@ -3118,7 +3147,7 @@ class ModifyParamsPaymentDetailsFlight(TypedDict): """ The individual flight segments associated with the trip. """ - ticket_number: NotRequired["str"] + ticket_number: NotRequired[str] """ The ticket number associated with the travel reservation. """ @@ -3130,7 +3159,7 @@ class ModifyParamsPaymentDetailsFlightAffiliate(TypedDict): """ class ModifyParamsPaymentDetailsFlightDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -3142,15 +3171,15 @@ class ModifyParamsPaymentDetailsFlightDelivery(TypedDict): """ class ModifyParamsPaymentDetailsFlightDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -3162,19 +3191,19 @@ class ModifyParamsPaymentDetailsFlightPassenger(TypedDict): """ class ModifyParamsPaymentDetailsFlightSegment(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The flight segment amount. """ - arrival_airport: NotRequired["str"] + arrival_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the arrival airport. """ - arrives_at: NotRequired["int"] + arrives_at: NotRequired[int] """ The arrival time for the flight segment. Measured in seconds since the Unix epoch. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment. """ @@ -3182,16 +3211,16 @@ class ModifyParamsPaymentDetailsFlightSegment(TypedDict): """ The departure time for the flight segment. Measured in seconds since the Unix epoch. """ - departure_airport: NotRequired["str"] + departure_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the departure airport. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number associated with the segment """ service_class: NotRequired[ - "Literal['business', 'economy', 'first', 'premium_economy']" + Literal["business", "economy", "first", "premium_economy"] ] """ The fare class for the segment. @@ -3202,7 +3231,7 @@ class ModifyParamsPaymentDetailsLodging(TypedDict): """ The lodging location's address. """ - adults: NotRequired["int"] + adults: NotRequired[int] """ The number of adults on the booking """ @@ -3212,11 +3241,11 @@ class ModifyParamsPaymentDetailsLodging(TypedDict): """ Affiliate details for this purchase. """ - booking_number: NotRequired["str"] + booking_number: NotRequired[str] """ The booking number associated with the lodging reservation. """ - category: NotRequired["Literal['hotel', 'vacation_rental']"] + category: NotRequired[Literal["hotel", "vacation_rental"]] """ The lodging category """ @@ -3228,11 +3257,11 @@ class ModifyParamsPaymentDetailsLodging(TypedDict): """ Lodging check-out time. Measured in seconds since the Unix epoch. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the lodging company. """ - daily_room_rate_amount: NotRequired["int"] + daily_room_rate_amount: NotRequired[int] """ The daily lodging room rate. """ @@ -3243,76 +3272,85 @@ class ModifyParamsPaymentDetailsLodging(TypedDict): Delivery details for this purchase. """ extra_charges: NotRequired[ - "List[Literal['gift_shop', 'laundry', 'mini_bar', 'other', 'restaurant', 'telephone']]" + List[ + Literal[ + "gift_shop", + "laundry", + "mini_bar", + "other", + "restaurant", + "telephone", + ] + ] ] """ List of additional charges being billed. """ - fire_safety_act_compliance: NotRequired["bool"] + fire_safety_act_compliance: NotRequired[bool] """ Indicates whether the lodging location is compliant with the Fire Safety Act. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the lodging location. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep their booking while failing to cancel the reservation. """ - number_of_rooms: NotRequired["int"] + number_of_rooms: NotRequired[int] """ The number of rooms on the booking """ passengers: NotRequired[ - "List[Charge.ModifyParamsPaymentDetailsLodgingPassenger]" + List["Charge.ModifyParamsPaymentDetailsLodgingPassenger"] ] """ The details of the passengers in the travel reservation """ - property_phone_number: NotRequired["str"] + property_phone_number: NotRequired[str] """ The phone number of the lodging location. """ - room_class: NotRequired["str"] + room_class: NotRequired[str] """ The room class for this purchase. """ - room_nights: NotRequired["int"] + room_nights: NotRequired[int] """ The number of room nights """ - total_room_tax_amount: NotRequired["int"] + total_room_tax_amount: NotRequired[int] """ The total tax amount associating with the room reservation. """ - total_tax_amount: NotRequired["int"] + total_tax_amount: NotRequired[int] """ The total tax amount """ class ModifyParamsPaymentDetailsLodgingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -3324,7 +3362,7 @@ class ModifyParamsPaymentDetailsLodgingAffiliate(TypedDict): """ class ModifyParamsPaymentDetailsLodgingDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -3336,15 +3374,15 @@ class ModifyParamsPaymentDetailsLodgingDelivery(TypedDict): """ class ModifyParamsPaymentDetailsLodgingDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -3362,7 +3400,7 @@ class ModifyParamsPaymentDetailsSubscription(TypedDict): """ Affiliate details for this purchase. """ - auto_renewal: NotRequired["bool"] + auto_renewal: NotRequired[bool] """ Info whether the subscription will be auto renewed upon expiry. """ @@ -3372,7 +3410,7 @@ class ModifyParamsPaymentDetailsSubscription(TypedDict): """ Subscription billing details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Subscription end time. Measured in seconds since the Unix epoch. """ @@ -3380,7 +3418,7 @@ class ModifyParamsPaymentDetailsSubscription(TypedDict): """ Name of the product on subscription. e.g. Apple Music Subscription """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Subscription start time. Measured in seconds since the Unix epoch. """ @@ -3406,7 +3444,7 @@ class ModifyParamsShipping(TypedDict): """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ @@ -3414,63 +3452,63 @@ class ModifyParamsShipping(TypedDict): """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class ModifyParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveRefundParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SearchParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - page: NotRequired["str"] + page: NotRequired[str] """ A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. """ diff --git a/stripe/_charge_service.py b/stripe/_charge_service.py index 58f7d2e98..3ad7549cf 100644 --- a/stripe/_charge_service.py +++ b/stripe/_charge_service.py @@ -12,19 +12,19 @@ class ChargeService(StripeService): class CaptureParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. """ - application_fee: NotRequired["int"] + application_fee: NotRequired[int] """ An application fee to add on to this charge. """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ An application fee amount to add on to this charge, which must be less than or equal to the original amount. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -34,15 +34,15 @@ class CaptureParams(TypedDict): """ Provides industry-specific information about the charge. """ - receipt_email: NotRequired["str"] + receipt_email: NotRequired[str] """ The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers' statements. Must contain at least one letter, maximum 22 characters. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. """ @@ -50,7 +50,7 @@ class CaptureParams(TypedDict): """ An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. """ @@ -96,23 +96,23 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): """ The booking number associated with the car rental. """ - car_class_code: NotRequired["str"] + car_class_code: NotRequired[str] """ Class code of the car. """ - car_make: NotRequired["str"] + car_make: NotRequired[str] """ Make of the car. """ - car_model: NotRequired["str"] + car_model: NotRequired[str] """ Model of the car. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the rental car company. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the car rental company. """ @@ -127,18 +127,26 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): Delivery details for this purchase. """ drivers: NotRequired[ - "List[ChargeService.CaptureParamsPaymentDetailsCarRentalDriver]" + List["ChargeService.CaptureParamsPaymentDetailsCarRentalDriver"] ] """ The details of the passengers in the travel reservation """ extra_charges: NotRequired[ - "List[Literal['extra_mileage', 'gas', 'late_return', 'one_way_service', 'parking_violation']]" + List[ + Literal[ + "extra_mileage", + "gas", + "late_return", + "one_way_service", + "parking_violation", + ] + ] ] """ List of additional charges being billed. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep nor cancel their booking. """ @@ -152,15 +160,15 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): """ Car pick-up time. Measured in seconds since the Unix epoch. """ - rate_amount: NotRequired["int"] + rate_amount: NotRequired[int] """ Rental rate. """ - rate_interval: NotRequired["Literal['day', 'month', 'week']"] + rate_interval: NotRequired[Literal["day", "month", "week"]] """ The frequency at which the rate amount is applied. One of `day`, `week` or `month` """ - renter_name: NotRequired["str"] + renter_name: NotRequired[str] """ The name of the person or entity renting the car. """ @@ -174,7 +182,7 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): """ Car return time. Measured in seconds since the Unix epoch. """ - tax_exempt: NotRequired["bool"] + tax_exempt: NotRequired[bool] """ Indicates whether the goods or services are tax-exempt or tax is not collected. """ @@ -186,7 +194,7 @@ class CaptureParamsPaymentDetailsCarRentalAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsCarRentalDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -198,15 +206,15 @@ class CaptureParamsPaymentDetailsCarRentalDelivery(TypedDict): """ class CaptureParamsPaymentDetailsCarRentalDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -218,59 +226,59 @@ class CaptureParamsPaymentDetailsCarRentalDriver(TypedDict): """ class CaptureParamsPaymentDetailsCarRentalPickupAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CaptureParamsPaymentDetailsCarRentalReturnAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CaptureParamsPaymentDetailsEventDetails(TypedDict): - access_controlled_venue: NotRequired["bool"] + access_controlled_venue: NotRequired[bool] """ Indicates if the tickets are digitally checked when entering the venue. """ @@ -286,7 +294,7 @@ class CaptureParamsPaymentDetailsEventDetails(TypedDict): """ Affiliate details for this purchase. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the company """ @@ -296,11 +304,11 @@ class CaptureParamsPaymentDetailsEventDetails(TypedDict): """ Delivery details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Event end time. Measured in seconds since the Unix epoch. """ - genre: NotRequired["str"] + genre: NotRequired[str] """ Type of the event entertainment (concert, sports event etc) """ @@ -308,33 +316,33 @@ class CaptureParamsPaymentDetailsEventDetails(TypedDict): """ The name of the event. """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Event start time. Measured in seconds since the Unix epoch. """ class CaptureParamsPaymentDetailsEventDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -346,7 +354,7 @@ class CaptureParamsPaymentDetailsEventDetailsAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsEventDetailsDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -358,15 +366,15 @@ class CaptureParamsPaymentDetailsEventDetailsDelivery(TypedDict): """ class CaptureParamsPaymentDetailsEventDetailsDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -378,11 +386,11 @@ class CaptureParamsPaymentDetailsFlight(TypedDict): """ Affiliate details for this purchase. """ - agency_number: NotRequired["str"] + agency_number: NotRequired[str] """ The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket. """ @@ -392,12 +400,12 @@ class CaptureParamsPaymentDetailsFlight(TypedDict): """ Delivery details for this purchase. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the person or entity on the reservation. """ passengers: NotRequired[ - "List[ChargeService.CaptureParamsPaymentDetailsFlightPassenger]" + List["ChargeService.CaptureParamsPaymentDetailsFlightPassenger"] ] """ The details of the passengers in the travel reservation. @@ -408,7 +416,7 @@ class CaptureParamsPaymentDetailsFlight(TypedDict): """ The individual flight segments associated with the trip. """ - ticket_number: NotRequired["str"] + ticket_number: NotRequired[str] """ The ticket number associated with the travel reservation. """ @@ -420,7 +428,7 @@ class CaptureParamsPaymentDetailsFlightAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsFlightDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -432,15 +440,15 @@ class CaptureParamsPaymentDetailsFlightDelivery(TypedDict): """ class CaptureParamsPaymentDetailsFlightDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -452,19 +460,19 @@ class CaptureParamsPaymentDetailsFlightPassenger(TypedDict): """ class CaptureParamsPaymentDetailsFlightSegment(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The flight segment amount. """ - arrival_airport: NotRequired["str"] + arrival_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the arrival airport. """ - arrives_at: NotRequired["int"] + arrives_at: NotRequired[int] """ The arrival time for the flight segment. Measured in seconds since the Unix epoch. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment. """ @@ -472,16 +480,16 @@ class CaptureParamsPaymentDetailsFlightSegment(TypedDict): """ The departure time for the flight segment. Measured in seconds since the Unix epoch. """ - departure_airport: NotRequired["str"] + departure_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the departure airport. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number associated with the segment """ service_class: NotRequired[ - "Literal['business', 'economy', 'first', 'premium_economy']" + Literal["business", "economy", "first", "premium_economy"] ] """ The fare class for the segment. @@ -494,7 +502,7 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): """ The lodging location's address. """ - adults: NotRequired["int"] + adults: NotRequired[int] """ The number of adults on the booking """ @@ -504,11 +512,11 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): """ Affiliate details for this purchase. """ - booking_number: NotRequired["str"] + booking_number: NotRequired[str] """ The booking number associated with the lodging reservation. """ - category: NotRequired["Literal['hotel', 'vacation_rental']"] + category: NotRequired[Literal["hotel", "vacation_rental"]] """ The lodging category """ @@ -520,11 +528,11 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): """ Lodging check-out time. Measured in seconds since the Unix epoch. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the lodging company. """ - daily_room_rate_amount: NotRequired["int"] + daily_room_rate_amount: NotRequired[int] """ The daily lodging room rate. """ @@ -535,76 +543,85 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): Delivery details for this purchase. """ extra_charges: NotRequired[ - "List[Literal['gift_shop', 'laundry', 'mini_bar', 'other', 'restaurant', 'telephone']]" + List[ + Literal[ + "gift_shop", + "laundry", + "mini_bar", + "other", + "restaurant", + "telephone", + ] + ] ] """ List of additional charges being billed. """ - fire_safety_act_compliance: NotRequired["bool"] + fire_safety_act_compliance: NotRequired[bool] """ Indicates whether the lodging location is compliant with the Fire Safety Act. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the lodging location. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep their booking while failing to cancel the reservation. """ - number_of_rooms: NotRequired["int"] + number_of_rooms: NotRequired[int] """ The number of rooms on the booking """ passengers: NotRequired[ - "List[ChargeService.CaptureParamsPaymentDetailsLodgingPassenger]" + List["ChargeService.CaptureParamsPaymentDetailsLodgingPassenger"] ] """ The details of the passengers in the travel reservation """ - property_phone_number: NotRequired["str"] + property_phone_number: NotRequired[str] """ The phone number of the lodging location. """ - room_class: NotRequired["str"] + room_class: NotRequired[str] """ The room class for this purchase. """ - room_nights: NotRequired["int"] + room_nights: NotRequired[int] """ The number of room nights """ - total_room_tax_amount: NotRequired["int"] + total_room_tax_amount: NotRequired[int] """ The total tax amount associating with the room reservation. """ - total_tax_amount: NotRequired["int"] + total_tax_amount: NotRequired[int] """ The total tax amount """ class CaptureParamsPaymentDetailsLodgingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -616,7 +633,7 @@ class CaptureParamsPaymentDetailsLodgingAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsLodgingDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -628,15 +645,15 @@ class CaptureParamsPaymentDetailsLodgingDelivery(TypedDict): """ class CaptureParamsPaymentDetailsLodgingDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -654,7 +671,7 @@ class CaptureParamsPaymentDetailsSubscription(TypedDict): """ Affiliate details for this purchase. """ - auto_renewal: NotRequired["bool"] + auto_renewal: NotRequired[bool] """ Info whether the subscription will be auto renewed upon expiry. """ @@ -664,7 +681,7 @@ class CaptureParamsPaymentDetailsSubscription(TypedDict): """ Subscription billing details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Subscription end time. Measured in seconds since the Unix epoch. """ @@ -672,7 +689,7 @@ class CaptureParamsPaymentDetailsSubscription(TypedDict): """ Name of the product on subscription. e.g. Apple Music Subscription """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Subscription start time. Measured in seconds since the Unix epoch. """ @@ -694,39 +711,39 @@ class CaptureParamsPaymentDetailsSubscriptionBillingInterval(TypedDict): """ class CaptureParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. """ class CreateParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). """ - application_fee: NotRequired["int"] - application_fee_amount: NotRequired["int"] + application_fee: NotRequired[int] + application_fee_amount: NotRequired[int] """ A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). """ - capture: NotRequired["bool"] + capture: NotRequired[bool] """ Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of an existing customer that will be charged in this request. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. """ destination: NotRequired["ChargeService.CreateParamsDestination"] - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -734,7 +751,7 @@ class CreateParams(TypedDict): """ 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`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). """ @@ -742,7 +759,7 @@ class CreateParams(TypedDict): """ Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. """ - receipt_email: NotRequired["str"] + receipt_email: NotRequired[str] """ The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). """ @@ -750,15 +767,15 @@ class CreateParams(TypedDict): """ Shipping information for the charge. Helps prevent fraud on charges for physical goods. """ - source: NotRequired["str"] + source: NotRequired[str] """ A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers' statements. Must contain at least one letter, maximum 22 characters. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. """ @@ -766,7 +783,7 @@ class CreateParams(TypedDict): """ An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options). """ @@ -776,13 +793,13 @@ class CreateParamsDestination(TypedDict): """ ID of an existing, connected Stripe account. """ - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount to transfer to the destination account without creating an `Application Fee` object. Cannot be combined with the `application_fee` parameter. Must be less than or equal to the charge amount. """ class CreateParamsRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -792,7 +809,7 @@ class CreateParamsShipping(TypedDict): """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ @@ -800,43 +817,43 @@ class CreateParamsShipping(TypedDict): """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class CreateParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. """ @@ -850,69 +867,69 @@ class ListParams(TypedDict): """ Only return charges that were created during the given date interval. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return charges for the customer specified by this customer ID. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - payment_intent: NotRequired["str"] + payment_intent: NotRequired[str] """ Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID. """ - starting_after: NotRequired["str"] + 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. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ Only return charges for this transfer group. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SearchParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - page: NotRequired["str"] + page: NotRequired[str] """ A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. """ @@ -922,15 +939,15 @@ class SearchParams(TypedDict): """ class UpdateParams(TypedDict): - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -948,7 +965,7 @@ class UpdateParams(TypedDict): """ Provides industry-specific information about the charge. """ - receipt_email: NotRequired["str"] + receipt_email: NotRequired[str] """ This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address. """ @@ -956,7 +973,7 @@ class UpdateParams(TypedDict): """ Shipping information for the charge. Helps prevent fraud on charges for physical goods. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. """ @@ -1006,23 +1023,23 @@ class UpdateParamsPaymentDetailsCarRental(TypedDict): """ The booking number associated with the car rental. """ - car_class_code: NotRequired["str"] + car_class_code: NotRequired[str] """ Class code of the car. """ - car_make: NotRequired["str"] + car_make: NotRequired[str] """ Make of the car. """ - car_model: NotRequired["str"] + car_model: NotRequired[str] """ Model of the car. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the rental car company. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the car rental company. """ @@ -1037,18 +1054,26 @@ class UpdateParamsPaymentDetailsCarRental(TypedDict): Delivery details for this purchase. """ drivers: NotRequired[ - "List[ChargeService.UpdateParamsPaymentDetailsCarRentalDriver]" + List["ChargeService.UpdateParamsPaymentDetailsCarRentalDriver"] ] """ The details of the passengers in the travel reservation """ extra_charges: NotRequired[ - "List[Literal['extra_mileage', 'gas', 'late_return', 'one_way_service', 'parking_violation']]" + List[ + Literal[ + "extra_mileage", + "gas", + "late_return", + "one_way_service", + "parking_violation", + ] + ] ] """ List of additional charges being billed. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep nor cancel their booking. """ @@ -1062,15 +1087,15 @@ class UpdateParamsPaymentDetailsCarRental(TypedDict): """ Car pick-up time. Measured in seconds since the Unix epoch. """ - rate_amount: NotRequired["int"] + rate_amount: NotRequired[int] """ Rental rate. """ - rate_interval: NotRequired["Literal['day', 'month', 'week']"] + rate_interval: NotRequired[Literal["day", "month", "week"]] """ The frequency at which the rate amount is applied. One of `day`, `week` or `month` """ - renter_name: NotRequired["str"] + renter_name: NotRequired[str] """ The name of the person or entity renting the car. """ @@ -1084,7 +1109,7 @@ class UpdateParamsPaymentDetailsCarRental(TypedDict): """ Car return time. Measured in seconds since the Unix epoch. """ - tax_exempt: NotRequired["bool"] + tax_exempt: NotRequired[bool] """ Indicates whether the goods or services are tax-exempt or tax is not collected. """ @@ -1096,7 +1121,7 @@ class UpdateParamsPaymentDetailsCarRentalAffiliate(TypedDict): """ class UpdateParamsPaymentDetailsCarRentalDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -1108,15 +1133,15 @@ class UpdateParamsPaymentDetailsCarRentalDelivery(TypedDict): """ class UpdateParamsPaymentDetailsCarRentalDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -1128,59 +1153,59 @@ class UpdateParamsPaymentDetailsCarRentalDriver(TypedDict): """ class UpdateParamsPaymentDetailsCarRentalPickupAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class UpdateParamsPaymentDetailsCarRentalReturnAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class UpdateParamsPaymentDetailsEventDetails(TypedDict): - access_controlled_venue: NotRequired["bool"] + access_controlled_venue: NotRequired[bool] """ Indicates if the tickets are digitally checked when entering the venue. """ @@ -1196,7 +1221,7 @@ class UpdateParamsPaymentDetailsEventDetails(TypedDict): """ Affiliate details for this purchase. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the company """ @@ -1206,11 +1231,11 @@ class UpdateParamsPaymentDetailsEventDetails(TypedDict): """ Delivery details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Event end time. Measured in seconds since the Unix epoch. """ - genre: NotRequired["str"] + genre: NotRequired[str] """ Type of the event entertainment (concert, sports event etc) """ @@ -1218,33 +1243,33 @@ class UpdateParamsPaymentDetailsEventDetails(TypedDict): """ The name of the event. """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Event start time. Measured in seconds since the Unix epoch. """ class UpdateParamsPaymentDetailsEventDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1256,7 +1281,7 @@ class UpdateParamsPaymentDetailsEventDetailsAffiliate(TypedDict): """ class UpdateParamsPaymentDetailsEventDetailsDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -1268,15 +1293,15 @@ class UpdateParamsPaymentDetailsEventDetailsDelivery(TypedDict): """ class UpdateParamsPaymentDetailsEventDetailsDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -1288,11 +1313,11 @@ class UpdateParamsPaymentDetailsFlight(TypedDict): """ Affiliate details for this purchase. """ - agency_number: NotRequired["str"] + agency_number: NotRequired[str] """ The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket. """ @@ -1302,12 +1327,12 @@ class UpdateParamsPaymentDetailsFlight(TypedDict): """ Delivery details for this purchase. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the person or entity on the reservation. """ passengers: NotRequired[ - "List[ChargeService.UpdateParamsPaymentDetailsFlightPassenger]" + List["ChargeService.UpdateParamsPaymentDetailsFlightPassenger"] ] """ The details of the passengers in the travel reservation. @@ -1316,7 +1341,7 @@ class UpdateParamsPaymentDetailsFlight(TypedDict): """ The individual flight segments associated with the trip. """ - ticket_number: NotRequired["str"] + ticket_number: NotRequired[str] """ The ticket number associated with the travel reservation. """ @@ -1328,7 +1353,7 @@ class UpdateParamsPaymentDetailsFlightAffiliate(TypedDict): """ class UpdateParamsPaymentDetailsFlightDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -1340,15 +1365,15 @@ class UpdateParamsPaymentDetailsFlightDelivery(TypedDict): """ class UpdateParamsPaymentDetailsFlightDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -1360,19 +1385,19 @@ class UpdateParamsPaymentDetailsFlightPassenger(TypedDict): """ class UpdateParamsPaymentDetailsFlightSegment(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The flight segment amount. """ - arrival_airport: NotRequired["str"] + arrival_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the arrival airport. """ - arrives_at: NotRequired["int"] + arrives_at: NotRequired[int] """ The arrival time for the flight segment. Measured in seconds since the Unix epoch. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment. """ @@ -1380,16 +1405,16 @@ class UpdateParamsPaymentDetailsFlightSegment(TypedDict): """ The departure time for the flight segment. Measured in seconds since the Unix epoch. """ - departure_airport: NotRequired["str"] + departure_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the departure airport. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number associated with the segment """ service_class: NotRequired[ - "Literal['business', 'economy', 'first', 'premium_economy']" + Literal["business", "economy", "first", "premium_economy"] ] """ The fare class for the segment. @@ -1402,7 +1427,7 @@ class UpdateParamsPaymentDetailsLodging(TypedDict): """ The lodging location's address. """ - adults: NotRequired["int"] + adults: NotRequired[int] """ The number of adults on the booking """ @@ -1412,11 +1437,11 @@ class UpdateParamsPaymentDetailsLodging(TypedDict): """ Affiliate details for this purchase. """ - booking_number: NotRequired["str"] + booking_number: NotRequired[str] """ The booking number associated with the lodging reservation. """ - category: NotRequired["Literal['hotel', 'vacation_rental']"] + category: NotRequired[Literal["hotel", "vacation_rental"]] """ The lodging category """ @@ -1428,11 +1453,11 @@ class UpdateParamsPaymentDetailsLodging(TypedDict): """ Lodging check-out time. Measured in seconds since the Unix epoch. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the lodging company. """ - daily_room_rate_amount: NotRequired["int"] + daily_room_rate_amount: NotRequired[int] """ The daily lodging room rate. """ @@ -1443,76 +1468,85 @@ class UpdateParamsPaymentDetailsLodging(TypedDict): Delivery details for this purchase. """ extra_charges: NotRequired[ - "List[Literal['gift_shop', 'laundry', 'mini_bar', 'other', 'restaurant', 'telephone']]" + List[ + Literal[ + "gift_shop", + "laundry", + "mini_bar", + "other", + "restaurant", + "telephone", + ] + ] ] """ List of additional charges being billed. """ - fire_safety_act_compliance: NotRequired["bool"] + fire_safety_act_compliance: NotRequired[bool] """ Indicates whether the lodging location is compliant with the Fire Safety Act. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the lodging location. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep their booking while failing to cancel the reservation. """ - number_of_rooms: NotRequired["int"] + number_of_rooms: NotRequired[int] """ The number of rooms on the booking """ passengers: NotRequired[ - "List[ChargeService.UpdateParamsPaymentDetailsLodgingPassenger]" + List["ChargeService.UpdateParamsPaymentDetailsLodgingPassenger"] ] """ The details of the passengers in the travel reservation """ - property_phone_number: NotRequired["str"] + property_phone_number: NotRequired[str] """ The phone number of the lodging location. """ - room_class: NotRequired["str"] + room_class: NotRequired[str] """ The room class for this purchase. """ - room_nights: NotRequired["int"] + room_nights: NotRequired[int] """ The number of room nights """ - total_room_tax_amount: NotRequired["int"] + total_room_tax_amount: NotRequired[int] """ The total tax amount associating with the room reservation. """ - total_tax_amount: NotRequired["int"] + total_tax_amount: NotRequired[int] """ The total tax amount """ class UpdateParamsPaymentDetailsLodgingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1524,7 +1558,7 @@ class UpdateParamsPaymentDetailsLodgingAffiliate(TypedDict): """ class UpdateParamsPaymentDetailsLodgingDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -1536,15 +1570,15 @@ class UpdateParamsPaymentDetailsLodgingDelivery(TypedDict): """ class UpdateParamsPaymentDetailsLodgingDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -1562,7 +1596,7 @@ class UpdateParamsPaymentDetailsSubscription(TypedDict): """ Affiliate details for this purchase. """ - auto_renewal: NotRequired["bool"] + auto_renewal: NotRequired[bool] """ Info whether the subscription will be auto renewed upon expiry. """ @@ -1572,7 +1606,7 @@ class UpdateParamsPaymentDetailsSubscription(TypedDict): """ Subscription billing details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Subscription end time. Measured in seconds since the Unix epoch. """ @@ -1580,7 +1614,7 @@ class UpdateParamsPaymentDetailsSubscription(TypedDict): """ Name of the product on subscription. e.g. Apple Music Subscription """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Subscription start time. Measured in seconds since the Unix epoch. """ @@ -1606,7 +1640,7 @@ class UpdateParamsShipping(TypedDict): """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ @@ -1614,37 +1648,37 @@ class UpdateParamsShipping(TypedDict): """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class UpdateParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ diff --git a/stripe/_confirmation_token.py b/stripe/_confirmation_token.py index 41f2da168..1a3514b65 100644 --- a/stripe/_confirmation_token.py +++ b/stripe/_confirmation_token.py @@ -1217,11 +1217,11 @@ class Address(StripeObject): _inner_class_types = {"address": Address} class CreateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ ID of an existing PaymentMethod. """ @@ -1231,11 +1231,11 @@ class CreateParams(RequestOptions): """ If provided, this hash will be used to create a PaymentMethod. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ Return URL used to confirm the Intent. """ - setup_future_usage: NotRequired["Literal['off_session', 'on_session']"] + setup_future_usage: NotRequired[Literal["off_session", "on_session"]] """ Indicates that you intend to make future payments with this ConfirmationToken's payment method. @@ -1369,7 +1369,7 @@ class CreateParamsPaymentMethodData(TypedDict): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -1551,11 +1551,11 @@ class CreateParamsPaymentMethodDataAuBecsDebit(TypedDict): """ class CreateParamsPaymentMethodDataBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -1584,27 +1584,27 @@ class CreateParamsPaymentMethodDataBillingDetails(TypedDict): """ class CreateParamsPaymentMethodDataBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1626,14 +1626,43 @@ class CreateParamsPaymentMethodDataCustomerBalance(TypedDict): class CreateParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class CreateParamsPaymentMethodDataFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -1673,7 +1702,24 @@ class CreateParamsPaymentMethodDataGrabpay(TypedDict): class CreateParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -1721,7 +1767,34 @@ class CreateParamsPaymentMethodDataOxxo(TypedDict): class CreateParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -1734,15 +1807,15 @@ class CreateParamsPaymentMethodDataPaypal(TypedDict): pass class CreateParamsPaymentMethodDataPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -1754,7 +1827,7 @@ class CreateParamsPaymentMethodDataPromptpay(TypedDict): pass class CreateParamsPaymentMethodDataRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -1781,23 +1854,23 @@ class CreateParamsPaymentMethodDataTwint(TypedDict): pass class CreateParamsPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -1823,33 +1896,33 @@ class CreateParamsShipping(TypedDict): """ class CreateParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_confirmation_token_service.py b/stripe/_confirmation_token_service.py index 70a7e3c43..c26ce0038 100644 --- a/stripe/_confirmation_token_service.py +++ b/stripe/_confirmation_token_service.py @@ -10,7 +10,7 @@ class ConfirmationTokenService(StripeService): class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_country_spec.py b/stripe/_country_spec.py index 95b8b386f..15c4886ba 100644 --- a/stripe/_country_spec.py +++ b/stripe/_country_spec.py @@ -46,25 +46,25 @@ class Individual(StripeObject): _inner_class_types = {"company": Company, "individual": Individual} class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_country_spec_service.py b/stripe/_country_spec_service.py index 0ee0b32bb..dbaa2b77b 100644 --- a/stripe/_country_spec_service.py +++ b/stripe/_country_spec_service.py @@ -11,25 +11,25 @@ class CountrySpecService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_coupon.py b/stripe/_coupon.py index 3a970186a..3e8d9edc3 100644 --- a/stripe/_coupon.py +++ b/stripe/_coupon.py @@ -39,7 +39,7 @@ class CurrencyOptions(StripeObject): """ class CreateParams(RequestOptions): - amount_off: NotRequired["int"] + amount_off: NotRequired[int] """ A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed). """ @@ -47,35 +47,35 @@ class CreateParams(RequestOptions): """ A hash containing directions for what this Coupon will apply discounts to. """ - currency: NotRequired["str"] + 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, Coupon.CreateParamsCurrencyOptions]" + Dict[str, "Coupon.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', 'variable']" + Literal["forever", "once", "repeating", "variable"] ] """ Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`. """ - duration_in_months: NotRequired["int"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - id: NotRequired["str"] + 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"] + 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. """ @@ -83,21 +83,21 @@ class CreateParams(RequestOptions): """ 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: 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"] + 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"] + 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]"] + products: NotRequired[List[str]] """ An array of Product IDs that this Coupon will apply to. """ @@ -116,49 +116,49 @@ class ListParams(RequestOptions): """ 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"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): currency_options: NotRequired[ - "Dict[str, Coupon.ModifyParamsCurrencyOptions]" + Dict[str, "Coupon.ModifyParamsCurrencyOptions"] ] """ 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -166,7 +166,7 @@ class ModifyParams(RequestOptions): """ 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: 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. """ @@ -178,7 +178,7 @@ class ModifyParamsCurrencyOptions(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_coupon_service.py b/stripe/_coupon_service.py index 6b74c1cb8..9b2096aee 100644 --- a/stripe/_coupon_service.py +++ b/stripe/_coupon_service.py @@ -11,7 +11,7 @@ class CouponService(StripeService): class CreateParams(TypedDict): - amount_off: NotRequired["int"] + amount_off: NotRequired[int] """ A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed). """ @@ -19,35 +19,35 @@ class CreateParams(TypedDict): """ A hash containing directions for what this Coupon will apply discounts to. """ - currency: NotRequired["str"] + 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]" + 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', 'variable']" + Literal["forever", "once", "repeating", "variable"] ] """ Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`. """ - duration_in_months: NotRequired["int"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - id: NotRequired["str"] + 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"] + 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. """ @@ -55,21 +55,21 @@ class CreateParams(TypedDict): """ 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: 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"] + 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"] + 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]"] + products: NotRequired[List[str]] """ An array of Product IDs that this Coupon will apply to. """ @@ -88,55 +88,55 @@ class ListParams(TypedDict): """ 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"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): currency_options: NotRequired[ - "Dict[str, CouponService.UpdateParamsCurrencyOptions]" + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -144,7 +144,7 @@ class UpdateParams(TypedDict): """ 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: 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. """ diff --git a/stripe/_credit_note.py b/stripe/_credit_note.py index 01cc7fb83..6c061a72e 100644 --- a/stripe/_credit_note.py +++ b/stripe/_credit_note.py @@ -165,19 +165,19 @@ class TaxAmount(StripeObject): """ class CreateParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the total amount of the credit note. """ - credit_amount: NotRequired["int"] + credit_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. """ - effective_at: NotRequired["int"] + effective_at: NotRequired[int] """ The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -185,37 +185,42 @@ class CreateParams(RequestOptions): """ ID of the invoice. """ - lines: NotRequired["List[CreditNote.CreateParamsLine]"] + lines: NotRequired[List["CreditNote.CreateParamsLine"]] """ Line items that make up the credit note. """ - memo: NotRequired["str"] + memo: NotRequired[str] """ The credit note's memo appears on the credit note PDF. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - out_of_band_amount: NotRequired["int"] + out_of_band_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe. """ reason: NotRequired[ - "Literal['duplicate', 'fraudulent', 'order_change', 'product_unsatisfactory']" + Literal[ + "duplicate", + "fraudulent", + "order_change", + "product_unsatisfactory", + ] ] """ Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` """ - refund: NotRequired["str"] + refund: NotRequired[str] """ ID of an existing refund to link this credit note to. """ - refund_amount: NotRequired["int"] + refund_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. """ - refunds: NotRequired["List[CreditNote.CreateParamsRefund]"] + refunds: NotRequired[List["CreditNote.CreateParamsRefund"]] """ Refunds to link to this credit note. """ @@ -225,19 +230,19 @@ class CreateParams(RequestOptions): """ class CreateParamsLine(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The line item amount to credit. Only valid when `type` is `invoice_line_item`. """ - description: NotRequired["str"] + description: NotRequired[str] """ The description of the credit note line item. Only valid when the `type` is `custom_line_item`. """ - invoice_line_item: NotRequired["str"] + invoice_line_item: NotRequired[str] """ The invoice line item to credit. Only valid when the `type` is `invoice_line_item`. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The line item quantity to credit. """ @@ -255,11 +260,11 @@ class CreateParamsLine(TypedDict): """ Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -279,7 +284,7 @@ class CreateParamsLineTaxAmount(TypedDict): """ class CreateParamsRefund(TypedDict): - amount_refunded: NotRequired["int"] + amount_refunded: NotRequired[int] """ Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount. """ @@ -289,25 +294,25 @@ class CreateParamsRefund(TypedDict): """ class CreateParamsShippingCost(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the shipping rate to use for this order. """ class ListLinesParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ @@ -317,81 +322,81 @@ class ListParams(RequestOptions): """ Only return credit notes that were created during the given date interval. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return credit notes for the customer specified by this customer ID. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - invoice: NotRequired["str"] + invoice: NotRequired[str] """ Only return credit notes for the invoice specified by this invoice ID. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - memo: NotRequired["str"] + memo: NotRequired[str] """ Credit note memo. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ class PreviewLinesParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the total amount of the credit note. """ - credit_amount: NotRequired["int"] + credit_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. """ - effective_at: NotRequired["int"] + effective_at: NotRequired[int] """ The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -399,41 +404,46 @@ class PreviewLinesParams(RequestOptions): """ ID of the invoice. """ - limit: NotRequired["int"] + 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. """ - lines: NotRequired["List[CreditNote.PreviewLinesParamsLine]"] + lines: NotRequired[List["CreditNote.PreviewLinesParamsLine"]] """ Line items that make up the credit note. """ - memo: NotRequired["str"] + memo: NotRequired[str] """ The credit note's memo appears on the credit note PDF. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - out_of_band_amount: NotRequired["int"] + out_of_band_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe. """ reason: NotRequired[ - "Literal['duplicate', 'fraudulent', 'order_change', 'product_unsatisfactory']" + Literal[ + "duplicate", + "fraudulent", + "order_change", + "product_unsatisfactory", + ] ] """ Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` """ - refund: NotRequired["str"] + refund: NotRequired[str] """ ID of an existing refund to link this credit note to. """ - refund_amount: NotRequired["int"] + refund_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. """ - refunds: NotRequired["List[CreditNote.PreviewLinesParamsRefund]"] + refunds: NotRequired[List["CreditNote.PreviewLinesParamsRefund"]] """ Refunds to link to this credit note. """ @@ -441,25 +451,25 @@ class PreviewLinesParams(RequestOptions): """ When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. """ - starting_after: NotRequired["str"] + 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 PreviewLinesParamsLine(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The line item amount to credit. Only valid when `type` is `invoice_line_item`. """ - description: NotRequired["str"] + description: NotRequired[str] """ The description of the credit note line item. Only valid when the `type` is `custom_line_item`. """ - invoice_line_item: NotRequired["str"] + invoice_line_item: NotRequired[str] """ The invoice line item to credit. Only valid when the `type` is `invoice_line_item`. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The line item quantity to credit. """ @@ -477,11 +487,11 @@ class PreviewLinesParamsLine(TypedDict): """ Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -501,7 +511,7 @@ class PreviewLinesParamsLineTaxAmount(TypedDict): """ class PreviewLinesParamsRefund(TypedDict): - amount_refunded: NotRequired["int"] + amount_refunded: NotRequired[int] """ Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount. """ @@ -511,25 +521,25 @@ class PreviewLinesParamsRefund(TypedDict): """ class PreviewLinesParamsShippingCost(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the shipping rate to use for this order. """ class PreviewParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the total amount of the credit note. """ - credit_amount: NotRequired["int"] + credit_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. """ - effective_at: NotRequired["int"] + effective_at: NotRequired[int] """ The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -537,37 +547,42 @@ class PreviewParams(RequestOptions): """ ID of the invoice. """ - lines: NotRequired["List[CreditNote.PreviewParamsLine]"] + lines: NotRequired[List["CreditNote.PreviewParamsLine"]] """ Line items that make up the credit note. """ - memo: NotRequired["str"] + memo: NotRequired[str] """ The credit note's memo appears on the credit note PDF. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - out_of_band_amount: NotRequired["int"] + out_of_band_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe. """ reason: NotRequired[ - "Literal['duplicate', 'fraudulent', 'order_change', 'product_unsatisfactory']" + Literal[ + "duplicate", + "fraudulent", + "order_change", + "product_unsatisfactory", + ] ] """ Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` """ - refund: NotRequired["str"] + refund: NotRequired[str] """ ID of an existing refund to link this credit note to. """ - refund_amount: NotRequired["int"] + refund_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. """ - refunds: NotRequired["List[CreditNote.PreviewParamsRefund]"] + refunds: NotRequired[List["CreditNote.PreviewParamsRefund"]] """ Refunds to link to this credit note. """ @@ -577,19 +592,19 @@ class PreviewParams(RequestOptions): """ class PreviewParamsLine(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The line item amount to credit. Only valid when `type` is `invoice_line_item`. """ - description: NotRequired["str"] + description: NotRequired[str] """ The description of the credit note line item. Only valid when the `type` is `custom_line_item`. """ - invoice_line_item: NotRequired["str"] + invoice_line_item: NotRequired[str] """ The invoice line item to credit. Only valid when the `type` is `invoice_line_item`. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The line item quantity to credit. """ @@ -607,11 +622,11 @@ class PreviewParamsLine(TypedDict): """ Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -631,7 +646,7 @@ class PreviewParamsLineTaxAmount(TypedDict): """ class PreviewParamsRefund(TypedDict): - amount_refunded: NotRequired["int"] + amount_refunded: NotRequired[int] """ Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount. """ @@ -641,19 +656,19 @@ class PreviewParamsRefund(TypedDict): """ class PreviewParamsShippingCost(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the shipping rate to use for this order. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class VoidCreditNoteParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_credit_note_line_item_service.py b/stripe/_credit_note_line_item_service.py index 692f99fec..2baa2f65f 100644 --- a/stripe/_credit_note_line_item_service.py +++ b/stripe/_credit_note_line_item_service.py @@ -11,19 +11,19 @@ class CreditNoteLineItemService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/_credit_note_preview_lines_service.py b/stripe/_credit_note_preview_lines_service.py index 36f9297a5..6e6fdf12d 100644 --- a/stripe/_credit_note_preview_lines_service.py +++ b/stripe/_credit_note_preview_lines_service.py @@ -10,23 +10,23 @@ class CreditNotePreviewLinesService(StripeService): class ListParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the total amount of the credit note. """ - credit_amount: NotRequired["int"] + credit_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. """ - effective_at: NotRequired["int"] + effective_at: NotRequired[int] """ The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -34,44 +34,49 @@ class ListParams(TypedDict): """ ID of the invoice. """ - limit: NotRequired["int"] + 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. """ lines: NotRequired[ - "List[CreditNotePreviewLinesService.ListParamsLine]" + List["CreditNotePreviewLinesService.ListParamsLine"] ] """ Line items that make up the credit note. """ - memo: NotRequired["str"] + memo: NotRequired[str] """ The credit note's memo appears on the credit note PDF. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - out_of_band_amount: NotRequired["int"] + out_of_band_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe. """ reason: NotRequired[ - "Literal['duplicate', 'fraudulent', 'order_change', 'product_unsatisfactory']" + Literal[ + "duplicate", + "fraudulent", + "order_change", + "product_unsatisfactory", + ] ] """ Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` """ - refund: NotRequired["str"] + refund: NotRequired[str] """ ID of an existing refund to link this credit note to. """ - refund_amount: NotRequired["int"] + refund_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. """ refunds: NotRequired[ - "List[CreditNotePreviewLinesService.ListParamsRefund]" + List["CreditNotePreviewLinesService.ListParamsRefund"] ] """ Refunds to link to this credit note. @@ -82,25 +87,25 @@ class ListParams(TypedDict): """ When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. """ - starting_after: NotRequired["str"] + 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 ListParamsLine(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The line item amount to credit. Only valid when `type` is `invoice_line_item`. """ - description: NotRequired["str"] + description: NotRequired[str] """ The description of the credit note line item. Only valid when the `type` is `custom_line_item`. """ - invoice_line_item: NotRequired["str"] + invoice_line_item: NotRequired[str] """ The invoice line item to credit. Only valid when the `type` is `invoice_line_item`. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The line item quantity to credit. """ @@ -118,11 +123,11 @@ class ListParamsLine(TypedDict): """ Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -142,7 +147,7 @@ class ListParamsLineTaxAmount(TypedDict): """ class ListParamsRefund(TypedDict): - amount_refunded: NotRequired["int"] + amount_refunded: NotRequired[int] """ Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount. """ @@ -152,7 +157,7 @@ class ListParamsRefund(TypedDict): """ class ListParamsShippingCost(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the shipping rate to use for this order. """ diff --git a/stripe/_credit_note_service.py b/stripe/_credit_note_service.py index 79137ba71..3b8780848 100644 --- a/stripe/_credit_note_service.py +++ b/stripe/_credit_note_service.py @@ -20,19 +20,19 @@ def __init__(self, requestor): self.preview_lines = CreditNotePreviewLinesService(self._requestor) class CreateParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the total amount of the credit note. """ - credit_amount: NotRequired["int"] + credit_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. """ - effective_at: NotRequired["int"] + effective_at: NotRequired[int] """ The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -40,37 +40,42 @@ class CreateParams(TypedDict): """ ID of the invoice. """ - lines: NotRequired["List[CreditNoteService.CreateParamsLine]"] + lines: NotRequired[List["CreditNoteService.CreateParamsLine"]] """ Line items that make up the credit note. """ - memo: NotRequired["str"] + memo: NotRequired[str] """ The credit note's memo appears on the credit note PDF. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - out_of_band_amount: NotRequired["int"] + out_of_band_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe. """ reason: NotRequired[ - "Literal['duplicate', 'fraudulent', 'order_change', 'product_unsatisfactory']" + Literal[ + "duplicate", + "fraudulent", + "order_change", + "product_unsatisfactory", + ] ] """ Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` """ - refund: NotRequired["str"] + refund: NotRequired[str] """ ID of an existing refund to link this credit note to. """ - refund_amount: NotRequired["int"] + refund_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. """ - refunds: NotRequired["List[CreditNoteService.CreateParamsRefund]"] + refunds: NotRequired[List["CreditNoteService.CreateParamsRefund"]] """ Refunds to link to this credit note. """ @@ -82,19 +87,19 @@ class CreateParams(TypedDict): """ class CreateParamsLine(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The line item amount to credit. Only valid when `type` is `invoice_line_item`. """ - description: NotRequired["str"] + description: NotRequired[str] """ The description of the credit note line item. Only valid when the `type` is `custom_line_item`. """ - invoice_line_item: NotRequired["str"] + invoice_line_item: NotRequired[str] """ The invoice line item to credit. Only valid when the `type` is `invoice_line_item`. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The line item quantity to credit. """ @@ -112,11 +117,11 @@ class CreateParamsLine(TypedDict): """ Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -136,7 +141,7 @@ class CreateParamsLineTaxAmount(TypedDict): """ class CreateParamsRefund(TypedDict): - amount_refunded: NotRequired["int"] + amount_refunded: NotRequired[int] """ Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount. """ @@ -146,7 +151,7 @@ class CreateParamsRefund(TypedDict): """ class CreateParamsShippingCost(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the shipping rate to use for this order. """ @@ -156,63 +161,63 @@ class ListParams(TypedDict): """ Only return credit notes that were created during the given date interval. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return credit notes for the customer specified by this customer ID. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - invoice: NotRequired["str"] + invoice: NotRequired[str] """ Only return credit notes for the invoice specified by this invoice ID. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class PreviewParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the total amount of the credit note. """ - credit_amount: NotRequired["int"] + credit_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. """ - effective_at: NotRequired["int"] + effective_at: NotRequired[int] """ The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -220,37 +225,42 @@ class PreviewParams(TypedDict): """ ID of the invoice. """ - lines: NotRequired["List[CreditNoteService.PreviewParamsLine]"] + lines: NotRequired[List["CreditNoteService.PreviewParamsLine"]] """ Line items that make up the credit note. """ - memo: NotRequired["str"] + memo: NotRequired[str] """ The credit note's memo appears on the credit note PDF. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - out_of_band_amount: NotRequired["int"] + out_of_band_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe. """ reason: NotRequired[ - "Literal['duplicate', 'fraudulent', 'order_change', 'product_unsatisfactory']" + Literal[ + "duplicate", + "fraudulent", + "order_change", + "product_unsatisfactory", + ] ] """ Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` """ - refund: NotRequired["str"] + refund: NotRequired[str] """ ID of an existing refund to link this credit note to. """ - refund_amount: NotRequired["int"] + refund_amount: NotRequired[int] """ The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. """ - refunds: NotRequired["List[CreditNoteService.PreviewParamsRefund]"] + refunds: NotRequired[List["CreditNoteService.PreviewParamsRefund"]] """ Refunds to link to this credit note. """ @@ -262,19 +272,19 @@ class PreviewParams(TypedDict): """ class PreviewParamsLine(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The line item amount to credit. Only valid when `type` is `invoice_line_item`. """ - description: NotRequired["str"] + description: NotRequired[str] """ The description of the credit note line item. Only valid when the `type` is `custom_line_item`. """ - invoice_line_item: NotRequired["str"] + invoice_line_item: NotRequired[str] """ The invoice line item to credit. Only valid when the `type` is `invoice_line_item`. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The line item quantity to credit. """ @@ -292,11 +302,11 @@ class PreviewParamsLine(TypedDict): """ Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -316,7 +326,7 @@ class PreviewParamsLineTaxAmount(TypedDict): """ class PreviewParamsRefund(TypedDict): - amount_refunded: NotRequired["int"] + amount_refunded: NotRequired[int] """ Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount. """ @@ -326,33 +336,33 @@ class PreviewParamsRefund(TypedDict): """ class PreviewParamsShippingCost(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the shipping rate to use for this order. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - memo: NotRequired["str"] + memo: NotRequired[str] """ Credit note memo. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ class VoidCreditNoteParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_customer.py b/stripe/_customer.py index 098d0f211..99d82d42d 100644 --- a/stripe/_customer.py +++ b/stripe/_customer.py @@ -225,11 +225,11 @@ class CreateBalanceTransactionParams(RequestOptions): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -247,7 +247,7 @@ class CreateFundingInstructionsParams(RequestOptions): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -264,7 +264,7 @@ class CreateFundingInstructionsParamsBankTransfer(TypedDict): Configuration for eu_bank_transfer funding type. """ requested_address_types: NotRequired[ - "List[Literal['iban', 'sort_code', 'spei', 'zengin']]" + List[Literal["iban", "sort_code", "spei", "zengin"]] ] """ List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. @@ -293,7 +293,7 @@ class CreateParams(RequestOptions): """ The customer's address. """ - balance: NotRequired["int"] + balance: NotRequired[int] """ An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. """ @@ -301,20 +301,20 @@ class CreateParams(RequestOptions): """ Balance information and default balance settings for this customer. """ - coupon: NotRequired["str"] - description: NotRequired["str"] + coupon: NotRequired[str] + description: NotRequired[str] """ An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. """ - email: NotRequired["str"] + email: NotRequired[str] """ Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - invoice_prefix: NotRequired["str"] + invoice_prefix: NotRequired[str] """ The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. """ @@ -326,24 +326,24 @@ class CreateParams(RequestOptions): """ 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: NotRequired[str] """ The customer's full name or business name. """ - next_invoice_sequence: NotRequired["int"] + next_invoice_sequence: NotRequired[int] """ The sequence to be used on the customer's next invoice. Defaults to 1. """ - payment_method: NotRequired["str"] - phone: NotRequired["str"] + payment_method: NotRequired[str] + phone: NotRequired[str] """ The customer's phone number. """ - preferred_locales: NotRequired["List[str]"] + preferred_locales: NotRequired[List[str]] """ Customer's preferred languages, ordered by preference. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. """ @@ -351,7 +351,7 @@ class CreateParams(RequestOptions): """ The customer's shipping information. Appears on invoices emailed to this customer. """ - source: NotRequired["str"] + source: NotRequired[str] tax: NotRequired["Customer.CreateParamsTax"] """ Tax details about the customer. @@ -362,38 +362,38 @@ class CreateParams(RequestOptions): """ The customer's tax exemption. One of `none`, `exempt`, or `reverse`. """ - tax_id_data: NotRequired["List[Customer.CreateParamsTaxIdDatum]"] + tax_id_data: NotRequired[List["Customer.CreateParamsTaxIdDatum"]] """ The customer's tax IDs. """ - test_clock: NotRequired["str"] + test_clock: NotRequired[str] """ ID of the test clock to attach to the customer. """ - validate: NotRequired["bool"] + validate: NotRequired[bool] class CreateParamsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -407,7 +407,7 @@ class CreateParamsCashBalance(TypedDict): class CreateParamsCashBalanceSettings(TypedDict): reconciliation_mode: NotRequired[ - "Literal['automatic', 'manual', 'merchant_default']" + Literal["automatic", "manual", "merchant_default"] ] """ Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation). @@ -420,11 +420,11 @@ class CreateParamsInvoiceSettings(TypedDict): """ The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. """ - footer: NotRequired["str"] + footer: NotRequired[str] """ Default footer to be displayed on invoices for this customer. """ @@ -462,33 +462,33 @@ class CreateParamsShipping(TypedDict): """ Customer name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Customer phone (including extension). """ class CreateParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -498,7 +498,7 @@ class CreateParamsTax(TypedDict): """ A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes. """ - validate_location: NotRequired["Literal['deferred', 'immediately']"] + validate_location: NotRequired[Literal["deferred", "immediately"]] """ A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`. """ @@ -582,11 +582,11 @@ class CreateParamsTaxIdDatum(TypedDict): """ class CreateSourceParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -594,10 +594,10 @@ class CreateSourceParams(RequestOptions): """ Please refer to full [documentation](https://stripe.com/docs/api) instead. """ - validate: NotRequired["bool"] + validate: NotRequired[bool] class CreateTaxIdParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -685,7 +685,7 @@ class DeleteParams(RequestOptions): pass class DeleteSourceParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -702,47 +702,47 @@ class FundCashBalanceParams(RequestOptions): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation algorithm](https://stripe.com/docs/payments/customer-balance/reconciliation) applies to different user inputs. """ class ListBalanceTransactionsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 ListCashBalanceTransactionsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ @@ -752,119 +752,157 @@ class ListParams(RequestOptions): """ Only return customers that were created during the given date interval. """ - email: NotRequired["str"] + email: NotRequired[str] """ A case-sensitive filter on the list based on the customer's `email` field. The value must be a string. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - test_clock: NotRequired["str"] + test_clock: NotRequired[str] """ Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListPaymentMethodsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ type: NotRequired[ - "Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'blik', 'boleto', 'card', 'cashapp', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'konbini', 'link', 'mobilepay', 'multibanco', 'oxxo', 'p24', 'paynow', 'paypal', 'payto', 'pix', 'promptpay', 'revolut_pay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']" + Literal[ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "card", + "cashapp", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "konbini", + "link", + "mobilepay", + "multibanco", + "oxxo", + "p24", + "paynow", + "paypal", + "payto", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "us_bank_account", + "wechat_pay", + "zip", + ] ] """ An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. """ class ListSourcesParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - object: NotRequired["str"] + object: NotRequired[str] """ Filter sources according to a particular object type. """ - starting_after: NotRequired["str"] + 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 ListTaxIdsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 ModifyBalanceTransactionParams(RequestOptions): - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -874,7 +912,7 @@ class ModifyBalanceTransactionParams(RequestOptions): """ class ModifyCashBalanceParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -885,7 +923,7 @@ class ModifyCashBalanceParams(RequestOptions): class ModifyCashBalanceParamsSettings(TypedDict): reconciliation_mode: NotRequired[ - "Literal['automatic', 'manual', 'merchant_default']" + Literal["automatic", "manual", "merchant_default"] ] """ Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation). @@ -896,7 +934,7 @@ class ModifyParams(RequestOptions): """ The customer's address. """ - balance: NotRequired["int"] + balance: NotRequired[int] """ An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. """ @@ -904,8 +942,8 @@ class ModifyParams(RequestOptions): """ Balance information and default balance settings for this customer. """ - coupon: NotRequired["str"] - default_source: NotRequired["str"] + coupon: NotRequired[str] + default_source: NotRequired[str] """ If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. @@ -913,19 +951,19 @@ class ModifyParams(RequestOptions): If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. """ - email: NotRequired["str"] + email: NotRequired[str] """ Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - invoice_prefix: NotRequired["str"] + invoice_prefix: NotRequired[str] """ The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. """ @@ -937,23 +975,23 @@ class ModifyParams(RequestOptions): """ 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: NotRequired[str] """ The customer's full name or business name. """ - next_invoice_sequence: NotRequired["int"] + next_invoice_sequence: NotRequired[int] """ The sequence to be used on the customer's next invoice. Defaults to 1. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The customer's phone number. """ - preferred_locales: NotRequired["List[str]"] + preferred_locales: NotRequired[List[str]] """ Customer's preferred languages, ordered by preference. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. """ @@ -961,7 +999,7 @@ class ModifyParams(RequestOptions): """ The customer's shipping information. Appears on invoices emailed to this customer. """ - source: NotRequired["str"] + source: NotRequired[str] tax: NotRequired["Customer.ModifyParamsTax"] """ Tax details about the customer. @@ -972,30 +1010,30 @@ class ModifyParams(RequestOptions): """ The customer's tax exemption. One of `none`, `exempt`, or `reverse`. """ - validate: NotRequired["bool"] + validate: NotRequired[bool] class ModifyParamsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1009,7 +1047,7 @@ class ModifyParamsCashBalance(TypedDict): class ModifyParamsCashBalanceSettings(TypedDict): reconciliation_mode: NotRequired[ - "Literal['automatic', 'manual', 'merchant_default']" + Literal["automatic", "manual", "merchant_default"] ] """ Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation). @@ -1022,11 +1060,11 @@ class ModifyParamsInvoiceSettings(TypedDict): """ The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. """ - footer: NotRequired["str"] + footer: NotRequired[str] """ Default footer to be displayed on invoices for this customer. """ @@ -1064,33 +1102,33 @@ class ModifyParamsShipping(TypedDict): """ Customer name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Customer phone (including extension). """ class ModifyParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1100,53 +1138,53 @@ class ModifyParamsTax(TypedDict): """ A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes. """ - validate_location: NotRequired["Literal['deferred', 'immediately']"] + validate_location: NotRequired[Literal["deferred", "immediately"]] """ A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`. """ class ModifySourceParams(RequestOptions): - account_holder_name: NotRequired["str"] + account_holder_name: NotRequired[str] """ The name of the person or business that owns the bank account. """ - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ The type of entity that holds the account. This can be either `individual` or `company`. """ - address_city: NotRequired["str"] + address_city: NotRequired[str] """ City/District/Suburb/Town/Village. """ - address_country: NotRequired["str"] + address_country: NotRequired[str] """ Billing address country, if provided when creating card. """ - address_line1: NotRequired["str"] + address_line1: NotRequired[str] """ Address line 1 (Street address/PO Box/Company name). """ - address_line2: NotRequired["str"] + address_line2: NotRequired[str] """ Address line 2 (Apartment/Suite/Unit/Building). """ - address_state: NotRequired["str"] + address_state: NotRequired[str] """ State/County/Province/Region. """ - address_zip: NotRequired["str"] + address_zip: NotRequired[str] """ ZIP or postal code. """ - exp_month: NotRequired["str"] + exp_month: NotRequired[str] """ Two digit number representing the card's expiration month. """ - exp_year: NotRequired["str"] + exp_year: NotRequired[str] """ Four digit number representing the card's expiration year. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1154,7 +1192,7 @@ class ModifySourceParams(RequestOptions): """ 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: NotRequired[str] """ Cardholder name. """ @@ -1165,97 +1203,97 @@ class ModifySourceParamsOwner(TypedDict): """ Owner's address. """ - email: NotRequired["str"] + email: NotRequired[str] """ Owner's email address. """ - name: NotRequired["str"] + name: NotRequired[str] """ Owner's full name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Owner's phone number. """ class ModifySourceParamsOwnerAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class RetrieveBalanceTransactionParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveCashBalanceParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveCashBalanceTransactionParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrievePaymentMethodParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveSourceParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveTaxIdParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SearchParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - page: NotRequired["str"] + page: NotRequired[str] """ A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. """ diff --git a/stripe/_customer_balance_transaction_service.py b/stripe/_customer_balance_transaction_service.py index 276729ee8..20291adac 100644 --- a/stripe/_customer_balance_transaction_service.py +++ b/stripe/_customer_balance_transaction_service.py @@ -19,11 +19,11 @@ class CreateParams(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -33,35 +33,35 @@ class CreateParams(TypedDict): """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_customer_cash_balance_service.py b/stripe/_customer_cash_balance_service.py index 6f12d71c5..5d50a3302 100644 --- a/stripe/_customer_cash_balance_service.py +++ b/stripe/_customer_cash_balance_service.py @@ -10,13 +10,13 @@ class CustomerCashBalanceService(StripeService): class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -29,7 +29,7 @@ class UpdateParams(TypedDict): class UpdateParamsSettings(TypedDict): reconciliation_mode: NotRequired[ - "Literal['automatic', 'manual', 'merchant_default']" + Literal["automatic", "manual", "merchant_default"] ] """ Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation). diff --git a/stripe/_customer_cash_balance_transaction_service.py b/stripe/_customer_cash_balance_transaction_service.py index 107203b69..5e8a8bbb1 100644 --- a/stripe/_customer_cash_balance_transaction_service.py +++ b/stripe/_customer_cash_balance_transaction_service.py @@ -13,25 +13,25 @@ class CustomerCashBalanceTransactionService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_customer_funding_instructions_service.py b/stripe/_customer_funding_instructions_service.py index 27c7520f0..b397991a2 100644 --- a/stripe/_customer_funding_instructions_service.py +++ b/stripe/_customer_funding_instructions_service.py @@ -18,7 +18,7 @@ class CreateParams(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -35,7 +35,7 @@ class CreateParamsBankTransfer(TypedDict): Configuration for eu_bank_transfer funding type. """ requested_address_types: NotRequired[ - "List[Literal['iban', 'sort_code', 'spei', 'zengin']]" + List[Literal["iban", "sort_code", "spei", "zengin"]] ] """ List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. diff --git a/stripe/_customer_payment_method_service.py b/stripe/_customer_payment_method_service.py index b9eb3e059..c5e963927 100644 --- a/stripe/_customer_payment_method_service.py +++ b/stripe/_customer_payment_method_service.py @@ -11,31 +11,69 @@ class CustomerPaymentMethodService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ type: NotRequired[ - "Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'blik', 'boleto', 'card', 'cashapp', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'konbini', 'link', 'mobilepay', 'multibanco', 'oxxo', 'p24', 'paynow', 'paypal', 'payto', 'pix', 'promptpay', 'revolut_pay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']" + Literal[ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "card", + "cashapp", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "konbini", + "link", + "mobilepay", + "multibanco", + "oxxo", + "p24", + "paynow", + "paypal", + "payto", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "us_bank_account", + "wechat_pay", + "zip", + ] ] """ An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_customer_payment_source_service.py b/stripe/_customer_payment_source_service.py index 441b504a1..0c70b7de2 100644 --- a/stripe/_customer_payment_source_service.py +++ b/stripe/_customer_payment_source_service.py @@ -14,11 +14,11 @@ class CustomerPaymentSourceService(StripeService): class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -26,84 +26,84 @@ class CreateParams(TypedDict): """ Please refer to full [documentation](https://stripe.com/docs/api) instead. """ - validate: NotRequired["bool"] + validate: NotRequired[bool] class DeleteParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - object: NotRequired["str"] + object: NotRequired[str] """ Filter sources according to a particular object type. """ - starting_after: NotRequired["str"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - account_holder_name: NotRequired["str"] + account_holder_name: NotRequired[str] """ The name of the person or business that owns the bank account. """ - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ The type of entity that holds the account. This can be either `individual` or `company`. """ - address_city: NotRequired["str"] + address_city: NotRequired[str] """ City/District/Suburb/Town/Village. """ - address_country: NotRequired["str"] + address_country: NotRequired[str] """ Billing address country, if provided when creating card. """ - address_line1: NotRequired["str"] + address_line1: NotRequired[str] """ Address line 1 (Street address/PO Box/Company name). """ - address_line2: NotRequired["str"] + address_line2: NotRequired[str] """ Address line 2 (Apartment/Suite/Unit/Building). """ - address_state: NotRequired["str"] + address_state: NotRequired[str] """ State/County/Province/Region. """ - address_zip: NotRequired["str"] + address_zip: NotRequired[str] """ ZIP or postal code. """ - exp_month: NotRequired["str"] + exp_month: NotRequired[str] """ Two digit number representing the card's expiration month. """ - exp_year: NotRequired["str"] + exp_year: NotRequired[str] """ Four digit number representing the card's expiration year. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -111,7 +111,7 @@ class UpdateParams(TypedDict): """ 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: NotRequired[str] """ Cardholder name. """ @@ -124,51 +124,51 @@ class UpdateParamsOwner(TypedDict): """ Owner's address. """ - email: NotRequired["str"] + email: NotRequired[str] """ Owner's email address. """ - name: NotRequired["str"] + name: NotRequired[str] """ Owner's full name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Owner's phone number. """ class UpdateParamsOwnerAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class VerifyParams(TypedDict): - amounts: NotRequired["List[int]"] + amounts: NotRequired[List[int]] """ Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_customer_service.py b/stripe/_customer_service.py index c72436997..5bc91e415 100644 --- a/stripe/_customer_service.py +++ b/stripe/_customer_service.py @@ -50,7 +50,7 @@ class CreateParams(TypedDict): """ The customer's address. """ - balance: NotRequired["int"] + balance: NotRequired[int] """ An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. """ @@ -58,20 +58,20 @@ class CreateParams(TypedDict): """ Balance information and default balance settings for this customer. """ - coupon: NotRequired["str"] - description: NotRequired["str"] + coupon: NotRequired[str] + description: NotRequired[str] """ An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. """ - email: NotRequired["str"] + email: NotRequired[str] """ Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - invoice_prefix: NotRequired["str"] + invoice_prefix: NotRequired[str] """ The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. """ @@ -85,24 +85,24 @@ class CreateParams(TypedDict): """ 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: NotRequired[str] """ The customer's full name or business name. """ - next_invoice_sequence: NotRequired["int"] + next_invoice_sequence: NotRequired[int] """ The sequence to be used on the customer's next invoice. Defaults to 1. """ - payment_method: NotRequired["str"] - phone: NotRequired["str"] + payment_method: NotRequired[str] + phone: NotRequired[str] """ The customer's phone number. """ - preferred_locales: NotRequired["List[str]"] + preferred_locales: NotRequired[List[str]] """ Customer's preferred languages, ordered by preference. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. """ @@ -112,7 +112,7 @@ class CreateParams(TypedDict): """ The customer's shipping information. Appears on invoices emailed to this customer. """ - source: NotRequired["str"] + source: NotRequired[str] tax: NotRequired["CustomerService.CreateParamsTax"] """ Tax details about the customer. @@ -124,39 +124,39 @@ class CreateParams(TypedDict): The customer's tax exemption. One of `none`, `exempt`, or `reverse`. """ tax_id_data: NotRequired[ - "List[CustomerService.CreateParamsTaxIdDatum]" + List["CustomerService.CreateParamsTaxIdDatum"] ] """ The customer's tax IDs. """ - test_clock: NotRequired["str"] + test_clock: NotRequired[str] """ ID of the test clock to attach to the customer. """ - validate: NotRequired["bool"] + validate: NotRequired[bool] class CreateParamsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -172,7 +172,7 @@ class CreateParamsCashBalance(TypedDict): class CreateParamsCashBalanceSettings(TypedDict): reconciliation_mode: NotRequired[ - "Literal['automatic', 'manual', 'merchant_default']" + Literal["automatic", "manual", "merchant_default"] ] """ Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation). @@ -185,11 +185,11 @@ class CreateParamsInvoiceSettings(TypedDict): """ The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. """ - footer: NotRequired["str"] + footer: NotRequired[str] """ Default footer to be displayed on invoices for this customer. """ @@ -227,33 +227,33 @@ class CreateParamsShipping(TypedDict): """ Customer name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Customer phone (including extension). """ class CreateParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -263,7 +263,7 @@ class CreateParamsTax(TypedDict): """ A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes. """ - validate_location: NotRequired["Literal['deferred', 'immediately']"] + validate_location: NotRequired[Literal["deferred", "immediately"]] """ A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`. """ @@ -357,65 +357,65 @@ class ListParams(TypedDict): """ Only return customers that were created during the given date interval. """ - email: NotRequired["str"] + email: NotRequired[str] """ A case-sensitive filter on the list based on the customer's `email` field. The value must be a string. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - test_clock: NotRequired["str"] + test_clock: NotRequired[str] """ Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SearchParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - page: NotRequired["str"] + page: NotRequired[str] """ A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. """ @@ -429,7 +429,7 @@ class UpdateParams(TypedDict): """ The customer's address. """ - balance: NotRequired["int"] + balance: NotRequired[int] """ An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. """ @@ -437,8 +437,8 @@ class UpdateParams(TypedDict): """ Balance information and default balance settings for this customer. """ - coupon: NotRequired["str"] - default_source: NotRequired["str"] + coupon: NotRequired[str] + default_source: NotRequired[str] """ If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. @@ -446,19 +446,19 @@ class UpdateParams(TypedDict): If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. """ - email: NotRequired["str"] + email: NotRequired[str] """ Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - invoice_prefix: NotRequired["str"] + invoice_prefix: NotRequired[str] """ The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. """ @@ -472,23 +472,23 @@ class UpdateParams(TypedDict): """ 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: NotRequired[str] """ The customer's full name or business name. """ - next_invoice_sequence: NotRequired["int"] + next_invoice_sequence: NotRequired[int] """ The sequence to be used on the customer's next invoice. Defaults to 1. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The customer's phone number. """ - preferred_locales: NotRequired["List[str]"] + preferred_locales: NotRequired[List[str]] """ Customer's preferred languages, ordered by preference. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. """ @@ -498,7 +498,7 @@ class UpdateParams(TypedDict): """ The customer's shipping information. Appears on invoices emailed to this customer. """ - source: NotRequired["str"] + source: NotRequired[str] tax: NotRequired["CustomerService.UpdateParamsTax"] """ Tax details about the customer. @@ -509,30 +509,30 @@ class UpdateParams(TypedDict): """ The customer's tax exemption. One of `none`, `exempt`, or `reverse`. """ - validate: NotRequired["bool"] + validate: NotRequired[bool] class UpdateParamsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -548,7 +548,7 @@ class UpdateParamsCashBalance(TypedDict): class UpdateParamsCashBalanceSettings(TypedDict): reconciliation_mode: NotRequired[ - "Literal['automatic', 'manual', 'merchant_default']" + Literal["automatic", "manual", "merchant_default"] ] """ Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation). @@ -561,11 +561,11 @@ class UpdateParamsInvoiceSettings(TypedDict): """ The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. """ - footer: NotRequired["str"] + footer: NotRequired[str] """ Default footer to be displayed on invoices for this customer. """ @@ -603,33 +603,33 @@ class UpdateParamsShipping(TypedDict): """ Customer name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Customer phone (including extension). """ class UpdateParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -639,7 +639,7 @@ class UpdateParamsTax(TypedDict): """ A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes. """ - validate_location: NotRequired["Literal['deferred', 'immediately']"] + validate_location: NotRequired[Literal["deferred", "immediately"]] """ A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`. """ diff --git a/stripe/_customer_session.py b/stripe/_customer_session.py index 9f98297b5..9aae91f23 100644 --- a/stripe/_customer_session.py +++ b/stripe/_customer_session.py @@ -94,7 +94,7 @@ class CreateParams(RequestOptions): """ The ID of an existing customer for which to create the customer session. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -138,21 +138,21 @@ class CreateParamsComponentsPaymentElement(TypedDict): """ class CreateParamsComponentsPaymentElementFeatures(TypedDict): - payment_method_remove: NotRequired["Literal['disabled', 'enabled']"] + payment_method_remove: NotRequired[Literal["disabled", "enabled"]] """ Controls whether the Payment Element allows the removal of a saved payment method. """ - payment_method_save: NotRequired["Literal['disabled', 'enabled']"] + payment_method_save: NotRequired[Literal["disabled", "enabled"]] """ Controls whether the Payment Element offers to save a new payment method. """ payment_method_set_as_default: NotRequired[ - "Literal['disabled', 'enabled']" + Literal["disabled", "enabled"] ] """ Controls whether the Payment Element offers to set a payment method as the default. """ - payment_method_update: NotRequired["Literal['disabled', 'enabled']"] + payment_method_update: NotRequired[Literal["disabled", "enabled"]] """ Controls whether the Payment Element allows the updating of a saved payment method. """ diff --git a/stripe/_customer_session_service.py b/stripe/_customer_session_service.py index 12a2642c8..bb78a50f5 100644 --- a/stripe/_customer_session_service.py +++ b/stripe/_customer_session_service.py @@ -17,7 +17,7 @@ class CreateParams(TypedDict): """ The ID of an existing customer for which to create the customer session. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -61,21 +61,21 @@ class CreateParamsComponentsPaymentElement(TypedDict): """ class CreateParamsComponentsPaymentElementFeatures(TypedDict): - payment_method_remove: NotRequired["Literal['disabled', 'enabled']"] + payment_method_remove: NotRequired[Literal["disabled", "enabled"]] """ Controls whether the Payment Element allows the removal of a saved payment method. """ - payment_method_save: NotRequired["Literal['disabled', 'enabled']"] + payment_method_save: NotRequired[Literal["disabled", "enabled"]] """ Controls whether the Payment Element offers to save a new payment method. """ payment_method_set_as_default: NotRequired[ - "Literal['disabled', 'enabled']" + Literal["disabled", "enabled"] ] """ Controls whether the Payment Element offers to set a payment method as the default. """ - payment_method_update: NotRequired["Literal['disabled', 'enabled']"] + payment_method_update: NotRequired[Literal["disabled", "enabled"]] """ Controls whether the Payment Element allows the updating of a saved payment method. """ diff --git a/stripe/_customer_tax_id_service.py b/stripe/_customer_tax_id_service.py index 95c9c0fc2..2b89ca5e1 100644 --- a/stripe/_customer_tax_id_service.py +++ b/stripe/_customer_tax_id_service.py @@ -11,7 +11,7 @@ class CustomerTaxIdService(StripeService): class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -96,25 +96,25 @@ class DeleteParams(TypedDict): pass class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_dispute.py b/stripe/_dispute.py index e1e93a129..ddf5098d7 100644 --- a/stripe/_dispute.py +++ b/stripe/_dispute.py @@ -374,52 +374,52 @@ class Card(StripeObject): _inner_class_types = {"card": Card} class CloseParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListParams(RequestOptions): - charge: NotRequired["str"] + charge: NotRequired[str] """ Only return disputes associated to the charge specified by this charge ID. """ created: NotRequired["Dispute.ListParamsCreated|int"] - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - payment_intent: NotRequired["str"] + payment_intent: NotRequired[str] """ Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ @@ -429,7 +429,7 @@ class ModifyParams(RequestOptions): """ Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -437,61 +437,61 @@ class ModifyParams(RequestOptions): """ 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`. """ - submit: NotRequired["bool"] + submit: NotRequired[bool] """ Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). """ class ModifyParamsEvidence(TypedDict): - access_activity_log: NotRequired["str"] + access_activity_log: NotRequired[str] """ Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. Has a maximum character count of 20,000. """ - billing_address: NotRequired["str"] + billing_address: NotRequired[str] """ The billing address provided by the customer. """ - cancellation_policy: NotRequired["str"] + cancellation_policy: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. """ - cancellation_policy_disclosure: NotRequired["str"] + cancellation_policy_disclosure: NotRequired[str] """ An explanation of how and when the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000. """ - cancellation_rebuttal: NotRequired["str"] + cancellation_rebuttal: NotRequired[str] """ A justification for why the customer's subscription was not canceled. Has a maximum character count of 20,000. """ - customer_communication: NotRequired["str"] + customer_communication: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service. """ - customer_email_address: NotRequired["str"] + customer_email_address: NotRequired[str] """ The email address of the customer. """ - customer_name: NotRequired["str"] + customer_name: NotRequired[str] """ The name of the customer. """ - customer_purchase_ip: NotRequired["str"] + customer_purchase_ip: NotRequired[str] """ The IP address that the customer used when making the purchase. """ - customer_signature: NotRequired["str"] + customer_signature: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. """ - duplicate_charge_documentation: NotRequired["str"] + duplicate_charge_documentation: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate. """ - duplicate_charge_explanation: NotRequired["str"] + duplicate_charge_explanation: NotRequired[str] """ An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. Has a maximum character count of 20,000. """ - duplicate_charge_id: NotRequired["str"] + duplicate_charge_id: NotRequired[str] """ The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. """ @@ -501,59 +501,59 @@ class ModifyParamsEvidence(TypedDict): """ Additional evidence for qualifying evidence programs. """ - product_description: NotRequired["str"] + product_description: NotRequired[str] """ A description of the product or service that was sold. Has a maximum character count of 20,000. """ - receipt: NotRequired["str"] + receipt: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge. """ - refund_policy: NotRequired["str"] + refund_policy: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. """ - refund_policy_disclosure: NotRequired["str"] + refund_policy_disclosure: NotRequired[str] """ Documentation demonstrating that the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000. """ - refund_refusal_explanation: NotRequired["str"] + refund_refusal_explanation: NotRequired[str] """ A justification for why the customer is not entitled to a refund. Has a maximum character count of 20,000. """ - service_date: NotRequired["str"] + service_date: NotRequired[str] """ The date on which the customer received or began receiving the purchased service, in a clear human-readable format. """ - service_documentation: NotRequired["str"] + service_documentation: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement. """ - shipping_address: NotRequired["str"] + shipping_address: NotRequired[str] """ The address to which a physical product was shipped. You should try to include as complete address information as possible. """ - shipping_carrier: NotRequired["str"] + shipping_carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas. """ - shipping_date: NotRequired["str"] + shipping_date: NotRequired[str] """ The date on which a physical product began its route to the shipping address, in a clear human-readable format. """ - shipping_documentation: NotRequired["str"] + shipping_documentation: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible. """ - shipping_tracking_number: NotRequired["str"] + shipping_tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ - uncategorized_file: NotRequired["str"] + uncategorized_file: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. """ - uncategorized_text: NotRequired["str"] + uncategorized_text: NotRequired[str] """ Any additional evidence or statements. Has a maximum character count of 20,000. """ @@ -576,7 +576,9 @@ class ModifyParamsEvidenceEnhancedEvidenceVisaCompellingEvidence3( Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission. """ prior_undisputed_transactions: NotRequired[ - "List[Dispute.ModifyParamsEvidenceEnhancedEvidenceVisaCompellingEvidence3PriorUndisputedTransaction]" + List[ + "Dispute.ModifyParamsEvidenceEnhancedEvidenceVisaCompellingEvidence3PriorUndisputedTransaction" + ] ] """ List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission. @@ -606,7 +608,7 @@ class ModifyParamsEvidenceEnhancedEvidenceVisaCompellingEvidence3DisputedTransac The IP address that the customer used when making the purchase. """ merchandise_or_services: NotRequired[ - "Literal['merchandise', 'services']" + Literal["merchandise", "services"] ] """ Categorization of disputed payment. @@ -717,7 +719,7 @@ class ModifyParamsEvidenceEnhancedEvidenceVisaCompellingEvidence3PriorUndisputed """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_dispute_service.py b/stripe/_dispute_service.py index c0d59e632..3d1fada92 100644 --- a/stripe/_dispute_service.py +++ b/stripe/_dispute_service.py @@ -11,58 +11,58 @@ class DisputeService(StripeService): class CloseParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListParams(TypedDict): - charge: NotRequired["str"] + charge: NotRequired[str] """ Only return disputes associated to the charge specified by this charge ID. """ created: NotRequired["DisputeService.ListParamsCreated|int"] - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - payment_intent: NotRequired["str"] + payment_intent: NotRequired[str] """ Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -72,7 +72,7 @@ class UpdateParams(TypedDict): """ Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -80,61 +80,61 @@ class UpdateParams(TypedDict): """ 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`. """ - submit: NotRequired["bool"] + submit: NotRequired[bool] """ Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). """ class UpdateParamsEvidence(TypedDict): - access_activity_log: NotRequired["str"] + access_activity_log: NotRequired[str] """ Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. Has a maximum character count of 20,000. """ - billing_address: NotRequired["str"] + billing_address: NotRequired[str] """ The billing address provided by the customer. """ - cancellation_policy: NotRequired["str"] + cancellation_policy: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. """ - cancellation_policy_disclosure: NotRequired["str"] + cancellation_policy_disclosure: NotRequired[str] """ An explanation of how and when the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000. """ - cancellation_rebuttal: NotRequired["str"] + cancellation_rebuttal: NotRequired[str] """ A justification for why the customer's subscription was not canceled. Has a maximum character count of 20,000. """ - customer_communication: NotRequired["str"] + customer_communication: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service. """ - customer_email_address: NotRequired["str"] + customer_email_address: NotRequired[str] """ The email address of the customer. """ - customer_name: NotRequired["str"] + customer_name: NotRequired[str] """ The name of the customer. """ - customer_purchase_ip: NotRequired["str"] + customer_purchase_ip: NotRequired[str] """ The IP address that the customer used when making the purchase. """ - customer_signature: NotRequired["str"] + customer_signature: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. """ - duplicate_charge_documentation: NotRequired["str"] + duplicate_charge_documentation: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate. """ - duplicate_charge_explanation: NotRequired["str"] + duplicate_charge_explanation: NotRequired[str] """ An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. Has a maximum character count of 20,000. """ - duplicate_charge_id: NotRequired["str"] + duplicate_charge_id: NotRequired[str] """ The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. """ @@ -144,59 +144,59 @@ class UpdateParamsEvidence(TypedDict): """ Additional evidence for qualifying evidence programs. """ - product_description: NotRequired["str"] + product_description: NotRequired[str] """ A description of the product or service that was sold. Has a maximum character count of 20,000. """ - receipt: NotRequired["str"] + receipt: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge. """ - refund_policy: NotRequired["str"] + refund_policy: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. """ - refund_policy_disclosure: NotRequired["str"] + refund_policy_disclosure: NotRequired[str] """ Documentation demonstrating that the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000. """ - refund_refusal_explanation: NotRequired["str"] + refund_refusal_explanation: NotRequired[str] """ A justification for why the customer is not entitled to a refund. Has a maximum character count of 20,000. """ - service_date: NotRequired["str"] + service_date: NotRequired[str] """ The date on which the customer received or began receiving the purchased service, in a clear human-readable format. """ - service_documentation: NotRequired["str"] + service_documentation: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement. """ - shipping_address: NotRequired["str"] + shipping_address: NotRequired[str] """ The address to which a physical product was shipped. You should try to include as complete address information as possible. """ - shipping_carrier: NotRequired["str"] + shipping_carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas. """ - shipping_date: NotRequired["str"] + shipping_date: NotRequired[str] """ The date on which a physical product began its route to the shipping address, in a clear human-readable format. """ - shipping_documentation: NotRequired["str"] + shipping_documentation: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible. """ - shipping_tracking_number: NotRequired["str"] + shipping_tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ - uncategorized_file: NotRequired["str"] + uncategorized_file: NotRequired[str] """ (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. """ - uncategorized_text: NotRequired["str"] + uncategorized_text: NotRequired[str] """ Any additional evidence or statements. Has a maximum character count of 20,000. """ @@ -219,7 +219,9 @@ class UpdateParamsEvidenceEnhancedEvidenceVisaCompellingEvidence3( Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission. """ prior_undisputed_transactions: NotRequired[ - "List[DisputeService.UpdateParamsEvidenceEnhancedEvidenceVisaCompellingEvidence3PriorUndisputedTransaction]" + List[ + "DisputeService.UpdateParamsEvidenceEnhancedEvidenceVisaCompellingEvidence3PriorUndisputedTransaction" + ] ] """ List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission. @@ -249,7 +251,7 @@ class UpdateParamsEvidenceEnhancedEvidenceVisaCompellingEvidence3DisputedTransac The IP address that the customer used when making the purchase. """ merchandise_or_services: NotRequired[ - "Literal['merchandise', 'services']" + Literal["merchandise", "services"] ] """ Categorization of disputed payment. diff --git a/stripe/_ephemeral_key.py b/stripe/_ephemeral_key.py index ea0e8e2a2..9fd5fd5ca 100644 --- a/stripe/_ephemeral_key.py +++ b/stripe/_ephemeral_key.py @@ -15,7 +15,7 @@ class EphemeralKey( OBJECT_NAME: ClassVar[Literal["ephemeral_key"]] = "ephemeral_key" class DeleteParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_ephemeral_key_service.py b/stripe/_ephemeral_key_service.py index 53b90f994..1e3c139a6 100644 --- a/stripe/_ephemeral_key_service.py +++ b/stripe/_ephemeral_key_service.py @@ -10,29 +10,29 @@ class EphemeralKeyService(StripeService): class CreateParams(TypedDict): - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of the Customer you'd like to modify using the resulting ephemeral key. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - issuing_card: NotRequired["str"] + issuing_card: NotRequired[str] """ The ID of the Issuing Card you'd like to access using the resulting ephemeral key. """ - nonce: NotRequired["str"] + nonce: NotRequired[str] """ A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information. """ - verification_session: NotRequired["str"] + verification_session: NotRequired[str] """ The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key """ class DeleteParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_event.py b/stripe/_event.py index 86abbd915..b9262934f 100644 --- a/stripe/_event.py +++ b/stripe/_event.py @@ -114,55 +114,55 @@ class ListParams(RequestOptions): """ Only return events that were created during the given date interval. """ - delivery_success: NotRequired["bool"] + delivery_success: NotRequired[bool] """ Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - type: NotRequired["str"] + type: NotRequired[str] """ A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property. """ - types: NotRequired["List[str]"] + types: NotRequired[List[str]] """ An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_event_service.py b/stripe/_event_service.py index f521f671f..bb816594f 100644 --- a/stripe/_event_service.py +++ b/stripe/_event_service.py @@ -15,55 +15,55 @@ class ListParams(TypedDict): """ Only return events that were created during the given date interval. """ - delivery_success: NotRequired["bool"] + delivery_success: NotRequired[bool] """ Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - type: NotRequired["str"] + type: NotRequired[str] """ A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property. """ - types: NotRequired["List[str]"] + types: NotRequired[List[str]] """ An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_exchange_rate.py b/stripe/_exchange_rate.py index 80bece0ef..443400403 100644 --- a/stripe/_exchange_rate.py +++ b/stripe/_exchange_rate.py @@ -40,25 +40,25 @@ class ExchangeRate(ListableAPIResource["ExchangeRate"]): OBJECT_NAME: ClassVar[Literal["exchange_rate"]] = "exchange_rate" class ListParams(RequestOptions): - ending_before: NotRequired["str"] + ending_before: NotRequired[str] """ A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + limit: NotRequired[int] """ A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max. """ - starting_after: NotRequired["str"] + starting_after: NotRequired[str] """ A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_exchange_rate_service.py b/stripe/_exchange_rate_service.py index 90e061372..a187e2b36 100644 --- a/stripe/_exchange_rate_service.py +++ b/stripe/_exchange_rate_service.py @@ -11,25 +11,25 @@ class ExchangeRateService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + ending_before: NotRequired[str] """ A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + limit: NotRequired[int] """ A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max. """ - starting_after: NotRequired["str"] + starting_after: NotRequired[str] """ A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_file.py b/stripe/_file.py index c4824a2c7..c83b91752 100644 --- a/stripe/_file.py +++ b/stripe/_file.py @@ -31,7 +31,7 @@ class File(CreateableAPIResource["File"], ListableAPIResource["File"]): OBJECT_NAME: ClassVar[Literal["file"]] = "file" class CreateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -64,7 +64,7 @@ class CreateParamsFileLinkData(TypedDict): """ Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ The link isn't available after this future timestamp. """ @@ -78,49 +78,65 @@ class ListParams(RequestOptions): """ Only return files that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ purpose: NotRequired[ - "Literal['account_requirement', 'additional_verification', 'business_icon', 'business_logo', 'customer_signature', 'dispute_evidence', 'document_provider_identity_document', 'finance_report_run', 'identity_document', 'identity_document_downloadable', 'pci_document', 'selfie', 'sigma_scheduled_query', 'tax_document_user_upload', 'terminal_reader_splashscreen']" + Literal[ + "account_requirement", + "additional_verification", + "business_icon", + "business_logo", + "customer_signature", + "dispute_evidence", + "document_provider_identity_document", + "finance_report_run", + "identity_document", + "identity_document_downloadable", + "pci_document", + "selfie", + "sigma_scheduled_query", + "tax_document_user_upload", + "terminal_reader_splashscreen", + ] ] """ Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_file_link.py b/stripe/_file_link.py index 4c36b12ef..e03684b86 100644 --- a/stripe/_file_link.py +++ b/stripe/_file_link.py @@ -34,11 +34,11 @@ class FileLink( OBJECT_NAME: ClassVar[Literal["file_link"]] = "file_link" class CreateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ The link isn't usable after this future timestamp. """ @@ -56,51 +56,51 @@ class ListParams(RequestOptions): """ Only return links that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expired: NotRequired["bool"] + expired: NotRequired[bool] """ Filter links by their expiration status. By default, Stripe returns all links. """ - file: NotRequired["str"] + file: NotRequired[str] """ Only return links for the given file. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -114,7 +114,7 @@ class ModifyParams(RequestOptions): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_file_link_service.py b/stripe/_file_link_service.py index 99b95ea68..a7426ea13 100644 --- a/stripe/_file_link_service.py +++ b/stripe/_file_link_service.py @@ -11,11 +11,11 @@ class FileLinkService(StripeService): class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ The link isn't usable after this future timestamp. """ @@ -33,57 +33,57 @@ class ListParams(TypedDict): """ Only return links that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expired: NotRequired["bool"] + expired: NotRequired[bool] """ Filter links by their expiration status. By default, Stripe returns all links. """ - file: NotRequired["str"] + file: NotRequired[str] """ Only return links for the given file. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_file_service.py b/stripe/_file_service.py index dea0fbe67..9d11bdfab 100644 --- a/stripe/_file_service.py +++ b/stripe/_file_service.py @@ -11,7 +11,7 @@ class FileService(StripeService): class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -44,7 +44,7 @@ class CreateParamsFileLinkData(TypedDict): """ Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ The link isn't available after this future timestamp. """ @@ -58,49 +58,65 @@ class ListParams(TypedDict): """ Only return files that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ purpose: NotRequired[ - "Literal['account_requirement', 'additional_verification', 'business_icon', 'business_logo', 'customer_signature', 'dispute_evidence', 'document_provider_identity_document', 'finance_report_run', 'identity_document', 'identity_document_downloadable', 'pci_document', 'selfie', 'sigma_scheduled_query', 'tax_document_user_upload', 'terminal_reader_splashscreen']" + Literal[ + "account_requirement", + "additional_verification", + "business_icon", + "business_logo", + "customer_signature", + "dispute_evidence", + "document_provider_identity_document", + "finance_report_run", + "identity_document", + "identity_document_downloadable", + "pci_document", + "selfie", + "sigma_scheduled_query", + "tax_document_user_upload", + "terminal_reader_splashscreen", + ] ] """ Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_invoice.py b/stripe/_invoice.py index 6540080b9..7c4f53b91 100644 --- a/stripe/_invoice.py +++ b/stripe/_invoice.py @@ -1061,7 +1061,7 @@ class TransferData(StripeObject): """ class AddLinesParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1075,15 +1075,15 @@ class AddLinesParams(RequestOptions): """ class AddLinesParamsLine(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations. """ @@ -1093,7 +1093,7 @@ class AddLinesParamsLine(TypedDict): """ The coupons & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. """ - invoice_item: NotRequired["str"] + invoice_item: NotRequired[str] """ ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created. """ @@ -1109,7 +1109,7 @@ class AddLinesParamsLine(TypedDict): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -1117,7 +1117,7 @@ class AddLinesParamsLine(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the line item. """ @@ -1133,11 +1133,11 @@ class AddLinesParamsLine(TypedDict): """ class AddLinesParamsLineDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1155,7 +1155,7 @@ class AddLinesParamsLineDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1189,7 +1189,7 @@ class AddLinesParamsLinePriceData(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - product: NotRequired["str"] + product: NotRequired[str] """ The ID of the product that this price will belong to. One of `product` or `product_data` is required. """ @@ -1200,30 +1200,30 @@ class AddLinesParamsLinePriceData(TypedDict): Data used to generate a new product object inline. One of `product` or `product_data` is required. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class AddLinesParamsLinePriceDataProductData(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. """ - images: NotRequired["List[str]"] + images: NotRequired[List[str]] """ A list of up to 8 URLs of images for this product, meant to be displayable to the customer. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -1231,7 +1231,7 @@ class AddLinesParamsLinePriceDataProductData(TypedDict): """ The product's name, meant to be displayable to the customer. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ @@ -1253,11 +1253,11 @@ class AddLinesParamsLineTaxAmount(TypedDict): """ class AddLinesParamsLineTaxAmountTaxRateData(TypedDict): - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. """ @@ -1269,7 +1269,7 @@ class AddLinesParamsLineTaxAmountTaxRateData(TypedDict): """ This specifies if the tax rate is inclusive or exclusive. """ - jurisdiction: NotRequired["str"] + jurisdiction: NotRequired[str] """ The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice. """ @@ -1277,23 +1277,36 @@ class AddLinesParamsLineTaxAmountTaxRateData(TypedDict): """ The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero. """ - state: NotRequired["str"] + state: NotRequired[str] """ [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. """ tax_type: NotRequired[ - "Literal['amusement_tax', 'communications_tax', 'gst', 'hst', 'igst', 'jct', 'lease_tax', 'pst', 'qst', 'rst', 'sales_tax', 'vat']" + Literal[ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat", + ] ] """ The high-level tax type, such as `vat` or `sales_tax`. """ class AttachPaymentIntentParams(RequestOptions): - amount_requested: NotRequired["int"] + amount_requested: NotRequired[int] """ The portion of the PaymentIntent's `amount` that should be applied to thisinvoice. Defaults to the entire amount. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1313,11 +1326,11 @@ class CreateParams(RequestOptions): """ List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`. """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). """ - auto_advance: NotRequired["bool"] + auto_advance: NotRequired[bool] """ Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. """ @@ -1326,12 +1339,12 @@ class CreateParams(RequestOptions): Settings for automatic tax lookup for this invoice. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency to create this invoice in. Defaults to that of `customer` if not specified. """ @@ -1341,31 +1354,31 @@ class CreateParams(RequestOptions): """ A list of up to 4 custom fields to be displayed on the invoice. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of the customer who will be billed. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`. """ - default_margins: NotRequired["List[str]"] + default_margins: NotRequired[List[str]] """ The ids of the margins to apply to the invoice. Can be overridden by line item `margins`. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. """ - default_source: NotRequired["str"] + default_source: NotRequired[str] """ ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. """ - default_tax_rates: NotRequired["List[str]"] + default_tax_rates: NotRequired[List[str]] """ The tax rates that will apply to any line item that does not have `tax_rates` set. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. """ @@ -1375,19 +1388,19 @@ class CreateParams(RequestOptions): """ The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts. """ - due_date: NotRequired["int"] + due_date: NotRequired[int] """ The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`. """ - effective_at: NotRequired["int"] + effective_at: NotRequired[int] """ The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - footer: NotRequired["str"] + footer: NotRequired[str] """ Footer to be displayed on the invoice. """ @@ -1403,11 +1416,11 @@ class CreateParams(RequestOptions): """ 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`. """ - number: NotRequired["str"] + number: NotRequired[str] """ Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. """ @@ -1416,7 +1429,7 @@ class CreateParams(RequestOptions): Configuration settings for the PaymentIntent that is generated when the invoice is finalized. """ pending_invoice_items_behavior: NotRequired[ - "Literal['exclude', 'include', 'include_and_require']" + Literal["exclude", "include", "include_and_require"] ] """ How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted. @@ -1439,11 +1452,11 @@ class CreateParams(RequestOptions): """ Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. """ - subscription: NotRequired["str"] + subscription: NotRequired[str] """ The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected. """ @@ -1457,7 +1470,7 @@ class CreateParamsAmountsDue(TypedDict): """ The amount in cents (or local equivalent). """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days from when invoice is finalized until the payment is due. """ @@ -1465,7 +1478,7 @@ class CreateParamsAmountsDue(TypedDict): """ An arbitrary string attached to the object. Often useful for displaying to users. """ - due_date: NotRequired["int"] + due_date: NotRequired[int] """ Date on which a payment plan's payment is due. """ @@ -1481,7 +1494,7 @@ class CreateParamsAutomaticTax(TypedDict): """ class CreateParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1501,11 +1514,11 @@ class CreateParamsCustomField(TypedDict): """ class CreateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1521,7 +1534,7 @@ class CreateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1551,7 +1564,7 @@ class CreateParamsFromInvoice(TypedDict): """ class CreateParamsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1630,7 +1643,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -1639,13 +1652,13 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions( TypedDict, ): - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ class CreateParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -1660,7 +1673,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. @@ -1669,7 +1682,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): class CreateParamsPaymentSettingsPaymentMethodOptionsCardInstallments( TypedDict, ): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Setting to true enables installments for this invoice. Setting to false will prevent any selected plan from applying to a payment. @@ -1707,7 +1720,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalance( """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["str"] + funding_type: NotRequired[str] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ @@ -1721,7 +1734,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer """ Configuration for eu_bank_transfer funding type. """ - type: NotRequired["str"] + type: NotRequired[str] """ The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. """ @@ -1750,7 +1763,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccount( Additional fields for Financial Connections Session creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -1760,13 +1773,24 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConne TypedDict, ): permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. @@ -1793,7 +1817,7 @@ class CreateParamsRenderingOptions(TypedDict): """ class CreateParamsRenderingPdf(TypedDict): - page_size: NotRequired["Literal['a4', 'auto', 'letter']"] + page_size: NotRequired[Literal["a4", "auto", "letter"]] """ Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`. If set to `auto`, invoice PDF page size defaults to `a4` for customers with @@ -1801,7 +1825,7 @@ class CreateParamsRenderingPdf(TypedDict): """ class CreateParamsShippingCost(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the shipping rate to use for this order. """ @@ -1829,21 +1853,21 @@ class CreateParamsShippingCostShippingRateData(TypedDict): """ Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ - type: NotRequired["Literal['fixed_amount']"] + type: NotRequired[Literal["fixed_amount"]] """ The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. """ @@ -1896,7 +1920,10 @@ class CreateParamsShippingCostShippingRateDataFixedAmount(TypedDict): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, Invoice.CreateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions]" + Dict[ + str, + "Invoice.CreateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions", + ] ] """ Shipping rates 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). @@ -1910,7 +1937,7 @@ class CreateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions( A non-negative integer in cents representing how much to charge. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. @@ -1931,33 +1958,33 @@ class CreateParamsShippingDetails(TypedDict): """ class CreateParamsShippingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. """ @@ -1971,15 +1998,15 @@ class CreatePreviewParams(RequestOptions): """ Settings for automatic tax lookup for this invoice preview. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency to preview this invoice in. Defaults to that of `customer` if not specified. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. """ @@ -1995,12 +2022,12 @@ class CreatePreviewParams(RequestOptions): """ The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ invoice_items: NotRequired[ - "List[Invoice.CreatePreviewParamsInvoiceItem]" + List["Invoice.CreatePreviewParamsInvoiceItem"] ] """ List of invoice items to add or update in the upcoming invoice preview. @@ -2013,11 +2040,11 @@ class CreatePreviewParams(RequestOptions): """ The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. """ - preview_mode: NotRequired["Literal['next', 'recurring']"] + preview_mode: NotRequired[Literal["next", "recurring"]] """ Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified. """ - schedule: NotRequired["str"] + schedule: NotRequired[str] """ The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. """ @@ -2027,7 +2054,7 @@ class CreatePreviewParams(RequestOptions): """ The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. """ - subscription: NotRequired["str"] + subscription: NotRequired[str] """ The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. """ @@ -2041,11 +2068,11 @@ class CreatePreviewParams(RequestOptions): """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. """ - subscription_cancel_at_period_end: NotRequired["bool"] + subscription_cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. """ - subscription_cancel_now: NotRequired["bool"] + subscription_cancel_now: NotRequired[bool] """ This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. """ @@ -2060,7 +2087,7 @@ class CreatePreviewParams(RequestOptions): The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. """ subscription_items: NotRequired[ - "List[Invoice.CreatePreviewParamsSubscriptionItem]" + List["Invoice.CreatePreviewParamsSubscriptionItem"] ] """ A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead. @@ -2072,20 +2099,20 @@ class CreatePreviewParams(RequestOptions): The pre-billing to apply to the subscription as a preview. This field has been deprecated and will be removed in a future API version. Use `subscription_details.prebilling` instead. """ subscription_proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead. """ - subscription_proration_date: NotRequired["int"] + subscription_proration_date: NotRequired[int] """ If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead. """ - subscription_resume_at: NotRequired["Literal['now']"] + subscription_resume_at: NotRequired[Literal["now"]] """ For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead. """ - subscription_start_date: NotRequired["int"] + subscription_start_date: NotRequired[int] """ Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead. """ @@ -2107,7 +2134,7 @@ class CreatePreviewParamsAutomaticTax(TypedDict): """ class CreatePreviewParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -2140,34 +2167,34 @@ class CreatePreviewParamsCustomerDetails(TypedDict): The customer's tax exemption. One of `none`, `exempt`, or `reverse`. """ tax_ids: NotRequired[ - "List[Invoice.CreatePreviewParamsCustomerDetailsTaxId]" + List["Invoice.CreatePreviewParamsCustomerDetailsTaxId"] ] """ The customer's tax IDs. """ class CreatePreviewParamsCustomerDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -2181,33 +2208,33 @@ class CreatePreviewParamsCustomerDetailsShipping(TypedDict): """ Customer name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Customer phone (including extension). """ class CreatePreviewParamsCustomerDetailsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -2297,11 +2324,11 @@ class CreatePreviewParamsCustomerDetailsTaxId(TypedDict): """ class CreatePreviewParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2311,7 +2338,7 @@ class CreatePreviewParamsDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2323,7 +2350,7 @@ class CreatePreviewParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2343,19 +2370,19 @@ class CreatePreviewParamsDiscountDiscountEndDuration(TypedDict): """ class CreatePreviewParamsInvoiceItem(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of previewed invoice item. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only applicable to new invoice items. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items. """ @@ -2365,7 +2392,7 @@ class CreatePreviewParamsInvoiceItem(TypedDict): """ The coupons to redeem into discounts for the invoice item in the preview. """ - invoiceitem: NotRequired["str"] + invoiceitem: NotRequired[str] """ The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice. """ @@ -2377,7 +2404,7 @@ class CreatePreviewParamsInvoiceItem(TypedDict): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -2387,12 +2414,12 @@ class CreatePreviewParamsInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the invoice item. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. @@ -2405,21 +2432,21 @@ class CreatePreviewParamsInvoiceItem(TypedDict): """ The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class CreatePreviewParamsInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2429,7 +2456,7 @@ class CreatePreviewParamsInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2441,7 +2468,7 @@ class CreatePreviewParamsInvoiceItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2480,22 +2507,22 @@ class CreatePreviewParamsInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class CreatePreviewParamsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -2506,23 +2533,23 @@ class CreatePreviewParamsIssuer(TypedDict): class CreatePreviewParamsScheduleDetails(TypedDict): amendments: NotRequired[ - "List[Invoice.CreatePreviewParamsScheduleDetailsAmendment]" + List["Invoice.CreatePreviewParamsScheduleDetailsAmendment"] ] """ Changes to apply to the phases of the subscription schedule, in the order provided. """ billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. """ - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. """ phases: NotRequired[ - "List[Invoice.CreatePreviewParamsScheduleDetailsPhase]" + List["Invoice.CreatePreviewParamsScheduleDetailsPhase"] ] """ List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. @@ -2534,7 +2561,7 @@ class CreatePreviewParamsScheduleDetails(TypedDict): Provide any time periods to bill in advance. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request. @@ -2552,31 +2579,37 @@ class CreatePreviewParamsScheduleDetailsAmendment(TypedDict): Details to identify the earliest timestamp where the proposed change should take effect. """ billing_cycle_anchor: NotRequired[ - "Literal['amendment_start', 'automatic']" + Literal["amendment_start", "automatic"] ] """ For a point-in-time amendment, this attribute lets you set or update whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp. """ discount_actions: NotRequired[ - "List[Invoice.CreatePreviewParamsScheduleDetailsAmendmentDiscountAction]" + List[ + "Invoice.CreatePreviewParamsScheduleDetailsAmendmentDiscountAction" + ] ] """ Changes to the coupons being redeemed or discounts being applied during the amendment time span. """ item_actions: NotRequired[ - "List[Invoice.CreatePreviewParamsScheduleDetailsAmendmentItemAction]" + List[ + "Invoice.CreatePreviewParamsScheduleDetailsAmendmentItemAction" + ] ] """ Changes to the subscription items during the amendment time span. """ metadata_actions: NotRequired[ - "List[Invoice.CreatePreviewParamsScheduleDetailsAmendmentMetadataAction]" + List[ + "Invoice.CreatePreviewParamsScheduleDetailsAmendmentMetadataAction" + ] ] """ Instructions for how to modify phase metadata """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`. @@ -2588,7 +2621,7 @@ class CreatePreviewParamsScheduleDetailsAmendment(TypedDict): Defines how to pause collection for the underlying subscription throughout the duration of the amendment. """ set_schedule_end: NotRequired[ - "Literal['amendment_end', 'amendment_start']" + Literal["amendment_end", "amendment_start"] ] """ Ends the subscription schedule early as dictated by either the accompanying amendment's start or end. @@ -2613,7 +2646,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentAmendmentEnd(TypedDict): """ Time span for the amendment starting from the `amendment_start`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`. """ @@ -2663,7 +2696,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentAmendmentStart(TypedDict): """ Use the `end` time of a given discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to start. """ @@ -2724,11 +2757,11 @@ class CreatePreviewParamsScheduleDetailsAmendmentDiscountAction(TypedDict): class CreatePreviewParamsScheduleDetailsAmendmentDiscountActionAdd( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to redeem. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount for a coupon that was already redeemed. """ @@ -2738,11 +2771,11 @@ class CreatePreviewParamsScheduleDetailsAmendmentDiscountActionAdd( """ Details to determine how long the discount should be applied for. """ - index: NotRequired["int"] + index: NotRequired[int] """ The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The promotion code to redeem. """ @@ -2758,15 +2791,15 @@ class CreatePreviewParamsScheduleDetailsAmendmentDiscountActionAddDiscountEnd( class CreatePreviewParamsScheduleDetailsAmendmentDiscountActionRemove( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to remove from the `discounts` array. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ The ID of a discount to remove from the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to remove from the `discounts` array. """ @@ -2774,15 +2807,15 @@ class CreatePreviewParamsScheduleDetailsAmendmentDiscountActionRemove( class CreatePreviewParamsScheduleDetailsAmendmentDiscountActionSet( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to replace the `discounts` array with. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount to replace the `discounts` array with. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ An ID of an existing promotion code to replace the `discounts` array with. """ @@ -2813,12 +2846,14 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemAction(TypedDict): class CreatePreviewParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): discounts: NotRequired[ - "List[Invoice.CreatePreviewParamsScheduleDetailsAmendmentItemActionAddDiscount]" + List[ + "Invoice.CreatePreviewParamsScheduleDetailsAmendmentItemActionAddDiscount" + ] ] """ The discounts applied to the item. Subscription item discounts are applied before subscription discounts. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -2826,11 +2861,11 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. """ @@ -2844,11 +2879,11 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): class CreatePreviewParamsScheduleDetailsAmendmentItemActionAddDiscount( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2858,7 +2893,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionAddDiscount( """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2872,7 +2907,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionAddDiscountDiscountEn """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2896,7 +2931,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionAddDiscountDiscountEn class CreatePreviewParamsScheduleDetailsAmendmentItemActionAddTrial( TypedDict, ): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -2915,12 +2950,14 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionRemove( class CreatePreviewParamsScheduleDetailsAmendmentItemActionSet(TypedDict): discounts: NotRequired[ - "List[Invoice.CreatePreviewParamsScheduleDetailsAmendmentItemActionSetDiscount]" + List[ + "Invoice.CreatePreviewParamsScheduleDetailsAmendmentItemActionSetDiscount" + ] ] """ If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`. """ @@ -2928,11 +2965,11 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionSet(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`. """ @@ -2946,11 +2983,11 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionSet(TypedDict): class CreatePreviewParamsScheduleDetailsAmendmentItemActionSetDiscount( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2960,7 +2997,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionSetDiscount( """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2974,7 +3011,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionSetDiscountDiscountEn """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2998,7 +3035,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionSetDiscountDiscountEn class CreatePreviewParamsScheduleDetailsAmendmentItemActionSetTrial( TypedDict, ): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -3008,11 +3045,11 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionSetTrial( """ class CreatePreviewParamsScheduleDetailsAmendmentMetadataAction(TypedDict): - add: NotRequired["Dict[str, str]"] + add: NotRequired[Dict[str, str]] """ Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata. """ - remove: NotRequired["List[str]"] + remove: NotRequired[List[str]] """ Keys to remove from schedule phase metadata. """ @@ -3058,19 +3095,21 @@ class CreatePreviewParamsScheduleDetailsAmendmentTrialSettings(TypedDict): class CreatePreviewParamsScheduleDetailsAmendmentTrialSettingsEndBehavior( TypedDict, ): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ class CreatePreviewParamsScheduleDetailsPhase(TypedDict): add_invoice_items: NotRequired[ - "List[Invoice.CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItem]" + List[ + "Invoice.CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItem" + ] ] """ A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items. """ - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ @@ -3080,9 +3119,7 @@ class CreatePreviewParamsScheduleDetailsPhase(TypedDict): """ Automatic tax settings for this phase. """ - billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'phase_start']" - ] + billing_cycle_anchor: NotRequired[Literal["automatic", "phase_start"]] """ Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -3093,20 +3130,20 @@ class CreatePreviewParamsScheduleDetailsPhase(TypedDict): Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. """ @@ -3138,15 +3175,15 @@ class CreatePreviewParamsScheduleDetailsPhase(TypedDict): """ List of configuration items, each with an attached price, to apply during this phase of the subscription schedule. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account on behalf of which to charge, for each of the associated subscription's invoices. """ @@ -3157,7 +3194,7 @@ class CreatePreviewParamsScheduleDetailsPhase(TypedDict): If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/billing/subscriptions/pause-payment). """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. @@ -3172,11 +3209,11 @@ class CreatePreviewParamsScheduleDetailsPhase(TypedDict): """ The data with which to automatically create a Transfer for each of the associated subscription's invoices. """ - trial: NotRequired["bool"] + trial: NotRequired[bool] """ If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. """ - trial_continuation: NotRequired["Literal['continue', 'none']"] + trial_continuation: NotRequired[Literal["continue", "none"]] """ Specify trial behavior when crossing phase boundaries """ @@ -3193,12 +3230,14 @@ class CreatePreviewParamsScheduleDetailsPhase(TypedDict): class CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): discounts: NotRequired[ - "List[Invoice.CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItemDiscount]" + List[ + "Invoice.CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItemDiscount" + ] ] """ The coupons to redeem into discounts for the item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -3208,7 +3247,7 @@ class CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. Defaults to 1. """ @@ -3220,11 +3259,11 @@ class CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): class CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItemDiscount( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -3234,7 +3273,7 @@ class CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItemDiscount( """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -3248,7 +3287,7 @@ class CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItemDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -3281,16 +3320,16 @@ class CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItemPriceData( The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -3310,7 +3349,7 @@ class CreatePreviewParamsScheduleDetailsPhaseAutomaticTax(TypedDict): class CreatePreviewParamsScheduleDetailsPhaseAutomaticTaxLiability( TypedDict, ): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -3320,21 +3359,21 @@ class CreatePreviewParamsScheduleDetailsPhaseAutomaticTaxLiability( """ class CreatePreviewParamsScheduleDetailsPhaseBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ class CreatePreviewParamsScheduleDetailsPhaseDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -3344,7 +3383,7 @@ class CreatePreviewParamsScheduleDetailsPhaseDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -3358,7 +3397,7 @@ class CreatePreviewParamsScheduleDetailsPhaseDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -3384,7 +3423,7 @@ class CreatePreviewParamsScheduleDetailsPhaseInvoiceSettings(TypedDict): """ The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. """ @@ -3398,7 +3437,7 @@ class CreatePreviewParamsScheduleDetailsPhaseInvoiceSettings(TypedDict): class CreatePreviewParamsScheduleDetailsPhaseInvoiceSettingsIssuer( TypedDict, ): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -3420,15 +3459,15 @@ class CreatePreviewParamsScheduleDetailsPhaseItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The plan ID to subscribe to. You may specify the same ID in `plan` and `price`. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -3438,7 +3477,7 @@ class CreatePreviewParamsScheduleDetailsPhaseItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`. """ @@ -3462,11 +3501,11 @@ class CreatePreviewParamsScheduleDetailsPhaseItemBillingThresholds( """ class CreatePreviewParamsScheduleDetailsPhaseItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -3476,7 +3515,7 @@ class CreatePreviewParamsScheduleDetailsPhaseItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -3490,7 +3529,7 @@ class CreatePreviewParamsScheduleDetailsPhaseItemDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -3525,16 +3564,16 @@ class CreatePreviewParamsScheduleDetailsPhaseItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -3546,13 +3585,13 @@ class CreatePreviewParamsScheduleDetailsPhaseItemPriceDataRecurring( """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class CreatePreviewParamsScheduleDetailsPhaseItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -3568,7 +3607,7 @@ class CreatePreviewParamsScheduleDetailsPhasePauseCollection(TypedDict): """ class CreatePreviewParamsScheduleDetailsPhaseTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -3588,7 +3627,7 @@ class CreatePreviewParamsScheduleDetailsPhaseTrialSettings(TypedDict): class CreatePreviewParamsScheduleDetailsPhaseTrialSettingsEndBehavior( TypedDict, ): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ @@ -3600,7 +3639,7 @@ class CreatePreviewParamsScheduleDetailsPrebilling(TypedDict): """ The end of the prebilled time period. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ This is used to determine the number of billing cycles to prebill. """ @@ -3618,7 +3657,7 @@ class CreatePreviewParamsScheduleDetailsPrebillingBillUntil(TypedDict): """ Time span for prebilling, starting from `bill_from`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ End the prebilled period at a precise integer timestamp, starting from the Unix epoch. """ @@ -3656,11 +3695,11 @@ class CreatePreviewParamsSubscriptionDetails(TypedDict): """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. """ - cancel_at_period_end: NotRequired["bool"] + cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. """ - cancel_now: NotRequired["bool"] + cancel_now: NotRequired[bool] """ This simulates the subscription being canceled or expired immediately. """ @@ -3669,7 +3708,7 @@ class CreatePreviewParamsSubscriptionDetails(TypedDict): If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. """ items: NotRequired[ - "List[Invoice.CreatePreviewParamsSubscriptionDetailsItem]" + List["Invoice.CreatePreviewParamsSubscriptionDetailsItem"] ] """ A list of up to 20 subscription items, each with an attached price. @@ -3681,20 +3720,20 @@ class CreatePreviewParamsSubscriptionDetails(TypedDict): The pre-billing to apply to the subscription as a preview. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'. """ - resume_at: NotRequired["Literal['now']"] + resume_at: NotRequired[Literal["now"]] """ For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. """ - start_date: NotRequired["int"] + start_date: NotRequired[int] """ Date a subscription is intended to start (can be future or past). """ @@ -3710,11 +3749,11 @@ class CreatePreviewParamsSubscriptionDetailsItem(TypedDict): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. """ - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`. """ - deleted: NotRequired["bool"] + deleted: NotRequired[bool] """ A flag that, if set to `true`, will delete the specified item. """ @@ -3724,7 +3763,7 @@ class CreatePreviewParamsSubscriptionDetailsItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - id: NotRequired["str"] + id: NotRequired[str] """ Subscription item to update. """ @@ -3732,11 +3771,11 @@ class CreatePreviewParamsSubscriptionDetailsItem(TypedDict): """ 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -3746,7 +3785,7 @@ class CreatePreviewParamsSubscriptionDetailsItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -3764,11 +3803,11 @@ class CreatePreviewParamsSubscriptionDetailsItemBillingThresholds( """ class CreatePreviewParamsSubscriptionDetailsItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -3778,7 +3817,7 @@ class CreatePreviewParamsSubscriptionDetailsItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -3792,7 +3831,7 @@ class CreatePreviewParamsSubscriptionDetailsItemDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -3827,16 +3866,16 @@ class CreatePreviewParamsSubscriptionDetailsItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -3848,7 +3887,7 @@ class CreatePreviewParamsSubscriptionDetailsItemPriceDataRecurring( """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -3866,11 +3905,11 @@ class CreatePreviewParamsSubscriptionItem(TypedDict): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. """ - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`. """ - deleted: NotRequired["bool"] + deleted: NotRequired[bool] """ A flag that, if set to `true`, will delete the specified item. """ @@ -3880,7 +3919,7 @@ class CreatePreviewParamsSubscriptionItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - id: NotRequired["str"] + id: NotRequired[str] """ Subscription item to update. """ @@ -3888,11 +3927,11 @@ class CreatePreviewParamsSubscriptionItem(TypedDict): """ 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -3902,7 +3941,7 @@ class CreatePreviewParamsSubscriptionItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -3918,11 +3957,11 @@ class CreatePreviewParamsSubscriptionItemBillingThresholds(TypedDict): """ class CreatePreviewParamsSubscriptionItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -3932,7 +3971,7 @@ class CreatePreviewParamsSubscriptionItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -3944,7 +3983,7 @@ class CreatePreviewParamsSubscriptionItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -3979,16 +4018,16 @@ class CreatePreviewParamsSubscriptionItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -3998,7 +4037,7 @@ class CreatePreviewParamsSubscriptionItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -4013,18 +4052,18 @@ class DeleteParams(RequestOptions): pass class FinalizeInvoiceParams(RequestOptions): - auto_advance: NotRequired["bool"] + auto_advance: NotRequired[bool] """ Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListParams(RequestOptions): collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. @@ -4033,94 +4072,94 @@ class ListParams(RequestOptions): """ Only return invoices that were created during the given date interval. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return invoices for the customer specified by this customer ID. """ due_date: NotRequired["Invoice.ListParamsDueDate|int"] - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['draft', 'open', 'paid', 'uncollectible', 'void']" + Literal["draft", "open", "paid", "uncollectible", "void"] ] """ The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) """ - subscription: NotRequired["str"] + subscription: NotRequired[str] """ Only return invoices for the subscription specified by this subscription ID. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsDueDate(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListPaymentsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 MarkUncollectibleParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -4136,11 +4175,11 @@ class ModifyParams(RequestOptions): """ List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`. """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). """ - auto_advance: NotRequired["bool"] + auto_advance: NotRequired[bool] """ Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. """ @@ -4149,7 +4188,7 @@ class ModifyParams(RequestOptions): Settings for automatic tax lookup for this invoice. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices. @@ -4160,7 +4199,7 @@ class ModifyParams(RequestOptions): """ A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. """ @@ -4168,7 +4207,7 @@ class ModifyParams(RequestOptions): """ The ids of the margins to apply to the invoice. Can be overridden by line item `margins`. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. """ @@ -4180,7 +4219,7 @@ class ModifyParams(RequestOptions): """ The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. """ @@ -4190,7 +4229,7 @@ class ModifyParams(RequestOptions): """ The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts. """ - due_date: NotRequired["int"] + due_date: NotRequired[int] """ The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. """ @@ -4198,11 +4237,11 @@ class ModifyParams(RequestOptions): """ The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - footer: NotRequired["str"] + footer: NotRequired[str] """ Footer to be displayed on the invoice. """ @@ -4248,7 +4287,7 @@ class ModifyParams(RequestOptions): """ Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. """ @@ -4264,7 +4303,7 @@ class ModifyParamsAmountsDue(TypedDict): """ The amount in cents (or local equivalent). """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days from when invoice is finalized until the payment is due. """ @@ -4272,7 +4311,7 @@ class ModifyParamsAmountsDue(TypedDict): """ An arbitrary string attached to the object. Often useful for displaying to users. """ - due_date: NotRequired["int"] + due_date: NotRequired[int] """ Date on which a payment plan's payment is due. """ @@ -4288,7 +4327,7 @@ class ModifyParamsAutomaticTax(TypedDict): """ class ModifyParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -4308,11 +4347,11 @@ class ModifyParamsCustomField(TypedDict): """ class ModifyParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -4328,7 +4367,7 @@ class ModifyParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -4348,7 +4387,7 @@ class ModifyParamsDiscountDiscountEndDuration(TypedDict): """ class ModifyParamsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -4427,7 +4466,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -4436,13 +4475,13 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): class ModifyParamsPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions( TypedDict, ): - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ class ModifyParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -4457,7 +4496,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. @@ -4466,7 +4505,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): class ModifyParamsPaymentSettingsPaymentMethodOptionsCardInstallments( TypedDict, ): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Setting to true enables installments for this invoice. Setting to false will prevent any selected plan from applying to a payment. @@ -4504,7 +4543,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsCustomerBalance( """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["str"] + funding_type: NotRequired[str] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ @@ -4518,7 +4557,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer """ Configuration for eu_bank_transfer funding type. """ - type: NotRequired["str"] + type: NotRequired[str] """ The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. """ @@ -4547,7 +4586,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsUsBankAccount( Additional fields for Financial Connections Session creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -4557,13 +4596,24 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConne TypedDict, ): permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. @@ -4590,7 +4640,7 @@ class ModifyParamsRenderingOptions(TypedDict): """ class ModifyParamsRenderingPdf(TypedDict): - page_size: NotRequired["Literal['a4', 'auto', 'letter']"] + page_size: NotRequired[Literal["a4", "auto", "letter"]] """ Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`. If set to `auto`, invoice PDF page size defaults to `a4` for customers with @@ -4598,7 +4648,7 @@ class ModifyParamsRenderingPdf(TypedDict): """ class ModifyParamsShippingCost(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the shipping rate to use for this order. """ @@ -4626,21 +4676,21 @@ class ModifyParamsShippingCostShippingRateData(TypedDict): """ Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ - type: NotRequired["Literal['fixed_amount']"] + type: NotRequired[Literal["fixed_amount"]] """ The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. """ @@ -4693,7 +4743,10 @@ class ModifyParamsShippingCostShippingRateDataFixedAmount(TypedDict): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, Invoice.ModifyParamsShippingCostShippingRateDataFixedAmountCurrencyOptions]" + Dict[ + str, + "Invoice.ModifyParamsShippingCostShippingRateDataFixedAmountCurrencyOptions", + ] ] """ Shipping rates 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). @@ -4707,7 +4760,7 @@ class ModifyParamsShippingCostShippingRateDataFixedAmountCurrencyOptions( A non-negative integer in cents representing how much to charge. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. @@ -4728,33 +4781,33 @@ class ModifyParamsShippingDetails(TypedDict): """ class ModifyParamsShippingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ModifyParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. """ @@ -4764,11 +4817,11 @@ class ModifyParamsTransferData(TypedDict): """ class PayParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - forgive: NotRequired["bool"] + forgive: NotRequired[bool] """ In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. @@ -4778,25 +4831,25 @@ class PayParams(RequestOptions): """ ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set. """ - off_session: NotRequired["bool"] + off_session: NotRequired[bool] """ Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session). """ - paid_out_of_band: NotRequired["bool"] + paid_out_of_band: NotRequired[bool] """ Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid. """ - source: NotRequired["str"] + source: NotRequired[str] """ A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid. """ class RemoveLinesParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -4820,27 +4873,27 @@ class RemoveLinesParamsLine(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrievePaymentParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SearchParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - page: NotRequired["str"] + page: NotRequired[str] """ A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. """ @@ -4850,7 +4903,7 @@ class SearchParams(RequestOptions): """ class SendInvoiceParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -4860,15 +4913,15 @@ class UpcomingLinesParams(RequestOptions): """ Settings for automatic tax lookup for this invoice preview. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency to preview this invoice in. Defaults to that of `customer` if not specified. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. """ @@ -4884,16 +4937,16 @@ class UpcomingLinesParams(RequestOptions): """ The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ invoice_items: NotRequired[ - "List[Invoice.UpcomingLinesParamsInvoiceItem]" + List["Invoice.UpcomingLinesParamsInvoiceItem"] ] """ List of invoice items to add or update in the upcoming invoice preview. @@ -4902,7 +4955,7 @@ class UpcomingLinesParams(RequestOptions): """ The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. """ - limit: NotRequired["int"] + 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. """ @@ -4910,11 +4963,11 @@ class UpcomingLinesParams(RequestOptions): """ The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. """ - preview_mode: NotRequired["Literal['next', 'recurring']"] + preview_mode: NotRequired[Literal["next", "recurring"]] """ Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified. """ - schedule: NotRequired["str"] + schedule: NotRequired[str] """ The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. """ @@ -4924,11 +4977,11 @@ class UpcomingLinesParams(RequestOptions): """ The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. """ - starting_after: NotRequired["str"] + 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. """ - subscription: NotRequired["str"] + subscription: NotRequired[str] """ The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. """ @@ -4942,11 +4995,11 @@ class UpcomingLinesParams(RequestOptions): """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. """ - subscription_cancel_at_period_end: NotRequired["bool"] + subscription_cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. """ - subscription_cancel_now: NotRequired["bool"] + subscription_cancel_now: NotRequired[bool] """ This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. """ @@ -4961,7 +5014,7 @@ class UpcomingLinesParams(RequestOptions): The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. """ subscription_items: NotRequired[ - "List[Invoice.UpcomingLinesParamsSubscriptionItem]" + List["Invoice.UpcomingLinesParamsSubscriptionItem"] ] """ A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead. @@ -4973,20 +5026,20 @@ class UpcomingLinesParams(RequestOptions): The pre-billing to apply to the subscription as a preview. This field has been deprecated and will be removed in a future API version. Use `subscription_details.prebilling` instead. """ subscription_proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead. """ - subscription_proration_date: NotRequired["int"] + subscription_proration_date: NotRequired[int] """ If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead. """ - subscription_resume_at: NotRequired["Literal['now']"] + subscription_resume_at: NotRequired[Literal["now"]] """ For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead. """ - subscription_start_date: NotRequired["int"] + subscription_start_date: NotRequired[int] """ Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead. """ @@ -5008,7 +5061,7 @@ class UpcomingLinesParamsAutomaticTax(TypedDict): """ class UpcomingLinesParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -5041,34 +5094,34 @@ class UpcomingLinesParamsCustomerDetails(TypedDict): The customer's tax exemption. One of `none`, `exempt`, or `reverse`. """ tax_ids: NotRequired[ - "List[Invoice.UpcomingLinesParamsCustomerDetailsTaxId]" + List["Invoice.UpcomingLinesParamsCustomerDetailsTaxId"] ] """ The customer's tax IDs. """ class UpcomingLinesParamsCustomerDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -5082,33 +5135,33 @@ class UpcomingLinesParamsCustomerDetailsShipping(TypedDict): """ Customer name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Customer phone (including extension). """ class UpcomingLinesParamsCustomerDetailsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -5198,11 +5251,11 @@ class UpcomingLinesParamsCustomerDetailsTaxId(TypedDict): """ class UpcomingLinesParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -5212,7 +5265,7 @@ class UpcomingLinesParamsDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -5224,7 +5277,7 @@ class UpcomingLinesParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -5244,19 +5297,19 @@ class UpcomingLinesParamsDiscountDiscountEndDuration(TypedDict): """ class UpcomingLinesParamsInvoiceItem(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of previewed invoice item. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only applicable to new invoice items. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items. """ @@ -5266,7 +5319,7 @@ class UpcomingLinesParamsInvoiceItem(TypedDict): """ The coupons to redeem into discounts for the invoice item in the preview. """ - invoiceitem: NotRequired["str"] + invoiceitem: NotRequired[str] """ The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice. """ @@ -5278,7 +5331,7 @@ class UpcomingLinesParamsInvoiceItem(TypedDict): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -5288,12 +5341,12 @@ class UpcomingLinesParamsInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the invoice item. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. @@ -5306,21 +5359,21 @@ class UpcomingLinesParamsInvoiceItem(TypedDict): """ The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class UpcomingLinesParamsInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -5330,7 +5383,7 @@ class UpcomingLinesParamsInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -5342,7 +5395,7 @@ class UpcomingLinesParamsInvoiceItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -5381,22 +5434,22 @@ class UpcomingLinesParamsInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class UpcomingLinesParamsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -5407,23 +5460,23 @@ class UpcomingLinesParamsIssuer(TypedDict): class UpcomingLinesParamsScheduleDetails(TypedDict): amendments: NotRequired[ - "List[Invoice.UpcomingLinesParamsScheduleDetailsAmendment]" + List["Invoice.UpcomingLinesParamsScheduleDetailsAmendment"] ] """ Changes to apply to the phases of the subscription schedule, in the order provided. """ billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. """ - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. """ phases: NotRequired[ - "List[Invoice.UpcomingLinesParamsScheduleDetailsPhase]" + List["Invoice.UpcomingLinesParamsScheduleDetailsPhase"] ] """ List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. @@ -5435,7 +5488,7 @@ class UpcomingLinesParamsScheduleDetails(TypedDict): Provide any time periods to bill in advance. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request. @@ -5453,31 +5506,37 @@ class UpcomingLinesParamsScheduleDetailsAmendment(TypedDict): Details to identify the earliest timestamp where the proposed change should take effect. """ billing_cycle_anchor: NotRequired[ - "Literal['amendment_start', 'automatic']" + Literal["amendment_start", "automatic"] ] """ For a point-in-time amendment, this attribute lets you set or update whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp. """ discount_actions: NotRequired[ - "List[Invoice.UpcomingLinesParamsScheduleDetailsAmendmentDiscountAction]" + List[ + "Invoice.UpcomingLinesParamsScheduleDetailsAmendmentDiscountAction" + ] ] """ Changes to the coupons being redeemed or discounts being applied during the amendment time span. """ item_actions: NotRequired[ - "List[Invoice.UpcomingLinesParamsScheduleDetailsAmendmentItemAction]" + List[ + "Invoice.UpcomingLinesParamsScheduleDetailsAmendmentItemAction" + ] ] """ Changes to the subscription items during the amendment time span. """ metadata_actions: NotRequired[ - "List[Invoice.UpcomingLinesParamsScheduleDetailsAmendmentMetadataAction]" + List[ + "Invoice.UpcomingLinesParamsScheduleDetailsAmendmentMetadataAction" + ] ] """ Instructions for how to modify phase metadata """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`. @@ -5489,7 +5548,7 @@ class UpcomingLinesParamsScheduleDetailsAmendment(TypedDict): Defines how to pause collection for the underlying subscription throughout the duration of the amendment. """ set_schedule_end: NotRequired[ - "Literal['amendment_end', 'amendment_start']" + Literal["amendment_end", "amendment_start"] ] """ Ends the subscription schedule early as dictated by either the accompanying amendment's start or end. @@ -5514,7 +5573,7 @@ class UpcomingLinesParamsScheduleDetailsAmendmentAmendmentEnd(TypedDict): """ Time span for the amendment starting from the `amendment_start`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`. """ @@ -5564,7 +5623,7 @@ class UpcomingLinesParamsScheduleDetailsAmendmentAmendmentStart(TypedDict): """ Use the `end` time of a given discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to start. """ @@ -5625,11 +5684,11 @@ class UpcomingLinesParamsScheduleDetailsAmendmentDiscountAction(TypedDict): class UpcomingLinesParamsScheduleDetailsAmendmentDiscountActionAdd( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to redeem. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount for a coupon that was already redeemed. """ @@ -5639,11 +5698,11 @@ class UpcomingLinesParamsScheduleDetailsAmendmentDiscountActionAdd( """ Details to determine how long the discount should be applied for. """ - index: NotRequired["int"] + index: NotRequired[int] """ The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The promotion code to redeem. """ @@ -5659,15 +5718,15 @@ class UpcomingLinesParamsScheduleDetailsAmendmentDiscountActionAddDiscountEnd( class UpcomingLinesParamsScheduleDetailsAmendmentDiscountActionRemove( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to remove from the `discounts` array. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ The ID of a discount to remove from the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to remove from the `discounts` array. """ @@ -5675,15 +5734,15 @@ class UpcomingLinesParamsScheduleDetailsAmendmentDiscountActionRemove( class UpcomingLinesParamsScheduleDetailsAmendmentDiscountActionSet( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to replace the `discounts` array with. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount to replace the `discounts` array with. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ An ID of an existing promotion code to replace the `discounts` array with. """ @@ -5714,12 +5773,14 @@ class UpcomingLinesParamsScheduleDetailsAmendmentItemAction(TypedDict): class UpcomingLinesParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): discounts: NotRequired[ - "List[Invoice.UpcomingLinesParamsScheduleDetailsAmendmentItemActionAddDiscount]" + List[ + "Invoice.UpcomingLinesParamsScheduleDetailsAmendmentItemActionAddDiscount" + ] ] """ The discounts applied to the item. Subscription item discounts are applied before subscription discounts. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -5727,11 +5788,11 @@ class UpcomingLinesParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. """ @@ -5745,11 +5806,11 @@ class UpcomingLinesParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): class UpcomingLinesParamsScheduleDetailsAmendmentItemActionAddDiscount( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -5759,7 +5820,7 @@ class UpcomingLinesParamsScheduleDetailsAmendmentItemActionAddDiscount( """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -5773,7 +5834,7 @@ class UpcomingLinesParamsScheduleDetailsAmendmentItemActionAddDiscountDiscountEn """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -5797,7 +5858,7 @@ class UpcomingLinesParamsScheduleDetailsAmendmentItemActionAddDiscountDiscountEn class UpcomingLinesParamsScheduleDetailsAmendmentItemActionAddTrial( TypedDict, ): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -5816,12 +5877,14 @@ class UpcomingLinesParamsScheduleDetailsAmendmentItemActionRemove( class UpcomingLinesParamsScheduleDetailsAmendmentItemActionSet(TypedDict): discounts: NotRequired[ - "List[Invoice.UpcomingLinesParamsScheduleDetailsAmendmentItemActionSetDiscount]" + List[ + "Invoice.UpcomingLinesParamsScheduleDetailsAmendmentItemActionSetDiscount" + ] ] """ If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`. """ @@ -5829,11 +5892,11 @@ class UpcomingLinesParamsScheduleDetailsAmendmentItemActionSet(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`. """ @@ -5847,11 +5910,11 @@ class UpcomingLinesParamsScheduleDetailsAmendmentItemActionSet(TypedDict): class UpcomingLinesParamsScheduleDetailsAmendmentItemActionSetDiscount( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -5861,7 +5924,7 @@ class UpcomingLinesParamsScheduleDetailsAmendmentItemActionSetDiscount( """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -5875,7 +5938,7 @@ class UpcomingLinesParamsScheduleDetailsAmendmentItemActionSetDiscountDiscountEn """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -5899,7 +5962,7 @@ class UpcomingLinesParamsScheduleDetailsAmendmentItemActionSetDiscountDiscountEn class UpcomingLinesParamsScheduleDetailsAmendmentItemActionSetTrial( TypedDict, ): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -5909,11 +5972,11 @@ class UpcomingLinesParamsScheduleDetailsAmendmentItemActionSetTrial( """ class UpcomingLinesParamsScheduleDetailsAmendmentMetadataAction(TypedDict): - add: NotRequired["Dict[str, str]"] + add: NotRequired[Dict[str, str]] """ Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata. """ - remove: NotRequired["List[str]"] + remove: NotRequired[List[str]] """ Keys to remove from schedule phase metadata. """ @@ -5959,19 +6022,21 @@ class UpcomingLinesParamsScheduleDetailsAmendmentTrialSettings(TypedDict): class UpcomingLinesParamsScheduleDetailsAmendmentTrialSettingsEndBehavior( TypedDict, ): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ class UpcomingLinesParamsScheduleDetailsPhase(TypedDict): add_invoice_items: NotRequired[ - "List[Invoice.UpcomingLinesParamsScheduleDetailsPhaseAddInvoiceItem]" + List[ + "Invoice.UpcomingLinesParamsScheduleDetailsPhaseAddInvoiceItem" + ] ] """ A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items. """ - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ @@ -5981,9 +6046,7 @@ class UpcomingLinesParamsScheduleDetailsPhase(TypedDict): """ Automatic tax settings for this phase. """ - billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'phase_start']" - ] + billing_cycle_anchor: NotRequired[Literal["automatic", "phase_start"]] """ Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -5994,20 +6057,20 @@ class UpcomingLinesParamsScheduleDetailsPhase(TypedDict): Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. """ @@ -6039,15 +6102,15 @@ class UpcomingLinesParamsScheduleDetailsPhase(TypedDict): """ List of configuration items, each with an attached price, to apply during this phase of the subscription schedule. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account on behalf of which to charge, for each of the associated subscription's invoices. """ @@ -6058,7 +6121,7 @@ class UpcomingLinesParamsScheduleDetailsPhase(TypedDict): If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/billing/subscriptions/pause-payment). """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. @@ -6073,11 +6136,11 @@ class UpcomingLinesParamsScheduleDetailsPhase(TypedDict): """ The data with which to automatically create a Transfer for each of the associated subscription's invoices. """ - trial: NotRequired["bool"] + trial: NotRequired[bool] """ If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. """ - trial_continuation: NotRequired["Literal['continue', 'none']"] + trial_continuation: NotRequired[Literal["continue", "none"]] """ Specify trial behavior when crossing phase boundaries """ @@ -6094,12 +6157,14 @@ class UpcomingLinesParamsScheduleDetailsPhase(TypedDict): class UpcomingLinesParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): discounts: NotRequired[ - "List[Invoice.UpcomingLinesParamsScheduleDetailsPhaseAddInvoiceItemDiscount]" + List[ + "Invoice.UpcomingLinesParamsScheduleDetailsPhaseAddInvoiceItemDiscount" + ] ] """ The coupons to redeem into discounts for the item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -6109,7 +6174,7 @@ class UpcomingLinesParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. Defaults to 1. """ @@ -6121,11 +6186,11 @@ class UpcomingLinesParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): class UpcomingLinesParamsScheduleDetailsPhaseAddInvoiceItemDiscount( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -6135,7 +6200,7 @@ class UpcomingLinesParamsScheduleDetailsPhaseAddInvoiceItemDiscount( """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -6149,7 +6214,7 @@ class UpcomingLinesParamsScheduleDetailsPhaseAddInvoiceItemDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -6182,16 +6247,16 @@ class UpcomingLinesParamsScheduleDetailsPhaseAddInvoiceItemPriceData( The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -6211,7 +6276,7 @@ class UpcomingLinesParamsScheduleDetailsPhaseAutomaticTax(TypedDict): class UpcomingLinesParamsScheduleDetailsPhaseAutomaticTaxLiability( TypedDict, ): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -6221,21 +6286,21 @@ class UpcomingLinesParamsScheduleDetailsPhaseAutomaticTaxLiability( """ class UpcomingLinesParamsScheduleDetailsPhaseBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ class UpcomingLinesParamsScheduleDetailsPhaseDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -6245,7 +6310,7 @@ class UpcomingLinesParamsScheduleDetailsPhaseDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -6259,7 +6324,7 @@ class UpcomingLinesParamsScheduleDetailsPhaseDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -6285,7 +6350,7 @@ class UpcomingLinesParamsScheduleDetailsPhaseInvoiceSettings(TypedDict): """ The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. """ @@ -6299,7 +6364,7 @@ class UpcomingLinesParamsScheduleDetailsPhaseInvoiceSettings(TypedDict): class UpcomingLinesParamsScheduleDetailsPhaseInvoiceSettingsIssuer( TypedDict, ): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -6321,15 +6386,15 @@ class UpcomingLinesParamsScheduleDetailsPhaseItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The plan ID to subscribe to. You may specify the same ID in `plan` and `price`. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -6339,7 +6404,7 @@ class UpcomingLinesParamsScheduleDetailsPhaseItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`. """ @@ -6363,11 +6428,11 @@ class UpcomingLinesParamsScheduleDetailsPhaseItemBillingThresholds( """ class UpcomingLinesParamsScheduleDetailsPhaseItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -6377,7 +6442,7 @@ class UpcomingLinesParamsScheduleDetailsPhaseItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -6391,7 +6456,7 @@ class UpcomingLinesParamsScheduleDetailsPhaseItemDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -6426,16 +6491,16 @@ class UpcomingLinesParamsScheduleDetailsPhaseItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -6447,13 +6512,13 @@ class UpcomingLinesParamsScheduleDetailsPhaseItemPriceDataRecurring( """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class UpcomingLinesParamsScheduleDetailsPhaseItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -6469,7 +6534,7 @@ class UpcomingLinesParamsScheduleDetailsPhasePauseCollection(TypedDict): """ class UpcomingLinesParamsScheduleDetailsPhaseTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -6489,7 +6554,7 @@ class UpcomingLinesParamsScheduleDetailsPhaseTrialSettings(TypedDict): class UpcomingLinesParamsScheduleDetailsPhaseTrialSettingsEndBehavior( TypedDict, ): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ @@ -6501,7 +6566,7 @@ class UpcomingLinesParamsScheduleDetailsPrebilling(TypedDict): """ The end of the prebilled time period. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ This is used to determine the number of billing cycles to prebill. """ @@ -6519,7 +6584,7 @@ class UpcomingLinesParamsScheduleDetailsPrebillingBillUntil(TypedDict): """ Time span for prebilling, starting from `bill_from`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ End the prebilled period at a precise integer timestamp, starting from the Unix epoch. """ @@ -6557,11 +6622,11 @@ class UpcomingLinesParamsSubscriptionDetails(TypedDict): """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. """ - cancel_at_period_end: NotRequired["bool"] + cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. """ - cancel_now: NotRequired["bool"] + cancel_now: NotRequired[bool] """ This simulates the subscription being canceled or expired immediately. """ @@ -6570,7 +6635,7 @@ class UpcomingLinesParamsSubscriptionDetails(TypedDict): If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. """ items: NotRequired[ - "List[Invoice.UpcomingLinesParamsSubscriptionDetailsItem]" + List["Invoice.UpcomingLinesParamsSubscriptionDetailsItem"] ] """ A list of up to 20 subscription items, each with an attached price. @@ -6582,20 +6647,20 @@ class UpcomingLinesParamsSubscriptionDetails(TypedDict): The pre-billing to apply to the subscription as a preview. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'. """ - resume_at: NotRequired["Literal['now']"] + resume_at: NotRequired[Literal["now"]] """ For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. """ - start_date: NotRequired["int"] + start_date: NotRequired[int] """ Date a subscription is intended to start (can be future or past). """ @@ -6611,11 +6676,11 @@ class UpcomingLinesParamsSubscriptionDetailsItem(TypedDict): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. """ - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`. """ - deleted: NotRequired["bool"] + deleted: NotRequired[bool] """ A flag that, if set to `true`, will delete the specified item. """ @@ -6625,7 +6690,7 @@ class UpcomingLinesParamsSubscriptionDetailsItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - id: NotRequired["str"] + id: NotRequired[str] """ Subscription item to update. """ @@ -6633,11 +6698,11 @@ class UpcomingLinesParamsSubscriptionDetailsItem(TypedDict): """ 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -6647,7 +6712,7 @@ class UpcomingLinesParamsSubscriptionDetailsItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -6665,11 +6730,11 @@ class UpcomingLinesParamsSubscriptionDetailsItemBillingThresholds( """ class UpcomingLinesParamsSubscriptionDetailsItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -6679,7 +6744,7 @@ class UpcomingLinesParamsSubscriptionDetailsItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -6693,7 +6758,7 @@ class UpcomingLinesParamsSubscriptionDetailsItemDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -6728,16 +6793,16 @@ class UpcomingLinesParamsSubscriptionDetailsItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -6749,7 +6814,7 @@ class UpcomingLinesParamsSubscriptionDetailsItemPriceDataRecurring( """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -6767,11 +6832,11 @@ class UpcomingLinesParamsSubscriptionItem(TypedDict): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. """ - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`. """ - deleted: NotRequired["bool"] + deleted: NotRequired[bool] """ A flag that, if set to `true`, will delete the specified item. """ @@ -6781,7 +6846,7 @@ class UpcomingLinesParamsSubscriptionItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - id: NotRequired["str"] + id: NotRequired[str] """ Subscription item to update. """ @@ -6789,11 +6854,11 @@ class UpcomingLinesParamsSubscriptionItem(TypedDict): """ 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -6803,7 +6868,7 @@ class UpcomingLinesParamsSubscriptionItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -6819,11 +6884,11 @@ class UpcomingLinesParamsSubscriptionItemBillingThresholds(TypedDict): """ class UpcomingLinesParamsSubscriptionItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -6833,7 +6898,7 @@ class UpcomingLinesParamsSubscriptionItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -6845,7 +6910,7 @@ class UpcomingLinesParamsSubscriptionItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -6880,16 +6945,16 @@ class UpcomingLinesParamsSubscriptionItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -6899,7 +6964,7 @@ class UpcomingLinesParamsSubscriptionItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -6915,15 +6980,15 @@ class UpcomingParams(RequestOptions): """ Settings for automatic tax lookup for this invoice preview. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency to preview this invoice in. Defaults to that of `customer` if not specified. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. """ @@ -6937,11 +7002,11 @@ class UpcomingParams(RequestOptions): """ The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - invoice_items: NotRequired["List[Invoice.UpcomingParamsInvoiceItem]"] + invoice_items: NotRequired[List["Invoice.UpcomingParamsInvoiceItem"]] """ List of invoice items to add or update in the upcoming invoice preview. """ @@ -6953,11 +7018,11 @@ class UpcomingParams(RequestOptions): """ The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. """ - preview_mode: NotRequired["Literal['next', 'recurring']"] + preview_mode: NotRequired[Literal["next", "recurring"]] """ Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified. """ - schedule: NotRequired["str"] + schedule: NotRequired[str] """ The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. """ @@ -6965,7 +7030,7 @@ class UpcomingParams(RequestOptions): """ The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. """ - subscription: NotRequired["str"] + subscription: NotRequired[str] """ The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. """ @@ -6979,11 +7044,11 @@ class UpcomingParams(RequestOptions): """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. """ - subscription_cancel_at_period_end: NotRequired["bool"] + subscription_cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. """ - subscription_cancel_now: NotRequired["bool"] + subscription_cancel_now: NotRequired[bool] """ This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. """ @@ -6998,7 +7063,7 @@ class UpcomingParams(RequestOptions): The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. """ subscription_items: NotRequired[ - "List[Invoice.UpcomingParamsSubscriptionItem]" + List["Invoice.UpcomingParamsSubscriptionItem"] ] """ A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead. @@ -7010,20 +7075,20 @@ class UpcomingParams(RequestOptions): The pre-billing to apply to the subscription as a preview. This field has been deprecated and will be removed in a future API version. Use `subscription_details.prebilling` instead. """ subscription_proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead. """ - subscription_proration_date: NotRequired["int"] + subscription_proration_date: NotRequired[int] """ If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead. """ - subscription_resume_at: NotRequired["Literal['now']"] + subscription_resume_at: NotRequired[Literal["now"]] """ For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead. """ - subscription_start_date: NotRequired["int"] + subscription_start_date: NotRequired[int] """ Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead. """ @@ -7043,7 +7108,7 @@ class UpcomingParamsAutomaticTax(TypedDict): """ class UpcomingParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -7076,34 +7141,34 @@ class UpcomingParamsCustomerDetails(TypedDict): The customer's tax exemption. One of `none`, `exempt`, or `reverse`. """ tax_ids: NotRequired[ - "List[Invoice.UpcomingParamsCustomerDetailsTaxId]" + List["Invoice.UpcomingParamsCustomerDetailsTaxId"] ] """ The customer's tax IDs. """ class UpcomingParamsCustomerDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -7117,33 +7182,33 @@ class UpcomingParamsCustomerDetailsShipping(TypedDict): """ Customer name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Customer phone (including extension). """ class UpcomingParamsCustomerDetailsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -7233,11 +7298,11 @@ class UpcomingParamsCustomerDetailsTaxId(TypedDict): """ class UpcomingParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -7245,7 +7310,7 @@ class UpcomingParamsDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -7257,7 +7322,7 @@ class UpcomingParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -7277,19 +7342,19 @@ class UpcomingParamsDiscountDiscountEndDuration(TypedDict): """ class UpcomingParamsInvoiceItem(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of previewed invoice item. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only applicable to new invoice items. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items. """ @@ -7299,7 +7364,7 @@ class UpcomingParamsInvoiceItem(TypedDict): """ The coupons to redeem into discounts for the invoice item in the preview. """ - invoiceitem: NotRequired["str"] + invoiceitem: NotRequired[str] """ The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice. """ @@ -7311,7 +7376,7 @@ class UpcomingParamsInvoiceItem(TypedDict): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -7319,12 +7384,12 @@ class UpcomingParamsInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the invoice item. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. @@ -7337,21 +7402,21 @@ class UpcomingParamsInvoiceItem(TypedDict): """ The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class UpcomingParamsInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -7361,7 +7426,7 @@ class UpcomingParamsInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -7373,7 +7438,7 @@ class UpcomingParamsInvoiceItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -7412,22 +7477,22 @@ class UpcomingParamsInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class UpcomingParamsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -7438,22 +7503,22 @@ class UpcomingParamsIssuer(TypedDict): class UpcomingParamsScheduleDetails(TypedDict): amendments: NotRequired[ - "List[Invoice.UpcomingParamsScheduleDetailsAmendment]" + List["Invoice.UpcomingParamsScheduleDetailsAmendment"] ] """ Changes to apply to the phases of the subscription schedule, in the order provided. """ billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. """ - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. """ - phases: NotRequired["List[Invoice.UpcomingParamsScheduleDetailsPhase]"] + phases: NotRequired[List["Invoice.UpcomingParamsScheduleDetailsPhase"]] """ List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. """ @@ -7464,7 +7529,7 @@ class UpcomingParamsScheduleDetails(TypedDict): Provide any time periods to bill in advance. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request. @@ -7482,31 +7547,35 @@ class UpcomingParamsScheduleDetailsAmendment(TypedDict): Details to identify the earliest timestamp where the proposed change should take effect. """ billing_cycle_anchor: NotRequired[ - "Literal['amendment_start', 'automatic']" + Literal["amendment_start", "automatic"] ] """ For a point-in-time amendment, this attribute lets you set or update whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp. """ discount_actions: NotRequired[ - "List[Invoice.UpcomingParamsScheduleDetailsAmendmentDiscountAction]" + List[ + "Invoice.UpcomingParamsScheduleDetailsAmendmentDiscountAction" + ] ] """ Changes to the coupons being redeemed or discounts being applied during the amendment time span. """ item_actions: NotRequired[ - "List[Invoice.UpcomingParamsScheduleDetailsAmendmentItemAction]" + List["Invoice.UpcomingParamsScheduleDetailsAmendmentItemAction"] ] """ Changes to the subscription items during the amendment time span. """ metadata_actions: NotRequired[ - "List[Invoice.UpcomingParamsScheduleDetailsAmendmentMetadataAction]" + List[ + "Invoice.UpcomingParamsScheduleDetailsAmendmentMetadataAction" + ] ] """ Instructions for how to modify phase metadata """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`. @@ -7518,7 +7587,7 @@ class UpcomingParamsScheduleDetailsAmendment(TypedDict): Defines how to pause collection for the underlying subscription throughout the duration of the amendment. """ set_schedule_end: NotRequired[ - "Literal['amendment_end', 'amendment_start']" + Literal["amendment_end", "amendment_start"] ] """ Ends the subscription schedule early as dictated by either the accompanying amendment's start or end. @@ -7543,7 +7612,7 @@ class UpcomingParamsScheduleDetailsAmendmentAmendmentEnd(TypedDict): """ Time span for the amendment starting from the `amendment_start`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`. """ @@ -7593,7 +7662,7 @@ class UpcomingParamsScheduleDetailsAmendmentAmendmentStart(TypedDict): """ Use the `end` time of a given discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to start. """ @@ -7652,11 +7721,11 @@ class UpcomingParamsScheduleDetailsAmendmentDiscountAction(TypedDict): """ class UpcomingParamsScheduleDetailsAmendmentDiscountActionAdd(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to redeem. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount for a coupon that was already redeemed. """ @@ -7666,11 +7735,11 @@ class UpcomingParamsScheduleDetailsAmendmentDiscountActionAdd(TypedDict): """ Details to determine how long the discount should be applied for. """ - index: NotRequired["int"] + index: NotRequired[int] """ The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The promotion code to redeem. """ @@ -7686,29 +7755,29 @@ class UpcomingParamsScheduleDetailsAmendmentDiscountActionAddDiscountEnd( class UpcomingParamsScheduleDetailsAmendmentDiscountActionRemove( TypedDict ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to remove from the `discounts` array. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ The ID of a discount to remove from the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to remove from the `discounts` array. """ class UpcomingParamsScheduleDetailsAmendmentDiscountActionSet(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to replace the `discounts` array with. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount to replace the `discounts` array with. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ An ID of an existing promotion code to replace the `discounts` array with. """ @@ -7739,12 +7808,14 @@ class UpcomingParamsScheduleDetailsAmendmentItemAction(TypedDict): class UpcomingParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): discounts: NotRequired[ - "List[Invoice.UpcomingParamsScheduleDetailsAmendmentItemActionAddDiscount]" + List[ + "Invoice.UpcomingParamsScheduleDetailsAmendmentItemActionAddDiscount" + ] ] """ The discounts applied to the item. Subscription item discounts are applied before subscription discounts. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -7752,11 +7823,11 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. """ @@ -7770,11 +7841,11 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): class UpcomingParamsScheduleDetailsAmendmentItemActionAddDiscount( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -7784,7 +7855,7 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionAddDiscount( """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -7798,7 +7869,7 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionAddDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -7820,7 +7891,7 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionAddDiscountDiscountEndDura """ class UpcomingParamsScheduleDetailsAmendmentItemActionAddTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -7837,12 +7908,14 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionRemove(TypedDict): class UpcomingParamsScheduleDetailsAmendmentItemActionSet(TypedDict): discounts: NotRequired[ - "List[Invoice.UpcomingParamsScheduleDetailsAmendmentItemActionSetDiscount]" + List[ + "Invoice.UpcomingParamsScheduleDetailsAmendmentItemActionSetDiscount" + ] ] """ If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`. """ @@ -7850,11 +7923,11 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionSet(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`. """ @@ -7868,11 +7941,11 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionSet(TypedDict): class UpcomingParamsScheduleDetailsAmendmentItemActionSetDiscount( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -7882,7 +7955,7 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionSetDiscount( """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -7896,7 +7969,7 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionSetDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -7918,7 +7991,7 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionSetDiscountDiscountEndDura """ class UpcomingParamsScheduleDetailsAmendmentItemActionSetTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -7928,11 +8001,11 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionSetTrial(TypedDict): """ class UpcomingParamsScheduleDetailsAmendmentMetadataAction(TypedDict): - add: NotRequired["Dict[str, str]"] + add: NotRequired[Dict[str, str]] """ Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata. """ - remove: NotRequired["List[str]"] + remove: NotRequired[List[str]] """ Keys to remove from schedule phase metadata. """ @@ -7976,19 +8049,19 @@ class UpcomingParamsScheduleDetailsAmendmentTrialSettings(TypedDict): class UpcomingParamsScheduleDetailsAmendmentTrialSettingsEndBehavior( TypedDict, ): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ class UpcomingParamsScheduleDetailsPhase(TypedDict): add_invoice_items: NotRequired[ - "List[Invoice.UpcomingParamsScheduleDetailsPhaseAddInvoiceItem]" + List["Invoice.UpcomingParamsScheduleDetailsPhaseAddInvoiceItem"] ] """ A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items. """ - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ @@ -7998,9 +8071,7 @@ class UpcomingParamsScheduleDetailsPhase(TypedDict): """ Automatic tax settings for this phase. """ - billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'phase_start']" - ] + billing_cycle_anchor: NotRequired[Literal["automatic", "phase_start"]] """ Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -8011,20 +8082,20 @@ class UpcomingParamsScheduleDetailsPhase(TypedDict): Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. """ @@ -8056,15 +8127,15 @@ class UpcomingParamsScheduleDetailsPhase(TypedDict): """ List of configuration items, each with an attached price, to apply during this phase of the subscription schedule. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account on behalf of which to charge, for each of the associated subscription's invoices. """ @@ -8075,7 +8146,7 @@ class UpcomingParamsScheduleDetailsPhase(TypedDict): If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/billing/subscriptions/pause-payment). """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. @@ -8090,11 +8161,11 @@ class UpcomingParamsScheduleDetailsPhase(TypedDict): """ The data with which to automatically create a Transfer for each of the associated subscription's invoices. """ - trial: NotRequired["bool"] + trial: NotRequired[bool] """ If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. """ - trial_continuation: NotRequired["Literal['continue', 'none']"] + trial_continuation: NotRequired[Literal["continue", "none"]] """ Specify trial behavior when crossing phase boundaries """ @@ -8111,12 +8182,14 @@ class UpcomingParamsScheduleDetailsPhase(TypedDict): class UpcomingParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): discounts: NotRequired[ - "List[Invoice.UpcomingParamsScheduleDetailsPhaseAddInvoiceItemDiscount]" + List[ + "Invoice.UpcomingParamsScheduleDetailsPhaseAddInvoiceItemDiscount" + ] ] """ The coupons to redeem into discounts for the item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -8126,7 +8199,7 @@ class UpcomingParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. Defaults to 1. """ @@ -8136,11 +8209,11 @@ class UpcomingParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): """ class UpcomingParamsScheduleDetailsPhaseAddInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -8150,7 +8223,7 @@ class UpcomingParamsScheduleDetailsPhaseAddInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -8164,7 +8237,7 @@ class UpcomingParamsScheduleDetailsPhaseAddInvoiceItemDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -8195,16 +8268,16 @@ class UpcomingParamsScheduleDetailsPhaseAddInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -8222,7 +8295,7 @@ class UpcomingParamsScheduleDetailsPhaseAutomaticTax(TypedDict): """ class UpcomingParamsScheduleDetailsPhaseAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -8232,21 +8305,21 @@ class UpcomingParamsScheduleDetailsPhaseAutomaticTaxLiability(TypedDict): """ class UpcomingParamsScheduleDetailsPhaseBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ class UpcomingParamsScheduleDetailsPhaseDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -8256,7 +8329,7 @@ class UpcomingParamsScheduleDetailsPhaseDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -8268,7 +8341,7 @@ class UpcomingParamsScheduleDetailsPhaseDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -8294,7 +8367,7 @@ class UpcomingParamsScheduleDetailsPhaseInvoiceSettings(TypedDict): """ The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. """ @@ -8306,7 +8379,7 @@ class UpcomingParamsScheduleDetailsPhaseInvoiceSettings(TypedDict): """ class UpcomingParamsScheduleDetailsPhaseInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -8328,15 +8401,15 @@ class UpcomingParamsScheduleDetailsPhaseItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The plan ID to subscribe to. You may specify the same ID in `plan` and `price`. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -8346,7 +8419,7 @@ class UpcomingParamsScheduleDetailsPhaseItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`. """ @@ -8368,11 +8441,11 @@ class UpcomingParamsScheduleDetailsPhaseItemBillingThresholds(TypedDict): """ class UpcomingParamsScheduleDetailsPhaseItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -8382,7 +8455,7 @@ class UpcomingParamsScheduleDetailsPhaseItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -8394,7 +8467,7 @@ class UpcomingParamsScheduleDetailsPhaseItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -8429,16 +8502,16 @@ class UpcomingParamsScheduleDetailsPhaseItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -8448,13 +8521,13 @@ class UpcomingParamsScheduleDetailsPhaseItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class UpcomingParamsScheduleDetailsPhaseItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -8470,7 +8543,7 @@ class UpcomingParamsScheduleDetailsPhasePauseCollection(TypedDict): """ class UpcomingParamsScheduleDetailsPhaseTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -8490,7 +8563,7 @@ class UpcomingParamsScheduleDetailsPhaseTrialSettings(TypedDict): class UpcomingParamsScheduleDetailsPhaseTrialSettingsEndBehavior( TypedDict ): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ @@ -8502,7 +8575,7 @@ class UpcomingParamsScheduleDetailsPrebilling(TypedDict): """ The end of the prebilled time period. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ This is used to determine the number of billing cycles to prebill. """ @@ -8520,7 +8593,7 @@ class UpcomingParamsScheduleDetailsPrebillingBillUntil(TypedDict): """ Time span for prebilling, starting from `bill_from`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ End the prebilled period at a precise integer timestamp, starting from the Unix epoch. """ @@ -8556,11 +8629,11 @@ class UpcomingParamsSubscriptionDetails(TypedDict): """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. """ - cancel_at_period_end: NotRequired["bool"] + cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. """ - cancel_now: NotRequired["bool"] + cancel_now: NotRequired[bool] """ This simulates the subscription being canceled or expired immediately. """ @@ -8569,7 +8642,7 @@ class UpcomingParamsSubscriptionDetails(TypedDict): If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. """ items: NotRequired[ - "List[Invoice.UpcomingParamsSubscriptionDetailsItem]" + List["Invoice.UpcomingParamsSubscriptionDetailsItem"] ] """ A list of up to 20 subscription items, each with an attached price. @@ -8581,20 +8654,20 @@ class UpcomingParamsSubscriptionDetails(TypedDict): The pre-billing to apply to the subscription as a preview. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'. """ - resume_at: NotRequired["Literal['now']"] + resume_at: NotRequired[Literal["now"]] """ For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. """ - start_date: NotRequired["int"] + start_date: NotRequired[int] """ Date a subscription is intended to start (can be future or past). """ @@ -8610,11 +8683,11 @@ class UpcomingParamsSubscriptionDetailsItem(TypedDict): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. """ - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`. """ - deleted: NotRequired["bool"] + deleted: NotRequired[bool] """ A flag that, if set to `true`, will delete the specified item. """ @@ -8624,7 +8697,7 @@ class UpcomingParamsSubscriptionDetailsItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - id: NotRequired["str"] + id: NotRequired[str] """ Subscription item to update. """ @@ -8632,11 +8705,11 @@ class UpcomingParamsSubscriptionDetailsItem(TypedDict): """ 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -8646,7 +8719,7 @@ class UpcomingParamsSubscriptionDetailsItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -8662,11 +8735,11 @@ class UpcomingParamsSubscriptionDetailsItemBillingThresholds(TypedDict): """ class UpcomingParamsSubscriptionDetailsItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -8676,7 +8749,7 @@ class UpcomingParamsSubscriptionDetailsItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -8688,7 +8761,7 @@ class UpcomingParamsSubscriptionDetailsItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -8723,16 +8796,16 @@ class UpcomingParamsSubscriptionDetailsItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -8742,7 +8815,7 @@ class UpcomingParamsSubscriptionDetailsItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -8760,11 +8833,11 @@ class UpcomingParamsSubscriptionItem(TypedDict): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. """ - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`. """ - deleted: NotRequired["bool"] + deleted: NotRequired[bool] """ A flag that, if set to `true`, will delete the specified item. """ @@ -8774,7 +8847,7 @@ class UpcomingParamsSubscriptionItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - id: NotRequired["str"] + id: NotRequired[str] """ Subscription item to update. """ @@ -8782,11 +8855,11 @@ class UpcomingParamsSubscriptionItem(TypedDict): """ 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -8796,7 +8869,7 @@ class UpcomingParamsSubscriptionItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -8812,11 +8885,11 @@ class UpcomingParamsSubscriptionItemBillingThresholds(TypedDict): """ class UpcomingParamsSubscriptionItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -8826,7 +8899,7 @@ class UpcomingParamsSubscriptionItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -8838,7 +8911,7 @@ class UpcomingParamsSubscriptionItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -8871,16 +8944,16 @@ class UpcomingParamsSubscriptionItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -8890,7 +8963,7 @@ class UpcomingParamsSubscriptionItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -8902,7 +8975,7 @@ class UpcomingParamsSubscriptionPrebilling(TypedDict): """ class UpdateLinesParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -8916,15 +8989,15 @@ class UpdateLinesParams(RequestOptions): """ class UpdateLinesParamsLine(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations. """ @@ -8950,7 +9023,7 @@ class UpdateLinesParamsLine(TypedDict): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -8958,7 +9031,7 @@ class UpdateLinesParamsLine(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the line item. """ @@ -8974,11 +9047,11 @@ class UpdateLinesParamsLine(TypedDict): """ class UpdateLinesParamsLineDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -8996,7 +9069,7 @@ class UpdateLinesParamsLineDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -9030,7 +9103,7 @@ class UpdateLinesParamsLinePriceData(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - product: NotRequired["str"] + product: NotRequired[str] """ The ID of the product that this price will belong to. One of `product` or `product_data` is required. """ @@ -9041,30 +9114,30 @@ class UpdateLinesParamsLinePriceData(TypedDict): Data used to generate a new product object inline. One of `product` or `product_data` is required. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class UpdateLinesParamsLinePriceDataProductData(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. """ - images: NotRequired["List[str]"] + images: NotRequired[List[str]] """ A list of up to 8 URLs of images for this product, meant to be displayable to the customer. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -9072,7 +9145,7 @@ class UpdateLinesParamsLinePriceDataProductData(TypedDict): """ The product's name, meant to be displayable to the customer. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ @@ -9094,11 +9167,11 @@ class UpdateLinesParamsLineTaxAmount(TypedDict): """ class UpdateLinesParamsLineTaxAmountTaxRateData(TypedDict): - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. """ @@ -9110,7 +9183,7 @@ class UpdateLinesParamsLineTaxAmountTaxRateData(TypedDict): """ This specifies if the tax rate is inclusive or exclusive. """ - jurisdiction: NotRequired["str"] + jurisdiction: NotRequired[str] """ The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice. """ @@ -9118,19 +9191,32 @@ class UpdateLinesParamsLineTaxAmountTaxRateData(TypedDict): """ The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero. """ - state: NotRequired["str"] + state: NotRequired[str] """ [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. """ tax_type: NotRequired[ - "Literal['amusement_tax', 'communications_tax', 'gst', 'hst', 'igst', 'jct', 'lease_tax', 'pst', 'qst', 'rst', 'sales_tax', 'vat']" + Literal[ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat", + ] ] """ The high-level tax type, such as `vat` or `sales_tax`. """ class VoidInvoiceParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_invoice_item.py b/stripe/_invoice_item.py index 5ca5f7f17..737a68b14 100644 --- a/stripe/_invoice_item.py +++ b/stripe/_invoice_item.py @@ -63,11 +63,11 @@ class Period(StripeObject): """ class CreateParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ @@ -75,11 +75,11 @@ class CreateParams(RequestOptions): """ The ID of the customer who will be billed when this invoice item is billed. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. """ @@ -89,15 +89,15 @@ class CreateParams(RequestOptions): """ The coupons to redeem into discounts for the invoice item or invoice line item. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - invoice: NotRequired["str"] + invoice: NotRequired[str] """ The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice. """ - margins: NotRequired["List[str]"] + margins: NotRequired[List[str]] """ The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item. """ @@ -109,7 +109,7 @@ class CreateParams(RequestOptions): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -117,16 +117,16 @@ class CreateParams(RequestOptions): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the invoice item. """ - subscription: NotRequired["str"] + subscription: NotRequired[str] """ The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. @@ -135,25 +135,25 @@ class CreateParams(RequestOptions): """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class CreateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -171,7 +171,7 @@ class CreateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -210,16 +210,16 @@ class CreateParamsPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -232,63 +232,63 @@ class ListParams(RequestOptions): """ Only return invoice items that were created during the given date interval. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - invoice: NotRequired["str"] + invoice: NotRequired[str] """ Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed. """ - limit: NotRequired["int"] + 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. """ - pending: NotRequired["bool"] + pending: NotRequired[bool] """ Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations. """ @@ -298,7 +298,7 @@ class ModifyParams(RequestOptions): """ The coupons & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -314,7 +314,7 @@ class ModifyParams(RequestOptions): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -322,12 +322,12 @@ class ModifyParams(RequestOptions): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the invoice item. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. @@ -340,21 +340,21 @@ class ModifyParams(RequestOptions): """ The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class ModifyParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -372,7 +372,7 @@ class ModifyParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -411,22 +411,22 @@ class ModifyParamsPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_invoice_item_service.py b/stripe/_invoice_item_service.py index 28e68894e..a0cb1f21d 100644 --- a/stripe/_invoice_item_service.py +++ b/stripe/_invoice_item_service.py @@ -11,11 +11,11 @@ class InvoiceItemService(StripeService): class CreateParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ @@ -23,11 +23,11 @@ class CreateParams(TypedDict): """ The ID of the customer who will be billed when this invoice item is billed. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. """ @@ -37,15 +37,15 @@ class CreateParams(TypedDict): """ The coupons to redeem into discounts for the invoice item or invoice line item. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - invoice: NotRequired["str"] + invoice: NotRequired[str] """ The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice. """ - margins: NotRequired["List[str]"] + margins: NotRequired[List[str]] """ The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item. """ @@ -57,7 +57,7 @@ class CreateParams(TypedDict): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -65,16 +65,16 @@ class CreateParams(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the invoice item. """ - subscription: NotRequired["str"] + subscription: NotRequired[str] """ The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. @@ -83,25 +83,25 @@ class CreateParams(TypedDict): """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class CreateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -119,7 +119,7 @@ class CreateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -158,16 +158,16 @@ class CreateParamsPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -180,69 +180,69 @@ class ListParams(TypedDict): """ Only return invoice items that were created during the given date interval. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - invoice: NotRequired["str"] + invoice: NotRequired[str] """ Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed. """ - limit: NotRequired["int"] + 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. """ - pending: NotRequired["bool"] + pending: NotRequired[bool] """ Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations. """ @@ -252,7 +252,7 @@ class UpdateParams(TypedDict): """ The coupons & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -268,7 +268,7 @@ class UpdateParams(TypedDict): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -276,12 +276,12 @@ class UpdateParams(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the invoice item. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. @@ -294,21 +294,21 @@ class UpdateParams(TypedDict): """ The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class UpdateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -326,7 +326,7 @@ class UpdateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -365,16 +365,16 @@ class UpdateParamsPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ diff --git a/stripe/_invoice_line_item.py b/stripe/_invoice_line_item.py index 7e7da72c5..9c46e7b3a 100644 --- a/stripe/_invoice_line_item.py +++ b/stripe/_invoice_line_item.py @@ -116,15 +116,15 @@ class TaxAmount(StripeObject): """ class ModifyParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations. """ @@ -134,7 +134,7 @@ class ModifyParams(RequestOptions): """ The coupons & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -150,7 +150,7 @@ class ModifyParams(RequestOptions): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -158,7 +158,7 @@ class ModifyParams(RequestOptions): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the line item. """ @@ -174,11 +174,11 @@ class ModifyParams(RequestOptions): """ class ModifyParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -196,7 +196,7 @@ class ModifyParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -230,7 +230,7 @@ class ModifyParamsPriceData(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - product: NotRequired["str"] + product: NotRequired[str] """ The ID of the product that this price will belong to. One of `product` or `product_data` is required. """ @@ -241,30 +241,30 @@ class ModifyParamsPriceData(TypedDict): Data used to generate a new product object inline. One of `product` or `product_data` is required. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class ModifyParamsPriceDataProductData(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. """ - images: NotRequired["List[str]"] + images: NotRequired[List[str]] """ A list of up to 8 URLs of images for this product, meant to be displayable to the customer. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -272,7 +272,7 @@ class ModifyParamsPriceDataProductData(TypedDict): """ The product's name, meant to be displayable to the customer. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ @@ -294,11 +294,11 @@ class ModifyParamsTaxAmount(TypedDict): """ class ModifyParamsTaxAmountTaxRateData(TypedDict): - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. """ @@ -310,7 +310,7 @@ class ModifyParamsTaxAmountTaxRateData(TypedDict): """ This specifies if the tax rate is inclusive or exclusive. """ - jurisdiction: NotRequired["str"] + jurisdiction: NotRequired[str] """ The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice. """ @@ -318,12 +318,26 @@ class ModifyParamsTaxAmountTaxRateData(TypedDict): """ The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero. """ - state: NotRequired["str"] + state: NotRequired[str] """ [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. """ tax_type: NotRequired[ - "Literal['amusement_tax', 'communications_tax', 'gst', 'hst', 'igst', 'jct', 'lease_tax', 'pst', 'qst', 'rst', 'sales_tax', 'vat', 'service_tax']" + Literal[ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat", + "service_tax", + ] ] """ The high-level tax type, such as `vat` or `sales_tax`. diff --git a/stripe/_invoice_line_item_service.py b/stripe/_invoice_line_item_service.py index 0818c3c1e..6c87261e2 100644 --- a/stripe/_invoice_line_item_service.py +++ b/stripe/_invoice_line_item_service.py @@ -11,33 +11,33 @@ class InvoiceLineItemService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 UpdateParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations. """ @@ -47,7 +47,7 @@ class UpdateParams(TypedDict): """ The coupons & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -63,7 +63,7 @@ class UpdateParams(TypedDict): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -71,7 +71,7 @@ class UpdateParams(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the line item. """ @@ -87,11 +87,11 @@ class UpdateParams(TypedDict): """ class UpdateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -109,7 +109,7 @@ class UpdateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -143,7 +143,7 @@ class UpdateParamsPriceData(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - product: NotRequired["str"] + product: NotRequired[str] """ The ID of the product that this price will belong to. One of `product` or `product_data` is required. """ @@ -154,30 +154,30 @@ class UpdateParamsPriceData(TypedDict): Data used to generate a new product object inline. One of `product` or `product_data` is required. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class UpdateParamsPriceDataProductData(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. """ - images: NotRequired["List[str]"] + images: NotRequired[List[str]] """ A list of up to 8 URLs of images for this product, meant to be displayable to the customer. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -185,7 +185,7 @@ class UpdateParamsPriceDataProductData(TypedDict): """ The product's name, meant to be displayable to the customer. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ @@ -207,11 +207,11 @@ class UpdateParamsTaxAmount(TypedDict): """ class UpdateParamsTaxAmountTaxRateData(TypedDict): - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. """ @@ -223,7 +223,7 @@ class UpdateParamsTaxAmountTaxRateData(TypedDict): """ This specifies if the tax rate is inclusive or exclusive. """ - jurisdiction: NotRequired["str"] + jurisdiction: NotRequired[str] """ The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice. """ @@ -231,12 +231,26 @@ class UpdateParamsTaxAmountTaxRateData(TypedDict): """ The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero. """ - state: NotRequired["str"] + state: NotRequired[str] """ [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. """ tax_type: NotRequired[ - "Literal['amusement_tax', 'communications_tax', 'gst', 'hst', 'igst', 'jct', 'lease_tax', 'pst', 'qst', 'rst', 'sales_tax', 'vat', 'service_tax']" + Literal[ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat", + "service_tax", + ] ] """ The high-level tax type, such as `vat` or `sales_tax`. diff --git a/stripe/_invoice_payment_service.py b/stripe/_invoice_payment_service.py index 66515402f..56d2cd592 100644 --- a/stripe/_invoice_payment_service.py +++ b/stripe/_invoice_payment_service.py @@ -11,25 +11,25 @@ class InvoicePaymentService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_invoice_service.py b/stripe/_invoice_service.py index 05c984b66..d792df516 100644 --- a/stripe/_invoice_service.py +++ b/stripe/_invoice_service.py @@ -21,7 +21,7 @@ def __init__(self, requestor): self.upcoming_lines = InvoiceUpcomingLinesService(self._requestor) class AddLinesParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -35,15 +35,15 @@ class AddLinesParams(TypedDict): """ class AddLinesParamsLine(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations. """ @@ -53,7 +53,7 @@ class AddLinesParamsLine(TypedDict): """ The coupons & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. """ - invoice_item: NotRequired["str"] + invoice_item: NotRequired[str] """ ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created. """ @@ -69,7 +69,7 @@ class AddLinesParamsLine(TypedDict): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -77,7 +77,7 @@ class AddLinesParamsLine(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the line item. """ @@ -93,11 +93,11 @@ class AddLinesParamsLine(TypedDict): """ class AddLinesParamsLineDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -115,7 +115,7 @@ class AddLinesParamsLineDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -149,7 +149,7 @@ class AddLinesParamsLinePriceData(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - product: NotRequired["str"] + product: NotRequired[str] """ The ID of the product that this price will belong to. One of `product` or `product_data` is required. """ @@ -160,30 +160,30 @@ class AddLinesParamsLinePriceData(TypedDict): Data used to generate a new product object inline. One of `product` or `product_data` is required. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class AddLinesParamsLinePriceDataProductData(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. """ - images: NotRequired["List[str]"] + images: NotRequired[List[str]] """ A list of up to 8 URLs of images for this product, meant to be displayable to the customer. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -191,7 +191,7 @@ class AddLinesParamsLinePriceDataProductData(TypedDict): """ The product's name, meant to be displayable to the customer. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ @@ -213,11 +213,11 @@ class AddLinesParamsLineTaxAmount(TypedDict): """ class AddLinesParamsLineTaxAmountTaxRateData(TypedDict): - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. """ @@ -229,7 +229,7 @@ class AddLinesParamsLineTaxAmountTaxRateData(TypedDict): """ This specifies if the tax rate is inclusive or exclusive. """ - jurisdiction: NotRequired["str"] + jurisdiction: NotRequired[str] """ The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice. """ @@ -237,23 +237,36 @@ class AddLinesParamsLineTaxAmountTaxRateData(TypedDict): """ The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero. """ - state: NotRequired["str"] + state: NotRequired[str] """ [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. """ tax_type: NotRequired[ - "Literal['amusement_tax', 'communications_tax', 'gst', 'hst', 'igst', 'jct', 'lease_tax', 'pst', 'qst', 'rst', 'sales_tax', 'vat']" + Literal[ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat", + ] ] """ The high-level tax type, such as `vat` or `sales_tax`. """ class AttachPaymentIntentParams(TypedDict): - amount_requested: NotRequired["int"] + amount_requested: NotRequired[int] """ The portion of the PaymentIntent's `amount` that should be applied to thisinvoice. Defaults to the entire amount. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -273,11 +286,11 @@ class CreateParams(TypedDict): """ List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`. """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). """ - auto_advance: NotRequired["bool"] + auto_advance: NotRequired[bool] """ Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. """ @@ -286,12 +299,12 @@ class CreateParams(TypedDict): Settings for automatic tax lookup for this invoice. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency to create this invoice in. Defaults to that of `customer` if not specified. """ @@ -301,31 +314,31 @@ class CreateParams(TypedDict): """ A list of up to 4 custom fields to be displayed on the invoice. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of the customer who will be billed. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`. """ - default_margins: NotRequired["List[str]"] + default_margins: NotRequired[List[str]] """ The ids of the margins to apply to the invoice. Can be overridden by line item `margins`. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. """ - default_source: NotRequired["str"] + default_source: NotRequired[str] """ ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. """ - default_tax_rates: NotRequired["List[str]"] + default_tax_rates: NotRequired[List[str]] """ The tax rates that will apply to any line item that does not have `tax_rates` set. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. """ @@ -335,19 +348,19 @@ class CreateParams(TypedDict): """ The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts. """ - due_date: NotRequired["int"] + due_date: NotRequired[int] """ The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`. """ - effective_at: NotRequired["int"] + effective_at: NotRequired[int] """ The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - footer: NotRequired["str"] + footer: NotRequired[str] """ Footer to be displayed on the invoice. """ @@ -363,11 +376,11 @@ class CreateParams(TypedDict): """ 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`. """ - number: NotRequired["str"] + number: NotRequired[str] """ Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. """ @@ -378,7 +391,7 @@ class CreateParams(TypedDict): Configuration settings for the PaymentIntent that is generated when the invoice is finalized. """ pending_invoice_items_behavior: NotRequired[ - "Literal['exclude', 'include', 'include_and_require']" + Literal["exclude", "include", "include_and_require"] ] """ How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted. @@ -403,11 +416,11 @@ class CreateParams(TypedDict): """ Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. """ - subscription: NotRequired["str"] + subscription: NotRequired[str] """ The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected. """ @@ -421,7 +434,7 @@ class CreateParamsAmountsDue(TypedDict): """ The amount in cents (or local equivalent). """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days from when invoice is finalized until the payment is due. """ @@ -429,7 +442,7 @@ class CreateParamsAmountsDue(TypedDict): """ An arbitrary string attached to the object. Often useful for displaying to users. """ - due_date: NotRequired["int"] + due_date: NotRequired[int] """ Date on which a payment plan's payment is due. """ @@ -447,7 +460,7 @@ class CreateParamsAutomaticTax(TypedDict): """ class CreateParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -467,11 +480,11 @@ class CreateParamsCustomField(TypedDict): """ class CreateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -489,7 +502,7 @@ class CreateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -519,7 +532,7 @@ class CreateParamsFromInvoice(TypedDict): """ class CreateParamsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -598,7 +611,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -607,13 +620,13 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions( TypedDict, ): - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ class CreateParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -628,7 +641,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. @@ -637,7 +650,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): class CreateParamsPaymentSettingsPaymentMethodOptionsCardInstallments( TypedDict, ): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Setting to true enables installments for this invoice. Setting to false will prevent any selected plan from applying to a payment. @@ -675,7 +688,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalance( """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["str"] + funding_type: NotRequired[str] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ @@ -689,7 +702,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer """ Configuration for eu_bank_transfer funding type. """ - type: NotRequired["str"] + type: NotRequired[str] """ The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. """ @@ -718,7 +731,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccount( Additional fields for Financial Connections Session creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -728,13 +741,24 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConne TypedDict, ): permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. @@ -761,7 +785,7 @@ class CreateParamsRenderingOptions(TypedDict): """ class CreateParamsRenderingPdf(TypedDict): - page_size: NotRequired["Literal['a4', 'auto', 'letter']"] + page_size: NotRequired[Literal["a4", "auto", "letter"]] """ Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`. If set to `auto`, invoice PDF page size defaults to `a4` for customers with @@ -769,7 +793,7 @@ class CreateParamsRenderingPdf(TypedDict): """ class CreateParamsShippingCost(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the shipping rate to use for this order. """ @@ -797,21 +821,21 @@ class CreateParamsShippingCostShippingRateData(TypedDict): """ Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ - type: NotRequired["Literal['fixed_amount']"] + type: NotRequired[Literal["fixed_amount"]] """ The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. """ @@ -864,7 +888,10 @@ class CreateParamsShippingCostShippingRateDataFixedAmount(TypedDict): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, InvoiceService.CreateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions]" + Dict[ + str, + "InvoiceService.CreateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions", + ] ] """ Shipping rates 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). @@ -878,7 +905,7 @@ class CreateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions( A non-negative integer in cents representing how much to charge. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. @@ -899,33 +926,33 @@ class CreateParamsShippingDetails(TypedDict): """ class CreateParamsShippingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. """ @@ -941,15 +968,15 @@ class CreatePreviewParams(TypedDict): """ Settings for automatic tax lookup for this invoice preview. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency to preview this invoice in. Defaults to that of `customer` if not specified. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. """ @@ -965,12 +992,12 @@ class CreatePreviewParams(TypedDict): """ The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ invoice_items: NotRequired[ - "List[InvoiceService.CreatePreviewParamsInvoiceItem]" + List["InvoiceService.CreatePreviewParamsInvoiceItem"] ] """ List of invoice items to add or update in the upcoming invoice preview. @@ -983,11 +1010,11 @@ class CreatePreviewParams(TypedDict): """ The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. """ - preview_mode: NotRequired["Literal['next', 'recurring']"] + preview_mode: NotRequired[Literal["next", "recurring"]] """ Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified. """ - schedule: NotRequired["str"] + schedule: NotRequired[str] """ The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. """ @@ -997,7 +1024,7 @@ class CreatePreviewParams(TypedDict): """ The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. """ - subscription: NotRequired["str"] + subscription: NotRequired[str] """ The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. """ @@ -1011,11 +1038,11 @@ class CreatePreviewParams(TypedDict): """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. """ - subscription_cancel_at_period_end: NotRequired["bool"] + subscription_cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. """ - subscription_cancel_now: NotRequired["bool"] + subscription_cancel_now: NotRequired[bool] """ This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. """ @@ -1030,7 +1057,7 @@ class CreatePreviewParams(TypedDict): The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. """ subscription_items: NotRequired[ - "List[InvoiceService.CreatePreviewParamsSubscriptionItem]" + List["InvoiceService.CreatePreviewParamsSubscriptionItem"] ] """ A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead. @@ -1042,20 +1069,20 @@ class CreatePreviewParams(TypedDict): The pre-billing to apply to the subscription as a preview. This field has been deprecated and will be removed in a future API version. Use `subscription_details.prebilling` instead. """ subscription_proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead. """ - subscription_proration_date: NotRequired["int"] + subscription_proration_date: NotRequired[int] """ If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead. """ - subscription_resume_at: NotRequired["Literal['now']"] + subscription_resume_at: NotRequired[Literal["now"]] """ For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead. """ - subscription_start_date: NotRequired["int"] + subscription_start_date: NotRequired[int] """ Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead. """ @@ -1077,7 +1104,7 @@ class CreatePreviewParamsAutomaticTax(TypedDict): """ class CreatePreviewParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1112,34 +1139,34 @@ class CreatePreviewParamsCustomerDetails(TypedDict): The customer's tax exemption. One of `none`, `exempt`, or `reverse`. """ tax_ids: NotRequired[ - "List[InvoiceService.CreatePreviewParamsCustomerDetailsTaxId]" + List["InvoiceService.CreatePreviewParamsCustomerDetailsTaxId"] ] """ The customer's tax IDs. """ class CreatePreviewParamsCustomerDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1153,33 +1180,33 @@ class CreatePreviewParamsCustomerDetailsShipping(TypedDict): """ Customer name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Customer phone (including extension). """ class CreatePreviewParamsCustomerDetailsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1269,11 +1296,11 @@ class CreatePreviewParamsCustomerDetailsTaxId(TypedDict): """ class CreatePreviewParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1283,7 +1310,7 @@ class CreatePreviewParamsDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1295,7 +1322,7 @@ class CreatePreviewParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1315,19 +1342,19 @@ class CreatePreviewParamsDiscountDiscountEndDuration(TypedDict): """ class CreatePreviewParamsInvoiceItem(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of previewed invoice item. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only applicable to new invoice items. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items. """ @@ -1337,7 +1364,7 @@ class CreatePreviewParamsInvoiceItem(TypedDict): """ The coupons to redeem into discounts for the invoice item in the preview. """ - invoiceitem: NotRequired["str"] + invoiceitem: NotRequired[str] """ The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice. """ @@ -1351,7 +1378,7 @@ class CreatePreviewParamsInvoiceItem(TypedDict): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -1361,12 +1388,12 @@ class CreatePreviewParamsInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the invoice item. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. @@ -1379,21 +1406,21 @@ class CreatePreviewParamsInvoiceItem(TypedDict): """ The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class CreatePreviewParamsInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1403,7 +1430,7 @@ class CreatePreviewParamsInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1415,7 +1442,7 @@ class CreatePreviewParamsInvoiceItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1454,22 +1481,22 @@ class CreatePreviewParamsInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class CreatePreviewParamsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1480,23 +1507,23 @@ class CreatePreviewParamsIssuer(TypedDict): class CreatePreviewParamsScheduleDetails(TypedDict): amendments: NotRequired[ - "List[InvoiceService.CreatePreviewParamsScheduleDetailsAmendment]" + List["InvoiceService.CreatePreviewParamsScheduleDetailsAmendment"] ] """ Changes to apply to the phases of the subscription schedule, in the order provided. """ billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. """ - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. """ phases: NotRequired[ - "List[InvoiceService.CreatePreviewParamsScheduleDetailsPhase]" + List["InvoiceService.CreatePreviewParamsScheduleDetailsPhase"] ] """ List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. @@ -1508,7 +1535,7 @@ class CreatePreviewParamsScheduleDetails(TypedDict): Provide any time periods to bill in advance. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request. @@ -1526,31 +1553,37 @@ class CreatePreviewParamsScheduleDetailsAmendment(TypedDict): Details to identify the earliest timestamp where the proposed change should take effect. """ billing_cycle_anchor: NotRequired[ - "Literal['amendment_start', 'automatic']" + Literal["amendment_start", "automatic"] ] """ For a point-in-time amendment, this attribute lets you set or update whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp. """ discount_actions: NotRequired[ - "List[InvoiceService.CreatePreviewParamsScheduleDetailsAmendmentDiscountAction]" + List[ + "InvoiceService.CreatePreviewParamsScheduleDetailsAmendmentDiscountAction" + ] ] """ Changes to the coupons being redeemed or discounts being applied during the amendment time span. """ item_actions: NotRequired[ - "List[InvoiceService.CreatePreviewParamsScheduleDetailsAmendmentItemAction]" + List[ + "InvoiceService.CreatePreviewParamsScheduleDetailsAmendmentItemAction" + ] ] """ Changes to the subscription items during the amendment time span. """ metadata_actions: NotRequired[ - "List[InvoiceService.CreatePreviewParamsScheduleDetailsAmendmentMetadataAction]" + List[ + "InvoiceService.CreatePreviewParamsScheduleDetailsAmendmentMetadataAction" + ] ] """ Instructions for how to modify phase metadata """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`. @@ -1562,7 +1595,7 @@ class CreatePreviewParamsScheduleDetailsAmendment(TypedDict): Defines how to pause collection for the underlying subscription throughout the duration of the amendment. """ set_schedule_end: NotRequired[ - "Literal['amendment_end', 'amendment_start']" + Literal["amendment_end", "amendment_start"] ] """ Ends the subscription schedule early as dictated by either the accompanying amendment's start or end. @@ -1587,7 +1620,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentAmendmentEnd(TypedDict): """ Time span for the amendment starting from the `amendment_start`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`. """ @@ -1637,7 +1670,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentAmendmentStart(TypedDict): """ Use the `end` time of a given discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to start. """ @@ -1698,11 +1731,11 @@ class CreatePreviewParamsScheduleDetailsAmendmentDiscountAction(TypedDict): class CreatePreviewParamsScheduleDetailsAmendmentDiscountActionAdd( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to redeem. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount for a coupon that was already redeemed. """ @@ -1712,11 +1745,11 @@ class CreatePreviewParamsScheduleDetailsAmendmentDiscountActionAdd( """ Details to determine how long the discount should be applied for. """ - index: NotRequired["int"] + index: NotRequired[int] """ The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The promotion code to redeem. """ @@ -1732,15 +1765,15 @@ class CreatePreviewParamsScheduleDetailsAmendmentDiscountActionAddDiscountEnd( class CreatePreviewParamsScheduleDetailsAmendmentDiscountActionRemove( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to remove from the `discounts` array. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ The ID of a discount to remove from the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to remove from the `discounts` array. """ @@ -1748,15 +1781,15 @@ class CreatePreviewParamsScheduleDetailsAmendmentDiscountActionRemove( class CreatePreviewParamsScheduleDetailsAmendmentDiscountActionSet( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to replace the `discounts` array with. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount to replace the `discounts` array with. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ An ID of an existing promotion code to replace the `discounts` array with. """ @@ -1787,12 +1820,14 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemAction(TypedDict): class CreatePreviewParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): discounts: NotRequired[ - "List[InvoiceService.CreatePreviewParamsScheduleDetailsAmendmentItemActionAddDiscount]" + List[ + "InvoiceService.CreatePreviewParamsScheduleDetailsAmendmentItemActionAddDiscount" + ] ] """ The discounts applied to the item. Subscription item discounts are applied before subscription discounts. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -1800,11 +1835,11 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. """ @@ -1818,11 +1853,11 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): class CreatePreviewParamsScheduleDetailsAmendmentItemActionAddDiscount( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1832,7 +1867,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionAddDiscount( """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1846,7 +1881,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionAddDiscountDiscountEn """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1870,7 +1905,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionAddDiscountDiscountEn class CreatePreviewParamsScheduleDetailsAmendmentItemActionAddTrial( TypedDict, ): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -1889,12 +1924,14 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionRemove( class CreatePreviewParamsScheduleDetailsAmendmentItemActionSet(TypedDict): discounts: NotRequired[ - "List[InvoiceService.CreatePreviewParamsScheduleDetailsAmendmentItemActionSetDiscount]" + List[ + "InvoiceService.CreatePreviewParamsScheduleDetailsAmendmentItemActionSetDiscount" + ] ] """ If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`. """ @@ -1902,11 +1939,11 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionSet(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`. """ @@ -1920,11 +1957,11 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionSet(TypedDict): class CreatePreviewParamsScheduleDetailsAmendmentItemActionSetDiscount( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1934,7 +1971,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionSetDiscount( """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1948,7 +1985,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionSetDiscountDiscountEn """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1972,7 +2009,7 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionSetDiscountDiscountEn class CreatePreviewParamsScheduleDetailsAmendmentItemActionSetTrial( TypedDict, ): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -1982,11 +2019,11 @@ class CreatePreviewParamsScheduleDetailsAmendmentItemActionSetTrial( """ class CreatePreviewParamsScheduleDetailsAmendmentMetadataAction(TypedDict): - add: NotRequired["Dict[str, str]"] + add: NotRequired[Dict[str, str]] """ Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata. """ - remove: NotRequired["List[str]"] + remove: NotRequired[List[str]] """ Keys to remove from schedule phase metadata. """ @@ -2032,19 +2069,21 @@ class CreatePreviewParamsScheduleDetailsAmendmentTrialSettings(TypedDict): class CreatePreviewParamsScheduleDetailsAmendmentTrialSettingsEndBehavior( TypedDict, ): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ class CreatePreviewParamsScheduleDetailsPhase(TypedDict): add_invoice_items: NotRequired[ - "List[InvoiceService.CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItem]" + List[ + "InvoiceService.CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItem" + ] ] """ A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items. """ - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ @@ -2054,9 +2093,7 @@ class CreatePreviewParamsScheduleDetailsPhase(TypedDict): """ Automatic tax settings for this phase. """ - billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'phase_start']" - ] + billing_cycle_anchor: NotRequired[Literal["automatic", "phase_start"]] """ Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -2067,20 +2104,20 @@ class CreatePreviewParamsScheduleDetailsPhase(TypedDict): Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. """ @@ -2114,15 +2151,15 @@ class CreatePreviewParamsScheduleDetailsPhase(TypedDict): """ List of configuration items, each with an attached price, to apply during this phase of the subscription schedule. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account on behalf of which to charge, for each of the associated subscription's invoices. """ @@ -2133,7 +2170,7 @@ class CreatePreviewParamsScheduleDetailsPhase(TypedDict): If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/billing/subscriptions/pause-payment). """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. @@ -2148,11 +2185,11 @@ class CreatePreviewParamsScheduleDetailsPhase(TypedDict): """ The data with which to automatically create a Transfer for each of the associated subscription's invoices. """ - trial: NotRequired["bool"] + trial: NotRequired[bool] """ If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. """ - trial_continuation: NotRequired["Literal['continue', 'none']"] + trial_continuation: NotRequired[Literal["continue", "none"]] """ Specify trial behavior when crossing phase boundaries """ @@ -2169,12 +2206,14 @@ class CreatePreviewParamsScheduleDetailsPhase(TypedDict): class CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): discounts: NotRequired[ - "List[InvoiceService.CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItemDiscount]" + List[ + "InvoiceService.CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItemDiscount" + ] ] """ The coupons to redeem into discounts for the item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -2184,7 +2223,7 @@ class CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. Defaults to 1. """ @@ -2196,11 +2235,11 @@ class CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): class CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItemDiscount( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2210,7 +2249,7 @@ class CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItemDiscount( """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2224,7 +2263,7 @@ class CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItemDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2257,16 +2296,16 @@ class CreatePreviewParamsScheduleDetailsPhaseAddInvoiceItemPriceData( The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -2286,7 +2325,7 @@ class CreatePreviewParamsScheduleDetailsPhaseAutomaticTax(TypedDict): class CreatePreviewParamsScheduleDetailsPhaseAutomaticTaxLiability( TypedDict, ): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -2296,21 +2335,21 @@ class CreatePreviewParamsScheduleDetailsPhaseAutomaticTaxLiability( """ class CreatePreviewParamsScheduleDetailsPhaseBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ class CreatePreviewParamsScheduleDetailsPhaseDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2320,7 +2359,7 @@ class CreatePreviewParamsScheduleDetailsPhaseDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2334,7 +2373,7 @@ class CreatePreviewParamsScheduleDetailsPhaseDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2360,7 +2399,7 @@ class CreatePreviewParamsScheduleDetailsPhaseInvoiceSettings(TypedDict): """ The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. """ @@ -2374,7 +2413,7 @@ class CreatePreviewParamsScheduleDetailsPhaseInvoiceSettings(TypedDict): class CreatePreviewParamsScheduleDetailsPhaseInvoiceSettingsIssuer( TypedDict, ): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -2396,15 +2435,15 @@ class CreatePreviewParamsScheduleDetailsPhaseItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The plan ID to subscribe to. You may specify the same ID in `plan` and `price`. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -2414,7 +2453,7 @@ class CreatePreviewParamsScheduleDetailsPhaseItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`. """ @@ -2438,11 +2477,11 @@ class CreatePreviewParamsScheduleDetailsPhaseItemBillingThresholds( """ class CreatePreviewParamsScheduleDetailsPhaseItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2452,7 +2491,7 @@ class CreatePreviewParamsScheduleDetailsPhaseItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2466,7 +2505,7 @@ class CreatePreviewParamsScheduleDetailsPhaseItemDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2501,16 +2540,16 @@ class CreatePreviewParamsScheduleDetailsPhaseItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -2522,13 +2561,13 @@ class CreatePreviewParamsScheduleDetailsPhaseItemPriceDataRecurring( """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class CreatePreviewParamsScheduleDetailsPhaseItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -2544,7 +2583,7 @@ class CreatePreviewParamsScheduleDetailsPhasePauseCollection(TypedDict): """ class CreatePreviewParamsScheduleDetailsPhaseTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -2564,7 +2603,7 @@ class CreatePreviewParamsScheduleDetailsPhaseTrialSettings(TypedDict): class CreatePreviewParamsScheduleDetailsPhaseTrialSettingsEndBehavior( TypedDict, ): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ @@ -2576,7 +2615,7 @@ class CreatePreviewParamsScheduleDetailsPrebilling(TypedDict): """ The end of the prebilled time period. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ This is used to determine the number of billing cycles to prebill. """ @@ -2594,7 +2633,7 @@ class CreatePreviewParamsScheduleDetailsPrebillingBillUntil(TypedDict): """ Time span for prebilling, starting from `bill_from`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ End the prebilled period at a precise integer timestamp, starting from the Unix epoch. """ @@ -2632,11 +2671,11 @@ class CreatePreviewParamsSubscriptionDetails(TypedDict): """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. """ - cancel_at_period_end: NotRequired["bool"] + cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. """ - cancel_now: NotRequired["bool"] + cancel_now: NotRequired[bool] """ This simulates the subscription being canceled or expired immediately. """ @@ -2645,7 +2684,7 @@ class CreatePreviewParamsSubscriptionDetails(TypedDict): If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. """ items: NotRequired[ - "List[InvoiceService.CreatePreviewParamsSubscriptionDetailsItem]" + List["InvoiceService.CreatePreviewParamsSubscriptionDetailsItem"] ] """ A list of up to 20 subscription items, each with an attached price. @@ -2657,20 +2696,20 @@ class CreatePreviewParamsSubscriptionDetails(TypedDict): The pre-billing to apply to the subscription as a preview. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'. """ - resume_at: NotRequired["Literal['now']"] + resume_at: NotRequired[Literal["now"]] """ For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. """ - start_date: NotRequired["int"] + start_date: NotRequired[int] """ Date a subscription is intended to start (can be future or past). """ @@ -2686,11 +2725,11 @@ class CreatePreviewParamsSubscriptionDetailsItem(TypedDict): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. """ - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`. """ - deleted: NotRequired["bool"] + deleted: NotRequired[bool] """ A flag that, if set to `true`, will delete the specified item. """ @@ -2700,7 +2739,7 @@ class CreatePreviewParamsSubscriptionDetailsItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - id: NotRequired["str"] + id: NotRequired[str] """ Subscription item to update. """ @@ -2708,11 +2747,11 @@ class CreatePreviewParamsSubscriptionDetailsItem(TypedDict): """ 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -2722,7 +2761,7 @@ class CreatePreviewParamsSubscriptionDetailsItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -2740,11 +2779,11 @@ class CreatePreviewParamsSubscriptionDetailsItemBillingThresholds( """ class CreatePreviewParamsSubscriptionDetailsItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2754,7 +2793,7 @@ class CreatePreviewParamsSubscriptionDetailsItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2768,7 +2807,7 @@ class CreatePreviewParamsSubscriptionDetailsItemDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2803,16 +2842,16 @@ class CreatePreviewParamsSubscriptionDetailsItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -2824,7 +2863,7 @@ class CreatePreviewParamsSubscriptionDetailsItemPriceDataRecurring( """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -2842,11 +2881,11 @@ class CreatePreviewParamsSubscriptionItem(TypedDict): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. """ - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`. """ - deleted: NotRequired["bool"] + deleted: NotRequired[bool] """ A flag that, if set to `true`, will delete the specified item. """ @@ -2856,7 +2895,7 @@ class CreatePreviewParamsSubscriptionItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - id: NotRequired["str"] + id: NotRequired[str] """ Subscription item to update. """ @@ -2864,11 +2903,11 @@ class CreatePreviewParamsSubscriptionItem(TypedDict): """ 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -2878,7 +2917,7 @@ class CreatePreviewParamsSubscriptionItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -2894,11 +2933,11 @@ class CreatePreviewParamsSubscriptionItemBillingThresholds(TypedDict): """ class CreatePreviewParamsSubscriptionItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2908,7 +2947,7 @@ class CreatePreviewParamsSubscriptionItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2920,7 +2959,7 @@ class CreatePreviewParamsSubscriptionItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2955,16 +2994,16 @@ class CreatePreviewParamsSubscriptionItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -2974,7 +3013,7 @@ class CreatePreviewParamsSubscriptionItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -2989,18 +3028,18 @@ class DeleteParams(TypedDict): pass class FinalizeInvoiceParams(TypedDict): - auto_advance: NotRequired["bool"] + auto_advance: NotRequired[bool] """ Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListParams(TypedDict): collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. @@ -3009,86 +3048,86 @@ class ListParams(TypedDict): """ Only return invoices that were created during the given date interval. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return invoices for the customer specified by this customer ID. """ due_date: NotRequired["InvoiceService.ListParamsDueDate|int"] - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['draft', 'open', 'paid', 'uncollectible', 'void']" + Literal["draft", "open", "paid", "uncollectible", "void"] ] """ The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) """ - subscription: NotRequired["str"] + subscription: NotRequired[str] """ Only return invoices for the subscription specified by this subscription ID. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsDueDate(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class MarkUncollectibleParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class PayParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - forgive: NotRequired["bool"] + forgive: NotRequired[bool] """ In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. @@ -3098,25 +3137,25 @@ class PayParams(TypedDict): """ ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set. """ - off_session: NotRequired["bool"] + off_session: NotRequired[bool] """ Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session). """ - paid_out_of_band: NotRequired["bool"] + paid_out_of_band: NotRequired[bool] """ Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid. """ - source: NotRequired["str"] + source: NotRequired[str] """ A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid. """ class RemoveLinesParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -3140,21 +3179,21 @@ class RemoveLinesParamsLine(TypedDict): """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SearchParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - page: NotRequired["str"] + page: NotRequired[str] """ A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. """ @@ -3164,7 +3203,7 @@ class SearchParams(TypedDict): """ class SendInvoiceParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -3174,15 +3213,15 @@ class UpcomingParams(TypedDict): """ Settings for automatic tax lookup for this invoice preview. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency to preview this invoice in. Defaults to that of `customer` if not specified. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. """ @@ -3198,12 +3237,12 @@ class UpcomingParams(TypedDict): """ The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ invoice_items: NotRequired[ - "List[InvoiceService.UpcomingParamsInvoiceItem]" + List["InvoiceService.UpcomingParamsInvoiceItem"] ] """ List of invoice items to add or update in the upcoming invoice preview. @@ -3216,11 +3255,11 @@ class UpcomingParams(TypedDict): """ The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. """ - preview_mode: NotRequired["Literal['next', 'recurring']"] + preview_mode: NotRequired[Literal["next", "recurring"]] """ Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified. """ - schedule: NotRequired["str"] + schedule: NotRequired[str] """ The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. """ @@ -3230,7 +3269,7 @@ class UpcomingParams(TypedDict): """ The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. """ - subscription: NotRequired["str"] + subscription: NotRequired[str] """ The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. """ @@ -3244,11 +3283,11 @@ class UpcomingParams(TypedDict): """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. """ - subscription_cancel_at_period_end: NotRequired["bool"] + subscription_cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. """ - subscription_cancel_now: NotRequired["bool"] + subscription_cancel_now: NotRequired[bool] """ This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. """ @@ -3263,7 +3302,7 @@ class UpcomingParams(TypedDict): The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. """ subscription_items: NotRequired[ - "List[InvoiceService.UpcomingParamsSubscriptionItem]" + List["InvoiceService.UpcomingParamsSubscriptionItem"] ] """ A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead. @@ -3275,20 +3314,20 @@ class UpcomingParams(TypedDict): The pre-billing to apply to the subscription as a preview. This field has been deprecated and will be removed in a future API version. Use `subscription_details.prebilling` instead. """ subscription_proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead. """ - subscription_proration_date: NotRequired["int"] + subscription_proration_date: NotRequired[int] """ If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead. """ - subscription_resume_at: NotRequired["Literal['now']"] + subscription_resume_at: NotRequired[Literal["now"]] """ For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead. """ - subscription_start_date: NotRequired["int"] + subscription_start_date: NotRequired[int] """ Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead. """ @@ -3310,7 +3349,7 @@ class UpcomingParamsAutomaticTax(TypedDict): """ class UpcomingParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -3343,34 +3382,34 @@ class UpcomingParamsCustomerDetails(TypedDict): The customer's tax exemption. One of `none`, `exempt`, or `reverse`. """ tax_ids: NotRequired[ - "List[InvoiceService.UpcomingParamsCustomerDetailsTaxId]" + List["InvoiceService.UpcomingParamsCustomerDetailsTaxId"] ] """ The customer's tax IDs. """ class UpcomingParamsCustomerDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -3384,33 +3423,33 @@ class UpcomingParamsCustomerDetailsShipping(TypedDict): """ Customer name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Customer phone (including extension). """ class UpcomingParamsCustomerDetailsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -3500,11 +3539,11 @@ class UpcomingParamsCustomerDetailsTaxId(TypedDict): """ class UpcomingParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -3514,7 +3553,7 @@ class UpcomingParamsDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -3526,7 +3565,7 @@ class UpcomingParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -3546,19 +3585,19 @@ class UpcomingParamsDiscountDiscountEndDuration(TypedDict): """ class UpcomingParamsInvoiceItem(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of previewed invoice item. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only applicable to new invoice items. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items. """ @@ -3568,7 +3607,7 @@ class UpcomingParamsInvoiceItem(TypedDict): """ The coupons to redeem into discounts for the invoice item in the preview. """ - invoiceitem: NotRequired["str"] + invoiceitem: NotRequired[str] """ The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice. """ @@ -3580,7 +3619,7 @@ class UpcomingParamsInvoiceItem(TypedDict): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -3590,12 +3629,12 @@ class UpcomingParamsInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the invoice item. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. @@ -3608,21 +3647,21 @@ class UpcomingParamsInvoiceItem(TypedDict): """ The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class UpcomingParamsInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -3632,7 +3671,7 @@ class UpcomingParamsInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -3644,7 +3683,7 @@ class UpcomingParamsInvoiceItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -3683,22 +3722,22 @@ class UpcomingParamsInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class UpcomingParamsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -3709,23 +3748,23 @@ class UpcomingParamsIssuer(TypedDict): class UpcomingParamsScheduleDetails(TypedDict): amendments: NotRequired[ - "List[InvoiceService.UpcomingParamsScheduleDetailsAmendment]" + List["InvoiceService.UpcomingParamsScheduleDetailsAmendment"] ] """ Changes to apply to the phases of the subscription schedule, in the order provided. """ billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. """ - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. """ phases: NotRequired[ - "List[InvoiceService.UpcomingParamsScheduleDetailsPhase]" + List["InvoiceService.UpcomingParamsScheduleDetailsPhase"] ] """ List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. @@ -3737,7 +3776,7 @@ class UpcomingParamsScheduleDetails(TypedDict): Provide any time periods to bill in advance. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request. @@ -3755,31 +3794,37 @@ class UpcomingParamsScheduleDetailsAmendment(TypedDict): Details to identify the earliest timestamp where the proposed change should take effect. """ billing_cycle_anchor: NotRequired[ - "Literal['amendment_start', 'automatic']" + Literal["amendment_start", "automatic"] ] """ For a point-in-time amendment, this attribute lets you set or update whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp. """ discount_actions: NotRequired[ - "List[InvoiceService.UpcomingParamsScheduleDetailsAmendmentDiscountAction]" + List[ + "InvoiceService.UpcomingParamsScheduleDetailsAmendmentDiscountAction" + ] ] """ Changes to the coupons being redeemed or discounts being applied during the amendment time span. """ item_actions: NotRequired[ - "List[InvoiceService.UpcomingParamsScheduleDetailsAmendmentItemAction]" + List[ + "InvoiceService.UpcomingParamsScheduleDetailsAmendmentItemAction" + ] ] """ Changes to the subscription items during the amendment time span. """ metadata_actions: NotRequired[ - "List[InvoiceService.UpcomingParamsScheduleDetailsAmendmentMetadataAction]" + List[ + "InvoiceService.UpcomingParamsScheduleDetailsAmendmentMetadataAction" + ] ] """ Instructions for how to modify phase metadata """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`. @@ -3791,7 +3836,7 @@ class UpcomingParamsScheduleDetailsAmendment(TypedDict): Defines how to pause collection for the underlying subscription throughout the duration of the amendment. """ set_schedule_end: NotRequired[ - "Literal['amendment_end', 'amendment_start']" + Literal["amendment_end", "amendment_start"] ] """ Ends the subscription schedule early as dictated by either the accompanying amendment's start or end. @@ -3816,7 +3861,7 @@ class UpcomingParamsScheduleDetailsAmendmentAmendmentEnd(TypedDict): """ Time span for the amendment starting from the `amendment_start`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`. """ @@ -3866,7 +3911,7 @@ class UpcomingParamsScheduleDetailsAmendmentAmendmentStart(TypedDict): """ Use the `end` time of a given discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to start. """ @@ -3925,11 +3970,11 @@ class UpcomingParamsScheduleDetailsAmendmentDiscountAction(TypedDict): """ class UpcomingParamsScheduleDetailsAmendmentDiscountActionAdd(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to redeem. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount for a coupon that was already redeemed. """ @@ -3939,11 +3984,11 @@ class UpcomingParamsScheduleDetailsAmendmentDiscountActionAdd(TypedDict): """ Details to determine how long the discount should be applied for. """ - index: NotRequired["int"] + index: NotRequired[int] """ The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The promotion code to redeem. """ @@ -3959,29 +4004,29 @@ class UpcomingParamsScheduleDetailsAmendmentDiscountActionAddDiscountEnd( class UpcomingParamsScheduleDetailsAmendmentDiscountActionRemove( TypedDict ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to remove from the `discounts` array. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ The ID of a discount to remove from the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to remove from the `discounts` array. """ class UpcomingParamsScheduleDetailsAmendmentDiscountActionSet(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to replace the `discounts` array with. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount to replace the `discounts` array with. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ An ID of an existing promotion code to replace the `discounts` array with. """ @@ -4012,12 +4057,14 @@ class UpcomingParamsScheduleDetailsAmendmentItemAction(TypedDict): class UpcomingParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): discounts: NotRequired[ - "List[InvoiceService.UpcomingParamsScheduleDetailsAmendmentItemActionAddDiscount]" + List[ + "InvoiceService.UpcomingParamsScheduleDetailsAmendmentItemActionAddDiscount" + ] ] """ The discounts applied to the item. Subscription item discounts are applied before subscription discounts. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -4025,11 +4072,11 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. """ @@ -4043,11 +4090,11 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): class UpcomingParamsScheduleDetailsAmendmentItemActionAddDiscount( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -4057,7 +4104,7 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionAddDiscount( """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -4071,7 +4118,7 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionAddDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -4093,7 +4140,7 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionAddDiscountDiscountEndDura """ class UpcomingParamsScheduleDetailsAmendmentItemActionAddTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -4110,12 +4157,14 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionRemove(TypedDict): class UpcomingParamsScheduleDetailsAmendmentItemActionSet(TypedDict): discounts: NotRequired[ - "List[InvoiceService.UpcomingParamsScheduleDetailsAmendmentItemActionSetDiscount]" + List[ + "InvoiceService.UpcomingParamsScheduleDetailsAmendmentItemActionSetDiscount" + ] ] """ If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`. """ @@ -4123,11 +4172,11 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionSet(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`. """ @@ -4141,11 +4190,11 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionSet(TypedDict): class UpcomingParamsScheduleDetailsAmendmentItemActionSetDiscount( TypedDict, ): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -4155,7 +4204,7 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionSetDiscount( """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -4169,7 +4218,7 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionSetDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -4191,7 +4240,7 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionSetDiscountDiscountEndDura """ class UpcomingParamsScheduleDetailsAmendmentItemActionSetTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -4201,11 +4250,11 @@ class UpcomingParamsScheduleDetailsAmendmentItemActionSetTrial(TypedDict): """ class UpcomingParamsScheduleDetailsAmendmentMetadataAction(TypedDict): - add: NotRequired["Dict[str, str]"] + add: NotRequired[Dict[str, str]] """ Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata. """ - remove: NotRequired["List[str]"] + remove: NotRequired[List[str]] """ Keys to remove from schedule phase metadata. """ @@ -4249,19 +4298,21 @@ class UpcomingParamsScheduleDetailsAmendmentTrialSettings(TypedDict): class UpcomingParamsScheduleDetailsAmendmentTrialSettingsEndBehavior( TypedDict, ): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ class UpcomingParamsScheduleDetailsPhase(TypedDict): add_invoice_items: NotRequired[ - "List[InvoiceService.UpcomingParamsScheduleDetailsPhaseAddInvoiceItem]" + List[ + "InvoiceService.UpcomingParamsScheduleDetailsPhaseAddInvoiceItem" + ] ] """ A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items. """ - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ @@ -4271,9 +4322,7 @@ class UpcomingParamsScheduleDetailsPhase(TypedDict): """ Automatic tax settings for this phase. """ - billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'phase_start']" - ] + billing_cycle_anchor: NotRequired[Literal["automatic", "phase_start"]] """ Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -4284,20 +4333,20 @@ class UpcomingParamsScheduleDetailsPhase(TypedDict): Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. """ @@ -4329,15 +4378,15 @@ class UpcomingParamsScheduleDetailsPhase(TypedDict): """ List of configuration items, each with an attached price, to apply during this phase of the subscription schedule. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account on behalf of which to charge, for each of the associated subscription's invoices. """ @@ -4348,7 +4397,7 @@ class UpcomingParamsScheduleDetailsPhase(TypedDict): If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/billing/subscriptions/pause-payment). """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. @@ -4363,11 +4412,11 @@ class UpcomingParamsScheduleDetailsPhase(TypedDict): """ The data with which to automatically create a Transfer for each of the associated subscription's invoices. """ - trial: NotRequired["bool"] + trial: NotRequired[bool] """ If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. """ - trial_continuation: NotRequired["Literal['continue', 'none']"] + trial_continuation: NotRequired[Literal["continue", "none"]] """ Specify trial behavior when crossing phase boundaries """ @@ -4384,12 +4433,14 @@ class UpcomingParamsScheduleDetailsPhase(TypedDict): class UpcomingParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): discounts: NotRequired[ - "List[InvoiceService.UpcomingParamsScheduleDetailsPhaseAddInvoiceItemDiscount]" + List[ + "InvoiceService.UpcomingParamsScheduleDetailsPhaseAddInvoiceItemDiscount" + ] ] """ The coupons to redeem into discounts for the item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -4399,7 +4450,7 @@ class UpcomingParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. Defaults to 1. """ @@ -4409,11 +4460,11 @@ class UpcomingParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): """ class UpcomingParamsScheduleDetailsPhaseAddInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -4423,7 +4474,7 @@ class UpcomingParamsScheduleDetailsPhaseAddInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -4437,7 +4488,7 @@ class UpcomingParamsScheduleDetailsPhaseAddInvoiceItemDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -4468,16 +4519,16 @@ class UpcomingParamsScheduleDetailsPhaseAddInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -4495,7 +4546,7 @@ class UpcomingParamsScheduleDetailsPhaseAutomaticTax(TypedDict): """ class UpcomingParamsScheduleDetailsPhaseAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -4505,21 +4556,21 @@ class UpcomingParamsScheduleDetailsPhaseAutomaticTaxLiability(TypedDict): """ class UpcomingParamsScheduleDetailsPhaseBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ class UpcomingParamsScheduleDetailsPhaseDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -4529,7 +4580,7 @@ class UpcomingParamsScheduleDetailsPhaseDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -4541,7 +4592,7 @@ class UpcomingParamsScheduleDetailsPhaseDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -4567,7 +4618,7 @@ class UpcomingParamsScheduleDetailsPhaseInvoiceSettings(TypedDict): """ The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. """ @@ -4579,7 +4630,7 @@ class UpcomingParamsScheduleDetailsPhaseInvoiceSettings(TypedDict): """ class UpcomingParamsScheduleDetailsPhaseInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -4601,15 +4652,15 @@ class UpcomingParamsScheduleDetailsPhaseItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The plan ID to subscribe to. You may specify the same ID in `plan` and `price`. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -4619,7 +4670,7 @@ class UpcomingParamsScheduleDetailsPhaseItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`. """ @@ -4641,11 +4692,11 @@ class UpcomingParamsScheduleDetailsPhaseItemBillingThresholds(TypedDict): """ class UpcomingParamsScheduleDetailsPhaseItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -4655,7 +4706,7 @@ class UpcomingParamsScheduleDetailsPhaseItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -4667,7 +4718,7 @@ class UpcomingParamsScheduleDetailsPhaseItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -4702,16 +4753,16 @@ class UpcomingParamsScheduleDetailsPhaseItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -4721,13 +4772,13 @@ class UpcomingParamsScheduleDetailsPhaseItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class UpcomingParamsScheduleDetailsPhaseItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -4743,7 +4794,7 @@ class UpcomingParamsScheduleDetailsPhasePauseCollection(TypedDict): """ class UpcomingParamsScheduleDetailsPhaseTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -4763,7 +4814,7 @@ class UpcomingParamsScheduleDetailsPhaseTrialSettings(TypedDict): class UpcomingParamsScheduleDetailsPhaseTrialSettingsEndBehavior( TypedDict ): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ @@ -4775,7 +4826,7 @@ class UpcomingParamsScheduleDetailsPrebilling(TypedDict): """ The end of the prebilled time period. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ This is used to determine the number of billing cycles to prebill. """ @@ -4793,7 +4844,7 @@ class UpcomingParamsScheduleDetailsPrebillingBillUntil(TypedDict): """ Time span for prebilling, starting from `bill_from`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ End the prebilled period at a precise integer timestamp, starting from the Unix epoch. """ @@ -4829,11 +4880,11 @@ class UpcomingParamsSubscriptionDetails(TypedDict): """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. """ - cancel_at_period_end: NotRequired["bool"] + cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. """ - cancel_now: NotRequired["bool"] + cancel_now: NotRequired[bool] """ This simulates the subscription being canceled or expired immediately. """ @@ -4842,7 +4893,7 @@ class UpcomingParamsSubscriptionDetails(TypedDict): If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. """ items: NotRequired[ - "List[InvoiceService.UpcomingParamsSubscriptionDetailsItem]" + List["InvoiceService.UpcomingParamsSubscriptionDetailsItem"] ] """ A list of up to 20 subscription items, each with an attached price. @@ -4854,20 +4905,20 @@ class UpcomingParamsSubscriptionDetails(TypedDict): The pre-billing to apply to the subscription as a preview. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'. """ - resume_at: NotRequired["Literal['now']"] + resume_at: NotRequired[Literal["now"]] """ For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. """ - start_date: NotRequired["int"] + start_date: NotRequired[int] """ Date a subscription is intended to start (can be future or past). """ @@ -4883,11 +4934,11 @@ class UpcomingParamsSubscriptionDetailsItem(TypedDict): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. """ - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`. """ - deleted: NotRequired["bool"] + deleted: NotRequired[bool] """ A flag that, if set to `true`, will delete the specified item. """ @@ -4897,7 +4948,7 @@ class UpcomingParamsSubscriptionDetailsItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - id: NotRequired["str"] + id: NotRequired[str] """ Subscription item to update. """ @@ -4905,11 +4956,11 @@ class UpcomingParamsSubscriptionDetailsItem(TypedDict): """ 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -4919,7 +4970,7 @@ class UpcomingParamsSubscriptionDetailsItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -4935,11 +4986,11 @@ class UpcomingParamsSubscriptionDetailsItemBillingThresholds(TypedDict): """ class UpcomingParamsSubscriptionDetailsItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -4949,7 +5000,7 @@ class UpcomingParamsSubscriptionDetailsItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -4961,7 +5012,7 @@ class UpcomingParamsSubscriptionDetailsItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -4996,16 +5047,16 @@ class UpcomingParamsSubscriptionDetailsItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -5015,7 +5066,7 @@ class UpcomingParamsSubscriptionDetailsItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -5033,11 +5084,11 @@ class UpcomingParamsSubscriptionItem(TypedDict): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. """ - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`. """ - deleted: NotRequired["bool"] + deleted: NotRequired[bool] """ A flag that, if set to `true`, will delete the specified item. """ @@ -5047,7 +5098,7 @@ class UpcomingParamsSubscriptionItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - id: NotRequired["str"] + id: NotRequired[str] """ Subscription item to update. """ @@ -5055,11 +5106,11 @@ class UpcomingParamsSubscriptionItem(TypedDict): """ 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -5069,7 +5120,7 @@ class UpcomingParamsSubscriptionItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -5085,11 +5136,11 @@ class UpcomingParamsSubscriptionItemBillingThresholds(TypedDict): """ class UpcomingParamsSubscriptionItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -5099,7 +5150,7 @@ class UpcomingParamsSubscriptionItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -5111,7 +5162,7 @@ class UpcomingParamsSubscriptionItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -5144,16 +5195,16 @@ class UpcomingParamsSubscriptionItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -5163,7 +5214,7 @@ class UpcomingParamsSubscriptionItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -5175,7 +5226,7 @@ class UpcomingParamsSubscriptionPrebilling(TypedDict): """ class UpdateLinesParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -5189,15 +5240,15 @@ class UpdateLinesParams(TypedDict): """ class UpdateLinesParamsLine(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations. """ @@ -5223,7 +5274,7 @@ class UpdateLinesParamsLine(TypedDict): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -5233,7 +5284,7 @@ class UpdateLinesParamsLine(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the line item. """ @@ -5249,11 +5300,11 @@ class UpdateLinesParamsLine(TypedDict): """ class UpdateLinesParamsLineDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -5271,7 +5322,7 @@ class UpdateLinesParamsLineDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -5305,7 +5356,7 @@ class UpdateLinesParamsLinePriceData(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - product: NotRequired["str"] + product: NotRequired[str] """ The ID of the product that this price will belong to. One of `product` or `product_data` is required. """ @@ -5316,30 +5367,30 @@ class UpdateLinesParamsLinePriceData(TypedDict): Data used to generate a new product object inline. One of `product` or `product_data` is required. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class UpdateLinesParamsLinePriceDataProductData(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. """ - images: NotRequired["List[str]"] + images: NotRequired[List[str]] """ A list of up to 8 URLs of images for this product, meant to be displayable to the customer. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -5347,7 +5398,7 @@ class UpdateLinesParamsLinePriceDataProductData(TypedDict): """ The product's name, meant to be displayable to the customer. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ @@ -5369,11 +5420,11 @@ class UpdateLinesParamsLineTaxAmount(TypedDict): """ class UpdateLinesParamsLineTaxAmountTaxRateData(TypedDict): - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. """ @@ -5385,7 +5436,7 @@ class UpdateLinesParamsLineTaxAmountTaxRateData(TypedDict): """ This specifies if the tax rate is inclusive or exclusive. """ - jurisdiction: NotRequired["str"] + jurisdiction: NotRequired[str] """ The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice. """ @@ -5393,12 +5444,25 @@ class UpdateLinesParamsLineTaxAmountTaxRateData(TypedDict): """ The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero. """ - state: NotRequired["str"] + state: NotRequired[str] """ [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. """ tax_type: NotRequired[ - "Literal['amusement_tax', 'communications_tax', 'gst', 'hst', 'igst', 'jct', 'lease_tax', 'pst', 'qst', 'rst', 'sales_tax', 'vat']" + Literal[ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat", + ] ] """ The high-level tax type, such as `vat` or `sales_tax`. @@ -5415,11 +5479,11 @@ class UpdateParams(TypedDict): """ List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`. """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). """ - auto_advance: NotRequired["bool"] + auto_advance: NotRequired[bool] """ Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. """ @@ -5428,7 +5492,7 @@ class UpdateParams(TypedDict): Settings for automatic tax lookup for this invoice. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices. @@ -5439,7 +5503,7 @@ class UpdateParams(TypedDict): """ A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. """ @@ -5447,7 +5511,7 @@ class UpdateParams(TypedDict): """ The ids of the margins to apply to the invoice. Can be overridden by line item `margins`. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. """ @@ -5459,7 +5523,7 @@ class UpdateParams(TypedDict): """ The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. """ @@ -5469,7 +5533,7 @@ class UpdateParams(TypedDict): """ The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts. """ - due_date: NotRequired["int"] + due_date: NotRequired[int] """ The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. """ @@ -5477,11 +5541,11 @@ class UpdateParams(TypedDict): """ The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - footer: NotRequired["str"] + footer: NotRequired[str] """ Footer to be displayed on the invoice. """ @@ -5529,7 +5593,7 @@ class UpdateParams(TypedDict): """ Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. """ @@ -5545,7 +5609,7 @@ class UpdateParamsAmountsDue(TypedDict): """ The amount in cents (or local equivalent). """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days from when invoice is finalized until the payment is due. """ @@ -5553,7 +5617,7 @@ class UpdateParamsAmountsDue(TypedDict): """ An arbitrary string attached to the object. Often useful for displaying to users. """ - due_date: NotRequired["int"] + due_date: NotRequired[int] """ Date on which a payment plan's payment is due. """ @@ -5571,7 +5635,7 @@ class UpdateParamsAutomaticTax(TypedDict): """ class UpdateParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -5591,11 +5655,11 @@ class UpdateParamsCustomField(TypedDict): """ class UpdateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -5613,7 +5677,7 @@ class UpdateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -5633,7 +5697,7 @@ class UpdateParamsDiscountDiscountEndDuration(TypedDict): """ class UpdateParamsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -5712,7 +5776,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -5721,13 +5785,13 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): class UpdateParamsPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions( TypedDict, ): - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ class UpdateParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -5742,7 +5806,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. @@ -5751,7 +5815,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): class UpdateParamsPaymentSettingsPaymentMethodOptionsCardInstallments( TypedDict, ): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Setting to true enables installments for this invoice. Setting to false will prevent any selected plan from applying to a payment. @@ -5789,7 +5853,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsCustomerBalance( """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["str"] + funding_type: NotRequired[str] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ @@ -5803,7 +5867,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer """ Configuration for eu_bank_transfer funding type. """ - type: NotRequired["str"] + type: NotRequired[str] """ The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. """ @@ -5832,7 +5896,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsUsBankAccount( Additional fields for Financial Connections Session creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -5842,13 +5906,24 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConne TypedDict, ): permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. @@ -5875,7 +5950,7 @@ class UpdateParamsRenderingOptions(TypedDict): """ class UpdateParamsRenderingPdf(TypedDict): - page_size: NotRequired["Literal['a4', 'auto', 'letter']"] + page_size: NotRequired[Literal["a4", "auto", "letter"]] """ Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`. If set to `auto`, invoice PDF page size defaults to `a4` for customers with @@ -5883,7 +5958,7 @@ class UpdateParamsRenderingPdf(TypedDict): """ class UpdateParamsShippingCost(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the shipping rate to use for this order. """ @@ -5911,21 +5986,21 @@ class UpdateParamsShippingCostShippingRateData(TypedDict): """ Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ - type: NotRequired["Literal['fixed_amount']"] + type: NotRequired[Literal["fixed_amount"]] """ The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. """ @@ -5978,7 +6053,10 @@ class UpdateParamsShippingCostShippingRateDataFixedAmount(TypedDict): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, InvoiceService.UpdateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions]" + Dict[ + str, + "InvoiceService.UpdateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions", + ] ] """ Shipping rates 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). @@ -5992,7 +6070,7 @@ class UpdateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions( A non-negative integer in cents representing how much to charge. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. @@ -6013,33 +6091,33 @@ class UpdateParamsShippingDetails(TypedDict): """ class UpdateParamsShippingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class UpdateParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. """ @@ -6049,7 +6127,7 @@ class UpdateParamsTransferData(TypedDict): """ class VoidInvoiceParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_invoice_upcoming_lines_service.py b/stripe/_invoice_upcoming_lines_service.py index 85ba4c720..8110ada77 100644 --- a/stripe/_invoice_upcoming_lines_service.py +++ b/stripe/_invoice_upcoming_lines_service.py @@ -16,15 +16,15 @@ class ListParams(TypedDict): """ Settings for automatic tax lookup for this invoice preview. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency to preview this invoice in. Defaults to that of `customer` if not specified. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. """ @@ -40,16 +40,16 @@ class ListParams(TypedDict): """ The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ invoice_items: NotRequired[ - "List[InvoiceUpcomingLinesService.ListParamsInvoiceItem]" + List["InvoiceUpcomingLinesService.ListParamsInvoiceItem"] ] """ List of invoice items to add or update in the upcoming invoice preview. @@ -58,7 +58,7 @@ class ListParams(TypedDict): """ The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. """ - limit: NotRequired["int"] + 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. """ @@ -66,11 +66,11 @@ class ListParams(TypedDict): """ The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. """ - preview_mode: NotRequired["Literal['next', 'recurring']"] + preview_mode: NotRequired[Literal["next", "recurring"]] """ Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified. """ - schedule: NotRequired["str"] + schedule: NotRequired[str] """ The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. """ @@ -80,11 +80,11 @@ class ListParams(TypedDict): """ The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. """ - starting_after: NotRequired["str"] + 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. """ - subscription: NotRequired["str"] + subscription: NotRequired[str] """ The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. """ @@ -98,11 +98,11 @@ class ListParams(TypedDict): """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. """ - subscription_cancel_at_period_end: NotRequired["bool"] + subscription_cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. """ - subscription_cancel_now: NotRequired["bool"] + subscription_cancel_now: NotRequired[bool] """ This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. """ @@ -117,7 +117,7 @@ class ListParams(TypedDict): The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. """ subscription_items: NotRequired[ - "List[InvoiceUpcomingLinesService.ListParamsSubscriptionItem]" + List["InvoiceUpcomingLinesService.ListParamsSubscriptionItem"] ] """ A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead. @@ -129,20 +129,20 @@ class ListParams(TypedDict): The pre-billing to apply to the subscription as a preview. This field has been deprecated and will be removed in a future API version. Use `subscription_details.prebilling` instead. """ subscription_proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead. """ - subscription_proration_date: NotRequired["int"] + subscription_proration_date: NotRequired[int] """ If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead. """ - subscription_resume_at: NotRequired["Literal['now']"] + subscription_resume_at: NotRequired[Literal["now"]] """ For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead. """ - subscription_start_date: NotRequired["int"] + subscription_start_date: NotRequired[int] """ Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead. """ @@ -164,7 +164,7 @@ class ListParamsAutomaticTax(TypedDict): """ class ListParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -199,34 +199,34 @@ class ListParamsCustomerDetails(TypedDict): The customer's tax exemption. One of `none`, `exempt`, or `reverse`. """ tax_ids: NotRequired[ - "List[InvoiceUpcomingLinesService.ListParamsCustomerDetailsTaxId]" + List["InvoiceUpcomingLinesService.ListParamsCustomerDetailsTaxId"] ] """ The customer's tax IDs. """ class ListParamsCustomerDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -240,33 +240,33 @@ class ListParamsCustomerDetailsShipping(TypedDict): """ Customer name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Customer phone (including extension). """ class ListParamsCustomerDetailsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -356,11 +356,11 @@ class ListParamsCustomerDetailsTaxId(TypedDict): """ class ListParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -370,7 +370,7 @@ class ListParamsDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -382,7 +382,7 @@ class ListParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -402,19 +402,19 @@ class ListParamsDiscountDiscountEndDuration(TypedDict): """ class ListParamsInvoiceItem(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The integer amount in cents (or local equivalent) of previewed invoice item. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only applicable to new invoice items. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. """ - discountable: NotRequired["bool"] + discountable: NotRequired[bool] """ Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items. """ @@ -424,7 +424,7 @@ class ListParamsInvoiceItem(TypedDict): """ The coupons to redeem into discounts for the invoice item in the preview. """ - invoiceitem: NotRequired["str"] + invoiceitem: NotRequired[str] """ The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice. """ @@ -438,7 +438,7 @@ class ListParamsInvoiceItem(TypedDict): """ The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -448,12 +448,12 @@ class ListParamsInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Non-negative integer. The quantity of units for the invoice item. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. @@ -466,21 +466,21 @@ class ListParamsInvoiceItem(TypedDict): """ The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class ListParamsInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -490,7 +490,7 @@ class ListParamsInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -502,7 +502,7 @@ class ListParamsInvoiceItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -541,22 +541,22 @@ class ListParamsInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class ListParamsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -567,23 +567,25 @@ class ListParamsIssuer(TypedDict): class ListParamsScheduleDetails(TypedDict): amendments: NotRequired[ - "List[InvoiceUpcomingLinesService.ListParamsScheduleDetailsAmendment]" + List[ + "InvoiceUpcomingLinesService.ListParamsScheduleDetailsAmendment" + ] ] """ Changes to apply to the phases of the subscription schedule, in the order provided. """ billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. """ - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. """ phases: NotRequired[ - "List[InvoiceUpcomingLinesService.ListParamsScheduleDetailsPhase]" + List["InvoiceUpcomingLinesService.ListParamsScheduleDetailsPhase"] ] """ List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. @@ -595,7 +597,7 @@ class ListParamsScheduleDetails(TypedDict): Provide any time periods to bill in advance. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request. @@ -613,31 +615,37 @@ class ListParamsScheduleDetailsAmendment(TypedDict): Details to identify the earliest timestamp where the proposed change should take effect. """ billing_cycle_anchor: NotRequired[ - "Literal['amendment_start', 'automatic']" + Literal["amendment_start", "automatic"] ] """ For a point-in-time amendment, this attribute lets you set or update whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp. """ discount_actions: NotRequired[ - "List[InvoiceUpcomingLinesService.ListParamsScheduleDetailsAmendmentDiscountAction]" + List[ + "InvoiceUpcomingLinesService.ListParamsScheduleDetailsAmendmentDiscountAction" + ] ] """ Changes to the coupons being redeemed or discounts being applied during the amendment time span. """ item_actions: NotRequired[ - "List[InvoiceUpcomingLinesService.ListParamsScheduleDetailsAmendmentItemAction]" + List[ + "InvoiceUpcomingLinesService.ListParamsScheduleDetailsAmendmentItemAction" + ] ] """ Changes to the subscription items during the amendment time span. """ metadata_actions: NotRequired[ - "List[InvoiceUpcomingLinesService.ListParamsScheduleDetailsAmendmentMetadataAction]" + List[ + "InvoiceUpcomingLinesService.ListParamsScheduleDetailsAmendmentMetadataAction" + ] ] """ Instructions for how to modify phase metadata """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`. @@ -649,7 +657,7 @@ class ListParamsScheduleDetailsAmendment(TypedDict): Defines how to pause collection for the underlying subscription throughout the duration of the amendment. """ set_schedule_end: NotRequired[ - "Literal['amendment_end', 'amendment_start']" + Literal["amendment_end", "amendment_start"] ] """ Ends the subscription schedule early as dictated by either the accompanying amendment's start or end. @@ -674,7 +682,7 @@ class ListParamsScheduleDetailsAmendmentAmendmentEnd(TypedDict): """ Time span for the amendment starting from the `amendment_start`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`. """ @@ -720,7 +728,7 @@ class ListParamsScheduleDetailsAmendmentAmendmentStart(TypedDict): """ Use the `end` time of a given discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to start. """ @@ -779,11 +787,11 @@ class ListParamsScheduleDetailsAmendmentDiscountAction(TypedDict): """ class ListParamsScheduleDetailsAmendmentDiscountActionAdd(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to redeem. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount for a coupon that was already redeemed. """ @@ -793,11 +801,11 @@ class ListParamsScheduleDetailsAmendmentDiscountActionAdd(TypedDict): """ Details to determine how long the discount should be applied for. """ - index: NotRequired["int"] + index: NotRequired[int] """ The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The promotion code to redeem. """ @@ -811,29 +819,29 @@ class ListParamsScheduleDetailsAmendmentDiscountActionAddDiscountEnd( """ class ListParamsScheduleDetailsAmendmentDiscountActionRemove(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to remove from the `discounts` array. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ The ID of a discount to remove from the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to remove from the `discounts` array. """ class ListParamsScheduleDetailsAmendmentDiscountActionSet(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to replace the `discounts` array with. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount to replace the `discounts` array with. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ An ID of an existing promotion code to replace the `discounts` array with. """ @@ -864,12 +872,14 @@ class ListParamsScheduleDetailsAmendmentItemAction(TypedDict): class ListParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): discounts: NotRequired[ - "List[InvoiceUpcomingLinesService.ListParamsScheduleDetailsAmendmentItemActionAddDiscount]" + List[ + "InvoiceUpcomingLinesService.ListParamsScheduleDetailsAmendmentItemActionAddDiscount" + ] ] """ The discounts applied to the item. Subscription item discounts are applied before subscription discounts. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -877,11 +887,11 @@ class ListParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. """ @@ -893,11 +903,11 @@ class ListParamsScheduleDetailsAmendmentItemActionAdd(TypedDict): """ class ListParamsScheduleDetailsAmendmentItemActionAddDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -907,7 +917,7 @@ class ListParamsScheduleDetailsAmendmentItemActionAddDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -921,7 +931,7 @@ class ListParamsScheduleDetailsAmendmentItemActionAddDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -943,7 +953,7 @@ class ListParamsScheduleDetailsAmendmentItemActionAddDiscountDiscountEndDuration """ class ListParamsScheduleDetailsAmendmentItemActionAddTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -960,12 +970,14 @@ class ListParamsScheduleDetailsAmendmentItemActionRemove(TypedDict): class ListParamsScheduleDetailsAmendmentItemActionSet(TypedDict): discounts: NotRequired[ - "List[InvoiceUpcomingLinesService.ListParamsScheduleDetailsAmendmentItemActionSetDiscount]" + List[ + "InvoiceUpcomingLinesService.ListParamsScheduleDetailsAmendmentItemActionSetDiscount" + ] ] """ If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`. """ @@ -973,11 +985,11 @@ class ListParamsScheduleDetailsAmendmentItemActionSet(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`. """ @@ -989,11 +1001,11 @@ class ListParamsScheduleDetailsAmendmentItemActionSet(TypedDict): """ class ListParamsScheduleDetailsAmendmentItemActionSetDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1003,7 +1015,7 @@ class ListParamsScheduleDetailsAmendmentItemActionSetDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1017,7 +1029,7 @@ class ListParamsScheduleDetailsAmendmentItemActionSetDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1039,7 +1051,7 @@ class ListParamsScheduleDetailsAmendmentItemActionSetDiscountDiscountEndDuration """ class ListParamsScheduleDetailsAmendmentItemActionSetTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -1049,11 +1061,11 @@ class ListParamsScheduleDetailsAmendmentItemActionSetTrial(TypedDict): """ class ListParamsScheduleDetailsAmendmentMetadataAction(TypedDict): - add: NotRequired["Dict[str, str]"] + add: NotRequired[Dict[str, str]] """ Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata. """ - remove: NotRequired["List[str]"] + remove: NotRequired[List[str]] """ Keys to remove from schedule phase metadata. """ @@ -1095,19 +1107,21 @@ class ListParamsScheduleDetailsAmendmentTrialSettings(TypedDict): class ListParamsScheduleDetailsAmendmentTrialSettingsEndBehavior( TypedDict ): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ class ListParamsScheduleDetailsPhase(TypedDict): add_invoice_items: NotRequired[ - "List[InvoiceUpcomingLinesService.ListParamsScheduleDetailsPhaseAddInvoiceItem]" + List[ + "InvoiceUpcomingLinesService.ListParamsScheduleDetailsPhaseAddInvoiceItem" + ] ] """ A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items. """ - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ @@ -1117,9 +1131,7 @@ class ListParamsScheduleDetailsPhase(TypedDict): """ Automatic tax settings for this phase. """ - billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'phase_start']" - ] + billing_cycle_anchor: NotRequired[Literal["automatic", "phase_start"]] """ Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -1130,20 +1142,20 @@ class ListParamsScheduleDetailsPhase(TypedDict): Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. """ @@ -1177,15 +1189,15 @@ class ListParamsScheduleDetailsPhase(TypedDict): """ List of configuration items, each with an attached price, to apply during this phase of the subscription schedule. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account on behalf of which to charge, for each of the associated subscription's invoices. """ @@ -1196,7 +1208,7 @@ class ListParamsScheduleDetailsPhase(TypedDict): If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/billing/subscriptions/pause-payment). """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. @@ -1211,11 +1223,11 @@ class ListParamsScheduleDetailsPhase(TypedDict): """ The data with which to automatically create a Transfer for each of the associated subscription's invoices. """ - trial: NotRequired["bool"] + trial: NotRequired[bool] """ If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. """ - trial_continuation: NotRequired["Literal['continue', 'none']"] + trial_continuation: NotRequired[Literal["continue", "none"]] """ Specify trial behavior when crossing phase boundaries """ @@ -1232,12 +1244,14 @@ class ListParamsScheduleDetailsPhase(TypedDict): class ListParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): discounts: NotRequired[ - "List[InvoiceUpcomingLinesService.ListParamsScheduleDetailsPhaseAddInvoiceItemDiscount]" + List[ + "InvoiceUpcomingLinesService.ListParamsScheduleDetailsPhaseAddInvoiceItemDiscount" + ] ] """ The coupons to redeem into discounts for the item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -1247,7 +1261,7 @@ class ListParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. Defaults to 1. """ @@ -1257,11 +1271,11 @@ class ListParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): """ class ListParamsScheduleDetailsPhaseAddInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1271,7 +1285,7 @@ class ListParamsScheduleDetailsPhaseAddInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1285,7 +1299,7 @@ class ListParamsScheduleDetailsPhaseAddInvoiceItemDiscountDiscountEnd( """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1316,16 +1330,16 @@ class ListParamsScheduleDetailsPhaseAddInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1343,7 +1357,7 @@ class ListParamsScheduleDetailsPhaseAutomaticTax(TypedDict): """ class ListParamsScheduleDetailsPhaseAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1353,21 +1367,21 @@ class ListParamsScheduleDetailsPhaseAutomaticTaxLiability(TypedDict): """ class ListParamsScheduleDetailsPhaseBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ class ListParamsScheduleDetailsPhaseDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1377,7 +1391,7 @@ class ListParamsScheduleDetailsPhaseDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1389,7 +1403,7 @@ class ListParamsScheduleDetailsPhaseDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1413,7 +1427,7 @@ class ListParamsScheduleDetailsPhaseInvoiceSettings(TypedDict): """ The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. """ @@ -1425,7 +1439,7 @@ class ListParamsScheduleDetailsPhaseInvoiceSettings(TypedDict): """ class ListParamsScheduleDetailsPhaseInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1447,15 +1461,15 @@ class ListParamsScheduleDetailsPhaseItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The plan ID to subscribe to. You may specify the same ID in `plan` and `price`. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -1465,7 +1479,7 @@ class ListParamsScheduleDetailsPhaseItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`. """ @@ -1487,11 +1501,11 @@ class ListParamsScheduleDetailsPhaseItemBillingThresholds(TypedDict): """ class ListParamsScheduleDetailsPhaseItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1501,7 +1515,7 @@ class ListParamsScheduleDetailsPhaseItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1513,7 +1527,7 @@ class ListParamsScheduleDetailsPhaseItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1548,16 +1562,16 @@ class ListParamsScheduleDetailsPhaseItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1567,13 +1581,13 @@ class ListParamsScheduleDetailsPhaseItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class ListParamsScheduleDetailsPhaseItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -1589,7 +1603,7 @@ class ListParamsScheduleDetailsPhasePauseCollection(TypedDict): """ class ListParamsScheduleDetailsPhaseTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -1607,7 +1621,7 @@ class ListParamsScheduleDetailsPhaseTrialSettings(TypedDict): """ class ListParamsScheduleDetailsPhaseTrialSettingsEndBehavior(TypedDict): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ @@ -1619,7 +1633,7 @@ class ListParamsScheduleDetailsPrebilling(TypedDict): """ The end of the prebilled time period. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ This is used to determine the number of billing cycles to prebill. """ @@ -1637,7 +1651,7 @@ class ListParamsScheduleDetailsPrebillingBillUntil(TypedDict): """ Time span for prebilling, starting from `bill_from`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ End the prebilled period at a precise integer timestamp, starting from the Unix epoch. """ @@ -1671,11 +1685,11 @@ class ListParamsSubscriptionDetails(TypedDict): """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. """ - cancel_at_period_end: NotRequired["bool"] + cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. """ - cancel_now: NotRequired["bool"] + cancel_now: NotRequired[bool] """ This simulates the subscription being canceled or expired immediately. """ @@ -1684,7 +1698,9 @@ class ListParamsSubscriptionDetails(TypedDict): If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. """ items: NotRequired[ - "List[InvoiceUpcomingLinesService.ListParamsSubscriptionDetailsItem]" + List[ + "InvoiceUpcomingLinesService.ListParamsSubscriptionDetailsItem" + ] ] """ A list of up to 20 subscription items, each with an attached price. @@ -1696,20 +1712,20 @@ class ListParamsSubscriptionDetails(TypedDict): The pre-billing to apply to the subscription as a preview. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'. """ - resume_at: NotRequired["Literal['now']"] + resume_at: NotRequired[Literal["now"]] """ For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. """ - start_date: NotRequired["int"] + start_date: NotRequired[int] """ Date a subscription is intended to start (can be future or past). """ @@ -1725,11 +1741,11 @@ class ListParamsSubscriptionDetailsItem(TypedDict): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. """ - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`. """ - deleted: NotRequired["bool"] + deleted: NotRequired[bool] """ A flag that, if set to `true`, will delete the specified item. """ @@ -1739,7 +1755,7 @@ class ListParamsSubscriptionDetailsItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - id: NotRequired["str"] + id: NotRequired[str] """ Subscription item to update. """ @@ -1747,11 +1763,11 @@ class ListParamsSubscriptionDetailsItem(TypedDict): """ 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -1761,7 +1777,7 @@ class ListParamsSubscriptionDetailsItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -1777,11 +1793,11 @@ class ListParamsSubscriptionDetailsItemBillingThresholds(TypedDict): """ class ListParamsSubscriptionDetailsItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1791,7 +1807,7 @@ class ListParamsSubscriptionDetailsItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1803,7 +1819,7 @@ class ListParamsSubscriptionDetailsItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1838,16 +1854,16 @@ class ListParamsSubscriptionDetailsItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1857,7 +1873,7 @@ class ListParamsSubscriptionDetailsItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -1875,11 +1891,11 @@ class ListParamsSubscriptionItem(TypedDict): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. """ - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`. """ - deleted: NotRequired["bool"] + deleted: NotRequired[bool] """ A flag that, if set to `true`, will delete the specified item. """ @@ -1889,7 +1905,7 @@ class ListParamsSubscriptionItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - id: NotRequired["str"] + id: NotRequired[str] """ Subscription item to update. """ @@ -1897,11 +1913,11 @@ class ListParamsSubscriptionItem(TypedDict): """ 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -1911,7 +1927,7 @@ class ListParamsSubscriptionItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -1927,11 +1943,11 @@ class ListParamsSubscriptionItemBillingThresholds(TypedDict): """ class ListParamsSubscriptionItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1941,7 +1957,7 @@ class ListParamsSubscriptionItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1953,7 +1969,7 @@ class ListParamsSubscriptionItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1986,16 +2002,16 @@ class ListParamsSubscriptionItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -2005,7 +2021,7 @@ class ListParamsSubscriptionItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ diff --git a/stripe/_mandate.py b/stripe/_mandate.py index 1cd7e4aa5..3a948871b 100644 --- a/stripe/_mandate.py +++ b/stripe/_mandate.py @@ -235,7 +235,7 @@ class SingleUse(StripeObject): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_mandate_service.py b/stripe/_mandate_service.py index aeb281ed6..52c0c6ca1 100644 --- a/stripe/_mandate_service.py +++ b/stripe/_mandate_service.py @@ -10,7 +10,7 @@ class MandateService(StripeService): class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_margin.py b/stripe/_margin.py index 1b1008ec8..085047872 100644 --- a/stripe/_margin.py +++ b/stripe/_margin.py @@ -23,19 +23,19 @@ class Margin( OBJECT_NAME: ClassVar[Literal["margin"]] = "margin" class CreateParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the margin can be applied to invoices, invoice items, or invoice line items or not. Defaults to `true`. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - name: NotRequired["str"] + name: NotRequired[str] """ Name of the margin, which is displayed to customers, such as on invoices. """ @@ -45,47 +45,47 @@ class CreateParams(RequestOptions): """ class ListParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Only return margins that are active or inactive, i.e., pass false to list all inactive margins. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the margin can be applied to invoices, invoice items, or invoice line items or not. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - name: NotRequired["str"] + name: NotRequired[str] """ Name of the margin, which is displayed to customers, such as on invoices. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_margin_service.py b/stripe/_margin_service.py index 859c29e8d..131fadf89 100644 --- a/stripe/_margin_service.py +++ b/stripe/_margin_service.py @@ -11,19 +11,19 @@ class MarginService(StripeService): class CreateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the margin can be applied to invoices, invoice items, or invoice line items or not. Defaults to `true`. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - name: NotRequired["str"] + name: NotRequired[str] """ Name of the margin, which is displayed to customers, such as on invoices. """ @@ -33,47 +33,47 @@ class CreateParams(TypedDict): """ class ListParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Only return margins that are active or inactive, i.e., pass false to list all inactive margins. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the margin can be applied to invoices, invoice items, or invoice line items or not. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - name: NotRequired["str"] + name: NotRequired[str] """ Name of the margin, which is displayed to customers, such as on invoices. """ diff --git a/stripe/_order.py b/stripe/_order.py index a951633af..7205eca72 100644 --- a/stripe/_order.py +++ b/stripe/_order.py @@ -869,7 +869,7 @@ class Tax(StripeObject): _inner_class_types = {"breakdown": Breakdown} class CancelParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -893,11 +893,11 @@ class CreateParams(RequestOptions): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The customer associated with this order. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ @@ -905,11 +905,11 @@ class CreateParams(RequestOptions): """ The coupons, promotion codes, and/or discounts to apply to the order. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - ip_address: NotRequired["str"] + ip_address: NotRequired[str] """ The IP address of the purchaser for this order. """ @@ -917,7 +917,7 @@ class CreateParams(RequestOptions): """ A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -953,47 +953,47 @@ class CreateParamsBillingDetails(TypedDict): """ The billing address provided by the customer. """ - email: NotRequired["str"] + email: NotRequired[str] """ The billing email provided by the customer. """ - name: NotRequired["str"] + name: NotRequired[str] """ The billing name provided by the customer. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The billing phone number provided by the customer. """ class CreateParamsBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". """ class CreateParamsCredit(TypedDict): - gift_card: NotRequired["str"] + gift_card: NotRequired[str] """ The gift card to apply to the order. """ @@ -1003,21 +1003,21 @@ class CreateParamsCredit(TypedDict): """ class CreateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ class CreateParamsLineItem(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The description for the line item. Will default to the name of the associated product. """ @@ -1027,7 +1027,7 @@ class CreateParamsLineItem(TypedDict): """ The discounts applied to this line item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of a [Price](https://stripe.com/docs/api/prices) to add to the Order. @@ -1041,7 +1041,7 @@ class CreateParamsLineItem(TypedDict): Each time you pass `price_data` we create a Price for the product. This Price is hidden in both the Dashboard and API lists and cannot be reused. """ - product: NotRequired["str"] + product: NotRequired[str] """ The ID of a [Product](https://stripe.com/docs/api/products) to add to the Order. @@ -1055,7 +1055,7 @@ class CreateParamsLineItem(TypedDict): `product_data` automatically creates a Product, just as if you had manually created the Product. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item. """ @@ -1065,37 +1065,37 @@ class CreateParamsLineItem(TypedDict): """ class CreateParamsLineItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ class CreateParamsLineItemPriceData(TypedDict): - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - product: NotRequired["str"] + product: NotRequired[str] """ ID of the product this price belongs to. Use this to implement a variable-pricing model in your integration. This is required if `product_data` is not specifed. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1129,7 +1129,7 @@ class CreateParamsLineItemProductData(TypedDict): """ The dimensions of this product for shipping purposes. """ - shippable: NotRequired["bool"] + shippable: NotRequired[bool] """ Whether this product is shipped (i.e., physical goods). """ @@ -1167,7 +1167,7 @@ class CreateParamsPayment(TypedDict): """ class CreateParamsPaymentSettings(TypedDict): - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. """ @@ -1178,20 +1178,44 @@ class CreateParamsPaymentSettings(TypedDict): PaymentMethod-specific configuration to provide to the order's PaymentIntent. """ payment_method_types: NotRequired[ - "List[Literal['acss_debit', 'afterpay_clearpay', 'alipay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'card', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'link', 'oxxo', 'p24', 'paypal', 'sepa_debit', 'sofort', 'wechat_pay']]" + List[ + Literal[ + "acss_debit", + "afterpay_clearpay", + "alipay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "card", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "link", + "oxxo", + "p24", + "paypal", + "sepa_debit", + "sofort", + "wechat_pay", + ] + ] ] """ The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL to redirect the customer to after they authenticate their payment. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. """ @@ -1314,7 +1338,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -1329,17 +1353,17 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions( The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -1348,7 +1372,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAfterpayClearpay( TypedDict, ): capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. @@ -1357,11 +1381,11 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAfterpayClearpay( If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ An internal identifier or reference this payment corresponds to. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with the payment method. @@ -1387,7 +1411,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAlipay(TypedDict): """ class CreateParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -1406,13 +1430,13 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): class CreateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. """ setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with the payment method. @@ -1433,11 +1457,11 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalance( """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["Literal['bank_transfer']"] + funding_type: NotRequired[Literal["bank_transfer"]] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1458,7 +1482,17 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer Configuration for the eu_bank_transfer funding type. """ requested_address_types: NotRequired[ - "List[Literal['aba', 'iban', 'sepa', 'sort_code', 'spei', 'swift', 'zengin']]" + List[ + Literal[ + "aba", + "iban", + "sepa", + "sort_code", + "spei", + "swift", + "zengin", + ] + ] ] """ List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. @@ -1508,12 +1542,57 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsKlarna(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-CH', 'de-DE', 'el-GR', 'en-AT', 'en-AU', 'en-BE', 'en-CA', 'en-CH', 'en-CZ', 'en-DE', 'en-DK', 'en-ES', 'en-FI', 'en-FR', 'en-GB', 'en-GR', 'en-IE', 'en-IT', 'en-NL', 'en-NO', 'en-NZ', 'en-PL', 'en-PT', 'en-SE', 'en-US', 'es-ES', 'es-US', 'fi-FI', 'fr-BE', 'fr-CA', 'fr-CH', 'fr-FR', 'it-CH', 'it-IT', 'nb-NO', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sv-FI', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-CH", + "de-DE", + "el-GR", + "en-AT", + "en-AU", + "en-BE", + "en-CA", + "en-CH", + "en-CZ", + "en-DE", + "en-DK", + "en-ES", + "en-FI", + "en-FR", + "en-GB", + "en-GR", + "en-IE", + "en-IT", + "en-NL", + "en-NO", + "en-NZ", + "en-PL", + "en-PT", + "en-SE", + "en-US", + "es-ES", + "es-US", + "fi-FI", + "fr-BE", + "fr-CA", + "fr-CH", + "fr-FR", + "it-CH", + "it-IT", + "nb-NO", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sv-FI", + "sv-SE", + ] ] """ Preferred language of the Klarna authorization page that the customer is redirected to """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1533,7 +1612,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsLink(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ @@ -1551,11 +1630,11 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsLink(TypedDict): """ class CreateParamsPaymentSettingsPaymentMethodOptionsOxxo(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1567,7 +1646,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsOxxo(TypedDict): """ class CreateParamsPaymentSettingsPaymentMethodOptionsP24(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1577,7 +1656,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsP24(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - tos_shown_and_accepted: NotRequired["bool"] + tos_shown_and_accepted: NotRequired[bool] """ Confirm that the payer has accepted the P24 terms and conditions. """ @@ -1588,20 +1667,42 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsPaypal(TypedDict): Controls when the funds will be captured from the customer's account. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-DE', 'de-LU', 'el-GR', 'en-GB', 'en-US', 'es-ES', 'fi-FI', 'fr-BE', 'fr-FR', 'fr-LU', 'hu-HU', 'it-IT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sk-SK', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-DE", + "de-LU", + "el-GR", + "en-GB", + "en-US", + "es-ES", + "fi-FI", + "fr-BE", + "fr-FR", + "fr-LU", + "hu-HU", + "it-IT", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sk-SK", + "sv-SE", + ] ] """ [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - reference_id: NotRequired["str"] + reference_id: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - risk_correlation_id: NotRequired["str"] + risk_correlation_id: NotRequired[str] """ The risk correlation ID for an on-session payment using a saved PayPal payment method. """ @@ -1617,7 +1718,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsPaypal(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - subsellers: NotRequired["List[str]"] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -1668,7 +1769,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsSofort(TypedDict): """ class CreateParamsPaymentSettingsPaymentMethodOptionsWechatPay(TypedDict): - app_id: NotRequired["str"] + app_id: NotRequired[str] """ The app ID registered with WeChat Pay. Only required when client is ios or android. """ @@ -1676,7 +1777,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsWechatPay(TypedDict): """ The client type that the end customer will pay from """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1688,7 +1789,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsWechatPay(TypedDict): """ class CreateParamsPaymentSettingsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when the order is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field. """ @@ -1698,7 +1799,7 @@ class CreateParamsPaymentSettingsTransferData(TypedDict): """ class CreateParamsShippingCost(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the shipping rate to use for this order. """ @@ -1726,21 +1827,21 @@ class CreateParamsShippingCostShippingRateData(TypedDict): """ Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ - type: NotRequired["Literal['fixed_amount']"] + type: NotRequired[Literal["fixed_amount"]] """ The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. """ @@ -1793,7 +1894,10 @@ class CreateParamsShippingCostShippingRateDataFixedAmount(TypedDict): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, Order.CreateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions]" + Dict[ + str, + "Order.CreateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions", + ] ] """ Shipping rates 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). @@ -1807,7 +1911,7 @@ class CreateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions( A non-negative integer in cents representing how much to charge. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. @@ -1828,27 +1932,27 @@ class CreateParamsShippingDetails(TypedDict): """ class CreateParamsShippingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". """ @@ -1860,7 +1964,7 @@ class CreateParamsTaxDetails(TypedDict): """ The purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`. """ - tax_ids: NotRequired["List[Order.CreateParamsTaxDetailsTaxId]"] + tax_ids: NotRequired[List["Order.CreateParamsTaxDetailsTaxId"]] """ The purchaser's tax IDs to be used for this order. """ @@ -1944,41 +2048,41 @@ class CreateParamsTaxDetailsTaxId(TypedDict): """ class ListLineItemsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 ListParams(RequestOptions): - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return orders for the given customer. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ @@ -1998,11 +2102,11 @@ class ModifyParams(RequestOptions): """ The credits to apply to the order, only `gift_card` currently supported. Pass the empty string `""` to unset this field. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The customer associated with this order. """ @@ -2014,15 +2118,15 @@ class ModifyParams(RequestOptions): """ The coupons, promotion codes, and/or discounts to apply to the order. Pass the empty string `""` to unset this field. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - ip_address: NotRequired["str"] + ip_address: NotRequired[str] """ The IP address of the purchaser for this order. """ - line_items: NotRequired["List[Order.ModifyParamsLineItem]"] + line_items: NotRequired[List["Order.ModifyParamsLineItem"]] """ A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost. """ @@ -2062,47 +2166,47 @@ class ModifyParamsBillingDetails(TypedDict): """ The billing address provided by the customer. """ - email: NotRequired["str"] + email: NotRequired[str] """ The billing email provided by the customer. """ - name: NotRequired["str"] + name: NotRequired[str] """ The billing name provided by the customer. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The billing phone number provided by the customer. """ class ModifyParamsBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". """ class ModifyParamsCredit(TypedDict): - gift_card: NotRequired["str"] + gift_card: NotRequired[str] """ The gift card to apply to the order. """ @@ -2112,21 +2216,21 @@ class ModifyParamsCredit(TypedDict): """ class ModifyParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ class ModifyParamsLineItem(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The description for the line item. Will default to the name of the associated product. """ @@ -2136,11 +2240,11 @@ class ModifyParamsLineItem(TypedDict): """ The discounts applied to this line item. """ - id: NotRequired["str"] + id: NotRequired[str] """ The ID of an existing line item on the order. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of a [Price](https://stripe.com/docs/api/prices) to add to the Order. @@ -2154,7 +2258,7 @@ class ModifyParamsLineItem(TypedDict): Each time you pass `price_data` we create a Price for the product. This Price is hidden in both the Dashboard and API lists and cannot be reused. """ - product: NotRequired["str"] + product: NotRequired[str] """ The ID of a [Product](https://stripe.com/docs/api/products) to add to the Order. @@ -2168,7 +2272,7 @@ class ModifyParamsLineItem(TypedDict): `product_data` automatically creates a Product, just as if you had manually created the Product. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item. """ @@ -2178,37 +2282,37 @@ class ModifyParamsLineItem(TypedDict): """ class ModifyParamsLineItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ class ModifyParamsLineItemPriceData(TypedDict): - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - product: NotRequired["str"] + product: NotRequired[str] """ ID of the product this price belongs to. Use this to implement a variable-pricing model in your integration. This is required if `product_data` is not specifed. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -2242,7 +2346,7 @@ class ModifyParamsLineItemProductData(TypedDict): """ The dimensions of this product for shipping purposes. """ - shippable: NotRequired["bool"] + shippable: NotRequired[bool] """ Whether this product is shipped (i.e., physical goods). """ @@ -2291,7 +2395,31 @@ class ModifyParamsPaymentSettings(TypedDict): PaymentMethod-specific configuration to provide to the order's PaymentIntent. """ payment_method_types: NotRequired[ - "List[Literal['acss_debit', 'afterpay_clearpay', 'alipay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'card', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'link', 'oxxo', 'p24', 'paypal', 'sepa_debit', 'sofort', 'wechat_pay']]" + List[ + Literal[ + "acss_debit", + "afterpay_clearpay", + "alipay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "card", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "link", + "oxxo", + "p24", + "paypal", + "sepa_debit", + "sofort", + "wechat_pay", + ] + ] ] """ The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). @@ -2300,11 +2428,11 @@ class ModifyParamsPaymentSettings(TypedDict): """ The URL to redirect the customer to after they authenticate their payment. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. """ @@ -2427,7 +2555,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -2442,17 +2570,17 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions( The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -2461,7 +2589,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsAfterpayClearpay( TypedDict, ): capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. @@ -2470,11 +2598,11 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsAfterpayClearpay( If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ An internal identifier or reference this payment corresponds to. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with the payment method. @@ -2500,7 +2628,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsAlipay(TypedDict): """ class ModifyParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -2519,13 +2647,13 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): class ModifyParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. """ setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with the payment method. @@ -2546,11 +2674,11 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsCustomerBalance( """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["Literal['bank_transfer']"] + funding_type: NotRequired[Literal["bank_transfer"]] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2571,7 +2699,17 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer Configuration for the eu_bank_transfer funding type. """ requested_address_types: NotRequired[ - "List[Literal['aba', 'iban', 'sepa', 'sort_code', 'spei', 'swift', 'zengin']]" + List[ + Literal[ + "aba", + "iban", + "sepa", + "sort_code", + "spei", + "swift", + "zengin", + ] + ] ] """ List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. @@ -2621,12 +2759,57 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsKlarna(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-CH', 'de-DE', 'el-GR', 'en-AT', 'en-AU', 'en-BE', 'en-CA', 'en-CH', 'en-CZ', 'en-DE', 'en-DK', 'en-ES', 'en-FI', 'en-FR', 'en-GB', 'en-GR', 'en-IE', 'en-IT', 'en-NL', 'en-NO', 'en-NZ', 'en-PL', 'en-PT', 'en-SE', 'en-US', 'es-ES', 'es-US', 'fi-FI', 'fr-BE', 'fr-CA', 'fr-CH', 'fr-FR', 'it-CH', 'it-IT', 'nb-NO', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sv-FI', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-CH", + "de-DE", + "el-GR", + "en-AT", + "en-AU", + "en-BE", + "en-CA", + "en-CH", + "en-CZ", + "en-DE", + "en-DK", + "en-ES", + "en-FI", + "en-FR", + "en-GB", + "en-GR", + "en-IE", + "en-IT", + "en-NL", + "en-NO", + "en-NZ", + "en-PL", + "en-PT", + "en-SE", + "en-US", + "es-ES", + "es-US", + "fi-FI", + "fr-BE", + "fr-CA", + "fr-CH", + "fr-FR", + "it-CH", + "it-IT", + "nb-NO", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sv-FI", + "sv-SE", + ] ] """ Preferred language of the Klarna authorization page that the customer is redirected to """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2646,7 +2829,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsLink(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ @@ -2664,11 +2847,11 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsLink(TypedDict): """ class ModifyParamsPaymentSettingsPaymentMethodOptionsOxxo(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2680,7 +2863,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsOxxo(TypedDict): """ class ModifyParamsPaymentSettingsPaymentMethodOptionsP24(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2690,7 +2873,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsP24(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - tos_shown_and_accepted: NotRequired["bool"] + tos_shown_and_accepted: NotRequired[bool] """ Confirm that the payer has accepted the P24 terms and conditions. """ @@ -2701,20 +2884,42 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsPaypal(TypedDict): Controls when the funds will be captured from the customer's account. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-DE', 'de-LU', 'el-GR', 'en-GB', 'en-US', 'es-ES', 'fi-FI', 'fr-BE', 'fr-FR', 'fr-LU', 'hu-HU', 'it-IT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sk-SK', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-DE", + "de-LU", + "el-GR", + "en-GB", + "en-US", + "es-ES", + "fi-FI", + "fr-BE", + "fr-FR", + "fr-LU", + "hu-HU", + "it-IT", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sk-SK", + "sv-SE", + ] ] """ [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - reference_id: NotRequired["str"] + reference_id: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - risk_correlation_id: NotRequired["str"] + risk_correlation_id: NotRequired[str] """ The risk correlation ID for an on-session payment using a saved PayPal payment method. """ @@ -2730,7 +2935,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsPaypal(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - subsellers: NotRequired["List[str]"] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -2781,7 +2986,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsSofort(TypedDict): """ class ModifyParamsPaymentSettingsPaymentMethodOptionsWechatPay(TypedDict): - app_id: NotRequired["str"] + app_id: NotRequired[str] """ The app ID registered with WeChat Pay. Only required when client is ios or android. """ @@ -2789,7 +2994,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsWechatPay(TypedDict): """ The client type that the end customer will pay from """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2801,7 +3006,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsWechatPay(TypedDict): """ class ModifyParamsPaymentSettingsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when the order is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field. """ @@ -2811,7 +3016,7 @@ class ModifyParamsPaymentSettingsTransferData(TypedDict): """ class ModifyParamsShippingCost(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the shipping rate to use for this order. """ @@ -2839,21 +3044,21 @@ class ModifyParamsShippingCostShippingRateData(TypedDict): """ Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ - type: NotRequired["Literal['fixed_amount']"] + type: NotRequired[Literal["fixed_amount"]] """ The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. """ @@ -2906,7 +3111,10 @@ class ModifyParamsShippingCostShippingRateDataFixedAmount(TypedDict): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, Order.ModifyParamsShippingCostShippingRateDataFixedAmountCurrencyOptions]" + Dict[ + str, + "Order.ModifyParamsShippingCostShippingRateDataFixedAmountCurrencyOptions", + ] ] """ Shipping rates 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). @@ -2920,7 +3128,7 @@ class ModifyParamsShippingCostShippingRateDataFixedAmountCurrencyOptions( A non-negative integer in cents representing how much to charge. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. @@ -2941,27 +3149,27 @@ class ModifyParamsShippingDetails(TypedDict): """ class ModifyParamsShippingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". """ @@ -2973,7 +3181,7 @@ class ModifyParamsTaxDetails(TypedDict): """ The purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`. """ - tax_ids: NotRequired["List[Order.ModifyParamsTaxDetailsTaxId]"] + tax_ids: NotRequired[List["Order.ModifyParamsTaxDetailsTaxId"]] """ The purchaser's tax IDs to be used for this order. """ @@ -3057,19 +3265,19 @@ class ModifyParamsTaxDetailsTaxId(TypedDict): """ class ReopenParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SubmitParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_order_line_item_service.py b/stripe/_order_line_item_service.py index b5f2250df..0ac3ed0f5 100644 --- a/stripe/_order_line_item_service.py +++ b/stripe/_order_line_item_service.py @@ -11,19 +11,19 @@ class OrderLineItemService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/_order_service.py b/stripe/_order_service.py index b1252178b..3e3c3addf 100644 --- a/stripe/_order_service.py +++ b/stripe/_order_service.py @@ -16,7 +16,7 @@ def __init__(self, requestor): self.line_items = OrderLineItemService(self._requestor) class CancelParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -42,11 +42,11 @@ class CreateParams(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The customer associated with this order. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ @@ -56,11 +56,11 @@ class CreateParams(TypedDict): """ The coupons, promotion codes, and/or discounts to apply to the order. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - ip_address: NotRequired["str"] + ip_address: NotRequired[str] """ The IP address of the purchaser for this order. """ @@ -68,7 +68,7 @@ class CreateParams(TypedDict): """ A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -104,47 +104,47 @@ class CreateParamsBillingDetails(TypedDict): """ The billing address provided by the customer. """ - email: NotRequired["str"] + email: NotRequired[str] """ The billing email provided by the customer. """ - name: NotRequired["str"] + name: NotRequired[str] """ The billing name provided by the customer. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The billing phone number provided by the customer. """ class CreateParamsBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". """ class CreateParamsCredit(TypedDict): - gift_card: NotRequired["str"] + gift_card: NotRequired[str] """ The gift card to apply to the order. """ @@ -154,21 +154,21 @@ class CreateParamsCredit(TypedDict): """ class CreateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ class CreateParamsLineItem(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The description for the line item. Will default to the name of the associated product. """ @@ -178,7 +178,7 @@ class CreateParamsLineItem(TypedDict): """ The discounts applied to this line item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of a [Price](https://stripe.com/docs/api/prices) to add to the Order. @@ -192,7 +192,7 @@ class CreateParamsLineItem(TypedDict): Each time you pass `price_data` we create a Price for the product. This Price is hidden in both the Dashboard and API lists and cannot be reused. """ - product: NotRequired["str"] + product: NotRequired[str] """ The ID of a [Product](https://stripe.com/docs/api/products) to add to the Order. @@ -208,7 +208,7 @@ class CreateParamsLineItem(TypedDict): `product_data` automatically creates a Product, just as if you had manually created the Product. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item. """ @@ -218,37 +218,37 @@ class CreateParamsLineItem(TypedDict): """ class CreateParamsLineItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ class CreateParamsLineItemPriceData(TypedDict): - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - product: NotRequired["str"] + product: NotRequired[str] """ ID of the product this price belongs to. Use this to implement a variable-pricing model in your integration. This is required if `product_data` is not specifed. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -282,7 +282,7 @@ class CreateParamsLineItemProductData(TypedDict): """ The dimensions of this product for shipping purposes. """ - shippable: NotRequired["bool"] + shippable: NotRequired[bool] """ Whether this product is shipped (i.e., physical goods). """ @@ -320,7 +320,7 @@ class CreateParamsPayment(TypedDict): """ class CreateParamsPaymentSettings(TypedDict): - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. """ @@ -331,20 +331,44 @@ class CreateParamsPaymentSettings(TypedDict): PaymentMethod-specific configuration to provide to the order's PaymentIntent. """ payment_method_types: NotRequired[ - "List[Literal['acss_debit', 'afterpay_clearpay', 'alipay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'card', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'link', 'oxxo', 'p24', 'paypal', 'sepa_debit', 'sofort', 'wechat_pay']]" + List[ + Literal[ + "acss_debit", + "afterpay_clearpay", + "alipay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "card", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "link", + "oxxo", + "p24", + "paypal", + "sepa_debit", + "sofort", + "wechat_pay", + ] + ] ] """ The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL to redirect the customer to after they authenticate their payment. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. """ @@ -467,7 +491,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -482,17 +506,17 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions( The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -501,7 +525,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAfterpayClearpay( TypedDict, ): capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. @@ -510,11 +534,11 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAfterpayClearpay( If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ An internal identifier or reference this payment corresponds to. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with the payment method. @@ -540,7 +564,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAlipay(TypedDict): """ class CreateParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -559,13 +583,13 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): class CreateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. """ setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with the payment method. @@ -586,11 +610,11 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalance( """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["Literal['bank_transfer']"] + funding_type: NotRequired[Literal["bank_transfer"]] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -611,7 +635,17 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer Configuration for the eu_bank_transfer funding type. """ requested_address_types: NotRequired[ - "List[Literal['aba', 'iban', 'sepa', 'sort_code', 'spei', 'swift', 'zengin']]" + List[ + Literal[ + "aba", + "iban", + "sepa", + "sort_code", + "spei", + "swift", + "zengin", + ] + ] ] """ List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. @@ -661,12 +695,57 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsKlarna(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-CH', 'de-DE', 'el-GR', 'en-AT', 'en-AU', 'en-BE', 'en-CA', 'en-CH', 'en-CZ', 'en-DE', 'en-DK', 'en-ES', 'en-FI', 'en-FR', 'en-GB', 'en-GR', 'en-IE', 'en-IT', 'en-NL', 'en-NO', 'en-NZ', 'en-PL', 'en-PT', 'en-SE', 'en-US', 'es-ES', 'es-US', 'fi-FI', 'fr-BE', 'fr-CA', 'fr-CH', 'fr-FR', 'it-CH', 'it-IT', 'nb-NO', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sv-FI', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-CH", + "de-DE", + "el-GR", + "en-AT", + "en-AU", + "en-BE", + "en-CA", + "en-CH", + "en-CZ", + "en-DE", + "en-DK", + "en-ES", + "en-FI", + "en-FR", + "en-GB", + "en-GR", + "en-IE", + "en-IT", + "en-NL", + "en-NO", + "en-NZ", + "en-PL", + "en-PT", + "en-SE", + "en-US", + "es-ES", + "es-US", + "fi-FI", + "fr-BE", + "fr-CA", + "fr-CH", + "fr-FR", + "it-CH", + "it-IT", + "nb-NO", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sv-FI", + "sv-SE", + ] ] """ Preferred language of the Klarna authorization page that the customer is redirected to """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -686,7 +765,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsLink(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ @@ -704,11 +783,11 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsLink(TypedDict): """ class CreateParamsPaymentSettingsPaymentMethodOptionsOxxo(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -720,7 +799,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsOxxo(TypedDict): """ class CreateParamsPaymentSettingsPaymentMethodOptionsP24(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -730,7 +809,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsP24(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - tos_shown_and_accepted: NotRequired["bool"] + tos_shown_and_accepted: NotRequired[bool] """ Confirm that the payer has accepted the P24 terms and conditions. """ @@ -741,20 +820,42 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsPaypal(TypedDict): Controls when the funds will be captured from the customer's account. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-DE', 'de-LU', 'el-GR', 'en-GB', 'en-US', 'es-ES', 'fi-FI', 'fr-BE', 'fr-FR', 'fr-LU', 'hu-HU', 'it-IT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sk-SK', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-DE", + "de-LU", + "el-GR", + "en-GB", + "en-US", + "es-ES", + "fi-FI", + "fr-BE", + "fr-FR", + "fr-LU", + "hu-HU", + "it-IT", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sk-SK", + "sv-SE", + ] ] """ [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - reference_id: NotRequired["str"] + reference_id: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - risk_correlation_id: NotRequired["str"] + risk_correlation_id: NotRequired[str] """ The risk correlation ID for an on-session payment using a saved PayPal payment method. """ @@ -770,7 +871,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsPaypal(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - subsellers: NotRequired["List[str]"] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -821,7 +922,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsSofort(TypedDict): """ class CreateParamsPaymentSettingsPaymentMethodOptionsWechatPay(TypedDict): - app_id: NotRequired["str"] + app_id: NotRequired[str] """ The app ID registered with WeChat Pay. Only required when client is ios or android. """ @@ -829,7 +930,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsWechatPay(TypedDict): """ The client type that the end customer will pay from """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -841,7 +942,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsWechatPay(TypedDict): """ class CreateParamsPaymentSettingsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when the order is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field. """ @@ -851,7 +952,7 @@ class CreateParamsPaymentSettingsTransferData(TypedDict): """ class CreateParamsShippingCost(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the shipping rate to use for this order. """ @@ -879,21 +980,21 @@ class CreateParamsShippingCostShippingRateData(TypedDict): """ Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ - type: NotRequired["Literal['fixed_amount']"] + type: NotRequired[Literal["fixed_amount"]] """ The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. """ @@ -946,7 +1047,10 @@ class CreateParamsShippingCostShippingRateDataFixedAmount(TypedDict): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, OrderService.CreateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions]" + Dict[ + str, + "OrderService.CreateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions", + ] ] """ Shipping rates 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). @@ -960,7 +1064,7 @@ class CreateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions( A non-negative integer in cents representing how much to charge. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. @@ -981,27 +1085,27 @@ class CreateParamsShippingDetails(TypedDict): """ class CreateParamsShippingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". """ @@ -1013,7 +1117,7 @@ class CreateParamsTaxDetails(TypedDict): """ The purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`. """ - tax_ids: NotRequired["List[OrderService.CreateParamsTaxDetailsTaxId]"] + tax_ids: NotRequired[List["OrderService.CreateParamsTaxDetailsTaxId"]] """ The purchaser's tax IDs to be used for this order. """ @@ -1097,41 +1201,41 @@ class CreateParamsTaxDetailsTaxId(TypedDict): """ class ListParams(TypedDict): - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return orders for the given customer. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 ReopenParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SubmitParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1157,11 +1261,11 @@ class UpdateParams(TypedDict): """ The credits to apply to the order, only `gift_card` currently supported. Pass the empty string `""` to unset this field. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The customer associated with this order. """ @@ -1175,15 +1279,15 @@ class UpdateParams(TypedDict): """ The coupons, promotion codes, and/or discounts to apply to the order. Pass the empty string `""` to unset this field. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - ip_address: NotRequired["str"] + ip_address: NotRequired[str] """ The IP address of the purchaser for this order. """ - line_items: NotRequired["List[OrderService.UpdateParamsLineItem]"] + line_items: NotRequired[List["OrderService.UpdateParamsLineItem"]] """ A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost. """ @@ -1223,47 +1327,47 @@ class UpdateParamsBillingDetails(TypedDict): """ The billing address provided by the customer. """ - email: NotRequired["str"] + email: NotRequired[str] """ The billing email provided by the customer. """ - name: NotRequired["str"] + name: NotRequired[str] """ The billing name provided by the customer. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The billing phone number provided by the customer. """ class UpdateParamsBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". """ class UpdateParamsCredit(TypedDict): - gift_card: NotRequired["str"] + gift_card: NotRequired[str] """ The gift card to apply to the order. """ @@ -1273,21 +1377,21 @@ class UpdateParamsCredit(TypedDict): """ class UpdateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ class UpdateParamsLineItem(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The description for the line item. Will default to the name of the associated product. """ @@ -1297,11 +1401,11 @@ class UpdateParamsLineItem(TypedDict): """ The discounts applied to this line item. """ - id: NotRequired["str"] + id: NotRequired[str] """ The ID of an existing line item on the order. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of a [Price](https://stripe.com/docs/api/prices) to add to the Order. @@ -1315,7 +1419,7 @@ class UpdateParamsLineItem(TypedDict): Each time you pass `price_data` we create a Price for the product. This Price is hidden in both the Dashboard and API lists and cannot be reused. """ - product: NotRequired["str"] + product: NotRequired[str] """ The ID of a [Product](https://stripe.com/docs/api/products) to add to the Order. @@ -1331,7 +1435,7 @@ class UpdateParamsLineItem(TypedDict): `product_data` automatically creates a Product, just as if you had manually created the Product. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item. """ @@ -1341,37 +1445,37 @@ class UpdateParamsLineItem(TypedDict): """ class UpdateParamsLineItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ class UpdateParamsLineItemPriceData(TypedDict): - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - product: NotRequired["str"] + product: NotRequired[str] """ ID of the product this price belongs to. Use this to implement a variable-pricing model in your integration. This is required if `product_data` is not specifed. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1405,7 +1509,7 @@ class UpdateParamsLineItemProductData(TypedDict): """ The dimensions of this product for shipping purposes. """ - shippable: NotRequired["bool"] + shippable: NotRequired[bool] """ Whether this product is shipped (i.e., physical goods). """ @@ -1454,7 +1558,31 @@ class UpdateParamsPaymentSettings(TypedDict): PaymentMethod-specific configuration to provide to the order's PaymentIntent. """ payment_method_types: NotRequired[ - "List[Literal['acss_debit', 'afterpay_clearpay', 'alipay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'card', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'link', 'oxxo', 'p24', 'paypal', 'sepa_debit', 'sofort', 'wechat_pay']]" + List[ + Literal[ + "acss_debit", + "afterpay_clearpay", + "alipay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "card", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "link", + "oxxo", + "p24", + "paypal", + "sepa_debit", + "sofort", + "wechat_pay", + ] + ] ] """ The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). @@ -1463,11 +1591,11 @@ class UpdateParamsPaymentSettings(TypedDict): """ The URL to redirect the customer to after they authenticate their payment. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. """ @@ -1590,7 +1718,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -1605,17 +1733,17 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions( The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -1624,7 +1752,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsAfterpayClearpay( TypedDict, ): capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. @@ -1633,11 +1761,11 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsAfterpayClearpay( If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ An internal identifier or reference this payment corresponds to. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with the payment method. @@ -1663,7 +1791,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsAlipay(TypedDict): """ class UpdateParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -1682,13 +1810,13 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): class UpdateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. """ setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with the payment method. @@ -1709,11 +1837,11 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsCustomerBalance( """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["Literal['bank_transfer']"] + funding_type: NotRequired[Literal["bank_transfer"]] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1734,7 +1862,17 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer Configuration for the eu_bank_transfer funding type. """ requested_address_types: NotRequired[ - "List[Literal['aba', 'iban', 'sepa', 'sort_code', 'spei', 'swift', 'zengin']]" + List[ + Literal[ + "aba", + "iban", + "sepa", + "sort_code", + "spei", + "swift", + "zengin", + ] + ] ] """ List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. @@ -1784,12 +1922,57 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsKlarna(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-CH', 'de-DE', 'el-GR', 'en-AT', 'en-AU', 'en-BE', 'en-CA', 'en-CH', 'en-CZ', 'en-DE', 'en-DK', 'en-ES', 'en-FI', 'en-FR', 'en-GB', 'en-GR', 'en-IE', 'en-IT', 'en-NL', 'en-NO', 'en-NZ', 'en-PL', 'en-PT', 'en-SE', 'en-US', 'es-ES', 'es-US', 'fi-FI', 'fr-BE', 'fr-CA', 'fr-CH', 'fr-FR', 'it-CH', 'it-IT', 'nb-NO', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sv-FI', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-CH", + "de-DE", + "el-GR", + "en-AT", + "en-AU", + "en-BE", + "en-CA", + "en-CH", + "en-CZ", + "en-DE", + "en-DK", + "en-ES", + "en-FI", + "en-FR", + "en-GB", + "en-GR", + "en-IE", + "en-IT", + "en-NL", + "en-NO", + "en-NZ", + "en-PL", + "en-PT", + "en-SE", + "en-US", + "es-ES", + "es-US", + "fi-FI", + "fr-BE", + "fr-CA", + "fr-CH", + "fr-FR", + "it-CH", + "it-IT", + "nb-NO", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sv-FI", + "sv-SE", + ] ] """ Preferred language of the Klarna authorization page that the customer is redirected to """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1809,7 +1992,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsLink(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ @@ -1827,11 +2010,11 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsLink(TypedDict): """ class UpdateParamsPaymentSettingsPaymentMethodOptionsOxxo(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1843,7 +2026,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsOxxo(TypedDict): """ class UpdateParamsPaymentSettingsPaymentMethodOptionsP24(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1853,7 +2036,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsP24(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - tos_shown_and_accepted: NotRequired["bool"] + tos_shown_and_accepted: NotRequired[bool] """ Confirm that the payer has accepted the P24 terms and conditions. """ @@ -1864,20 +2047,42 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsPaypal(TypedDict): Controls when the funds will be captured from the customer's account. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-DE', 'de-LU', 'el-GR', 'en-GB', 'en-US', 'es-ES', 'fi-FI', 'fr-BE', 'fr-FR', 'fr-LU', 'hu-HU', 'it-IT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sk-SK', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-DE", + "de-LU", + "el-GR", + "en-GB", + "en-US", + "es-ES", + "fi-FI", + "fr-BE", + "fr-FR", + "fr-LU", + "hu-HU", + "it-IT", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sk-SK", + "sv-SE", + ] ] """ [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - reference_id: NotRequired["str"] + reference_id: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - risk_correlation_id: NotRequired["str"] + risk_correlation_id: NotRequired[str] """ The risk correlation ID for an on-session payment using a saved PayPal payment method. """ @@ -1893,7 +2098,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsPaypal(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - subsellers: NotRequired["List[str]"] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -1944,7 +2149,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsSofort(TypedDict): """ class UpdateParamsPaymentSettingsPaymentMethodOptionsWechatPay(TypedDict): - app_id: NotRequired["str"] + app_id: NotRequired[str] """ The app ID registered with WeChat Pay. Only required when client is ios or android. """ @@ -1952,7 +2157,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsWechatPay(TypedDict): """ The client type that the end customer will pay from """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1964,7 +2169,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsWechatPay(TypedDict): """ class UpdateParamsPaymentSettingsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when the order is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field. """ @@ -1974,7 +2179,7 @@ class UpdateParamsPaymentSettingsTransferData(TypedDict): """ class UpdateParamsShippingCost(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the shipping rate to use for this order. """ @@ -2002,21 +2207,21 @@ class UpdateParamsShippingCostShippingRateData(TypedDict): """ Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ - type: NotRequired["Literal['fixed_amount']"] + type: NotRequired[Literal["fixed_amount"]] """ The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. """ @@ -2069,7 +2274,10 @@ class UpdateParamsShippingCostShippingRateDataFixedAmount(TypedDict): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, OrderService.UpdateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions]" + Dict[ + str, + "OrderService.UpdateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions", + ] ] """ Shipping rates 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). @@ -2083,7 +2291,7 @@ class UpdateParamsShippingCostShippingRateDataFixedAmountCurrencyOptions( A non-negative integer in cents representing how much to charge. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. @@ -2104,27 +2312,27 @@ class UpdateParamsShippingDetails(TypedDict): """ class UpdateParamsShippingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". """ @@ -2136,7 +2344,7 @@ class UpdateParamsTaxDetails(TypedDict): """ The purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`. """ - tax_ids: NotRequired["List[OrderService.UpdateParamsTaxDetailsTaxId]"] + tax_ids: NotRequired[List["OrderService.UpdateParamsTaxDetailsTaxId"]] """ The purchaser's tax IDs to be used for this order. """ diff --git a/stripe/_payment_intent.py b/stripe/_payment_intent.py index cb7476782..b40336b4e 100644 --- a/stripe/_payment_intent.py +++ b/stripe/_payment_intent.py @@ -2324,7 +2324,7 @@ class TransferData(StripeObject): """ class ApplyCustomerBalanceParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount that you intend to apply to this PaymentIntent from the customer's cash balance. @@ -2334,41 +2334,43 @@ class ApplyCustomerBalanceParams(RequestOptions): When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CancelParams(RequestOptions): cancellation_reason: NotRequired[ - "Literal['abandoned', 'duplicate', 'fraudulent', 'requested_by_customer']" + Literal[ + "abandoned", "duplicate", "fraudulent", "requested_by_customer" + ] ] """ Reason for canceling this PaymentIntent. Possible values are: `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned` """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CaptureParams(RequestOptions): - amount_to_capture: NotRequired["int"] + amount_to_capture: NotRequired[int] """ The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount is automatically refunded. Defaults to the full `amount_capturable` if it's not provided. """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - final_capture: NotRequired["bool"] + final_capture: NotRequired[bool] """ Defaults to `true`. When capturing a PaymentIntent, setting `final_capture` to `false` notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when [multicapture](https://stripe.com/docs/payments/multicapture) is available for PaymentIntents. """ @@ -2382,11 +2384,11 @@ class CaptureParams(RequestOptions): """ Provides industry-specific information about the charge. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. The concatenated descriptor must be 1-22 characters long. """ @@ -2437,23 +2439,23 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): """ The booking number associated with the car rental. """ - car_class_code: NotRequired["str"] + car_class_code: NotRequired[str] """ Class code of the car. """ - car_make: NotRequired["str"] + car_make: NotRequired[str] """ Make of the car. """ - car_model: NotRequired["str"] + car_model: NotRequired[str] """ Model of the car. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the rental car company. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the car rental company. """ @@ -2468,18 +2470,26 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): Delivery details for this purchase. """ drivers: NotRequired[ - "List[PaymentIntent.CaptureParamsPaymentDetailsCarRentalDriver]" + List["PaymentIntent.CaptureParamsPaymentDetailsCarRentalDriver"] ] """ The details of the passengers in the travel reservation """ extra_charges: NotRequired[ - "List[Literal['extra_mileage', 'gas', 'late_return', 'one_way_service', 'parking_violation']]" + List[ + Literal[ + "extra_mileage", + "gas", + "late_return", + "one_way_service", + "parking_violation", + ] + ] ] """ List of additional charges being billed. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep nor cancel their booking. """ @@ -2493,15 +2503,15 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): """ Car pick-up time. Measured in seconds since the Unix epoch. """ - rate_amount: NotRequired["int"] + rate_amount: NotRequired[int] """ Rental rate. """ - rate_interval: NotRequired["Literal['day', 'month', 'week']"] + rate_interval: NotRequired[Literal["day", "month", "week"]] """ The frequency at which the rate amount is applied. One of `day`, `week` or `month` """ - renter_name: NotRequired["str"] + renter_name: NotRequired[str] """ The name of the person or entity renting the car. """ @@ -2515,7 +2525,7 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): """ Car return time. Measured in seconds since the Unix epoch. """ - tax_exempt: NotRequired["bool"] + tax_exempt: NotRequired[bool] """ Indicates whether the goods or services are tax-exempt or tax is not collected. """ @@ -2527,7 +2537,7 @@ class CaptureParamsPaymentDetailsCarRentalAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsCarRentalDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -2539,15 +2549,15 @@ class CaptureParamsPaymentDetailsCarRentalDelivery(TypedDict): """ class CaptureParamsPaymentDetailsCarRentalDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -2559,59 +2569,59 @@ class CaptureParamsPaymentDetailsCarRentalDriver(TypedDict): """ class CaptureParamsPaymentDetailsCarRentalPickupAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CaptureParamsPaymentDetailsCarRentalReturnAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CaptureParamsPaymentDetailsEventDetails(TypedDict): - access_controlled_venue: NotRequired["bool"] + access_controlled_venue: NotRequired[bool] """ Indicates if the tickets are digitally checked when entering the venue. """ @@ -2627,7 +2637,7 @@ class CaptureParamsPaymentDetailsEventDetails(TypedDict): """ Affiliate details for this purchase. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the company """ @@ -2637,11 +2647,11 @@ class CaptureParamsPaymentDetailsEventDetails(TypedDict): """ Delivery details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Event end time. Measured in seconds since the Unix epoch. """ - genre: NotRequired["str"] + genre: NotRequired[str] """ Type of the event entertainment (concert, sports event etc) """ @@ -2649,33 +2659,33 @@ class CaptureParamsPaymentDetailsEventDetails(TypedDict): """ The name of the event. """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Event start time. Measured in seconds since the Unix epoch. """ class CaptureParamsPaymentDetailsEventDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -2687,7 +2697,7 @@ class CaptureParamsPaymentDetailsEventDetailsAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsEventDetailsDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -2699,15 +2709,15 @@ class CaptureParamsPaymentDetailsEventDetailsDelivery(TypedDict): """ class CaptureParamsPaymentDetailsEventDetailsDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -2719,11 +2729,11 @@ class CaptureParamsPaymentDetailsFlight(TypedDict): """ Affiliate details for this purchase. """ - agency_number: NotRequired["str"] + agency_number: NotRequired[str] """ The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket. """ @@ -2733,12 +2743,12 @@ class CaptureParamsPaymentDetailsFlight(TypedDict): """ Delivery details for this purchase. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the person or entity on the reservation. """ passengers: NotRequired[ - "List[PaymentIntent.CaptureParamsPaymentDetailsFlightPassenger]" + List["PaymentIntent.CaptureParamsPaymentDetailsFlightPassenger"] ] """ The details of the passengers in the travel reservation. @@ -2749,7 +2759,7 @@ class CaptureParamsPaymentDetailsFlight(TypedDict): """ The individual flight segments associated with the trip. """ - ticket_number: NotRequired["str"] + ticket_number: NotRequired[str] """ The ticket number associated with the travel reservation. """ @@ -2761,7 +2771,7 @@ class CaptureParamsPaymentDetailsFlightAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsFlightDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -2773,15 +2783,15 @@ class CaptureParamsPaymentDetailsFlightDelivery(TypedDict): """ class CaptureParamsPaymentDetailsFlightDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -2793,19 +2803,19 @@ class CaptureParamsPaymentDetailsFlightPassenger(TypedDict): """ class CaptureParamsPaymentDetailsFlightSegment(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The flight segment amount. """ - arrival_airport: NotRequired["str"] + arrival_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the arrival airport. """ - arrives_at: NotRequired["int"] + arrives_at: NotRequired[int] """ The arrival time for the flight segment. Measured in seconds since the Unix epoch. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment. """ @@ -2813,16 +2823,16 @@ class CaptureParamsPaymentDetailsFlightSegment(TypedDict): """ The departure time for the flight segment. Measured in seconds since the Unix epoch. """ - departure_airport: NotRequired["str"] + departure_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the departure airport. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number associated with the segment """ service_class: NotRequired[ - "Literal['business', 'economy', 'first', 'premium_economy']" + Literal["business", "economy", "first", "premium_economy"] ] """ The fare class for the segment. @@ -2835,7 +2845,7 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): """ The lodging location's address. """ - adults: NotRequired["int"] + adults: NotRequired[int] """ The number of adults on the booking """ @@ -2845,11 +2855,11 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): """ Affiliate details for this purchase. """ - booking_number: NotRequired["str"] + booking_number: NotRequired[str] """ The booking number associated with the lodging reservation. """ - category: NotRequired["Literal['hotel', 'vacation_rental']"] + category: NotRequired[Literal["hotel", "vacation_rental"]] """ The lodging category """ @@ -2861,11 +2871,11 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): """ Lodging check-out time. Measured in seconds since the Unix epoch. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the lodging company. """ - daily_room_rate_amount: NotRequired["int"] + daily_room_rate_amount: NotRequired[int] """ The daily lodging room rate. """ @@ -2876,76 +2886,85 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): Delivery details for this purchase. """ extra_charges: NotRequired[ - "List[Literal['gift_shop', 'laundry', 'mini_bar', 'other', 'restaurant', 'telephone']]" + List[ + Literal[ + "gift_shop", + "laundry", + "mini_bar", + "other", + "restaurant", + "telephone", + ] + ] ] """ List of additional charges being billed. """ - fire_safety_act_compliance: NotRequired["bool"] + fire_safety_act_compliance: NotRequired[bool] """ Indicates whether the lodging location is compliant with the Fire Safety Act. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the lodging location. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep their booking while failing to cancel the reservation. """ - number_of_rooms: NotRequired["int"] + number_of_rooms: NotRequired[int] """ The number of rooms on the booking """ passengers: NotRequired[ - "List[PaymentIntent.CaptureParamsPaymentDetailsLodgingPassenger]" + List["PaymentIntent.CaptureParamsPaymentDetailsLodgingPassenger"] ] """ The details of the passengers in the travel reservation """ - property_phone_number: NotRequired["str"] + property_phone_number: NotRequired[str] """ The phone number of the lodging location. """ - room_class: NotRequired["str"] + room_class: NotRequired[str] """ The room class for this purchase. """ - room_nights: NotRequired["int"] + room_nights: NotRequired[int] """ The number of room nights """ - total_room_tax_amount: NotRequired["int"] + total_room_tax_amount: NotRequired[int] """ The total tax amount associating with the room reservation. """ - total_tax_amount: NotRequired["int"] + total_tax_amount: NotRequired[int] """ The total tax amount """ class CaptureParamsPaymentDetailsLodgingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -2957,7 +2976,7 @@ class CaptureParamsPaymentDetailsLodgingAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsLodgingDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -2969,15 +2988,15 @@ class CaptureParamsPaymentDetailsLodgingDelivery(TypedDict): """ class CaptureParamsPaymentDetailsLodgingDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -2995,7 +3014,7 @@ class CaptureParamsPaymentDetailsSubscription(TypedDict): """ Affiliate details for this purchase. """ - auto_renewal: NotRequired["bool"] + auto_renewal: NotRequired[bool] """ Info whether the subscription will be auto renewed upon expiry. """ @@ -3005,7 +3024,7 @@ class CaptureParamsPaymentDetailsSubscription(TypedDict): """ Subscription billing details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Subscription end time. Measured in seconds since the Unix epoch. """ @@ -3013,7 +3032,7 @@ class CaptureParamsPaymentDetailsSubscription(TypedDict): """ Name of the product on subscription. e.g. Apple Music Subscription """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Subscription start time. Measured in seconds since the Unix epoch. """ @@ -3035,7 +3054,7 @@ class CaptureParamsPaymentDetailsSubscriptionBillingInterval(TypedDict): """ class CaptureParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when a charge succeeds. """ @@ -3046,26 +3065,26 @@ class ConfirmParams(RequestOptions): The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. """ - confirmation_token: NotRequired["str"] + confirmation_token: NotRequired[str] """ ID of the ConfirmationToken used to confirm this PaymentIntent. If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence. """ - error_on_requires_action: NotRequired["bool"] + error_on_requires_action: NotRequired[bool] """ Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - mandate: NotRequired["str"] + mandate: NotRequired[str] """ ID of the mandate that's used for this payment. """ @@ -3082,7 +3101,7 @@ class ConfirmParams(RequestOptions): """ Provides industry-specific information about the charge. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. """ @@ -3108,7 +3127,7 @@ class ConfirmParams(RequestOptions): """ Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. @@ -3132,7 +3151,7 @@ class ConfirmParams(RequestOptions): """ Shipping information for this PaymentIntent. """ - use_stripe_sdk: NotRequired["bool"] + use_stripe_sdk: NotRequired[bool] """ Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. """ @@ -3146,7 +3165,7 @@ class ConfirmParamsMandateData(TypedDict): """ class ConfirmParamsMandateDataCustomerAcceptance(TypedDict): - accepted_at: NotRequired["int"] + accepted_at: NotRequired[int] """ The time at which the customer accepted the Mandate. """ @@ -3171,11 +3190,11 @@ class ConfirmParamsMandateDataCustomerAcceptanceOffline(TypedDict): pass class ConfirmParamsMandateDataCustomerAcceptanceOnline(TypedDict): - ip_address: NotRequired["str"] + ip_address: NotRequired[str] """ The IP address from which the Mandate was accepted by the customer. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the Mandate was accepted by the customer. """ @@ -3221,23 +3240,23 @@ class ConfirmParamsPaymentDetailsCarRental(TypedDict): """ The booking number associated with the car rental. """ - car_class_code: NotRequired["str"] + car_class_code: NotRequired[str] """ Class code of the car. """ - car_make: NotRequired["str"] + car_make: NotRequired[str] """ Make of the car. """ - car_model: NotRequired["str"] + car_model: NotRequired[str] """ Model of the car. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the rental car company. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the car rental company. """ @@ -3252,18 +3271,26 @@ class ConfirmParamsPaymentDetailsCarRental(TypedDict): Delivery details for this purchase. """ drivers: NotRequired[ - "List[PaymentIntent.ConfirmParamsPaymentDetailsCarRentalDriver]" + List["PaymentIntent.ConfirmParamsPaymentDetailsCarRentalDriver"] ] """ The details of the passengers in the travel reservation """ extra_charges: NotRequired[ - "List[Literal['extra_mileage', 'gas', 'late_return', 'one_way_service', 'parking_violation']]" + List[ + Literal[ + "extra_mileage", + "gas", + "late_return", + "one_way_service", + "parking_violation", + ] + ] ] """ List of additional charges being billed. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep nor cancel their booking. """ @@ -3277,15 +3304,15 @@ class ConfirmParamsPaymentDetailsCarRental(TypedDict): """ Car pick-up time. Measured in seconds since the Unix epoch. """ - rate_amount: NotRequired["int"] + rate_amount: NotRequired[int] """ Rental rate. """ - rate_interval: NotRequired["Literal['day', 'month', 'week']"] + rate_interval: NotRequired[Literal["day", "month", "week"]] """ The frequency at which the rate amount is applied. One of `day`, `week` or `month` """ - renter_name: NotRequired["str"] + renter_name: NotRequired[str] """ The name of the person or entity renting the car. """ @@ -3299,7 +3326,7 @@ class ConfirmParamsPaymentDetailsCarRental(TypedDict): """ Car return time. Measured in seconds since the Unix epoch. """ - tax_exempt: NotRequired["bool"] + tax_exempt: NotRequired[bool] """ Indicates whether the goods or services are tax-exempt or tax is not collected. """ @@ -3311,7 +3338,7 @@ class ConfirmParamsPaymentDetailsCarRentalAffiliate(TypedDict): """ class ConfirmParamsPaymentDetailsCarRentalDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -3323,15 +3350,15 @@ class ConfirmParamsPaymentDetailsCarRentalDelivery(TypedDict): """ class ConfirmParamsPaymentDetailsCarRentalDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -3343,59 +3370,59 @@ class ConfirmParamsPaymentDetailsCarRentalDriver(TypedDict): """ class ConfirmParamsPaymentDetailsCarRentalPickupAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ConfirmParamsPaymentDetailsCarRentalReturnAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ConfirmParamsPaymentDetailsEventDetails(TypedDict): - access_controlled_venue: NotRequired["bool"] + access_controlled_venue: NotRequired[bool] """ Indicates if the tickets are digitally checked when entering the venue. """ @@ -3411,7 +3438,7 @@ class ConfirmParamsPaymentDetailsEventDetails(TypedDict): """ Affiliate details for this purchase. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the company """ @@ -3421,11 +3448,11 @@ class ConfirmParamsPaymentDetailsEventDetails(TypedDict): """ Delivery details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Event end time. Measured in seconds since the Unix epoch. """ - genre: NotRequired["str"] + genre: NotRequired[str] """ Type of the event entertainment (concert, sports event etc) """ @@ -3433,33 +3460,33 @@ class ConfirmParamsPaymentDetailsEventDetails(TypedDict): """ The name of the event. """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Event start time. Measured in seconds since the Unix epoch. """ class ConfirmParamsPaymentDetailsEventDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -3471,7 +3498,7 @@ class ConfirmParamsPaymentDetailsEventDetailsAffiliate(TypedDict): """ class ConfirmParamsPaymentDetailsEventDetailsDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -3483,15 +3510,15 @@ class ConfirmParamsPaymentDetailsEventDetailsDelivery(TypedDict): """ class ConfirmParamsPaymentDetailsEventDetailsDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -3503,11 +3530,11 @@ class ConfirmParamsPaymentDetailsFlight(TypedDict): """ Affiliate details for this purchase. """ - agency_number: NotRequired["str"] + agency_number: NotRequired[str] """ The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket. """ @@ -3517,12 +3544,12 @@ class ConfirmParamsPaymentDetailsFlight(TypedDict): """ Delivery details for this purchase. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the person or entity on the reservation. """ passengers: NotRequired[ - "List[PaymentIntent.ConfirmParamsPaymentDetailsFlightPassenger]" + List["PaymentIntent.ConfirmParamsPaymentDetailsFlightPassenger"] ] """ The details of the passengers in the travel reservation. @@ -3533,7 +3560,7 @@ class ConfirmParamsPaymentDetailsFlight(TypedDict): """ The individual flight segments associated with the trip. """ - ticket_number: NotRequired["str"] + ticket_number: NotRequired[str] """ The ticket number associated with the travel reservation. """ @@ -3545,7 +3572,7 @@ class ConfirmParamsPaymentDetailsFlightAffiliate(TypedDict): """ class ConfirmParamsPaymentDetailsFlightDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -3557,15 +3584,15 @@ class ConfirmParamsPaymentDetailsFlightDelivery(TypedDict): """ class ConfirmParamsPaymentDetailsFlightDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -3577,19 +3604,19 @@ class ConfirmParamsPaymentDetailsFlightPassenger(TypedDict): """ class ConfirmParamsPaymentDetailsFlightSegment(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The flight segment amount. """ - arrival_airport: NotRequired["str"] + arrival_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the arrival airport. """ - arrives_at: NotRequired["int"] + arrives_at: NotRequired[int] """ The arrival time for the flight segment. Measured in seconds since the Unix epoch. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment. """ @@ -3597,16 +3624,16 @@ class ConfirmParamsPaymentDetailsFlightSegment(TypedDict): """ The departure time for the flight segment. Measured in seconds since the Unix epoch. """ - departure_airport: NotRequired["str"] + departure_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the departure airport. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number associated with the segment """ service_class: NotRequired[ - "Literal['business', 'economy', 'first', 'premium_economy']" + Literal["business", "economy", "first", "premium_economy"] ] """ The fare class for the segment. @@ -3619,7 +3646,7 @@ class ConfirmParamsPaymentDetailsLodging(TypedDict): """ The lodging location's address. """ - adults: NotRequired["int"] + adults: NotRequired[int] """ The number of adults on the booking """ @@ -3629,11 +3656,11 @@ class ConfirmParamsPaymentDetailsLodging(TypedDict): """ Affiliate details for this purchase. """ - booking_number: NotRequired["str"] + booking_number: NotRequired[str] """ The booking number associated with the lodging reservation. """ - category: NotRequired["Literal['hotel', 'vacation_rental']"] + category: NotRequired[Literal["hotel", "vacation_rental"]] """ The lodging category """ @@ -3645,11 +3672,11 @@ class ConfirmParamsPaymentDetailsLodging(TypedDict): """ Lodging check-out time. Measured in seconds since the Unix epoch. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the lodging company. """ - daily_room_rate_amount: NotRequired["int"] + daily_room_rate_amount: NotRequired[int] """ The daily lodging room rate. """ @@ -3660,76 +3687,85 @@ class ConfirmParamsPaymentDetailsLodging(TypedDict): Delivery details for this purchase. """ extra_charges: NotRequired[ - "List[Literal['gift_shop', 'laundry', 'mini_bar', 'other', 'restaurant', 'telephone']]" + List[ + Literal[ + "gift_shop", + "laundry", + "mini_bar", + "other", + "restaurant", + "telephone", + ] + ] ] """ List of additional charges being billed. """ - fire_safety_act_compliance: NotRequired["bool"] + fire_safety_act_compliance: NotRequired[bool] """ Indicates whether the lodging location is compliant with the Fire Safety Act. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the lodging location. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep their booking while failing to cancel the reservation. """ - number_of_rooms: NotRequired["int"] + number_of_rooms: NotRequired[int] """ The number of rooms on the booking """ passengers: NotRequired[ - "List[PaymentIntent.ConfirmParamsPaymentDetailsLodgingPassenger]" + List["PaymentIntent.ConfirmParamsPaymentDetailsLodgingPassenger"] ] """ The details of the passengers in the travel reservation """ - property_phone_number: NotRequired["str"] + property_phone_number: NotRequired[str] """ The phone number of the lodging location. """ - room_class: NotRequired["str"] + room_class: NotRequired[str] """ The room class for this purchase. """ - room_nights: NotRequired["int"] + room_nights: NotRequired[int] """ The number of room nights """ - total_room_tax_amount: NotRequired["int"] + total_room_tax_amount: NotRequired[int] """ The total tax amount associating with the room reservation. """ - total_tax_amount: NotRequired["int"] + total_tax_amount: NotRequired[int] """ The total tax amount """ class ConfirmParamsPaymentDetailsLodgingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -3741,7 +3777,7 @@ class ConfirmParamsPaymentDetailsLodgingAffiliate(TypedDict): """ class ConfirmParamsPaymentDetailsLodgingDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -3753,15 +3789,15 @@ class ConfirmParamsPaymentDetailsLodgingDelivery(TypedDict): """ class ConfirmParamsPaymentDetailsLodgingDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -3779,7 +3815,7 @@ class ConfirmParamsPaymentDetailsSubscription(TypedDict): """ Affiliate details for this purchase. """ - auto_renewal: NotRequired["bool"] + auto_renewal: NotRequired[bool] """ Info whether the subscription will be auto renewed upon expiry. """ @@ -3789,7 +3825,7 @@ class ConfirmParamsPaymentDetailsSubscription(TypedDict): """ Subscription billing details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Subscription end time. Measured in seconds since the Unix epoch. """ @@ -3797,7 +3833,7 @@ class ConfirmParamsPaymentDetailsSubscription(TypedDict): """ Name of the product on subscription. e.g. Apple Music Subscription """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Subscription start time. Measured in seconds since the Unix epoch. """ @@ -3935,7 +3971,7 @@ class ConfirmParamsPaymentMethodData(TypedDict): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -4109,11 +4145,11 @@ class ConfirmParamsPaymentMethodDataAuBecsDebit(TypedDict): """ class ConfirmParamsPaymentMethodDataBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -4142,27 +4178,27 @@ class ConfirmParamsPaymentMethodDataBillingDetails(TypedDict): """ class ConfirmParamsPaymentMethodDataBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -4184,14 +4220,43 @@ class ConfirmParamsPaymentMethodDataCustomerBalance(TypedDict): class ConfirmParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class ConfirmParamsPaymentMethodDataFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -4231,7 +4296,24 @@ class ConfirmParamsPaymentMethodDataGrabpay(TypedDict): class ConfirmParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -4279,7 +4361,34 @@ class ConfirmParamsPaymentMethodDataOxxo(TypedDict): class ConfirmParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -4292,15 +4401,15 @@ class ConfirmParamsPaymentMethodDataPaypal(TypedDict): pass class ConfirmParamsPaymentMethodDataPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -4312,7 +4421,7 @@ class ConfirmParamsPaymentMethodDataPromptpay(TypedDict): pass class ConfirmParamsPaymentMethodDataRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -4339,23 +4448,23 @@ class ConfirmParamsPaymentMethodDataTwint(TypedDict): pass class ConfirmParamsPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -4616,7 +4725,7 @@ class ConfirmParamsPaymentMethodOptionsAcssDebit(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -4629,17 +4738,17 @@ class ConfirmParamsPaymentMethodOptionsAcssDebitMandateOptions(TypedDict): The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -4653,11 +4762,11 @@ class ConfirmParamsPaymentMethodOptionsAffirm(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - preferred_locale: NotRequired["str"] + preferred_locale: NotRequired[str] """ Preferred language of the Affirm authorization page that the customer is redirected to. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -4677,12 +4786,12 @@ class ConfirmParamsPaymentMethodOptionsAfterpayClearpay(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes. This field differs from the statement descriptor and item name. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -4736,7 +4845,7 @@ class ConfirmParamsPaymentMethodOptionsBacsDebit(TypedDict): """ class ConfirmParamsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -4754,7 +4863,7 @@ class ConfirmParamsPaymentMethodOptionsBancontact(TypedDict): """ class ConfirmParamsPaymentMethodOptionsBlik(TypedDict): - code: NotRequired["str"] + code: NotRequired[str] """ The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation. """ @@ -4770,7 +4879,7 @@ class ConfirmParamsPaymentMethodOptionsBlik(TypedDict): """ class ConfirmParamsPaymentMethodOptionsBoleto(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time. """ @@ -4796,7 +4905,7 @@ class ConfirmParamsPaymentMethodOptionsCard(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - cvc_token: NotRequired["str"] + cvc_token: NotRequired[str] """ A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation. """ @@ -4814,51 +4923,63 @@ class ConfirmParamsPaymentMethodOptionsCard(TypedDict): """ Configuration options for setting up an eMandate for cards issued in India. """ - moto: NotRequired["bool"] + moto: NotRequired[bool] """ When specified, this parameter indicates that a transaction will be marked as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time. """ request_decremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent. """ request_extended_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent. """ request_incremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. """ - request_multicapture: NotRequired["Literal['if_available', 'never']"] + request_multicapture: NotRequired[Literal["if_available", "never"]] """ Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent. """ - request_overcapture: NotRequired["Literal['if_available', 'never']"] + request_overcapture: NotRequired[Literal["if_available", "never"]] """ Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ - require_cvc_recollection: NotRequired["bool"] + require_cvc_recollection: NotRequired[bool] """ When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter). """ @@ -4897,7 +5018,7 @@ class ConfirmParamsPaymentMethodOptionsCard(TypedDict): """ class ConfirmParamsPaymentMethodOptionsCardInstallments(TypedDict): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Setting to true enables installments for this PaymentIntent. This will cause the response to contain a list of available installment plans. @@ -4935,11 +5056,11 @@ class ConfirmParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ @@ -4947,7 +5068,7 @@ class ConfirmParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ @@ -4959,22 +5080,22 @@ class ConfirmParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ - supported_types: NotRequired["List[Literal['india']]"] + supported_types: NotRequired[List[Literal["india"]]] """ Specifies the type of mandates supported. Possible values are `india`. """ class ConfirmParamsPaymentMethodOptionsCardPresent(TypedDict): - request_extended_authorization: NotRequired["bool"] + request_extended_authorization: NotRequired[bool] """ Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity) """ - request_incremental_authorization_support: NotRequired["bool"] + request_incremental_authorization_support: NotRequired[bool] """ Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. """ request_incremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ This field was released by mistake and will be removed in the next major version @@ -4987,7 +5108,7 @@ class ConfirmParamsPaymentMethodOptionsCardStatementDetails(TypedDict): """ Please pass in an address that is within your Stripe user account country """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Phone number (e.g., a toll-free number that customers can call) """ @@ -4995,34 +5116,34 @@ class ConfirmParamsPaymentMethodOptionsCardStatementDetails(TypedDict): class ConfirmParamsPaymentMethodOptionsCardStatementDetailsAddress( TypedDict, ): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ConfirmParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): ares_trans_status: NotRequired[ - "Literal['A', 'C', 'I', 'N', 'R', 'U', 'Y']" + Literal["A", "C", "I", "N", "R", "U", "Y"] ] """ The `transStatus` returned from the card Issuer's ACS in the ARes. @@ -5035,13 +5156,13 @@ class ConfirmParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): is what you should specify here.) """ electronic_commerce_indicator: NotRequired[ - "Literal['01', '02', '05', '06', '07']" + Literal["01", "02", "05", "06", "07"] ] """ The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed. """ - exemption_indicator: NotRequired["Literal['low_risk', 'none']"] + exemption_indicator: NotRequired[Literal["low_risk", "none"]] """ The exemption requested via 3DS and accepted by the issuer at authentication time. """ @@ -5053,7 +5174,7 @@ class ConfirmParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly """ - requestor_challenge_indicator: NotRequired["str"] + requestor_challenge_indicator: NotRequired[str] """ The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99. @@ -5087,14 +5208,14 @@ class ConfirmParamsPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBanca to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`. messageExtension: CB-AVALGO """ - cb_exemption: NotRequired["str"] + cb_exemption: NotRequired[str] """ The exemption indicator returned from Cartes Bancaires in the ARes. message extension: CB-EXEMPTION; string (4 characters) This is a 3 byte bitmap (low significant byte first and most significant bit first) that has been Base64 encoded """ - cb_score: NotRequired["int"] + cb_score: NotRequired[int] """ The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99 @@ -5129,11 +5250,11 @@ class ConfirmParamsPaymentMethodOptionsCustomerBalance(TypedDict): """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["Literal['bank_transfer']"] + funding_type: NotRequired[Literal["bank_transfer"]] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5154,7 +5275,17 @@ class ConfirmParamsPaymentMethodOptionsCustomerBalanceBankTransfer( Configuration for the eu_bank_transfer funding type. """ requested_address_types: NotRequired[ - "List[Literal['aba', 'iban', 'sepa', 'sort_code', 'spei', 'swift', 'zengin']]" + List[ + Literal[ + "aba", + "iban", + "sepa", + "sort_code", + "spei", + "swift", + "zengin", + ] + ] ] """ List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. @@ -5181,7 +5312,7 @@ class ConfirmParamsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer """ class ConfirmParamsPaymentMethodOptionsEps(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5193,7 +5324,7 @@ class ConfirmParamsPaymentMethodOptionsEps(TypedDict): """ class ConfirmParamsPaymentMethodOptionsFpx(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5205,7 +5336,7 @@ class ConfirmParamsPaymentMethodOptionsFpx(TypedDict): """ class ConfirmParamsPaymentMethodOptionsGiropay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5217,7 +5348,7 @@ class ConfirmParamsPaymentMethodOptionsGiropay(TypedDict): """ class ConfirmParamsPaymentMethodOptionsGrabpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5255,12 +5386,57 @@ class ConfirmParamsPaymentMethodOptionsKlarna(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-CH', 'de-DE', 'el-GR', 'en-AT', 'en-AU', 'en-BE', 'en-CA', 'en-CH', 'en-CZ', 'en-DE', 'en-DK', 'en-ES', 'en-FI', 'en-FR', 'en-GB', 'en-GR', 'en-IE', 'en-IT', 'en-NL', 'en-NO', 'en-NZ', 'en-PL', 'en-PT', 'en-SE', 'en-US', 'es-ES', 'es-US', 'fi-FI', 'fr-BE', 'fr-CA', 'fr-CH', 'fr-FR', 'it-CH', 'it-IT', 'nb-NO', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sv-FI', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-CH", + "de-DE", + "el-GR", + "en-AT", + "en-AU", + "en-BE", + "en-CA", + "en-CH", + "en-CZ", + "en-DE", + "en-DK", + "en-ES", + "en-FI", + "en-FR", + "en-GB", + "en-GR", + "en-IE", + "en-IT", + "en-NL", + "en-NO", + "en-NZ", + "en-PL", + "en-PT", + "en-SE", + "en-US", + "es-ES", + "es-US", + "fi-FI", + "fr-BE", + "fr-CA", + "fr-CH", + "fr-FR", + "it-CH", + "it-IT", + "nb-NO", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sv-FI", + "sv-SE", + ] ] """ Preferred language of the Klarna authorization page that the customer is redirected to """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5288,7 +5464,7 @@ class ConfirmParamsPaymentMethodOptionsKonbini(TypedDict): """ A product descriptor of up to 22 characters, which will appear to customers at the convenience store. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5308,7 +5484,7 @@ class ConfirmParamsPaymentMethodOptionsLink(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ @@ -5334,7 +5510,7 @@ class ConfirmParamsPaymentMethodOptionsMobilepay(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5346,7 +5522,7 @@ class ConfirmParamsPaymentMethodOptionsMobilepay(TypedDict): """ class ConfirmParamsPaymentMethodOptionsMultibanco(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5358,11 +5534,11 @@ class ConfirmParamsPaymentMethodOptionsMultibanco(TypedDict): """ class ConfirmParamsPaymentMethodOptionsOxxo(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5374,7 +5550,7 @@ class ConfirmParamsPaymentMethodOptionsOxxo(TypedDict): """ class ConfirmParamsPaymentMethodOptionsP24(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5384,13 +5560,13 @@ class ConfirmParamsPaymentMethodOptionsP24(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - tos_shown_and_accepted: NotRequired["bool"] + tos_shown_and_accepted: NotRequired[bool] """ Confirm that the payer has accepted the P24 terms and conditions. """ class ConfirmParamsPaymentMethodOptionsPaynow(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5407,20 +5583,42 @@ class ConfirmParamsPaymentMethodOptionsPaypal(TypedDict): Controls when the funds will be captured from the customer's account. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-DE', 'de-LU', 'el-GR', 'en-GB', 'en-US', 'es-ES', 'fi-FI', 'fr-BE', 'fr-FR', 'fr-LU', 'hu-HU', 'it-IT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sk-SK', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-DE", + "de-LU", + "el-GR", + "en-GB", + "en-US", + "es-ES", + "fi-FI", + "fr-BE", + "fr-FR", + "fr-LU", + "hu-HU", + "it-IT", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sk-SK", + "sv-SE", + ] ] """ [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - reference_id: NotRequired["str"] + reference_id: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - risk_correlation_id: NotRequired["str"] + risk_correlation_id: NotRequired[str] """ The risk correlation ID for an on-session payment using a saved PayPal payment method. """ @@ -5436,7 +5634,7 @@ class ConfirmParamsPaymentMethodOptionsPaypal(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - subsellers: NotRequired["List[str]"] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -5462,45 +5660,66 @@ class ConfirmParamsPaymentMethodOptionsPayto(TypedDict): """ class ConfirmParamsPaymentMethodOptionsPaytoMandateOptions(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount that will be collected. It is required when `amount_type` is `fixed`. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. """ - end_date: NotRequired["str"] + end_date: NotRequired[str] """ Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. """ payment_schedule: NotRequired[ - "Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] ] """ The periodicity at which payments will be collected. """ - payments_per_period: NotRequired["int"] + payments_per_period: NotRequired[int] """ The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. """ purpose: NotRequired[ - "Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] ] """ The purpose for which payments are made. Defaults to retail. """ class ConfirmParamsPaymentMethodOptionsPix(TypedDict): - expires_after_seconds: NotRequired["int"] + expires_after_seconds: NotRequired[int] """ The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5512,7 +5731,7 @@ class ConfirmParamsPaymentMethodOptionsPix(TypedDict): """ class ConfirmParamsPaymentMethodOptionsPromptpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5583,7 +5802,7 @@ class ConfirmParamsPaymentMethodOptionsSwish(TypedDict): """ The order ID displayed in the Swish app after the payment is authorized. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5632,7 +5851,7 @@ class ConfirmParamsPaymentMethodOptionsUsBankAccount(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -5648,18 +5867,29 @@ class ConfirmParamsPaymentMethodOptionsUsBankAccountFinancialConnections( Customize manual entry behavior """ permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ @@ -5681,13 +5911,13 @@ class ConfirmParamsPaymentMethodOptionsUsBankAccountMandateOptions( """ class ConfirmParamsPaymentMethodOptionsUsBankAccountNetworks(TypedDict): - requested: NotRequired["List[Literal['ach', 'us_domestic_wire']]"] + requested: NotRequired[List[Literal["ach", "us_domestic_wire"]]] """ Triggers validations to run across the selected networks """ class ConfirmParamsPaymentMethodOptionsWechatPay(TypedDict): - app_id: NotRequired["str"] + app_id: NotRequired[str] """ The app ID registered with WeChat Pay. Only required when client is ios or android. """ @@ -5695,7 +5925,7 @@ class ConfirmParamsPaymentMethodOptionsWechatPay(TypedDict): """ The client type that the end customer will pay from """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5707,7 +5937,7 @@ class ConfirmParamsPaymentMethodOptionsWechatPay(TypedDict): """ class ConfirmParamsPaymentMethodOptionsZip(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5719,7 +5949,7 @@ class ConfirmParamsPaymentMethodOptionsZip(TypedDict): """ class ConfirmParamsRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -5729,7 +5959,7 @@ class ConfirmParamsShipping(TypedDict): """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ @@ -5737,37 +5967,37 @@ class ConfirmParamsShipping(TypedDict): """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class ConfirmParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -5777,7 +6007,7 @@ class CreateParams(RequestOptions): """ Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ @@ -5788,20 +6018,20 @@ class CreateParams(RequestOptions): When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters. """ capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. """ - confirm: NotRequired["bool"] + confirm: NotRequired[bool] """ Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm). """ - confirmation_method: NotRequired["Literal['automatic', 'manual']"] + confirmation_method: NotRequired[Literal["automatic", "manual"]] """ Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. """ - confirmation_token: NotRequired["str"] + confirmation_token: NotRequired[str] """ ID of the ConfirmationToken used to confirm this PaymentIntent. @@ -5811,7 +6041,7 @@ class CreateParams(RequestOptions): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ ID of the Customer this PaymentIntent belongs to, if one exists. @@ -5819,19 +6049,19 @@ class CreateParams(RequestOptions): If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - error_on_requires_action: NotRequired["bool"] + error_on_requires_action: NotRequired[bool] """ Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - mandate: NotRequired["str"] + mandate: NotRequired[str] """ ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). """ @@ -5841,7 +6071,7 @@ class CreateParams(RequestOptions): """ This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -5849,7 +6079,7 @@ class CreateParams(RequestOptions): """ Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ @@ -5859,13 +6089,13 @@ class CreateParams(RequestOptions): """ Provides industry-specific information about the charge. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent. If you don't provide the `payment_method` parameter or the `source` parameter with `confirm=true`, `source` automatically populates with `customer.default_source` to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward. """ - payment_method_configuration: NotRequired["str"] + payment_method_configuration: NotRequired[str] """ The ID of the payment method configuration to use with this PaymentIntent. """ @@ -5883,7 +6113,7 @@ class CreateParams(RequestOptions): """ Payment method-specific configuration for this PaymentIntent. """ - payment_method_types: NotRequired["List[str]"] + payment_method_types: NotRequired[List[str]] """ The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, it defaults to ["card"]. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). """ @@ -5891,19 +6121,19 @@ class CreateParams(RequestOptions): """ Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session). """ - receipt_email: NotRequired["str"] + receipt_email: NotRequired[str] """ Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails). """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). """ - secret_key_confirmation: NotRequired["Literal['optional', 'required']"] + secret_key_confirmation: NotRequired[Literal["optional", "required"]] """ Indicates whether confirmation for this PaymentIntent using a secret key is `required` or `optional`. """ - setup_future_usage: NotRequired["Literal['off_session', 'on_session']"] + setup_future_usage: NotRequired[Literal["off_session", "on_session"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5915,11 +6145,11 @@ class CreateParams(RequestOptions): """ Shipping information for this PaymentIntent. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. The concatenated descriptor must contain 1-22 characters. """ @@ -5928,17 +6158,17 @@ class CreateParams(RequestOptions): The parameters that you can use to automatically create a Transfer. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). """ - use_stripe_sdk: NotRequired["bool"] + use_stripe_sdk: NotRequired[bool] """ Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. """ class CreateParamsAutomaticPaymentMethods(TypedDict): - allow_redirects: NotRequired["Literal['always', 'never']"] + allow_redirects: NotRequired[Literal["always", "never"]] """ Controls whether this PaymentIntent will accept redirect-based payment methods. @@ -5956,7 +6186,7 @@ class CreateParamsMandateData(TypedDict): """ class CreateParamsMandateDataCustomerAcceptance(TypedDict): - accepted_at: NotRequired["int"] + accepted_at: NotRequired[int] """ The time at which the customer accepted the Mandate. """ @@ -6029,23 +6259,23 @@ class CreateParamsPaymentDetailsCarRental(TypedDict): """ The booking number associated with the car rental. """ - car_class_code: NotRequired["str"] + car_class_code: NotRequired[str] """ Class code of the car. """ - car_make: NotRequired["str"] + car_make: NotRequired[str] """ Make of the car. """ - car_model: NotRequired["str"] + car_model: NotRequired[str] """ Model of the car. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the rental car company. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the car rental company. """ @@ -6060,18 +6290,26 @@ class CreateParamsPaymentDetailsCarRental(TypedDict): Delivery details for this purchase. """ drivers: NotRequired[ - "List[PaymentIntent.CreateParamsPaymentDetailsCarRentalDriver]" + List["PaymentIntent.CreateParamsPaymentDetailsCarRentalDriver"] ] """ The details of the passengers in the travel reservation """ extra_charges: NotRequired[ - "List[Literal['extra_mileage', 'gas', 'late_return', 'one_way_service', 'parking_violation']]" + List[ + Literal[ + "extra_mileage", + "gas", + "late_return", + "one_way_service", + "parking_violation", + ] + ] ] """ List of additional charges being billed. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep nor cancel their booking. """ @@ -6085,15 +6323,15 @@ class CreateParamsPaymentDetailsCarRental(TypedDict): """ Car pick-up time. Measured in seconds since the Unix epoch. """ - rate_amount: NotRequired["int"] + rate_amount: NotRequired[int] """ Rental rate. """ - rate_interval: NotRequired["Literal['day', 'month', 'week']"] + rate_interval: NotRequired[Literal["day", "month", "week"]] """ The frequency at which the rate amount is applied. One of `day`, `week` or `month` """ - renter_name: NotRequired["str"] + renter_name: NotRequired[str] """ The name of the person or entity renting the car. """ @@ -6107,7 +6345,7 @@ class CreateParamsPaymentDetailsCarRental(TypedDict): """ Car return time. Measured in seconds since the Unix epoch. """ - tax_exempt: NotRequired["bool"] + tax_exempt: NotRequired[bool] """ Indicates whether the goods or services are tax-exempt or tax is not collected. """ @@ -6119,7 +6357,7 @@ class CreateParamsPaymentDetailsCarRentalAffiliate(TypedDict): """ class CreateParamsPaymentDetailsCarRentalDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -6131,15 +6369,15 @@ class CreateParamsPaymentDetailsCarRentalDelivery(TypedDict): """ class CreateParamsPaymentDetailsCarRentalDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -6151,59 +6389,59 @@ class CreateParamsPaymentDetailsCarRentalDriver(TypedDict): """ class CreateParamsPaymentDetailsCarRentalPickupAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsPaymentDetailsCarRentalReturnAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsPaymentDetailsEventDetails(TypedDict): - access_controlled_venue: NotRequired["bool"] + access_controlled_venue: NotRequired[bool] """ Indicates if the tickets are digitally checked when entering the venue. """ @@ -6219,7 +6457,7 @@ class CreateParamsPaymentDetailsEventDetails(TypedDict): """ Affiliate details for this purchase. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the company """ @@ -6229,11 +6467,11 @@ class CreateParamsPaymentDetailsEventDetails(TypedDict): """ Delivery details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Event end time. Measured in seconds since the Unix epoch. """ - genre: NotRequired["str"] + genre: NotRequired[str] """ Type of the event entertainment (concert, sports event etc) """ @@ -6241,33 +6479,33 @@ class CreateParamsPaymentDetailsEventDetails(TypedDict): """ The name of the event. """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Event start time. Measured in seconds since the Unix epoch. """ class CreateParamsPaymentDetailsEventDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -6279,7 +6517,7 @@ class CreateParamsPaymentDetailsEventDetailsAffiliate(TypedDict): """ class CreateParamsPaymentDetailsEventDetailsDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -6291,15 +6529,15 @@ class CreateParamsPaymentDetailsEventDetailsDelivery(TypedDict): """ class CreateParamsPaymentDetailsEventDetailsDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -6311,11 +6549,11 @@ class CreateParamsPaymentDetailsFlight(TypedDict): """ Affiliate details for this purchase. """ - agency_number: NotRequired["str"] + agency_number: NotRequired[str] """ The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket. """ @@ -6325,12 +6563,12 @@ class CreateParamsPaymentDetailsFlight(TypedDict): """ Delivery details for this purchase. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the person or entity on the reservation. """ passengers: NotRequired[ - "List[PaymentIntent.CreateParamsPaymentDetailsFlightPassenger]" + List["PaymentIntent.CreateParamsPaymentDetailsFlightPassenger"] ] """ The details of the passengers in the travel reservation. @@ -6339,7 +6577,7 @@ class CreateParamsPaymentDetailsFlight(TypedDict): """ The individual flight segments associated with the trip. """ - ticket_number: NotRequired["str"] + ticket_number: NotRequired[str] """ The ticket number associated with the travel reservation. """ @@ -6351,7 +6589,7 @@ class CreateParamsPaymentDetailsFlightAffiliate(TypedDict): """ class CreateParamsPaymentDetailsFlightDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -6363,15 +6601,15 @@ class CreateParamsPaymentDetailsFlightDelivery(TypedDict): """ class CreateParamsPaymentDetailsFlightDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -6383,19 +6621,19 @@ class CreateParamsPaymentDetailsFlightPassenger(TypedDict): """ class CreateParamsPaymentDetailsFlightSegment(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The flight segment amount. """ - arrival_airport: NotRequired["str"] + arrival_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the arrival airport. """ - arrives_at: NotRequired["int"] + arrives_at: NotRequired[int] """ The arrival time for the flight segment. Measured in seconds since the Unix epoch. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment. """ @@ -6403,16 +6641,16 @@ class CreateParamsPaymentDetailsFlightSegment(TypedDict): """ The departure time for the flight segment. Measured in seconds since the Unix epoch. """ - departure_airport: NotRequired["str"] + departure_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the departure airport. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number associated with the segment """ service_class: NotRequired[ - "Literal['business', 'economy', 'first', 'premium_economy']" + Literal["business", "economy", "first", "premium_economy"] ] """ The fare class for the segment. @@ -6425,7 +6663,7 @@ class CreateParamsPaymentDetailsLodging(TypedDict): """ The lodging location's address. """ - adults: NotRequired["int"] + adults: NotRequired[int] """ The number of adults on the booking """ @@ -6435,11 +6673,11 @@ class CreateParamsPaymentDetailsLodging(TypedDict): """ Affiliate details for this purchase. """ - booking_number: NotRequired["str"] + booking_number: NotRequired[str] """ The booking number associated with the lodging reservation. """ - category: NotRequired["Literal['hotel', 'vacation_rental']"] + category: NotRequired[Literal["hotel", "vacation_rental"]] """ The lodging category """ @@ -6451,11 +6689,11 @@ class CreateParamsPaymentDetailsLodging(TypedDict): """ Lodging check-out time. Measured in seconds since the Unix epoch. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the lodging company. """ - daily_room_rate_amount: NotRequired["int"] + daily_room_rate_amount: NotRequired[int] """ The daily lodging room rate. """ @@ -6466,76 +6704,85 @@ class CreateParamsPaymentDetailsLodging(TypedDict): Delivery details for this purchase. """ extra_charges: NotRequired[ - "List[Literal['gift_shop', 'laundry', 'mini_bar', 'other', 'restaurant', 'telephone']]" + List[ + Literal[ + "gift_shop", + "laundry", + "mini_bar", + "other", + "restaurant", + "telephone", + ] + ] ] """ List of additional charges being billed. """ - fire_safety_act_compliance: NotRequired["bool"] + fire_safety_act_compliance: NotRequired[bool] """ Indicates whether the lodging location is compliant with the Fire Safety Act. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the lodging location. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep their booking while failing to cancel the reservation. """ - number_of_rooms: NotRequired["int"] + number_of_rooms: NotRequired[int] """ The number of rooms on the booking """ passengers: NotRequired[ - "List[PaymentIntent.CreateParamsPaymentDetailsLodgingPassenger]" + List["PaymentIntent.CreateParamsPaymentDetailsLodgingPassenger"] ] """ The details of the passengers in the travel reservation """ - property_phone_number: NotRequired["str"] + property_phone_number: NotRequired[str] """ The phone number of the lodging location. """ - room_class: NotRequired["str"] + room_class: NotRequired[str] """ The room class for this purchase. """ - room_nights: NotRequired["int"] + room_nights: NotRequired[int] """ The number of room nights """ - total_room_tax_amount: NotRequired["int"] + total_room_tax_amount: NotRequired[int] """ The total tax amount associating with the room reservation. """ - total_tax_amount: NotRequired["int"] + total_tax_amount: NotRequired[int] """ The total tax amount """ class CreateParamsPaymentDetailsLodgingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -6547,7 +6794,7 @@ class CreateParamsPaymentDetailsLodgingAffiliate(TypedDict): """ class CreateParamsPaymentDetailsLodgingDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -6559,15 +6806,15 @@ class CreateParamsPaymentDetailsLodgingDelivery(TypedDict): """ class CreateParamsPaymentDetailsLodgingDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -6585,7 +6832,7 @@ class CreateParamsPaymentDetailsSubscription(TypedDict): """ Affiliate details for this purchase. """ - auto_renewal: NotRequired["bool"] + auto_renewal: NotRequired[bool] """ Info whether the subscription will be auto renewed upon expiry. """ @@ -6595,7 +6842,7 @@ class CreateParamsPaymentDetailsSubscription(TypedDict): """ Subscription billing details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Subscription end time. Measured in seconds since the Unix epoch. """ @@ -6603,7 +6850,7 @@ class CreateParamsPaymentDetailsSubscription(TypedDict): """ Name of the product on subscription. e.g. Apple Music Subscription """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Subscription start time. Measured in seconds since the Unix epoch. """ @@ -6741,7 +6988,7 @@ class CreateParamsPaymentMethodData(TypedDict): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -6915,11 +7162,11 @@ class CreateParamsPaymentMethodDataAuBecsDebit(TypedDict): """ class CreateParamsPaymentMethodDataBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -6948,27 +7195,27 @@ class CreateParamsPaymentMethodDataBillingDetails(TypedDict): """ class CreateParamsPaymentMethodDataBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -6990,14 +7237,43 @@ class CreateParamsPaymentMethodDataCustomerBalance(TypedDict): class CreateParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class CreateParamsPaymentMethodDataFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -7037,7 +7313,24 @@ class CreateParamsPaymentMethodDataGrabpay(TypedDict): class CreateParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -7085,7 +7378,34 @@ class CreateParamsPaymentMethodDataOxxo(TypedDict): class CreateParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -7098,15 +7418,15 @@ class CreateParamsPaymentMethodDataPaypal(TypedDict): pass class CreateParamsPaymentMethodDataPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -7118,7 +7438,7 @@ class CreateParamsPaymentMethodDataPromptpay(TypedDict): pass class CreateParamsPaymentMethodDataRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -7145,23 +7465,23 @@ class CreateParamsPaymentMethodDataTwint(TypedDict): pass class CreateParamsPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -7422,7 +7742,7 @@ class CreateParamsPaymentMethodOptionsAcssDebit(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -7435,17 +7755,17 @@ class CreateParamsPaymentMethodOptionsAcssDebitMandateOptions(TypedDict): The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -7459,11 +7779,11 @@ class CreateParamsPaymentMethodOptionsAffirm(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - preferred_locale: NotRequired["str"] + preferred_locale: NotRequired[str] """ Preferred language of the Affirm authorization page that the customer is redirected to. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -7483,12 +7803,12 @@ class CreateParamsPaymentMethodOptionsAfterpayClearpay(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes. This field differs from the statement descriptor and item name. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -7542,7 +7862,7 @@ class CreateParamsPaymentMethodOptionsBacsDebit(TypedDict): """ class CreateParamsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -7560,7 +7880,7 @@ class CreateParamsPaymentMethodOptionsBancontact(TypedDict): """ class CreateParamsPaymentMethodOptionsBlik(TypedDict): - code: NotRequired["str"] + code: NotRequired[str] """ The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation. """ @@ -7576,7 +7896,7 @@ class CreateParamsPaymentMethodOptionsBlik(TypedDict): """ class CreateParamsPaymentMethodOptionsBoleto(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time. """ @@ -7602,7 +7922,7 @@ class CreateParamsPaymentMethodOptionsCard(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - cvc_token: NotRequired["str"] + cvc_token: NotRequired[str] """ A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation. """ @@ -7620,51 +7940,63 @@ class CreateParamsPaymentMethodOptionsCard(TypedDict): """ Configuration options for setting up an eMandate for cards issued in India. """ - moto: NotRequired["bool"] + moto: NotRequired[bool] """ When specified, this parameter indicates that a transaction will be marked as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time. """ request_decremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent. """ request_extended_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent. """ request_incremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. """ - request_multicapture: NotRequired["Literal['if_available', 'never']"] + request_multicapture: NotRequired[Literal["if_available", "never"]] """ Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent. """ - request_overcapture: NotRequired["Literal['if_available', 'never']"] + request_overcapture: NotRequired[Literal["if_available", "never"]] """ Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ - require_cvc_recollection: NotRequired["bool"] + require_cvc_recollection: NotRequired[bool] """ When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter). """ @@ -7703,7 +8035,7 @@ class CreateParamsPaymentMethodOptionsCard(TypedDict): """ class CreateParamsPaymentMethodOptionsCardInstallments(TypedDict): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Setting to true enables installments for this PaymentIntent. This will cause the response to contain a list of available installment plans. @@ -7741,11 +8073,11 @@ class CreateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ @@ -7753,7 +8085,7 @@ class CreateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ @@ -7765,22 +8097,22 @@ class CreateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ - supported_types: NotRequired["List[Literal['india']]"] + supported_types: NotRequired[List[Literal["india"]]] """ Specifies the type of mandates supported. Possible values are `india`. """ class CreateParamsPaymentMethodOptionsCardPresent(TypedDict): - request_extended_authorization: NotRequired["bool"] + request_extended_authorization: NotRequired[bool] """ Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity) """ - request_incremental_authorization_support: NotRequired["bool"] + request_incremental_authorization_support: NotRequired[bool] """ Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. """ request_incremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ This field was released by mistake and will be removed in the next major version @@ -7793,7 +8125,7 @@ class CreateParamsPaymentMethodOptionsCardStatementDetails(TypedDict): """ Please pass in an address that is within your Stripe user account country """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Phone number (e.g., a toll-free number that customers can call) """ @@ -7801,34 +8133,34 @@ class CreateParamsPaymentMethodOptionsCardStatementDetails(TypedDict): class CreateParamsPaymentMethodOptionsCardStatementDetailsAddress( TypedDict, ): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): ares_trans_status: NotRequired[ - "Literal['A', 'C', 'I', 'N', 'R', 'U', 'Y']" + Literal["A", "C", "I", "N", "R", "U", "Y"] ] """ The `transStatus` returned from the card Issuer's ACS in the ARes. @@ -7841,13 +8173,13 @@ class CreateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): is what you should specify here.) """ electronic_commerce_indicator: NotRequired[ - "Literal['01', '02', '05', '06', '07']" + Literal["01", "02", "05", "06", "07"] ] """ The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed. """ - exemption_indicator: NotRequired["Literal['low_risk', 'none']"] + exemption_indicator: NotRequired[Literal["low_risk", "none"]] """ The exemption requested via 3DS and accepted by the issuer at authentication time. """ @@ -7859,7 +8191,7 @@ class CreateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly """ - requestor_challenge_indicator: NotRequired["str"] + requestor_challenge_indicator: NotRequired[str] """ The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99. @@ -7893,14 +8225,14 @@ class CreateParamsPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancai to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`. messageExtension: CB-AVALGO """ - cb_exemption: NotRequired["str"] + cb_exemption: NotRequired[str] """ The exemption indicator returned from Cartes Bancaires in the ARes. message extension: CB-EXEMPTION; string (4 characters) This is a 3 byte bitmap (low significant byte first and most significant bit first) that has been Base64 encoded """ - cb_score: NotRequired["int"] + cb_score: NotRequired[int] """ The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99 @@ -7935,11 +8267,11 @@ class CreateParamsPaymentMethodOptionsCustomerBalance(TypedDict): """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["Literal['bank_transfer']"] + funding_type: NotRequired[Literal["bank_transfer"]] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -7960,7 +8292,17 @@ class CreateParamsPaymentMethodOptionsCustomerBalanceBankTransfer( Configuration for the eu_bank_transfer funding type. """ requested_address_types: NotRequired[ - "List[Literal['aba', 'iban', 'sepa', 'sort_code', 'spei', 'swift', 'zengin']]" + List[ + Literal[ + "aba", + "iban", + "sepa", + "sort_code", + "spei", + "swift", + "zengin", + ] + ] ] """ List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. @@ -7987,7 +8329,7 @@ class CreateParamsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer( """ class CreateParamsPaymentMethodOptionsEps(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -7999,7 +8341,7 @@ class CreateParamsPaymentMethodOptionsEps(TypedDict): """ class CreateParamsPaymentMethodOptionsFpx(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8011,7 +8353,7 @@ class CreateParamsPaymentMethodOptionsFpx(TypedDict): """ class CreateParamsPaymentMethodOptionsGiropay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8023,7 +8365,7 @@ class CreateParamsPaymentMethodOptionsGiropay(TypedDict): """ class CreateParamsPaymentMethodOptionsGrabpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8061,12 +8403,57 @@ class CreateParamsPaymentMethodOptionsKlarna(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-CH', 'de-DE', 'el-GR', 'en-AT', 'en-AU', 'en-BE', 'en-CA', 'en-CH', 'en-CZ', 'en-DE', 'en-DK', 'en-ES', 'en-FI', 'en-FR', 'en-GB', 'en-GR', 'en-IE', 'en-IT', 'en-NL', 'en-NO', 'en-NZ', 'en-PL', 'en-PT', 'en-SE', 'en-US', 'es-ES', 'es-US', 'fi-FI', 'fr-BE', 'fr-CA', 'fr-CH', 'fr-FR', 'it-CH', 'it-IT', 'nb-NO', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sv-FI', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-CH", + "de-DE", + "el-GR", + "en-AT", + "en-AU", + "en-BE", + "en-CA", + "en-CH", + "en-CZ", + "en-DE", + "en-DK", + "en-ES", + "en-FI", + "en-FR", + "en-GB", + "en-GR", + "en-IE", + "en-IT", + "en-NL", + "en-NO", + "en-NZ", + "en-PL", + "en-PT", + "en-SE", + "en-US", + "es-ES", + "es-US", + "fi-FI", + "fr-BE", + "fr-CA", + "fr-CH", + "fr-FR", + "it-CH", + "it-IT", + "nb-NO", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sv-FI", + "sv-SE", + ] ] """ Preferred language of the Klarna authorization page that the customer is redirected to """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8094,7 +8481,7 @@ class CreateParamsPaymentMethodOptionsKonbini(TypedDict): """ A product descriptor of up to 22 characters, which will appear to customers at the convenience store. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8114,7 +8501,7 @@ class CreateParamsPaymentMethodOptionsLink(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ @@ -8140,7 +8527,7 @@ class CreateParamsPaymentMethodOptionsMobilepay(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8152,7 +8539,7 @@ class CreateParamsPaymentMethodOptionsMobilepay(TypedDict): """ class CreateParamsPaymentMethodOptionsMultibanco(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8164,11 +8551,11 @@ class CreateParamsPaymentMethodOptionsMultibanco(TypedDict): """ class CreateParamsPaymentMethodOptionsOxxo(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8180,7 +8567,7 @@ class CreateParamsPaymentMethodOptionsOxxo(TypedDict): """ class CreateParamsPaymentMethodOptionsP24(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8190,13 +8577,13 @@ class CreateParamsPaymentMethodOptionsP24(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - tos_shown_and_accepted: NotRequired["bool"] + tos_shown_and_accepted: NotRequired[bool] """ Confirm that the payer has accepted the P24 terms and conditions. """ class CreateParamsPaymentMethodOptionsPaynow(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8213,20 +8600,42 @@ class CreateParamsPaymentMethodOptionsPaypal(TypedDict): Controls when the funds will be captured from the customer's account. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-DE', 'de-LU', 'el-GR', 'en-GB', 'en-US', 'es-ES', 'fi-FI', 'fr-BE', 'fr-FR', 'fr-LU', 'hu-HU', 'it-IT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sk-SK', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-DE", + "de-LU", + "el-GR", + "en-GB", + "en-US", + "es-ES", + "fi-FI", + "fr-BE", + "fr-FR", + "fr-LU", + "hu-HU", + "it-IT", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sk-SK", + "sv-SE", + ] ] """ [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - reference_id: NotRequired["str"] + reference_id: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - risk_correlation_id: NotRequired["str"] + risk_correlation_id: NotRequired[str] """ The risk correlation ID for an on-session payment using a saved PayPal payment method. """ @@ -8242,7 +8651,7 @@ class CreateParamsPaymentMethodOptionsPaypal(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - subsellers: NotRequired["List[str]"] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -8268,45 +8677,66 @@ class CreateParamsPaymentMethodOptionsPayto(TypedDict): """ class CreateParamsPaymentMethodOptionsPaytoMandateOptions(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount that will be collected. It is required when `amount_type` is `fixed`. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. """ - end_date: NotRequired["str"] + end_date: NotRequired[str] """ Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. """ payment_schedule: NotRequired[ - "Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] ] """ The periodicity at which payments will be collected. """ - payments_per_period: NotRequired["int"] + payments_per_period: NotRequired[int] """ The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. """ purpose: NotRequired[ - "Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] ] """ The purpose for which payments are made. Defaults to retail. """ class CreateParamsPaymentMethodOptionsPix(TypedDict): - expires_after_seconds: NotRequired["int"] + expires_after_seconds: NotRequired[int] """ The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8318,7 +8748,7 @@ class CreateParamsPaymentMethodOptionsPix(TypedDict): """ class CreateParamsPaymentMethodOptionsPromptpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8389,7 +8819,7 @@ class CreateParamsPaymentMethodOptionsSwish(TypedDict): """ The order ID displayed in the Swish app after the payment is authorized. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8438,7 +8868,7 @@ class CreateParamsPaymentMethodOptionsUsBankAccount(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -8454,18 +8884,29 @@ class CreateParamsPaymentMethodOptionsUsBankAccountFinancialConnections( Customize manual entry behavior """ permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ @@ -8487,13 +8928,13 @@ class CreateParamsPaymentMethodOptionsUsBankAccountMandateOptions( """ class CreateParamsPaymentMethodOptionsUsBankAccountNetworks(TypedDict): - requested: NotRequired["List[Literal['ach', 'us_domestic_wire']]"] + requested: NotRequired[List[Literal["ach", "us_domestic_wire"]]] """ Triggers validations to run across the selected networks """ class CreateParamsPaymentMethodOptionsWechatPay(TypedDict): - app_id: NotRequired["str"] + app_id: NotRequired[str] """ The app ID registered with WeChat Pay. Only required when client is ios or android. """ @@ -8501,7 +8942,7 @@ class CreateParamsPaymentMethodOptionsWechatPay(TypedDict): """ The client type that the end customer will pay from """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8513,7 +8954,7 @@ class CreateParamsPaymentMethodOptionsWechatPay(TypedDict): """ class CreateParamsPaymentMethodOptionsZip(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8525,7 +8966,7 @@ class CreateParamsPaymentMethodOptionsZip(TypedDict): """ class CreateParamsRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -8535,7 +8976,7 @@ class CreateParamsShipping(TypedDict): """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ @@ -8543,43 +8984,43 @@ class CreateParamsShipping(TypedDict): """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class CreateParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when a charge succeeds. The amount is capped at the total transaction amount and if no amount is set, @@ -8602,19 +9043,19 @@ class DecrementAuthorizationParams(RequestOptions): """ The updated total amount that you intend to collect from the cardholder. This amount must be smaller than the currently authorized amount. """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -8627,7 +9068,7 @@ class DecrementAuthorizationParams(RequestOptions): """ class DecrementAuthorizationParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when a charge succeeds. """ @@ -8637,23 +9078,23 @@ class IncrementAuthorizationParams(RequestOptions): """ The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount. """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. """ @@ -8666,7 +9107,7 @@ class IncrementAuthorizationParams(RequestOptions): """ class IncrementAuthorizationParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when a charge succeeds. """ @@ -8676,47 +9117,47 @@ class ListParams(RequestOptions): """ A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return PaymentIntents for the customer that this customer ID specifies. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). """ @@ -8725,16 +9166,16 @@ class ModifyParams(RequestOptions): The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ ID of the Customer this PaymentIntent belongs to, if one exists. @@ -8742,11 +9183,11 @@ class ModifyParams(RequestOptions): If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -8764,11 +9205,11 @@ class ModifyParams(RequestOptions): """ Provides industry-specific information about the charge. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. """ - payment_method_configuration: NotRequired["str"] + payment_method_configuration: NotRequired[str] """ The ID of the payment method configuration to use with this PaymentIntent. """ @@ -8786,7 +9227,7 @@ class ModifyParams(RequestOptions): """ Payment-method-specific configuration for this PaymentIntent. """ - payment_method_types: NotRequired["List[str]"] + payment_method_types: NotRequired[List[str]] """ The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). """ @@ -8810,11 +9251,11 @@ class ModifyParams(RequestOptions): """ Shipping information for this PaymentIntent. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. """ @@ -8822,7 +9263,7 @@ class ModifyParams(RequestOptions): """ Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ @@ -8844,11 +9285,11 @@ class ModifyParamsMandateDataCustomerAcceptance(TypedDict): """ class ModifyParamsMandateDataCustomerAcceptanceOnline(TypedDict): - ip_address: NotRequired["str"] + ip_address: NotRequired[str] """ The IP address from which the Mandate was accepted by the customer. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the Mandate was accepted by the customer. """ @@ -8892,23 +9333,23 @@ class ModifyParamsPaymentDetailsCarRental(TypedDict): """ The booking number associated with the car rental. """ - car_class_code: NotRequired["str"] + car_class_code: NotRequired[str] """ Class code of the car. """ - car_make: NotRequired["str"] + car_make: NotRequired[str] """ Make of the car. """ - car_model: NotRequired["str"] + car_model: NotRequired[str] """ Model of the car. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the rental car company. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the car rental company. """ @@ -8923,18 +9364,26 @@ class ModifyParamsPaymentDetailsCarRental(TypedDict): Delivery details for this purchase. """ drivers: NotRequired[ - "List[PaymentIntent.ModifyParamsPaymentDetailsCarRentalDriver]" + List["PaymentIntent.ModifyParamsPaymentDetailsCarRentalDriver"] ] """ The details of the passengers in the travel reservation """ extra_charges: NotRequired[ - "List[Literal['extra_mileage', 'gas', 'late_return', 'one_way_service', 'parking_violation']]" + List[ + Literal[ + "extra_mileage", + "gas", + "late_return", + "one_way_service", + "parking_violation", + ] + ] ] """ List of additional charges being billed. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep nor cancel their booking. """ @@ -8948,15 +9397,15 @@ class ModifyParamsPaymentDetailsCarRental(TypedDict): """ Car pick-up time. Measured in seconds since the Unix epoch. """ - rate_amount: NotRequired["int"] + rate_amount: NotRequired[int] """ Rental rate. """ - rate_interval: NotRequired["Literal['day', 'month', 'week']"] + rate_interval: NotRequired[Literal["day", "month", "week"]] """ The frequency at which the rate amount is applied. One of `day`, `week` or `month` """ - renter_name: NotRequired["str"] + renter_name: NotRequired[str] """ The name of the person or entity renting the car. """ @@ -8970,7 +9419,7 @@ class ModifyParamsPaymentDetailsCarRental(TypedDict): """ Car return time. Measured in seconds since the Unix epoch. """ - tax_exempt: NotRequired["bool"] + tax_exempt: NotRequired[bool] """ Indicates whether the goods or services are tax-exempt or tax is not collected. """ @@ -8982,7 +9431,7 @@ class ModifyParamsPaymentDetailsCarRentalAffiliate(TypedDict): """ class ModifyParamsPaymentDetailsCarRentalDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -8994,15 +9443,15 @@ class ModifyParamsPaymentDetailsCarRentalDelivery(TypedDict): """ class ModifyParamsPaymentDetailsCarRentalDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -9014,59 +9463,59 @@ class ModifyParamsPaymentDetailsCarRentalDriver(TypedDict): """ class ModifyParamsPaymentDetailsCarRentalPickupAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ModifyParamsPaymentDetailsCarRentalReturnAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ModifyParamsPaymentDetailsEventDetails(TypedDict): - access_controlled_venue: NotRequired["bool"] + access_controlled_venue: NotRequired[bool] """ Indicates if the tickets are digitally checked when entering the venue. """ @@ -9082,7 +9531,7 @@ class ModifyParamsPaymentDetailsEventDetails(TypedDict): """ Affiliate details for this purchase. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the company """ @@ -9092,11 +9541,11 @@ class ModifyParamsPaymentDetailsEventDetails(TypedDict): """ Delivery details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Event end time. Measured in seconds since the Unix epoch. """ - genre: NotRequired["str"] + genre: NotRequired[str] """ Type of the event entertainment (concert, sports event etc) """ @@ -9104,33 +9553,33 @@ class ModifyParamsPaymentDetailsEventDetails(TypedDict): """ The name of the event. """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Event start time. Measured in seconds since the Unix epoch. """ class ModifyParamsPaymentDetailsEventDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -9142,7 +9591,7 @@ class ModifyParamsPaymentDetailsEventDetailsAffiliate(TypedDict): """ class ModifyParamsPaymentDetailsEventDetailsDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -9154,15 +9603,15 @@ class ModifyParamsPaymentDetailsEventDetailsDelivery(TypedDict): """ class ModifyParamsPaymentDetailsEventDetailsDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -9174,11 +9623,11 @@ class ModifyParamsPaymentDetailsFlight(TypedDict): """ Affiliate details for this purchase. """ - agency_number: NotRequired["str"] + agency_number: NotRequired[str] """ The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket. """ @@ -9188,12 +9637,12 @@ class ModifyParamsPaymentDetailsFlight(TypedDict): """ Delivery details for this purchase. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the person or entity on the reservation. """ passengers: NotRequired[ - "List[PaymentIntent.ModifyParamsPaymentDetailsFlightPassenger]" + List["PaymentIntent.ModifyParamsPaymentDetailsFlightPassenger"] ] """ The details of the passengers in the travel reservation. @@ -9202,7 +9651,7 @@ class ModifyParamsPaymentDetailsFlight(TypedDict): """ The individual flight segments associated with the trip. """ - ticket_number: NotRequired["str"] + ticket_number: NotRequired[str] """ The ticket number associated with the travel reservation. """ @@ -9214,7 +9663,7 @@ class ModifyParamsPaymentDetailsFlightAffiliate(TypedDict): """ class ModifyParamsPaymentDetailsFlightDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -9226,15 +9675,15 @@ class ModifyParamsPaymentDetailsFlightDelivery(TypedDict): """ class ModifyParamsPaymentDetailsFlightDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -9246,19 +9695,19 @@ class ModifyParamsPaymentDetailsFlightPassenger(TypedDict): """ class ModifyParamsPaymentDetailsFlightSegment(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The flight segment amount. """ - arrival_airport: NotRequired["str"] + arrival_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the arrival airport. """ - arrives_at: NotRequired["int"] + arrives_at: NotRequired[int] """ The arrival time for the flight segment. Measured in seconds since the Unix epoch. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment. """ @@ -9266,16 +9715,16 @@ class ModifyParamsPaymentDetailsFlightSegment(TypedDict): """ The departure time for the flight segment. Measured in seconds since the Unix epoch. """ - departure_airport: NotRequired["str"] + departure_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the departure airport. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number associated with the segment """ service_class: NotRequired[ - "Literal['business', 'economy', 'first', 'premium_economy']" + Literal["business", "economy", "first", "premium_economy"] ] """ The fare class for the segment. @@ -9288,7 +9737,7 @@ class ModifyParamsPaymentDetailsLodging(TypedDict): """ The lodging location's address. """ - adults: NotRequired["int"] + adults: NotRequired[int] """ The number of adults on the booking """ @@ -9298,11 +9747,11 @@ class ModifyParamsPaymentDetailsLodging(TypedDict): """ Affiliate details for this purchase. """ - booking_number: NotRequired["str"] + booking_number: NotRequired[str] """ The booking number associated with the lodging reservation. """ - category: NotRequired["Literal['hotel', 'vacation_rental']"] + category: NotRequired[Literal["hotel", "vacation_rental"]] """ The lodging category """ @@ -9314,11 +9763,11 @@ class ModifyParamsPaymentDetailsLodging(TypedDict): """ Lodging check-out time. Measured in seconds since the Unix epoch. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the lodging company. """ - daily_room_rate_amount: NotRequired["int"] + daily_room_rate_amount: NotRequired[int] """ The daily lodging room rate. """ @@ -9329,76 +9778,85 @@ class ModifyParamsPaymentDetailsLodging(TypedDict): Delivery details for this purchase. """ extra_charges: NotRequired[ - "List[Literal['gift_shop', 'laundry', 'mini_bar', 'other', 'restaurant', 'telephone']]" + List[ + Literal[ + "gift_shop", + "laundry", + "mini_bar", + "other", + "restaurant", + "telephone", + ] + ] ] """ List of additional charges being billed. """ - fire_safety_act_compliance: NotRequired["bool"] + fire_safety_act_compliance: NotRequired[bool] """ Indicates whether the lodging location is compliant with the Fire Safety Act. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the lodging location. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep their booking while failing to cancel the reservation. """ - number_of_rooms: NotRequired["int"] + number_of_rooms: NotRequired[int] """ The number of rooms on the booking """ passengers: NotRequired[ - "List[PaymentIntent.ModifyParamsPaymentDetailsLodgingPassenger]" + List["PaymentIntent.ModifyParamsPaymentDetailsLodgingPassenger"] ] """ The details of the passengers in the travel reservation """ - property_phone_number: NotRequired["str"] + property_phone_number: NotRequired[str] """ The phone number of the lodging location. """ - room_class: NotRequired["str"] + room_class: NotRequired[str] """ The room class for this purchase. """ - room_nights: NotRequired["int"] + room_nights: NotRequired[int] """ The number of room nights """ - total_room_tax_amount: NotRequired["int"] + total_room_tax_amount: NotRequired[int] """ The total tax amount associating with the room reservation. """ - total_tax_amount: NotRequired["int"] + total_tax_amount: NotRequired[int] """ The total tax amount """ class ModifyParamsPaymentDetailsLodgingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -9410,7 +9868,7 @@ class ModifyParamsPaymentDetailsLodgingAffiliate(TypedDict): """ class ModifyParamsPaymentDetailsLodgingDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -9422,15 +9880,15 @@ class ModifyParamsPaymentDetailsLodgingDelivery(TypedDict): """ class ModifyParamsPaymentDetailsLodgingDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -9448,7 +9906,7 @@ class ModifyParamsPaymentDetailsSubscription(TypedDict): """ Affiliate details for this purchase. """ - auto_renewal: NotRequired["bool"] + auto_renewal: NotRequired[bool] """ Info whether the subscription will be auto renewed upon expiry. """ @@ -9458,7 +9916,7 @@ class ModifyParamsPaymentDetailsSubscription(TypedDict): """ Subscription billing details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Subscription end time. Measured in seconds since the Unix epoch. """ @@ -9466,7 +9924,7 @@ class ModifyParamsPaymentDetailsSubscription(TypedDict): """ Name of the product on subscription. e.g. Apple Music Subscription """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Subscription start time. Measured in seconds since the Unix epoch. """ @@ -9604,7 +10062,7 @@ class ModifyParamsPaymentMethodData(TypedDict): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -9778,11 +10236,11 @@ class ModifyParamsPaymentMethodDataAuBecsDebit(TypedDict): """ class ModifyParamsPaymentMethodDataBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -9811,27 +10269,27 @@ class ModifyParamsPaymentMethodDataBillingDetails(TypedDict): """ class ModifyParamsPaymentMethodDataBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -9853,14 +10311,43 @@ class ModifyParamsPaymentMethodDataCustomerBalance(TypedDict): class ModifyParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class ModifyParamsPaymentMethodDataFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -9900,7 +10387,24 @@ class ModifyParamsPaymentMethodDataGrabpay(TypedDict): class ModifyParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -9948,7 +10452,34 @@ class ModifyParamsPaymentMethodDataOxxo(TypedDict): class ModifyParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -9961,15 +10492,15 @@ class ModifyParamsPaymentMethodDataPaypal(TypedDict): pass class ModifyParamsPaymentMethodDataPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -9981,7 +10512,7 @@ class ModifyParamsPaymentMethodDataPromptpay(TypedDict): pass class ModifyParamsPaymentMethodDataRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -10008,23 +10539,23 @@ class ModifyParamsPaymentMethodDataTwint(TypedDict): pass class ModifyParamsPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -10285,7 +10816,7 @@ class ModifyParamsPaymentMethodOptionsAcssDebit(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -10298,17 +10829,17 @@ class ModifyParamsPaymentMethodOptionsAcssDebitMandateOptions(TypedDict): The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -10322,11 +10853,11 @@ class ModifyParamsPaymentMethodOptionsAffirm(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - preferred_locale: NotRequired["str"] + preferred_locale: NotRequired[str] """ Preferred language of the Affirm authorization page that the customer is redirected to. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -10346,12 +10877,12 @@ class ModifyParamsPaymentMethodOptionsAfterpayClearpay(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes. This field differs from the statement descriptor and item name. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -10405,7 +10936,7 @@ class ModifyParamsPaymentMethodOptionsBacsDebit(TypedDict): """ class ModifyParamsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -10423,7 +10954,7 @@ class ModifyParamsPaymentMethodOptionsBancontact(TypedDict): """ class ModifyParamsPaymentMethodOptionsBlik(TypedDict): - code: NotRequired["str"] + code: NotRequired[str] """ The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation. """ @@ -10439,7 +10970,7 @@ class ModifyParamsPaymentMethodOptionsBlik(TypedDict): """ class ModifyParamsPaymentMethodOptionsBoleto(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time. """ @@ -10465,7 +10996,7 @@ class ModifyParamsPaymentMethodOptionsCard(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - cvc_token: NotRequired["str"] + cvc_token: NotRequired[str] """ A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation. """ @@ -10483,51 +11014,63 @@ class ModifyParamsPaymentMethodOptionsCard(TypedDict): """ Configuration options for setting up an eMandate for cards issued in India. """ - moto: NotRequired["bool"] + moto: NotRequired[bool] """ When specified, this parameter indicates that a transaction will be marked as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time. """ request_decremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent. """ request_extended_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent. """ request_incremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. """ - request_multicapture: NotRequired["Literal['if_available', 'never']"] + request_multicapture: NotRequired[Literal["if_available", "never"]] """ Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent. """ - request_overcapture: NotRequired["Literal['if_available', 'never']"] + request_overcapture: NotRequired[Literal["if_available", "never"]] """ Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ - require_cvc_recollection: NotRequired["bool"] + require_cvc_recollection: NotRequired[bool] """ When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter). """ @@ -10566,7 +11109,7 @@ class ModifyParamsPaymentMethodOptionsCard(TypedDict): """ class ModifyParamsPaymentMethodOptionsCardInstallments(TypedDict): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Setting to true enables installments for this PaymentIntent. This will cause the response to contain a list of available installment plans. @@ -10604,11 +11147,11 @@ class ModifyParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ @@ -10616,7 +11159,7 @@ class ModifyParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ @@ -10628,22 +11171,22 @@ class ModifyParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ - supported_types: NotRequired["List[Literal['india']]"] + supported_types: NotRequired[List[Literal["india"]]] """ Specifies the type of mandates supported. Possible values are `india`. """ class ModifyParamsPaymentMethodOptionsCardPresent(TypedDict): - request_extended_authorization: NotRequired["bool"] + request_extended_authorization: NotRequired[bool] """ Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity) """ - request_incremental_authorization_support: NotRequired["bool"] + request_incremental_authorization_support: NotRequired[bool] """ Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. """ request_incremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ This field was released by mistake and will be removed in the next major version @@ -10656,7 +11199,7 @@ class ModifyParamsPaymentMethodOptionsCardStatementDetails(TypedDict): """ Please pass in an address that is within your Stripe user account country """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Phone number (e.g., a toll-free number that customers can call) """ @@ -10664,34 +11207,34 @@ class ModifyParamsPaymentMethodOptionsCardStatementDetails(TypedDict): class ModifyParamsPaymentMethodOptionsCardStatementDetailsAddress( TypedDict, ): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ModifyParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): ares_trans_status: NotRequired[ - "Literal['A', 'C', 'I', 'N', 'R', 'U', 'Y']" + Literal["A", "C", "I", "N", "R", "U", "Y"] ] """ The `transStatus` returned from the card Issuer's ACS in the ARes. @@ -10704,13 +11247,13 @@ class ModifyParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): is what you should specify here.) """ electronic_commerce_indicator: NotRequired[ - "Literal['01', '02', '05', '06', '07']" + Literal["01", "02", "05", "06", "07"] ] """ The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed. """ - exemption_indicator: NotRequired["Literal['low_risk', 'none']"] + exemption_indicator: NotRequired[Literal["low_risk", "none"]] """ The exemption requested via 3DS and accepted by the issuer at authentication time. """ @@ -10722,7 +11265,7 @@ class ModifyParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly """ - requestor_challenge_indicator: NotRequired["str"] + requestor_challenge_indicator: NotRequired[str] """ The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99. @@ -10756,14 +11299,14 @@ class ModifyParamsPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancai to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`. messageExtension: CB-AVALGO """ - cb_exemption: NotRequired["str"] + cb_exemption: NotRequired[str] """ The exemption indicator returned from Cartes Bancaires in the ARes. message extension: CB-EXEMPTION; string (4 characters) This is a 3 byte bitmap (low significant byte first and most significant bit first) that has been Base64 encoded """ - cb_score: NotRequired["int"] + cb_score: NotRequired[int] """ The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99 @@ -10798,11 +11341,11 @@ class ModifyParamsPaymentMethodOptionsCustomerBalance(TypedDict): """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["Literal['bank_transfer']"] + funding_type: NotRequired[Literal["bank_transfer"]] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -10823,7 +11366,17 @@ class ModifyParamsPaymentMethodOptionsCustomerBalanceBankTransfer( Configuration for the eu_bank_transfer funding type. """ requested_address_types: NotRequired[ - "List[Literal['aba', 'iban', 'sepa', 'sort_code', 'spei', 'swift', 'zengin']]" + List[ + Literal[ + "aba", + "iban", + "sepa", + "sort_code", + "spei", + "swift", + "zengin", + ] + ] ] """ List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. @@ -10850,7 +11403,7 @@ class ModifyParamsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer( """ class ModifyParamsPaymentMethodOptionsEps(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -10862,7 +11415,7 @@ class ModifyParamsPaymentMethodOptionsEps(TypedDict): """ class ModifyParamsPaymentMethodOptionsFpx(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -10874,7 +11427,7 @@ class ModifyParamsPaymentMethodOptionsFpx(TypedDict): """ class ModifyParamsPaymentMethodOptionsGiropay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -10886,7 +11439,7 @@ class ModifyParamsPaymentMethodOptionsGiropay(TypedDict): """ class ModifyParamsPaymentMethodOptionsGrabpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -10924,12 +11477,57 @@ class ModifyParamsPaymentMethodOptionsKlarna(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-CH', 'de-DE', 'el-GR', 'en-AT', 'en-AU', 'en-BE', 'en-CA', 'en-CH', 'en-CZ', 'en-DE', 'en-DK', 'en-ES', 'en-FI', 'en-FR', 'en-GB', 'en-GR', 'en-IE', 'en-IT', 'en-NL', 'en-NO', 'en-NZ', 'en-PL', 'en-PT', 'en-SE', 'en-US', 'es-ES', 'es-US', 'fi-FI', 'fr-BE', 'fr-CA', 'fr-CH', 'fr-FR', 'it-CH', 'it-IT', 'nb-NO', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sv-FI', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-CH", + "de-DE", + "el-GR", + "en-AT", + "en-AU", + "en-BE", + "en-CA", + "en-CH", + "en-CZ", + "en-DE", + "en-DK", + "en-ES", + "en-FI", + "en-FR", + "en-GB", + "en-GR", + "en-IE", + "en-IT", + "en-NL", + "en-NO", + "en-NZ", + "en-PL", + "en-PT", + "en-SE", + "en-US", + "es-ES", + "es-US", + "fi-FI", + "fr-BE", + "fr-CA", + "fr-CH", + "fr-FR", + "it-CH", + "it-IT", + "nb-NO", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sv-FI", + "sv-SE", + ] ] """ Preferred language of the Klarna authorization page that the customer is redirected to """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -10957,7 +11555,7 @@ class ModifyParamsPaymentMethodOptionsKonbini(TypedDict): """ A product descriptor of up to 22 characters, which will appear to customers at the convenience store. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -10977,7 +11575,7 @@ class ModifyParamsPaymentMethodOptionsLink(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ @@ -11003,7 +11601,7 @@ class ModifyParamsPaymentMethodOptionsMobilepay(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -11015,7 +11613,7 @@ class ModifyParamsPaymentMethodOptionsMobilepay(TypedDict): """ class ModifyParamsPaymentMethodOptionsMultibanco(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -11027,11 +11625,11 @@ class ModifyParamsPaymentMethodOptionsMultibanco(TypedDict): """ class ModifyParamsPaymentMethodOptionsOxxo(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -11043,7 +11641,7 @@ class ModifyParamsPaymentMethodOptionsOxxo(TypedDict): """ class ModifyParamsPaymentMethodOptionsP24(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -11053,13 +11651,13 @@ class ModifyParamsPaymentMethodOptionsP24(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - tos_shown_and_accepted: NotRequired["bool"] + tos_shown_and_accepted: NotRequired[bool] """ Confirm that the payer has accepted the P24 terms and conditions. """ class ModifyParamsPaymentMethodOptionsPaynow(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -11076,20 +11674,42 @@ class ModifyParamsPaymentMethodOptionsPaypal(TypedDict): Controls when the funds will be captured from the customer's account. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-DE', 'de-LU', 'el-GR', 'en-GB', 'en-US', 'es-ES', 'fi-FI', 'fr-BE', 'fr-FR', 'fr-LU', 'hu-HU', 'it-IT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sk-SK', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-DE", + "de-LU", + "el-GR", + "en-GB", + "en-US", + "es-ES", + "fi-FI", + "fr-BE", + "fr-FR", + "fr-LU", + "hu-HU", + "it-IT", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sk-SK", + "sv-SE", + ] ] """ [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - reference_id: NotRequired["str"] + reference_id: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - risk_correlation_id: NotRequired["str"] + risk_correlation_id: NotRequired[str] """ The risk correlation ID for an on-session payment using a saved PayPal payment method. """ @@ -11105,7 +11725,7 @@ class ModifyParamsPaymentMethodOptionsPaypal(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - subsellers: NotRequired["List[str]"] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -11131,45 +11751,66 @@ class ModifyParamsPaymentMethodOptionsPayto(TypedDict): """ class ModifyParamsPaymentMethodOptionsPaytoMandateOptions(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount that will be collected. It is required when `amount_type` is `fixed`. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. """ - end_date: NotRequired["str"] + end_date: NotRequired[str] """ Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. """ payment_schedule: NotRequired[ - "Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] ] """ The periodicity at which payments will be collected. """ - payments_per_period: NotRequired["int"] + payments_per_period: NotRequired[int] """ The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. """ purpose: NotRequired[ - "Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] ] """ The purpose for which payments are made. Defaults to retail. """ class ModifyParamsPaymentMethodOptionsPix(TypedDict): - expires_after_seconds: NotRequired["int"] + expires_after_seconds: NotRequired[int] """ The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -11181,7 +11822,7 @@ class ModifyParamsPaymentMethodOptionsPix(TypedDict): """ class ModifyParamsPaymentMethodOptionsPromptpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -11252,7 +11893,7 @@ class ModifyParamsPaymentMethodOptionsSwish(TypedDict): """ The order ID displayed in the Swish app after the payment is authorized. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -11301,7 +11942,7 @@ class ModifyParamsPaymentMethodOptionsUsBankAccount(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -11317,18 +11958,29 @@ class ModifyParamsPaymentMethodOptionsUsBankAccountFinancialConnections( Customize manual entry behavior """ permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ @@ -11350,13 +12002,13 @@ class ModifyParamsPaymentMethodOptionsUsBankAccountMandateOptions( """ class ModifyParamsPaymentMethodOptionsUsBankAccountNetworks(TypedDict): - requested: NotRequired["List[Literal['ach', 'us_domestic_wire']]"] + requested: NotRequired[List[Literal["ach", "us_domestic_wire"]]] """ Triggers validations to run across the selected networks """ class ModifyParamsPaymentMethodOptionsWechatPay(TypedDict): - app_id: NotRequired["str"] + app_id: NotRequired[str] """ The app ID registered with WeChat Pay. Only required when client is ios or android. """ @@ -11364,7 +12016,7 @@ class ModifyParamsPaymentMethodOptionsWechatPay(TypedDict): """ The client type that the end customer will pay from """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -11376,7 +12028,7 @@ class ModifyParamsPaymentMethodOptionsWechatPay(TypedDict): """ class ModifyParamsPaymentMethodOptionsZip(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -11392,7 +12044,7 @@ class ModifyParamsShipping(TypedDict): """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ @@ -11400,67 +12052,67 @@ class ModifyParamsShipping(TypedDict): """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class ModifyParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ModifyParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when a charge succeeds. """ class RetrieveParams(RequestOptions): - client_secret: NotRequired["str"] + client_secret: NotRequired[str] """ The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SearchParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - page: NotRequired["str"] + page: NotRequired[str] """ A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. """ @@ -11470,15 +12122,15 @@ class SearchParams(RequestOptions): """ class VerifyMicrodepositsParams(RequestOptions): - amounts: NotRequired["List[int]"] + amounts: NotRequired[List[int]] """ Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. """ - descriptor_code: NotRequired["str"] + descriptor_code: NotRequired[str] """ A six-character code starting with SM present in the microdeposit sent to the bank account. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_payment_intent_service.py b/stripe/_payment_intent_service.py index 8aff65ab3..c1645fc86 100644 --- a/stripe/_payment_intent_service.py +++ b/stripe/_payment_intent_service.py @@ -12,7 +12,7 @@ class PaymentIntentService(StripeService): class ApplyCustomerBalanceParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount that you intend to apply to this PaymentIntent from the customer's cash balance. @@ -22,41 +22,43 @@ class ApplyCustomerBalanceParams(TypedDict): When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CancelParams(TypedDict): cancellation_reason: NotRequired[ - "Literal['abandoned', 'duplicate', 'fraudulent', 'requested_by_customer']" + Literal[ + "abandoned", "duplicate", "fraudulent", "requested_by_customer" + ] ] """ Reason for canceling this PaymentIntent. Possible values are: `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned` """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CaptureParams(TypedDict): - amount_to_capture: NotRequired["int"] + amount_to_capture: NotRequired[int] """ The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount is automatically refunded. Defaults to the full `amount_capturable` if it's not provided. """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - final_capture: NotRequired["bool"] + final_capture: NotRequired[bool] """ Defaults to `true`. When capturing a PaymentIntent, setting `final_capture` to `false` notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when [multicapture](https://stripe.com/docs/payments/multicapture) is available for PaymentIntents. """ @@ -70,11 +72,11 @@ class CaptureParams(TypedDict): """ Provides industry-specific information about the charge. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. The concatenated descriptor must be 1-22 characters long. """ @@ -129,23 +131,23 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): """ The booking number associated with the car rental. """ - car_class_code: NotRequired["str"] + car_class_code: NotRequired[str] """ Class code of the car. """ - car_make: NotRequired["str"] + car_make: NotRequired[str] """ Make of the car. """ - car_model: NotRequired["str"] + car_model: NotRequired[str] """ Model of the car. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the rental car company. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the car rental company. """ @@ -160,18 +162,28 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): Delivery details for this purchase. """ drivers: NotRequired[ - "List[PaymentIntentService.CaptureParamsPaymentDetailsCarRentalDriver]" + List[ + "PaymentIntentService.CaptureParamsPaymentDetailsCarRentalDriver" + ] ] """ The details of the passengers in the travel reservation """ extra_charges: NotRequired[ - "List[Literal['extra_mileage', 'gas', 'late_return', 'one_way_service', 'parking_violation']]" + List[ + Literal[ + "extra_mileage", + "gas", + "late_return", + "one_way_service", + "parking_violation", + ] + ] ] """ List of additional charges being billed. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep nor cancel their booking. """ @@ -185,15 +197,15 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): """ Car pick-up time. Measured in seconds since the Unix epoch. """ - rate_amount: NotRequired["int"] + rate_amount: NotRequired[int] """ Rental rate. """ - rate_interval: NotRequired["Literal['day', 'month', 'week']"] + rate_interval: NotRequired[Literal["day", "month", "week"]] """ The frequency at which the rate amount is applied. One of `day`, `week` or `month` """ - renter_name: NotRequired["str"] + renter_name: NotRequired[str] """ The name of the person or entity renting the car. """ @@ -207,7 +219,7 @@ class CaptureParamsPaymentDetailsCarRental(TypedDict): """ Car return time. Measured in seconds since the Unix epoch. """ - tax_exempt: NotRequired["bool"] + tax_exempt: NotRequired[bool] """ Indicates whether the goods or services are tax-exempt or tax is not collected. """ @@ -219,7 +231,7 @@ class CaptureParamsPaymentDetailsCarRentalAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsCarRentalDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -231,15 +243,15 @@ class CaptureParamsPaymentDetailsCarRentalDelivery(TypedDict): """ class CaptureParamsPaymentDetailsCarRentalDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -251,59 +263,59 @@ class CaptureParamsPaymentDetailsCarRentalDriver(TypedDict): """ class CaptureParamsPaymentDetailsCarRentalPickupAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CaptureParamsPaymentDetailsCarRentalReturnAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CaptureParamsPaymentDetailsEventDetails(TypedDict): - access_controlled_venue: NotRequired["bool"] + access_controlled_venue: NotRequired[bool] """ Indicates if the tickets are digitally checked when entering the venue. """ @@ -319,7 +331,7 @@ class CaptureParamsPaymentDetailsEventDetails(TypedDict): """ Affiliate details for this purchase. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the company """ @@ -329,11 +341,11 @@ class CaptureParamsPaymentDetailsEventDetails(TypedDict): """ Delivery details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Event end time. Measured in seconds since the Unix epoch. """ - genre: NotRequired["str"] + genre: NotRequired[str] """ Type of the event entertainment (concert, sports event etc) """ @@ -341,33 +353,33 @@ class CaptureParamsPaymentDetailsEventDetails(TypedDict): """ The name of the event. """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Event start time. Measured in seconds since the Unix epoch. """ class CaptureParamsPaymentDetailsEventDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -379,7 +391,7 @@ class CaptureParamsPaymentDetailsEventDetailsAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsEventDetailsDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -391,15 +403,15 @@ class CaptureParamsPaymentDetailsEventDetailsDelivery(TypedDict): """ class CaptureParamsPaymentDetailsEventDetailsDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -411,11 +423,11 @@ class CaptureParamsPaymentDetailsFlight(TypedDict): """ Affiliate details for this purchase. """ - agency_number: NotRequired["str"] + agency_number: NotRequired[str] """ The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket. """ @@ -425,12 +437,14 @@ class CaptureParamsPaymentDetailsFlight(TypedDict): """ Delivery details for this purchase. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the person or entity on the reservation. """ passengers: NotRequired[ - "List[PaymentIntentService.CaptureParamsPaymentDetailsFlightPassenger]" + List[ + "PaymentIntentService.CaptureParamsPaymentDetailsFlightPassenger" + ] ] """ The details of the passengers in the travel reservation. @@ -441,7 +455,7 @@ class CaptureParamsPaymentDetailsFlight(TypedDict): """ The individual flight segments associated with the trip. """ - ticket_number: NotRequired["str"] + ticket_number: NotRequired[str] """ The ticket number associated with the travel reservation. """ @@ -453,7 +467,7 @@ class CaptureParamsPaymentDetailsFlightAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsFlightDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -465,15 +479,15 @@ class CaptureParamsPaymentDetailsFlightDelivery(TypedDict): """ class CaptureParamsPaymentDetailsFlightDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -485,19 +499,19 @@ class CaptureParamsPaymentDetailsFlightPassenger(TypedDict): """ class CaptureParamsPaymentDetailsFlightSegment(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The flight segment amount. """ - arrival_airport: NotRequired["str"] + arrival_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the arrival airport. """ - arrives_at: NotRequired["int"] + arrives_at: NotRequired[int] """ The arrival time for the flight segment. Measured in seconds since the Unix epoch. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment. """ @@ -505,16 +519,16 @@ class CaptureParamsPaymentDetailsFlightSegment(TypedDict): """ The departure time for the flight segment. Measured in seconds since the Unix epoch. """ - departure_airport: NotRequired["str"] + departure_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the departure airport. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number associated with the segment """ service_class: NotRequired[ - "Literal['business', 'economy', 'first', 'premium_economy']" + Literal["business", "economy", "first", "premium_economy"] ] """ The fare class for the segment. @@ -527,7 +541,7 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): """ The lodging location's address. """ - adults: NotRequired["int"] + adults: NotRequired[int] """ The number of adults on the booking """ @@ -537,11 +551,11 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): """ Affiliate details for this purchase. """ - booking_number: NotRequired["str"] + booking_number: NotRequired[str] """ The booking number associated with the lodging reservation. """ - category: NotRequired["Literal['hotel', 'vacation_rental']"] + category: NotRequired[Literal["hotel", "vacation_rental"]] """ The lodging category """ @@ -553,11 +567,11 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): """ Lodging check-out time. Measured in seconds since the Unix epoch. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the lodging company. """ - daily_room_rate_amount: NotRequired["int"] + daily_room_rate_amount: NotRequired[int] """ The daily lodging room rate. """ @@ -568,76 +582,87 @@ class CaptureParamsPaymentDetailsLodging(TypedDict): Delivery details for this purchase. """ extra_charges: NotRequired[ - "List[Literal['gift_shop', 'laundry', 'mini_bar', 'other', 'restaurant', 'telephone']]" + List[ + Literal[ + "gift_shop", + "laundry", + "mini_bar", + "other", + "restaurant", + "telephone", + ] + ] ] """ List of additional charges being billed. """ - fire_safety_act_compliance: NotRequired["bool"] + fire_safety_act_compliance: NotRequired[bool] """ Indicates whether the lodging location is compliant with the Fire Safety Act. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the lodging location. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep their booking while failing to cancel the reservation. """ - number_of_rooms: NotRequired["int"] + number_of_rooms: NotRequired[int] """ The number of rooms on the booking """ passengers: NotRequired[ - "List[PaymentIntentService.CaptureParamsPaymentDetailsLodgingPassenger]" + List[ + "PaymentIntentService.CaptureParamsPaymentDetailsLodgingPassenger" + ] ] """ The details of the passengers in the travel reservation """ - property_phone_number: NotRequired["str"] + property_phone_number: NotRequired[str] """ The phone number of the lodging location. """ - room_class: NotRequired["str"] + room_class: NotRequired[str] """ The room class for this purchase. """ - room_nights: NotRequired["int"] + room_nights: NotRequired[int] """ The number of room nights """ - total_room_tax_amount: NotRequired["int"] + total_room_tax_amount: NotRequired[int] """ The total tax amount associating with the room reservation. """ - total_tax_amount: NotRequired["int"] + total_tax_amount: NotRequired[int] """ The total tax amount """ class CaptureParamsPaymentDetailsLodgingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -649,7 +674,7 @@ class CaptureParamsPaymentDetailsLodgingAffiliate(TypedDict): """ class CaptureParamsPaymentDetailsLodgingDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -661,15 +686,15 @@ class CaptureParamsPaymentDetailsLodgingDelivery(TypedDict): """ class CaptureParamsPaymentDetailsLodgingDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -687,7 +712,7 @@ class CaptureParamsPaymentDetailsSubscription(TypedDict): """ Affiliate details for this purchase. """ - auto_renewal: NotRequired["bool"] + auto_renewal: NotRequired[bool] """ Info whether the subscription will be auto renewed upon expiry. """ @@ -697,7 +722,7 @@ class CaptureParamsPaymentDetailsSubscription(TypedDict): """ Subscription billing details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Subscription end time. Measured in seconds since the Unix epoch. """ @@ -705,7 +730,7 @@ class CaptureParamsPaymentDetailsSubscription(TypedDict): """ Name of the product on subscription. e.g. Apple Music Subscription """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Subscription start time. Measured in seconds since the Unix epoch. """ @@ -727,7 +752,7 @@ class CaptureParamsPaymentDetailsSubscriptionBillingInterval(TypedDict): """ class CaptureParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when a charge succeeds. """ @@ -738,26 +763,26 @@ class ConfirmParams(TypedDict): The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. """ - confirmation_token: NotRequired["str"] + confirmation_token: NotRequired[str] """ ID of the ConfirmationToken used to confirm this PaymentIntent. If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence. """ - error_on_requires_action: NotRequired["bool"] + error_on_requires_action: NotRequired[bool] """ Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - mandate: NotRequired["str"] + mandate: NotRequired[str] """ ID of the mandate that's used for this payment. """ @@ -774,7 +799,7 @@ class ConfirmParams(TypedDict): """ Provides industry-specific information about the charge. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. """ @@ -802,7 +827,7 @@ class ConfirmParams(TypedDict): """ Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. @@ -826,7 +851,7 @@ class ConfirmParams(TypedDict): """ Shipping information for this PaymentIntent. """ - use_stripe_sdk: NotRequired["bool"] + use_stripe_sdk: NotRequired[bool] """ Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. """ @@ -840,7 +865,7 @@ class ConfirmParamsMandateData(TypedDict): """ class ConfirmParamsMandateDataCustomerAcceptance(TypedDict): - accepted_at: NotRequired["int"] + accepted_at: NotRequired[int] """ The time at which the customer accepted the Mandate. """ @@ -865,11 +890,11 @@ class ConfirmParamsMandateDataCustomerAcceptanceOffline(TypedDict): pass class ConfirmParamsMandateDataCustomerAcceptanceOnline(TypedDict): - ip_address: NotRequired["str"] + ip_address: NotRequired[str] """ The IP address from which the Mandate was accepted by the customer. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the Mandate was accepted by the customer. """ @@ -917,23 +942,23 @@ class ConfirmParamsPaymentDetailsCarRental(TypedDict): """ The booking number associated with the car rental. """ - car_class_code: NotRequired["str"] + car_class_code: NotRequired[str] """ Class code of the car. """ - car_make: NotRequired["str"] + car_make: NotRequired[str] """ Make of the car. """ - car_model: NotRequired["str"] + car_model: NotRequired[str] """ Model of the car. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the rental car company. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the car rental company. """ @@ -948,18 +973,28 @@ class ConfirmParamsPaymentDetailsCarRental(TypedDict): Delivery details for this purchase. """ drivers: NotRequired[ - "List[PaymentIntentService.ConfirmParamsPaymentDetailsCarRentalDriver]" + List[ + "PaymentIntentService.ConfirmParamsPaymentDetailsCarRentalDriver" + ] ] """ The details of the passengers in the travel reservation """ extra_charges: NotRequired[ - "List[Literal['extra_mileage', 'gas', 'late_return', 'one_way_service', 'parking_violation']]" + List[ + Literal[ + "extra_mileage", + "gas", + "late_return", + "one_way_service", + "parking_violation", + ] + ] ] """ List of additional charges being billed. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep nor cancel their booking. """ @@ -973,15 +1008,15 @@ class ConfirmParamsPaymentDetailsCarRental(TypedDict): """ Car pick-up time. Measured in seconds since the Unix epoch. """ - rate_amount: NotRequired["int"] + rate_amount: NotRequired[int] """ Rental rate. """ - rate_interval: NotRequired["Literal['day', 'month', 'week']"] + rate_interval: NotRequired[Literal["day", "month", "week"]] """ The frequency at which the rate amount is applied. One of `day`, `week` or `month` """ - renter_name: NotRequired["str"] + renter_name: NotRequired[str] """ The name of the person or entity renting the car. """ @@ -995,7 +1030,7 @@ class ConfirmParamsPaymentDetailsCarRental(TypedDict): """ Car return time. Measured in seconds since the Unix epoch. """ - tax_exempt: NotRequired["bool"] + tax_exempt: NotRequired[bool] """ Indicates whether the goods or services are tax-exempt or tax is not collected. """ @@ -1007,7 +1042,7 @@ class ConfirmParamsPaymentDetailsCarRentalAffiliate(TypedDict): """ class ConfirmParamsPaymentDetailsCarRentalDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -1019,15 +1054,15 @@ class ConfirmParamsPaymentDetailsCarRentalDelivery(TypedDict): """ class ConfirmParamsPaymentDetailsCarRentalDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -1039,59 +1074,59 @@ class ConfirmParamsPaymentDetailsCarRentalDriver(TypedDict): """ class ConfirmParamsPaymentDetailsCarRentalPickupAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ConfirmParamsPaymentDetailsCarRentalReturnAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ConfirmParamsPaymentDetailsEventDetails(TypedDict): - access_controlled_venue: NotRequired["bool"] + access_controlled_venue: NotRequired[bool] """ Indicates if the tickets are digitally checked when entering the venue. """ @@ -1107,7 +1142,7 @@ class ConfirmParamsPaymentDetailsEventDetails(TypedDict): """ Affiliate details for this purchase. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the company """ @@ -1117,11 +1152,11 @@ class ConfirmParamsPaymentDetailsEventDetails(TypedDict): """ Delivery details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Event end time. Measured in seconds since the Unix epoch. """ - genre: NotRequired["str"] + genre: NotRequired[str] """ Type of the event entertainment (concert, sports event etc) """ @@ -1129,33 +1164,33 @@ class ConfirmParamsPaymentDetailsEventDetails(TypedDict): """ The name of the event. """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Event start time. Measured in seconds since the Unix epoch. """ class ConfirmParamsPaymentDetailsEventDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1167,7 +1202,7 @@ class ConfirmParamsPaymentDetailsEventDetailsAffiliate(TypedDict): """ class ConfirmParamsPaymentDetailsEventDetailsDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -1179,15 +1214,15 @@ class ConfirmParamsPaymentDetailsEventDetailsDelivery(TypedDict): """ class ConfirmParamsPaymentDetailsEventDetailsDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -1199,11 +1234,11 @@ class ConfirmParamsPaymentDetailsFlight(TypedDict): """ Affiliate details for this purchase. """ - agency_number: NotRequired["str"] + agency_number: NotRequired[str] """ The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket. """ @@ -1213,12 +1248,14 @@ class ConfirmParamsPaymentDetailsFlight(TypedDict): """ Delivery details for this purchase. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the person or entity on the reservation. """ passengers: NotRequired[ - "List[PaymentIntentService.ConfirmParamsPaymentDetailsFlightPassenger]" + List[ + "PaymentIntentService.ConfirmParamsPaymentDetailsFlightPassenger" + ] ] """ The details of the passengers in the travel reservation. @@ -1229,7 +1266,7 @@ class ConfirmParamsPaymentDetailsFlight(TypedDict): """ The individual flight segments associated with the trip. """ - ticket_number: NotRequired["str"] + ticket_number: NotRequired[str] """ The ticket number associated with the travel reservation. """ @@ -1241,7 +1278,7 @@ class ConfirmParamsPaymentDetailsFlightAffiliate(TypedDict): """ class ConfirmParamsPaymentDetailsFlightDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -1253,15 +1290,15 @@ class ConfirmParamsPaymentDetailsFlightDelivery(TypedDict): """ class ConfirmParamsPaymentDetailsFlightDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -1273,19 +1310,19 @@ class ConfirmParamsPaymentDetailsFlightPassenger(TypedDict): """ class ConfirmParamsPaymentDetailsFlightSegment(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The flight segment amount. """ - arrival_airport: NotRequired["str"] + arrival_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the arrival airport. """ - arrives_at: NotRequired["int"] + arrives_at: NotRequired[int] """ The arrival time for the flight segment. Measured in seconds since the Unix epoch. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment. """ @@ -1293,16 +1330,16 @@ class ConfirmParamsPaymentDetailsFlightSegment(TypedDict): """ The departure time for the flight segment. Measured in seconds since the Unix epoch. """ - departure_airport: NotRequired["str"] + departure_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the departure airport. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number associated with the segment """ service_class: NotRequired[ - "Literal['business', 'economy', 'first', 'premium_economy']" + Literal["business", "economy", "first", "premium_economy"] ] """ The fare class for the segment. @@ -1315,7 +1352,7 @@ class ConfirmParamsPaymentDetailsLodging(TypedDict): """ The lodging location's address. """ - adults: NotRequired["int"] + adults: NotRequired[int] """ The number of adults on the booking """ @@ -1325,11 +1362,11 @@ class ConfirmParamsPaymentDetailsLodging(TypedDict): """ Affiliate details for this purchase. """ - booking_number: NotRequired["str"] + booking_number: NotRequired[str] """ The booking number associated with the lodging reservation. """ - category: NotRequired["Literal['hotel', 'vacation_rental']"] + category: NotRequired[Literal["hotel", "vacation_rental"]] """ The lodging category """ @@ -1341,11 +1378,11 @@ class ConfirmParamsPaymentDetailsLodging(TypedDict): """ Lodging check-out time. Measured in seconds since the Unix epoch. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the lodging company. """ - daily_room_rate_amount: NotRequired["int"] + daily_room_rate_amount: NotRequired[int] """ The daily lodging room rate. """ @@ -1356,76 +1393,87 @@ class ConfirmParamsPaymentDetailsLodging(TypedDict): Delivery details for this purchase. """ extra_charges: NotRequired[ - "List[Literal['gift_shop', 'laundry', 'mini_bar', 'other', 'restaurant', 'telephone']]" + List[ + Literal[ + "gift_shop", + "laundry", + "mini_bar", + "other", + "restaurant", + "telephone", + ] + ] ] """ List of additional charges being billed. """ - fire_safety_act_compliance: NotRequired["bool"] + fire_safety_act_compliance: NotRequired[bool] """ Indicates whether the lodging location is compliant with the Fire Safety Act. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the lodging location. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep their booking while failing to cancel the reservation. """ - number_of_rooms: NotRequired["int"] + number_of_rooms: NotRequired[int] """ The number of rooms on the booking """ passengers: NotRequired[ - "List[PaymentIntentService.ConfirmParamsPaymentDetailsLodgingPassenger]" + List[ + "PaymentIntentService.ConfirmParamsPaymentDetailsLodgingPassenger" + ] ] """ The details of the passengers in the travel reservation """ - property_phone_number: NotRequired["str"] + property_phone_number: NotRequired[str] """ The phone number of the lodging location. """ - room_class: NotRequired["str"] + room_class: NotRequired[str] """ The room class for this purchase. """ - room_nights: NotRequired["int"] + room_nights: NotRequired[int] """ The number of room nights """ - total_room_tax_amount: NotRequired["int"] + total_room_tax_amount: NotRequired[int] """ The total tax amount associating with the room reservation. """ - total_tax_amount: NotRequired["int"] + total_tax_amount: NotRequired[int] """ The total tax amount """ class ConfirmParamsPaymentDetailsLodgingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1437,7 +1485,7 @@ class ConfirmParamsPaymentDetailsLodgingAffiliate(TypedDict): """ class ConfirmParamsPaymentDetailsLodgingDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -1449,15 +1497,15 @@ class ConfirmParamsPaymentDetailsLodgingDelivery(TypedDict): """ class ConfirmParamsPaymentDetailsLodgingDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -1475,7 +1523,7 @@ class ConfirmParamsPaymentDetailsSubscription(TypedDict): """ Affiliate details for this purchase. """ - auto_renewal: NotRequired["bool"] + auto_renewal: NotRequired[bool] """ Info whether the subscription will be auto renewed upon expiry. """ @@ -1485,7 +1533,7 @@ class ConfirmParamsPaymentDetailsSubscription(TypedDict): """ Subscription billing details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Subscription end time. Measured in seconds since the Unix epoch. """ @@ -1493,7 +1541,7 @@ class ConfirmParamsPaymentDetailsSubscription(TypedDict): """ Name of the product on subscription. e.g. Apple Music Subscription """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Subscription start time. Measured in seconds since the Unix epoch. """ @@ -1641,7 +1689,7 @@ class ConfirmParamsPaymentMethodData(TypedDict): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -1829,11 +1877,11 @@ class ConfirmParamsPaymentMethodDataAuBecsDebit(TypedDict): """ class ConfirmParamsPaymentMethodDataBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -1862,27 +1910,27 @@ class ConfirmParamsPaymentMethodDataBillingDetails(TypedDict): """ class ConfirmParamsPaymentMethodDataBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1904,14 +1952,43 @@ class ConfirmParamsPaymentMethodDataCustomerBalance(TypedDict): class ConfirmParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class ConfirmParamsPaymentMethodDataFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -1951,7 +2028,24 @@ class ConfirmParamsPaymentMethodDataGrabpay(TypedDict): class ConfirmParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -1999,7 +2093,34 @@ class ConfirmParamsPaymentMethodDataOxxo(TypedDict): class ConfirmParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -2012,15 +2133,15 @@ class ConfirmParamsPaymentMethodDataPaypal(TypedDict): pass class ConfirmParamsPaymentMethodDataPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -2032,7 +2153,7 @@ class ConfirmParamsPaymentMethodDataPromptpay(TypedDict): pass class ConfirmParamsPaymentMethodDataRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -2059,23 +2180,23 @@ class ConfirmParamsPaymentMethodDataTwint(TypedDict): pass class ConfirmParamsPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -2336,7 +2457,7 @@ class ConfirmParamsPaymentMethodOptionsAcssDebit(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -2349,17 +2470,17 @@ class ConfirmParamsPaymentMethodOptionsAcssDebitMandateOptions(TypedDict): The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -2373,11 +2494,11 @@ class ConfirmParamsPaymentMethodOptionsAffirm(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - preferred_locale: NotRequired["str"] + preferred_locale: NotRequired[str] """ Preferred language of the Affirm authorization page that the customer is redirected to. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2397,12 +2518,12 @@ class ConfirmParamsPaymentMethodOptionsAfterpayClearpay(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes. This field differs from the statement descriptor and item name. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2456,7 +2577,7 @@ class ConfirmParamsPaymentMethodOptionsBacsDebit(TypedDict): """ class ConfirmParamsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -2474,7 +2595,7 @@ class ConfirmParamsPaymentMethodOptionsBancontact(TypedDict): """ class ConfirmParamsPaymentMethodOptionsBlik(TypedDict): - code: NotRequired["str"] + code: NotRequired[str] """ The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation. """ @@ -2490,7 +2611,7 @@ class ConfirmParamsPaymentMethodOptionsBlik(TypedDict): """ class ConfirmParamsPaymentMethodOptionsBoleto(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time. """ @@ -2516,7 +2637,7 @@ class ConfirmParamsPaymentMethodOptionsCard(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - cvc_token: NotRequired["str"] + cvc_token: NotRequired[str] """ A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation. """ @@ -2534,51 +2655,63 @@ class ConfirmParamsPaymentMethodOptionsCard(TypedDict): """ Configuration options for setting up an eMandate for cards issued in India. """ - moto: NotRequired["bool"] + moto: NotRequired[bool] """ When specified, this parameter indicates that a transaction will be marked as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time. """ request_decremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent. """ request_extended_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent. """ request_incremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. """ - request_multicapture: NotRequired["Literal['if_available', 'never']"] + request_multicapture: NotRequired[Literal["if_available", "never"]] """ Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent. """ - request_overcapture: NotRequired["Literal['if_available', 'never']"] + request_overcapture: NotRequired[Literal["if_available", "never"]] """ Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ - require_cvc_recollection: NotRequired["bool"] + require_cvc_recollection: NotRequired[bool] """ When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter). """ @@ -2617,7 +2750,7 @@ class ConfirmParamsPaymentMethodOptionsCard(TypedDict): """ class ConfirmParamsPaymentMethodOptionsCardInstallments(TypedDict): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Setting to true enables installments for this PaymentIntent. This will cause the response to contain a list of available installment plans. @@ -2655,11 +2788,11 @@ class ConfirmParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ @@ -2667,7 +2800,7 @@ class ConfirmParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ @@ -2679,22 +2812,22 @@ class ConfirmParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ - supported_types: NotRequired["List[Literal['india']]"] + supported_types: NotRequired[List[Literal["india"]]] """ Specifies the type of mandates supported. Possible values are `india`. """ class ConfirmParamsPaymentMethodOptionsCardPresent(TypedDict): - request_extended_authorization: NotRequired["bool"] + request_extended_authorization: NotRequired[bool] """ Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity) """ - request_incremental_authorization_support: NotRequired["bool"] + request_incremental_authorization_support: NotRequired[bool] """ Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. """ request_incremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ This field was released by mistake and will be removed in the next major version @@ -2707,7 +2840,7 @@ class ConfirmParamsPaymentMethodOptionsCardStatementDetails(TypedDict): """ Please pass in an address that is within your Stripe user account country """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Phone number (e.g., a toll-free number that customers can call) """ @@ -2715,34 +2848,34 @@ class ConfirmParamsPaymentMethodOptionsCardStatementDetails(TypedDict): class ConfirmParamsPaymentMethodOptionsCardStatementDetailsAddress( TypedDict, ): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ConfirmParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): ares_trans_status: NotRequired[ - "Literal['A', 'C', 'I', 'N', 'R', 'U', 'Y']" + Literal["A", "C", "I", "N", "R", "U", "Y"] ] """ The `transStatus` returned from the card Issuer's ACS in the ARes. @@ -2755,13 +2888,13 @@ class ConfirmParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): is what you should specify here.) """ electronic_commerce_indicator: NotRequired[ - "Literal['01', '02', '05', '06', '07']" + Literal["01", "02", "05", "06", "07"] ] """ The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed. """ - exemption_indicator: NotRequired["Literal['low_risk', 'none']"] + exemption_indicator: NotRequired[Literal["low_risk", "none"]] """ The exemption requested via 3DS and accepted by the issuer at authentication time. """ @@ -2773,7 +2906,7 @@ class ConfirmParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly """ - requestor_challenge_indicator: NotRequired["str"] + requestor_challenge_indicator: NotRequired[str] """ The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99. @@ -2807,14 +2940,14 @@ class ConfirmParamsPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBanca to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`. messageExtension: CB-AVALGO """ - cb_exemption: NotRequired["str"] + cb_exemption: NotRequired[str] """ The exemption indicator returned from Cartes Bancaires in the ARes. message extension: CB-EXEMPTION; string (4 characters) This is a 3 byte bitmap (low significant byte first and most significant bit first) that has been Base64 encoded """ - cb_score: NotRequired["int"] + cb_score: NotRequired[int] """ The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99 @@ -2849,11 +2982,11 @@ class ConfirmParamsPaymentMethodOptionsCustomerBalance(TypedDict): """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["Literal['bank_transfer']"] + funding_type: NotRequired[Literal["bank_transfer"]] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2874,7 +3007,17 @@ class ConfirmParamsPaymentMethodOptionsCustomerBalanceBankTransfer( Configuration for the eu_bank_transfer funding type. """ requested_address_types: NotRequired[ - "List[Literal['aba', 'iban', 'sepa', 'sort_code', 'spei', 'swift', 'zengin']]" + List[ + Literal[ + "aba", + "iban", + "sepa", + "sort_code", + "spei", + "swift", + "zengin", + ] + ] ] """ List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. @@ -2901,7 +3044,7 @@ class ConfirmParamsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer """ class ConfirmParamsPaymentMethodOptionsEps(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2913,7 +3056,7 @@ class ConfirmParamsPaymentMethodOptionsEps(TypedDict): """ class ConfirmParamsPaymentMethodOptionsFpx(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2925,7 +3068,7 @@ class ConfirmParamsPaymentMethodOptionsFpx(TypedDict): """ class ConfirmParamsPaymentMethodOptionsGiropay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2937,7 +3080,7 @@ class ConfirmParamsPaymentMethodOptionsGiropay(TypedDict): """ class ConfirmParamsPaymentMethodOptionsGrabpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2975,12 +3118,57 @@ class ConfirmParamsPaymentMethodOptionsKlarna(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-CH', 'de-DE', 'el-GR', 'en-AT', 'en-AU', 'en-BE', 'en-CA', 'en-CH', 'en-CZ', 'en-DE', 'en-DK', 'en-ES', 'en-FI', 'en-FR', 'en-GB', 'en-GR', 'en-IE', 'en-IT', 'en-NL', 'en-NO', 'en-NZ', 'en-PL', 'en-PT', 'en-SE', 'en-US', 'es-ES', 'es-US', 'fi-FI', 'fr-BE', 'fr-CA', 'fr-CH', 'fr-FR', 'it-CH', 'it-IT', 'nb-NO', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sv-FI', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-CH", + "de-DE", + "el-GR", + "en-AT", + "en-AU", + "en-BE", + "en-CA", + "en-CH", + "en-CZ", + "en-DE", + "en-DK", + "en-ES", + "en-FI", + "en-FR", + "en-GB", + "en-GR", + "en-IE", + "en-IT", + "en-NL", + "en-NO", + "en-NZ", + "en-PL", + "en-PT", + "en-SE", + "en-US", + "es-ES", + "es-US", + "fi-FI", + "fr-BE", + "fr-CA", + "fr-CH", + "fr-FR", + "it-CH", + "it-IT", + "nb-NO", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sv-FI", + "sv-SE", + ] ] """ Preferred language of the Klarna authorization page that the customer is redirected to """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -3008,7 +3196,7 @@ class ConfirmParamsPaymentMethodOptionsKonbini(TypedDict): """ A product descriptor of up to 22 characters, which will appear to customers at the convenience store. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -3028,7 +3216,7 @@ class ConfirmParamsPaymentMethodOptionsLink(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ @@ -3054,7 +3242,7 @@ class ConfirmParamsPaymentMethodOptionsMobilepay(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -3066,7 +3254,7 @@ class ConfirmParamsPaymentMethodOptionsMobilepay(TypedDict): """ class ConfirmParamsPaymentMethodOptionsMultibanco(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -3078,11 +3266,11 @@ class ConfirmParamsPaymentMethodOptionsMultibanco(TypedDict): """ class ConfirmParamsPaymentMethodOptionsOxxo(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -3094,7 +3282,7 @@ class ConfirmParamsPaymentMethodOptionsOxxo(TypedDict): """ class ConfirmParamsPaymentMethodOptionsP24(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -3104,13 +3292,13 @@ class ConfirmParamsPaymentMethodOptionsP24(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - tos_shown_and_accepted: NotRequired["bool"] + tos_shown_and_accepted: NotRequired[bool] """ Confirm that the payer has accepted the P24 terms and conditions. """ class ConfirmParamsPaymentMethodOptionsPaynow(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -3127,20 +3315,42 @@ class ConfirmParamsPaymentMethodOptionsPaypal(TypedDict): Controls when the funds will be captured from the customer's account. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-DE', 'de-LU', 'el-GR', 'en-GB', 'en-US', 'es-ES', 'fi-FI', 'fr-BE', 'fr-FR', 'fr-LU', 'hu-HU', 'it-IT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sk-SK', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-DE", + "de-LU", + "el-GR", + "en-GB", + "en-US", + "es-ES", + "fi-FI", + "fr-BE", + "fr-FR", + "fr-LU", + "hu-HU", + "it-IT", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sk-SK", + "sv-SE", + ] ] """ [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - reference_id: NotRequired["str"] + reference_id: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - risk_correlation_id: NotRequired["str"] + risk_correlation_id: NotRequired[str] """ The risk correlation ID for an on-session payment using a saved PayPal payment method. """ @@ -3156,7 +3366,7 @@ class ConfirmParamsPaymentMethodOptionsPaypal(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - subsellers: NotRequired["List[str]"] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -3182,45 +3392,66 @@ class ConfirmParamsPaymentMethodOptionsPayto(TypedDict): """ class ConfirmParamsPaymentMethodOptionsPaytoMandateOptions(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount that will be collected. It is required when `amount_type` is `fixed`. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. """ - end_date: NotRequired["str"] + end_date: NotRequired[str] """ Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. """ payment_schedule: NotRequired[ - "Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] ] """ The periodicity at which payments will be collected. """ - payments_per_period: NotRequired["int"] + payments_per_period: NotRequired[int] """ The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. """ purpose: NotRequired[ - "Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] ] """ The purpose for which payments are made. Defaults to retail. """ class ConfirmParamsPaymentMethodOptionsPix(TypedDict): - expires_after_seconds: NotRequired["int"] + expires_after_seconds: NotRequired[int] """ The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -3232,7 +3463,7 @@ class ConfirmParamsPaymentMethodOptionsPix(TypedDict): """ class ConfirmParamsPaymentMethodOptionsPromptpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -3303,7 +3534,7 @@ class ConfirmParamsPaymentMethodOptionsSwish(TypedDict): """ The order ID displayed in the Swish app after the payment is authorized. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -3352,7 +3583,7 @@ class ConfirmParamsPaymentMethodOptionsUsBankAccount(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -3368,18 +3599,29 @@ class ConfirmParamsPaymentMethodOptionsUsBankAccountFinancialConnections( Customize manual entry behavior """ permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ @@ -3401,13 +3643,13 @@ class ConfirmParamsPaymentMethodOptionsUsBankAccountMandateOptions( """ class ConfirmParamsPaymentMethodOptionsUsBankAccountNetworks(TypedDict): - requested: NotRequired["List[Literal['ach', 'us_domestic_wire']]"] + requested: NotRequired[List[Literal["ach", "us_domestic_wire"]]] """ Triggers validations to run across the selected networks """ class ConfirmParamsPaymentMethodOptionsWechatPay(TypedDict): - app_id: NotRequired["str"] + app_id: NotRequired[str] """ The app ID registered with WeChat Pay. Only required when client is ios or android. """ @@ -3415,7 +3657,7 @@ class ConfirmParamsPaymentMethodOptionsWechatPay(TypedDict): """ The client type that the end customer will pay from """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -3427,7 +3669,7 @@ class ConfirmParamsPaymentMethodOptionsWechatPay(TypedDict): """ class ConfirmParamsPaymentMethodOptionsZip(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -3439,7 +3681,7 @@ class ConfirmParamsPaymentMethodOptionsZip(TypedDict): """ class ConfirmParamsRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -3449,7 +3691,7 @@ class ConfirmParamsShipping(TypedDict): """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ @@ -3457,37 +3699,37 @@ class ConfirmParamsShipping(TypedDict): """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class ConfirmParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -3497,7 +3739,7 @@ class CreateParams(TypedDict): """ Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ @@ -3508,20 +3750,20 @@ class CreateParams(TypedDict): When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters. """ capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. """ - confirm: NotRequired["bool"] + confirm: NotRequired[bool] """ Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm). """ - confirmation_method: NotRequired["Literal['automatic', 'manual']"] + confirmation_method: NotRequired[Literal["automatic", "manual"]] """ Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. """ - confirmation_token: NotRequired["str"] + confirmation_token: NotRequired[str] """ ID of the ConfirmationToken used to confirm this PaymentIntent. @@ -3531,7 +3773,7 @@ class CreateParams(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ ID of the Customer this PaymentIntent belongs to, if one exists. @@ -3539,19 +3781,19 @@ class CreateParams(TypedDict): If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - error_on_requires_action: NotRequired["bool"] + error_on_requires_action: NotRequired[bool] """ Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - mandate: NotRequired["str"] + mandate: NotRequired[str] """ ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). """ @@ -3561,7 +3803,7 @@ class CreateParams(TypedDict): """ This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -3569,7 +3811,7 @@ class CreateParams(TypedDict): """ Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ @@ -3579,13 +3821,13 @@ class CreateParams(TypedDict): """ Provides industry-specific information about the charge. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent. If you don't provide the `payment_method` parameter or the `source` parameter with `confirm=true`, `source` automatically populates with `customer.default_source` to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward. """ - payment_method_configuration: NotRequired["str"] + payment_method_configuration: NotRequired[str] """ The ID of the payment method configuration to use with this PaymentIntent. """ @@ -3603,7 +3845,7 @@ class CreateParams(TypedDict): """ Payment method-specific configuration for this PaymentIntent. """ - payment_method_types: NotRequired["List[str]"] + payment_method_types: NotRequired[List[str]] """ The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, it defaults to ["card"]. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). """ @@ -3613,19 +3855,19 @@ class CreateParams(TypedDict): """ Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session). """ - receipt_email: NotRequired["str"] + receipt_email: NotRequired[str] """ Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails). """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). """ - secret_key_confirmation: NotRequired["Literal['optional', 'required']"] + secret_key_confirmation: NotRequired[Literal["optional", "required"]] """ Indicates whether confirmation for this PaymentIntent using a secret key is `required` or `optional`. """ - setup_future_usage: NotRequired["Literal['off_session', 'on_session']"] + setup_future_usage: NotRequired[Literal["off_session", "on_session"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -3637,11 +3879,11 @@ class CreateParams(TypedDict): """ Shipping information for this PaymentIntent. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. The concatenated descriptor must contain 1-22 characters. """ @@ -3652,17 +3894,17 @@ class CreateParams(TypedDict): The parameters that you can use to automatically create a Transfer. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). """ - use_stripe_sdk: NotRequired["bool"] + use_stripe_sdk: NotRequired[bool] """ Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. """ class CreateParamsAutomaticPaymentMethods(TypedDict): - allow_redirects: NotRequired["Literal['always', 'never']"] + allow_redirects: NotRequired[Literal["always", "never"]] """ Controls whether this PaymentIntent will accept redirect-based payment methods. @@ -3680,7 +3922,7 @@ class CreateParamsMandateData(TypedDict): """ class CreateParamsMandateDataCustomerAcceptance(TypedDict): - accepted_at: NotRequired["int"] + accepted_at: NotRequired[int] """ The time at which the customer accepted the Mandate. """ @@ -3757,23 +3999,23 @@ class CreateParamsPaymentDetailsCarRental(TypedDict): """ The booking number associated with the car rental. """ - car_class_code: NotRequired["str"] + car_class_code: NotRequired[str] """ Class code of the car. """ - car_make: NotRequired["str"] + car_make: NotRequired[str] """ Make of the car. """ - car_model: NotRequired["str"] + car_model: NotRequired[str] """ Model of the car. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the rental car company. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the car rental company. """ @@ -3788,18 +4030,28 @@ class CreateParamsPaymentDetailsCarRental(TypedDict): Delivery details for this purchase. """ drivers: NotRequired[ - "List[PaymentIntentService.CreateParamsPaymentDetailsCarRentalDriver]" + List[ + "PaymentIntentService.CreateParamsPaymentDetailsCarRentalDriver" + ] ] """ The details of the passengers in the travel reservation """ extra_charges: NotRequired[ - "List[Literal['extra_mileage', 'gas', 'late_return', 'one_way_service', 'parking_violation']]" + List[ + Literal[ + "extra_mileage", + "gas", + "late_return", + "one_way_service", + "parking_violation", + ] + ] ] """ List of additional charges being billed. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep nor cancel their booking. """ @@ -3813,15 +4065,15 @@ class CreateParamsPaymentDetailsCarRental(TypedDict): """ Car pick-up time. Measured in seconds since the Unix epoch. """ - rate_amount: NotRequired["int"] + rate_amount: NotRequired[int] """ Rental rate. """ - rate_interval: NotRequired["Literal['day', 'month', 'week']"] + rate_interval: NotRequired[Literal["day", "month", "week"]] """ The frequency at which the rate amount is applied. One of `day`, `week` or `month` """ - renter_name: NotRequired["str"] + renter_name: NotRequired[str] """ The name of the person or entity renting the car. """ @@ -3835,7 +4087,7 @@ class CreateParamsPaymentDetailsCarRental(TypedDict): """ Car return time. Measured in seconds since the Unix epoch. """ - tax_exempt: NotRequired["bool"] + tax_exempt: NotRequired[bool] """ Indicates whether the goods or services are tax-exempt or tax is not collected. """ @@ -3847,7 +4099,7 @@ class CreateParamsPaymentDetailsCarRentalAffiliate(TypedDict): """ class CreateParamsPaymentDetailsCarRentalDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -3859,15 +4111,15 @@ class CreateParamsPaymentDetailsCarRentalDelivery(TypedDict): """ class CreateParamsPaymentDetailsCarRentalDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -3879,59 +4131,59 @@ class CreateParamsPaymentDetailsCarRentalDriver(TypedDict): """ class CreateParamsPaymentDetailsCarRentalPickupAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsPaymentDetailsCarRentalReturnAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsPaymentDetailsEventDetails(TypedDict): - access_controlled_venue: NotRequired["bool"] + access_controlled_venue: NotRequired[bool] """ Indicates if the tickets are digitally checked when entering the venue. """ @@ -3947,7 +4199,7 @@ class CreateParamsPaymentDetailsEventDetails(TypedDict): """ Affiliate details for this purchase. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the company """ @@ -3957,11 +4209,11 @@ class CreateParamsPaymentDetailsEventDetails(TypedDict): """ Delivery details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Event end time. Measured in seconds since the Unix epoch. """ - genre: NotRequired["str"] + genre: NotRequired[str] """ Type of the event entertainment (concert, sports event etc) """ @@ -3969,33 +4221,33 @@ class CreateParamsPaymentDetailsEventDetails(TypedDict): """ The name of the event. """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Event start time. Measured in seconds since the Unix epoch. """ class CreateParamsPaymentDetailsEventDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -4007,7 +4259,7 @@ class CreateParamsPaymentDetailsEventDetailsAffiliate(TypedDict): """ class CreateParamsPaymentDetailsEventDetailsDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -4019,15 +4271,15 @@ class CreateParamsPaymentDetailsEventDetailsDelivery(TypedDict): """ class CreateParamsPaymentDetailsEventDetailsDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -4039,11 +4291,11 @@ class CreateParamsPaymentDetailsFlight(TypedDict): """ Affiliate details for this purchase. """ - agency_number: NotRequired["str"] + agency_number: NotRequired[str] """ The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket. """ @@ -4053,12 +4305,14 @@ class CreateParamsPaymentDetailsFlight(TypedDict): """ Delivery details for this purchase. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the person or entity on the reservation. """ passengers: NotRequired[ - "List[PaymentIntentService.CreateParamsPaymentDetailsFlightPassenger]" + List[ + "PaymentIntentService.CreateParamsPaymentDetailsFlightPassenger" + ] ] """ The details of the passengers in the travel reservation. @@ -4069,7 +4323,7 @@ class CreateParamsPaymentDetailsFlight(TypedDict): """ The individual flight segments associated with the trip. """ - ticket_number: NotRequired["str"] + ticket_number: NotRequired[str] """ The ticket number associated with the travel reservation. """ @@ -4081,7 +4335,7 @@ class CreateParamsPaymentDetailsFlightAffiliate(TypedDict): """ class CreateParamsPaymentDetailsFlightDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -4093,15 +4347,15 @@ class CreateParamsPaymentDetailsFlightDelivery(TypedDict): """ class CreateParamsPaymentDetailsFlightDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -4113,19 +4367,19 @@ class CreateParamsPaymentDetailsFlightPassenger(TypedDict): """ class CreateParamsPaymentDetailsFlightSegment(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The flight segment amount. """ - arrival_airport: NotRequired["str"] + arrival_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the arrival airport. """ - arrives_at: NotRequired["int"] + arrives_at: NotRequired[int] """ The arrival time for the flight segment. Measured in seconds since the Unix epoch. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment. """ @@ -4133,16 +4387,16 @@ class CreateParamsPaymentDetailsFlightSegment(TypedDict): """ The departure time for the flight segment. Measured in seconds since the Unix epoch. """ - departure_airport: NotRequired["str"] + departure_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the departure airport. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number associated with the segment """ service_class: NotRequired[ - "Literal['business', 'economy', 'first', 'premium_economy']" + Literal["business", "economy", "first", "premium_economy"] ] """ The fare class for the segment. @@ -4155,7 +4409,7 @@ class CreateParamsPaymentDetailsLodging(TypedDict): """ The lodging location's address. """ - adults: NotRequired["int"] + adults: NotRequired[int] """ The number of adults on the booking """ @@ -4165,11 +4419,11 @@ class CreateParamsPaymentDetailsLodging(TypedDict): """ Affiliate details for this purchase. """ - booking_number: NotRequired["str"] + booking_number: NotRequired[str] """ The booking number associated with the lodging reservation. """ - category: NotRequired["Literal['hotel', 'vacation_rental']"] + category: NotRequired[Literal["hotel", "vacation_rental"]] """ The lodging category """ @@ -4181,11 +4435,11 @@ class CreateParamsPaymentDetailsLodging(TypedDict): """ Lodging check-out time. Measured in seconds since the Unix epoch. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the lodging company. """ - daily_room_rate_amount: NotRequired["int"] + daily_room_rate_amount: NotRequired[int] """ The daily lodging room rate. """ @@ -4196,76 +4450,87 @@ class CreateParamsPaymentDetailsLodging(TypedDict): Delivery details for this purchase. """ extra_charges: NotRequired[ - "List[Literal['gift_shop', 'laundry', 'mini_bar', 'other', 'restaurant', 'telephone']]" + List[ + Literal[ + "gift_shop", + "laundry", + "mini_bar", + "other", + "restaurant", + "telephone", + ] + ] ] """ List of additional charges being billed. """ - fire_safety_act_compliance: NotRequired["bool"] + fire_safety_act_compliance: NotRequired[bool] """ Indicates whether the lodging location is compliant with the Fire Safety Act. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the lodging location. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep their booking while failing to cancel the reservation. """ - number_of_rooms: NotRequired["int"] + number_of_rooms: NotRequired[int] """ The number of rooms on the booking """ passengers: NotRequired[ - "List[PaymentIntentService.CreateParamsPaymentDetailsLodgingPassenger]" + List[ + "PaymentIntentService.CreateParamsPaymentDetailsLodgingPassenger" + ] ] """ The details of the passengers in the travel reservation """ - property_phone_number: NotRequired["str"] + property_phone_number: NotRequired[str] """ The phone number of the lodging location. """ - room_class: NotRequired["str"] + room_class: NotRequired[str] """ The room class for this purchase. """ - room_nights: NotRequired["int"] + room_nights: NotRequired[int] """ The number of room nights """ - total_room_tax_amount: NotRequired["int"] + total_room_tax_amount: NotRequired[int] """ The total tax amount associating with the room reservation. """ - total_tax_amount: NotRequired["int"] + total_tax_amount: NotRequired[int] """ The total tax amount """ class CreateParamsPaymentDetailsLodgingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -4277,7 +4542,7 @@ class CreateParamsPaymentDetailsLodgingAffiliate(TypedDict): """ class CreateParamsPaymentDetailsLodgingDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -4289,15 +4554,15 @@ class CreateParamsPaymentDetailsLodgingDelivery(TypedDict): """ class CreateParamsPaymentDetailsLodgingDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -4315,7 +4580,7 @@ class CreateParamsPaymentDetailsSubscription(TypedDict): """ Affiliate details for this purchase. """ - auto_renewal: NotRequired["bool"] + auto_renewal: NotRequired[bool] """ Info whether the subscription will be auto renewed upon expiry. """ @@ -4325,7 +4590,7 @@ class CreateParamsPaymentDetailsSubscription(TypedDict): """ Subscription billing details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Subscription end time. Measured in seconds since the Unix epoch. """ @@ -4333,7 +4598,7 @@ class CreateParamsPaymentDetailsSubscription(TypedDict): """ Name of the product on subscription. e.g. Apple Music Subscription """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Subscription start time. Measured in seconds since the Unix epoch. """ @@ -4481,7 +4746,7 @@ class CreateParamsPaymentMethodData(TypedDict): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -4669,11 +4934,11 @@ class CreateParamsPaymentMethodDataAuBecsDebit(TypedDict): """ class CreateParamsPaymentMethodDataBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -4702,27 +4967,27 @@ class CreateParamsPaymentMethodDataBillingDetails(TypedDict): """ class CreateParamsPaymentMethodDataBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -4744,14 +5009,43 @@ class CreateParamsPaymentMethodDataCustomerBalance(TypedDict): class CreateParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class CreateParamsPaymentMethodDataFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -4791,7 +5085,24 @@ class CreateParamsPaymentMethodDataGrabpay(TypedDict): class CreateParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -4839,7 +5150,34 @@ class CreateParamsPaymentMethodDataOxxo(TypedDict): class CreateParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -4852,15 +5190,15 @@ class CreateParamsPaymentMethodDataPaypal(TypedDict): pass class CreateParamsPaymentMethodDataPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -4872,7 +5210,7 @@ class CreateParamsPaymentMethodDataPromptpay(TypedDict): pass class CreateParamsPaymentMethodDataRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -4899,23 +5237,23 @@ class CreateParamsPaymentMethodDataTwint(TypedDict): pass class CreateParamsPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -5176,7 +5514,7 @@ class CreateParamsPaymentMethodOptionsAcssDebit(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -5189,17 +5527,17 @@ class CreateParamsPaymentMethodOptionsAcssDebitMandateOptions(TypedDict): The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -5213,11 +5551,11 @@ class CreateParamsPaymentMethodOptionsAffirm(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - preferred_locale: NotRequired["str"] + preferred_locale: NotRequired[str] """ Preferred language of the Affirm authorization page that the customer is redirected to. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5237,12 +5575,12 @@ class CreateParamsPaymentMethodOptionsAfterpayClearpay(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes. This field differs from the statement descriptor and item name. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5296,7 +5634,7 @@ class CreateParamsPaymentMethodOptionsBacsDebit(TypedDict): """ class CreateParamsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -5314,7 +5652,7 @@ class CreateParamsPaymentMethodOptionsBancontact(TypedDict): """ class CreateParamsPaymentMethodOptionsBlik(TypedDict): - code: NotRequired["str"] + code: NotRequired[str] """ The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation. """ @@ -5330,7 +5668,7 @@ class CreateParamsPaymentMethodOptionsBlik(TypedDict): """ class CreateParamsPaymentMethodOptionsBoleto(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time. """ @@ -5356,7 +5694,7 @@ class CreateParamsPaymentMethodOptionsCard(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - cvc_token: NotRequired["str"] + cvc_token: NotRequired[str] """ A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation. """ @@ -5374,51 +5712,63 @@ class CreateParamsPaymentMethodOptionsCard(TypedDict): """ Configuration options for setting up an eMandate for cards issued in India. """ - moto: NotRequired["bool"] + moto: NotRequired[bool] """ When specified, this parameter indicates that a transaction will be marked as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time. """ request_decremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent. """ request_extended_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent. """ request_incremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. """ - request_multicapture: NotRequired["Literal['if_available', 'never']"] + request_multicapture: NotRequired[Literal["if_available", "never"]] """ Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent. """ - request_overcapture: NotRequired["Literal['if_available', 'never']"] + request_overcapture: NotRequired[Literal["if_available", "never"]] """ Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ - require_cvc_recollection: NotRequired["bool"] + require_cvc_recollection: NotRequired[bool] """ When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter). """ @@ -5457,7 +5807,7 @@ class CreateParamsPaymentMethodOptionsCard(TypedDict): """ class CreateParamsPaymentMethodOptionsCardInstallments(TypedDict): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Setting to true enables installments for this PaymentIntent. This will cause the response to contain a list of available installment plans. @@ -5495,11 +5845,11 @@ class CreateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ @@ -5507,7 +5857,7 @@ class CreateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ @@ -5519,22 +5869,22 @@ class CreateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ - supported_types: NotRequired["List[Literal['india']]"] + supported_types: NotRequired[List[Literal["india"]]] """ Specifies the type of mandates supported. Possible values are `india`. """ class CreateParamsPaymentMethodOptionsCardPresent(TypedDict): - request_extended_authorization: NotRequired["bool"] + request_extended_authorization: NotRequired[bool] """ Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity) """ - request_incremental_authorization_support: NotRequired["bool"] + request_incremental_authorization_support: NotRequired[bool] """ Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. """ request_incremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ This field was released by mistake and will be removed in the next major version @@ -5547,7 +5897,7 @@ class CreateParamsPaymentMethodOptionsCardStatementDetails(TypedDict): """ Please pass in an address that is within your Stripe user account country """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Phone number (e.g., a toll-free number that customers can call) """ @@ -5555,34 +5905,34 @@ class CreateParamsPaymentMethodOptionsCardStatementDetails(TypedDict): class CreateParamsPaymentMethodOptionsCardStatementDetailsAddress( TypedDict, ): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): ares_trans_status: NotRequired[ - "Literal['A', 'C', 'I', 'N', 'R', 'U', 'Y']" + Literal["A", "C", "I", "N", "R", "U", "Y"] ] """ The `transStatus` returned from the card Issuer's ACS in the ARes. @@ -5595,13 +5945,13 @@ class CreateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): is what you should specify here.) """ electronic_commerce_indicator: NotRequired[ - "Literal['01', '02', '05', '06', '07']" + Literal["01", "02", "05", "06", "07"] ] """ The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed. """ - exemption_indicator: NotRequired["Literal['low_risk', 'none']"] + exemption_indicator: NotRequired[Literal["low_risk", "none"]] """ The exemption requested via 3DS and accepted by the issuer at authentication time. """ @@ -5613,7 +5963,7 @@ class CreateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly """ - requestor_challenge_indicator: NotRequired["str"] + requestor_challenge_indicator: NotRequired[str] """ The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99. @@ -5647,14 +5997,14 @@ class CreateParamsPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancai to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`. messageExtension: CB-AVALGO """ - cb_exemption: NotRequired["str"] + cb_exemption: NotRequired[str] """ The exemption indicator returned from Cartes Bancaires in the ARes. message extension: CB-EXEMPTION; string (4 characters) This is a 3 byte bitmap (low significant byte first and most significant bit first) that has been Base64 encoded """ - cb_score: NotRequired["int"] + cb_score: NotRequired[int] """ The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99 @@ -5689,11 +6039,11 @@ class CreateParamsPaymentMethodOptionsCustomerBalance(TypedDict): """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["Literal['bank_transfer']"] + funding_type: NotRequired[Literal["bank_transfer"]] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5714,7 +6064,17 @@ class CreateParamsPaymentMethodOptionsCustomerBalanceBankTransfer( Configuration for the eu_bank_transfer funding type. """ requested_address_types: NotRequired[ - "List[Literal['aba', 'iban', 'sepa', 'sort_code', 'spei', 'swift', 'zengin']]" + List[ + Literal[ + "aba", + "iban", + "sepa", + "sort_code", + "spei", + "swift", + "zengin", + ] + ] ] """ List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. @@ -5741,7 +6101,7 @@ class CreateParamsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer( """ class CreateParamsPaymentMethodOptionsEps(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5753,7 +6113,7 @@ class CreateParamsPaymentMethodOptionsEps(TypedDict): """ class CreateParamsPaymentMethodOptionsFpx(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5765,7 +6125,7 @@ class CreateParamsPaymentMethodOptionsFpx(TypedDict): """ class CreateParamsPaymentMethodOptionsGiropay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5777,7 +6137,7 @@ class CreateParamsPaymentMethodOptionsGiropay(TypedDict): """ class CreateParamsPaymentMethodOptionsGrabpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5815,12 +6175,57 @@ class CreateParamsPaymentMethodOptionsKlarna(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-CH', 'de-DE', 'el-GR', 'en-AT', 'en-AU', 'en-BE', 'en-CA', 'en-CH', 'en-CZ', 'en-DE', 'en-DK', 'en-ES', 'en-FI', 'en-FR', 'en-GB', 'en-GR', 'en-IE', 'en-IT', 'en-NL', 'en-NO', 'en-NZ', 'en-PL', 'en-PT', 'en-SE', 'en-US', 'es-ES', 'es-US', 'fi-FI', 'fr-BE', 'fr-CA', 'fr-CH', 'fr-FR', 'it-CH', 'it-IT', 'nb-NO', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sv-FI', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-CH", + "de-DE", + "el-GR", + "en-AT", + "en-AU", + "en-BE", + "en-CA", + "en-CH", + "en-CZ", + "en-DE", + "en-DK", + "en-ES", + "en-FI", + "en-FR", + "en-GB", + "en-GR", + "en-IE", + "en-IT", + "en-NL", + "en-NO", + "en-NZ", + "en-PL", + "en-PT", + "en-SE", + "en-US", + "es-ES", + "es-US", + "fi-FI", + "fr-BE", + "fr-CA", + "fr-CH", + "fr-FR", + "it-CH", + "it-IT", + "nb-NO", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sv-FI", + "sv-SE", + ] ] """ Preferred language of the Klarna authorization page that the customer is redirected to """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5848,7 +6253,7 @@ class CreateParamsPaymentMethodOptionsKonbini(TypedDict): """ A product descriptor of up to 22 characters, which will appear to customers at the convenience store. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5868,7 +6273,7 @@ class CreateParamsPaymentMethodOptionsLink(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ @@ -5894,7 +6299,7 @@ class CreateParamsPaymentMethodOptionsMobilepay(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5906,7 +6311,7 @@ class CreateParamsPaymentMethodOptionsMobilepay(TypedDict): """ class CreateParamsPaymentMethodOptionsMultibanco(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5918,11 +6323,11 @@ class CreateParamsPaymentMethodOptionsMultibanco(TypedDict): """ class CreateParamsPaymentMethodOptionsOxxo(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5934,7 +6339,7 @@ class CreateParamsPaymentMethodOptionsOxxo(TypedDict): """ class CreateParamsPaymentMethodOptionsP24(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5944,13 +6349,13 @@ class CreateParamsPaymentMethodOptionsP24(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - tos_shown_and_accepted: NotRequired["bool"] + tos_shown_and_accepted: NotRequired[bool] """ Confirm that the payer has accepted the P24 terms and conditions. """ class CreateParamsPaymentMethodOptionsPaynow(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5967,20 +6372,42 @@ class CreateParamsPaymentMethodOptionsPaypal(TypedDict): Controls when the funds will be captured from the customer's account. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-DE', 'de-LU', 'el-GR', 'en-GB', 'en-US', 'es-ES', 'fi-FI', 'fr-BE', 'fr-FR', 'fr-LU', 'hu-HU', 'it-IT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sk-SK', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-DE", + "de-LU", + "el-GR", + "en-GB", + "en-US", + "es-ES", + "fi-FI", + "fr-BE", + "fr-FR", + "fr-LU", + "hu-HU", + "it-IT", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sk-SK", + "sv-SE", + ] ] """ [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - reference_id: NotRequired["str"] + reference_id: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - risk_correlation_id: NotRequired["str"] + risk_correlation_id: NotRequired[str] """ The risk correlation ID for an on-session payment using a saved PayPal payment method. """ @@ -5996,7 +6423,7 @@ class CreateParamsPaymentMethodOptionsPaypal(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - subsellers: NotRequired["List[str]"] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -6022,45 +6449,66 @@ class CreateParamsPaymentMethodOptionsPayto(TypedDict): """ class CreateParamsPaymentMethodOptionsPaytoMandateOptions(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount that will be collected. It is required when `amount_type` is `fixed`. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. """ - end_date: NotRequired["str"] + end_date: NotRequired[str] """ Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. """ payment_schedule: NotRequired[ - "Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] ] """ The periodicity at which payments will be collected. """ - payments_per_period: NotRequired["int"] + payments_per_period: NotRequired[int] """ The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. """ purpose: NotRequired[ - "Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] ] """ The purpose for which payments are made. Defaults to retail. """ class CreateParamsPaymentMethodOptionsPix(TypedDict): - expires_after_seconds: NotRequired["int"] + expires_after_seconds: NotRequired[int] """ The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -6072,7 +6520,7 @@ class CreateParamsPaymentMethodOptionsPix(TypedDict): """ class CreateParamsPaymentMethodOptionsPromptpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -6143,7 +6591,7 @@ class CreateParamsPaymentMethodOptionsSwish(TypedDict): """ The order ID displayed in the Swish app after the payment is authorized. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -6192,7 +6640,7 @@ class CreateParamsPaymentMethodOptionsUsBankAccount(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -6208,18 +6656,29 @@ class CreateParamsPaymentMethodOptionsUsBankAccountFinancialConnections( Customize manual entry behavior """ permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ @@ -6241,13 +6700,13 @@ class CreateParamsPaymentMethodOptionsUsBankAccountMandateOptions( """ class CreateParamsPaymentMethodOptionsUsBankAccountNetworks(TypedDict): - requested: NotRequired["List[Literal['ach', 'us_domestic_wire']]"] + requested: NotRequired[List[Literal["ach", "us_domestic_wire"]]] """ Triggers validations to run across the selected networks """ class CreateParamsPaymentMethodOptionsWechatPay(TypedDict): - app_id: NotRequired["str"] + app_id: NotRequired[str] """ The app ID registered with WeChat Pay. Only required when client is ios or android. """ @@ -6255,7 +6714,7 @@ class CreateParamsPaymentMethodOptionsWechatPay(TypedDict): """ The client type that the end customer will pay from """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -6267,7 +6726,7 @@ class CreateParamsPaymentMethodOptionsWechatPay(TypedDict): """ class CreateParamsPaymentMethodOptionsZip(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -6279,7 +6738,7 @@ class CreateParamsPaymentMethodOptionsZip(TypedDict): """ class CreateParamsRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -6289,7 +6748,7 @@ class CreateParamsShipping(TypedDict): """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ @@ -6297,43 +6756,43 @@ class CreateParamsShipping(TypedDict): """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class CreateParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when a charge succeeds. The amount is capped at the total transaction amount and if no amount is set, @@ -6356,19 +6815,19 @@ class DecrementAuthorizationParams(TypedDict): """ The updated total amount that you intend to collect from the cardholder. This amount must be smaller than the currently authorized amount. """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -6381,7 +6840,7 @@ class DecrementAuthorizationParams(TypedDict): """ class DecrementAuthorizationParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when a charge succeeds. """ @@ -6391,23 +6850,23 @@ class IncrementAuthorizationParams(TypedDict): """ The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount. """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. """ @@ -6420,7 +6879,7 @@ class IncrementAuthorizationParams(TypedDict): """ class IncrementAuthorizationParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when a charge succeeds. """ @@ -6430,65 +6889,65 @@ class ListParams(TypedDict): """ A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return PaymentIntents for the customer that this customer ID specifies. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - client_secret: NotRequired["str"] + client_secret: NotRequired[str] """ The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SearchParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - page: NotRequired["str"] + page: NotRequired[str] """ A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. """ @@ -6498,7 +6957,7 @@ class SearchParams(TypedDict): """ class UpdateParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). """ @@ -6507,16 +6966,16 @@ class UpdateParams(TypedDict): The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ ID of the Customer this PaymentIntent belongs to, if one exists. @@ -6524,11 +6983,11 @@ class UpdateParams(TypedDict): If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -6548,11 +7007,11 @@ class UpdateParams(TypedDict): """ Provides industry-specific information about the charge. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. """ - payment_method_configuration: NotRequired["str"] + payment_method_configuration: NotRequired[str] """ The ID of the payment method configuration to use with this PaymentIntent. """ @@ -6570,7 +7029,7 @@ class UpdateParams(TypedDict): """ Payment-method-specific configuration for this PaymentIntent. """ - payment_method_types: NotRequired["List[str]"] + payment_method_types: NotRequired[List[str]] """ The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). """ @@ -6596,11 +7055,11 @@ class UpdateParams(TypedDict): """ Shipping information for this PaymentIntent. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. """ @@ -6610,7 +7069,7 @@ class UpdateParams(TypedDict): """ Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ @@ -6632,11 +7091,11 @@ class UpdateParamsMandateDataCustomerAcceptance(TypedDict): """ class UpdateParamsMandateDataCustomerAcceptanceOnline(TypedDict): - ip_address: NotRequired["str"] + ip_address: NotRequired[str] """ The IP address from which the Mandate was accepted by the customer. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the Mandate was accepted by the customer. """ @@ -6684,23 +7143,23 @@ class UpdateParamsPaymentDetailsCarRental(TypedDict): """ The booking number associated with the car rental. """ - car_class_code: NotRequired["str"] + car_class_code: NotRequired[str] """ Class code of the car. """ - car_make: NotRequired["str"] + car_make: NotRequired[str] """ Make of the car. """ - car_model: NotRequired["str"] + car_model: NotRequired[str] """ Model of the car. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the rental car company. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the car rental company. """ @@ -6715,18 +7174,28 @@ class UpdateParamsPaymentDetailsCarRental(TypedDict): Delivery details for this purchase. """ drivers: NotRequired[ - "List[PaymentIntentService.UpdateParamsPaymentDetailsCarRentalDriver]" + List[ + "PaymentIntentService.UpdateParamsPaymentDetailsCarRentalDriver" + ] ] """ The details of the passengers in the travel reservation """ extra_charges: NotRequired[ - "List[Literal['extra_mileage', 'gas', 'late_return', 'one_way_service', 'parking_violation']]" + List[ + Literal[ + "extra_mileage", + "gas", + "late_return", + "one_way_service", + "parking_violation", + ] + ] ] """ List of additional charges being billed. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep nor cancel their booking. """ @@ -6740,15 +7209,15 @@ class UpdateParamsPaymentDetailsCarRental(TypedDict): """ Car pick-up time. Measured in seconds since the Unix epoch. """ - rate_amount: NotRequired["int"] + rate_amount: NotRequired[int] """ Rental rate. """ - rate_interval: NotRequired["Literal['day', 'month', 'week']"] + rate_interval: NotRequired[Literal["day", "month", "week"]] """ The frequency at which the rate amount is applied. One of `day`, `week` or `month` """ - renter_name: NotRequired["str"] + renter_name: NotRequired[str] """ The name of the person or entity renting the car. """ @@ -6762,7 +7231,7 @@ class UpdateParamsPaymentDetailsCarRental(TypedDict): """ Car return time. Measured in seconds since the Unix epoch. """ - tax_exempt: NotRequired["bool"] + tax_exempt: NotRequired[bool] """ Indicates whether the goods or services are tax-exempt or tax is not collected. """ @@ -6774,7 +7243,7 @@ class UpdateParamsPaymentDetailsCarRentalAffiliate(TypedDict): """ class UpdateParamsPaymentDetailsCarRentalDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -6786,15 +7255,15 @@ class UpdateParamsPaymentDetailsCarRentalDelivery(TypedDict): """ class UpdateParamsPaymentDetailsCarRentalDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -6806,59 +7275,59 @@ class UpdateParamsPaymentDetailsCarRentalDriver(TypedDict): """ class UpdateParamsPaymentDetailsCarRentalPickupAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class UpdateParamsPaymentDetailsCarRentalReturnAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class UpdateParamsPaymentDetailsEventDetails(TypedDict): - access_controlled_venue: NotRequired["bool"] + access_controlled_venue: NotRequired[bool] """ Indicates if the tickets are digitally checked when entering the venue. """ @@ -6874,7 +7343,7 @@ class UpdateParamsPaymentDetailsEventDetails(TypedDict): """ Affiliate details for this purchase. """ - company: NotRequired["str"] + company: NotRequired[str] """ The name of the company """ @@ -6884,11 +7353,11 @@ class UpdateParamsPaymentDetailsEventDetails(TypedDict): """ Delivery details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Event end time. Measured in seconds since the Unix epoch. """ - genre: NotRequired["str"] + genre: NotRequired[str] """ Type of the event entertainment (concert, sports event etc) """ @@ -6896,33 +7365,33 @@ class UpdateParamsPaymentDetailsEventDetails(TypedDict): """ The name of the event. """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Event start time. Measured in seconds since the Unix epoch. """ class UpdateParamsPaymentDetailsEventDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -6934,7 +7403,7 @@ class UpdateParamsPaymentDetailsEventDetailsAffiliate(TypedDict): """ class UpdateParamsPaymentDetailsEventDetailsDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -6946,15 +7415,15 @@ class UpdateParamsPaymentDetailsEventDetailsDelivery(TypedDict): """ class UpdateParamsPaymentDetailsEventDetailsDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -6966,11 +7435,11 @@ class UpdateParamsPaymentDetailsFlight(TypedDict): """ Affiliate details for this purchase. """ - agency_number: NotRequired["str"] + agency_number: NotRequired[str] """ The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket. """ @@ -6980,12 +7449,14 @@ class UpdateParamsPaymentDetailsFlight(TypedDict): """ Delivery details for this purchase. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the person or entity on the reservation. """ passengers: NotRequired[ - "List[PaymentIntentService.UpdateParamsPaymentDetailsFlightPassenger]" + List[ + "PaymentIntentService.UpdateParamsPaymentDetailsFlightPassenger" + ] ] """ The details of the passengers in the travel reservation. @@ -6996,7 +7467,7 @@ class UpdateParamsPaymentDetailsFlight(TypedDict): """ The individual flight segments associated with the trip. """ - ticket_number: NotRequired["str"] + ticket_number: NotRequired[str] """ The ticket number associated with the travel reservation. """ @@ -7008,7 +7479,7 @@ class UpdateParamsPaymentDetailsFlightAffiliate(TypedDict): """ class UpdateParamsPaymentDetailsFlightDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -7020,15 +7491,15 @@ class UpdateParamsPaymentDetailsFlightDelivery(TypedDict): """ class UpdateParamsPaymentDetailsFlightDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -7040,19 +7511,19 @@ class UpdateParamsPaymentDetailsFlightPassenger(TypedDict): """ class UpdateParamsPaymentDetailsFlightSegment(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The flight segment amount. """ - arrival_airport: NotRequired["str"] + arrival_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the arrival airport. """ - arrives_at: NotRequired["int"] + arrives_at: NotRequired[int] """ The arrival time for the flight segment. Measured in seconds since the Unix epoch. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment. """ @@ -7060,16 +7531,16 @@ class UpdateParamsPaymentDetailsFlightSegment(TypedDict): """ The departure time for the flight segment. Measured in seconds since the Unix epoch. """ - departure_airport: NotRequired["str"] + departure_airport: NotRequired[str] """ The International Air Transport Association (IATA) airport code for the departure airport. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number associated with the segment """ service_class: NotRequired[ - "Literal['business', 'economy', 'first', 'premium_economy']" + Literal["business", "economy", "first", "premium_economy"] ] """ The fare class for the segment. @@ -7082,7 +7553,7 @@ class UpdateParamsPaymentDetailsLodging(TypedDict): """ The lodging location's address. """ - adults: NotRequired["int"] + adults: NotRequired[int] """ The number of adults on the booking """ @@ -7092,11 +7563,11 @@ class UpdateParamsPaymentDetailsLodging(TypedDict): """ Affiliate details for this purchase. """ - booking_number: NotRequired["str"] + booking_number: NotRequired[str] """ The booking number associated with the lodging reservation. """ - category: NotRequired["Literal['hotel', 'vacation_rental']"] + category: NotRequired[Literal["hotel", "vacation_rental"]] """ The lodging category """ @@ -7108,11 +7579,11 @@ class UpdateParamsPaymentDetailsLodging(TypedDict): """ Lodging check-out time. Measured in seconds since the Unix epoch. """ - customer_service_phone_number: NotRequired["str"] + customer_service_phone_number: NotRequired[str] """ The customer service phone number of the lodging company. """ - daily_room_rate_amount: NotRequired["int"] + daily_room_rate_amount: NotRequired[int] """ The daily lodging room rate. """ @@ -7123,76 +7594,87 @@ class UpdateParamsPaymentDetailsLodging(TypedDict): Delivery details for this purchase. """ extra_charges: NotRequired[ - "List[Literal['gift_shop', 'laundry', 'mini_bar', 'other', 'restaurant', 'telephone']]" + List[ + Literal[ + "gift_shop", + "laundry", + "mini_bar", + "other", + "restaurant", + "telephone", + ] + ] ] """ List of additional charges being billed. """ - fire_safety_act_compliance: NotRequired["bool"] + fire_safety_act_compliance: NotRequired[bool] """ Indicates whether the lodging location is compliant with the Fire Safety Act. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the lodging location. """ - no_show: NotRequired["bool"] + no_show: NotRequired[bool] """ Indicates if the customer did not keep their booking while failing to cancel the reservation. """ - number_of_rooms: NotRequired["int"] + number_of_rooms: NotRequired[int] """ The number of rooms on the booking """ passengers: NotRequired[ - "List[PaymentIntentService.UpdateParamsPaymentDetailsLodgingPassenger]" + List[ + "PaymentIntentService.UpdateParamsPaymentDetailsLodgingPassenger" + ] ] """ The details of the passengers in the travel reservation """ - property_phone_number: NotRequired["str"] + property_phone_number: NotRequired[str] """ The phone number of the lodging location. """ - room_class: NotRequired["str"] + room_class: NotRequired[str] """ The room class for this purchase. """ - room_nights: NotRequired["int"] + room_nights: NotRequired[int] """ The number of room nights """ - total_room_tax_amount: NotRequired["int"] + total_room_tax_amount: NotRequired[int] """ The total tax amount associating with the room reservation. """ - total_tax_amount: NotRequired["int"] + total_tax_amount: NotRequired[int] """ The total tax amount """ class UpdateParamsPaymentDetailsLodgingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -7204,7 +7686,7 @@ class UpdateParamsPaymentDetailsLodgingAffiliate(TypedDict): """ class UpdateParamsPaymentDetailsLodgingDelivery(TypedDict): - mode: NotRequired["Literal['email', 'phone', 'pickup', 'post']"] + mode: NotRequired[Literal["email", "phone", "pickup", "post"]] """ The delivery method for the payment """ @@ -7216,15 +7698,15 @@ class UpdateParamsPaymentDetailsLodgingDelivery(TypedDict): """ class UpdateParamsPaymentDetailsLodgingDeliveryRecipient(TypedDict): - email: NotRequired["str"] + email: NotRequired[str] """ The email of the recipient the ticket is delivered to. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name of the recipient the ticket is delivered to. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The phone number of the recipient the ticket is delivered to. """ @@ -7242,7 +7724,7 @@ class UpdateParamsPaymentDetailsSubscription(TypedDict): """ Affiliate details for this purchase. """ - auto_renewal: NotRequired["bool"] + auto_renewal: NotRequired[bool] """ Info whether the subscription will be auto renewed upon expiry. """ @@ -7252,7 +7734,7 @@ class UpdateParamsPaymentDetailsSubscription(TypedDict): """ Subscription billing details for this purchase. """ - ends_at: NotRequired["int"] + ends_at: NotRequired[int] """ Subscription end time. Measured in seconds since the Unix epoch. """ @@ -7260,7 +7742,7 @@ class UpdateParamsPaymentDetailsSubscription(TypedDict): """ Name of the product on subscription. e.g. Apple Music Subscription """ - starts_at: NotRequired["int"] + starts_at: NotRequired[int] """ Subscription start time. Measured in seconds since the Unix epoch. """ @@ -7408,7 +7890,7 @@ class UpdateParamsPaymentMethodData(TypedDict): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -7596,11 +8078,11 @@ class UpdateParamsPaymentMethodDataAuBecsDebit(TypedDict): """ class UpdateParamsPaymentMethodDataBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -7629,27 +8111,27 @@ class UpdateParamsPaymentMethodDataBillingDetails(TypedDict): """ class UpdateParamsPaymentMethodDataBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -7671,14 +8153,43 @@ class UpdateParamsPaymentMethodDataCustomerBalance(TypedDict): class UpdateParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class UpdateParamsPaymentMethodDataFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -7718,7 +8229,24 @@ class UpdateParamsPaymentMethodDataGrabpay(TypedDict): class UpdateParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -7766,7 +8294,34 @@ class UpdateParamsPaymentMethodDataOxxo(TypedDict): class UpdateParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -7779,15 +8334,15 @@ class UpdateParamsPaymentMethodDataPaypal(TypedDict): pass class UpdateParamsPaymentMethodDataPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -7799,7 +8354,7 @@ class UpdateParamsPaymentMethodDataPromptpay(TypedDict): pass class UpdateParamsPaymentMethodDataRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -7826,23 +8381,23 @@ class UpdateParamsPaymentMethodDataTwint(TypedDict): pass class UpdateParamsPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -8103,7 +8658,7 @@ class UpdateParamsPaymentMethodOptionsAcssDebit(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -8116,17 +8671,17 @@ class UpdateParamsPaymentMethodOptionsAcssDebitMandateOptions(TypedDict): The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -8140,11 +8695,11 @@ class UpdateParamsPaymentMethodOptionsAffirm(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - preferred_locale: NotRequired["str"] + preferred_locale: NotRequired[str] """ Preferred language of the Affirm authorization page that the customer is redirected to. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8164,12 +8719,12 @@ class UpdateParamsPaymentMethodOptionsAfterpayClearpay(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes. This field differs from the statement descriptor and item name. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8223,7 +8778,7 @@ class UpdateParamsPaymentMethodOptionsBacsDebit(TypedDict): """ class UpdateParamsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -8241,7 +8796,7 @@ class UpdateParamsPaymentMethodOptionsBancontact(TypedDict): """ class UpdateParamsPaymentMethodOptionsBlik(TypedDict): - code: NotRequired["str"] + code: NotRequired[str] """ The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation. """ @@ -8257,7 +8812,7 @@ class UpdateParamsPaymentMethodOptionsBlik(TypedDict): """ class UpdateParamsPaymentMethodOptionsBoleto(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time. """ @@ -8283,7 +8838,7 @@ class UpdateParamsPaymentMethodOptionsCard(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - cvc_token: NotRequired["str"] + cvc_token: NotRequired[str] """ A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation. """ @@ -8301,51 +8856,63 @@ class UpdateParamsPaymentMethodOptionsCard(TypedDict): """ Configuration options for setting up an eMandate for cards issued in India. """ - moto: NotRequired["bool"] + moto: NotRequired[bool] """ When specified, this parameter indicates that a transaction will be marked as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time. """ request_decremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent. """ request_extended_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent. """ request_incremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. """ - request_multicapture: NotRequired["Literal['if_available', 'never']"] + request_multicapture: NotRequired[Literal["if_available", "never"]] """ Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent. """ - request_overcapture: NotRequired["Literal['if_available', 'never']"] + request_overcapture: NotRequired[Literal["if_available", "never"]] """ Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ - require_cvc_recollection: NotRequired["bool"] + require_cvc_recollection: NotRequired[bool] """ When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter). """ @@ -8384,7 +8951,7 @@ class UpdateParamsPaymentMethodOptionsCard(TypedDict): """ class UpdateParamsPaymentMethodOptionsCardInstallments(TypedDict): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Setting to true enables installments for this PaymentIntent. This will cause the response to contain a list of available installment plans. @@ -8422,11 +8989,11 @@ class UpdateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ @@ -8434,7 +9001,7 @@ class UpdateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ @@ -8446,22 +9013,22 @@ class UpdateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ - supported_types: NotRequired["List[Literal['india']]"] + supported_types: NotRequired[List[Literal["india"]]] """ Specifies the type of mandates supported. Possible values are `india`. """ class UpdateParamsPaymentMethodOptionsCardPresent(TypedDict): - request_extended_authorization: NotRequired["bool"] + request_extended_authorization: NotRequired[bool] """ Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity) """ - request_incremental_authorization_support: NotRequired["bool"] + request_incremental_authorization_support: NotRequired[bool] """ Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. """ request_incremental_authorization: NotRequired[ - "Literal['if_available', 'never']" + Literal["if_available", "never"] ] """ This field was released by mistake and will be removed in the next major version @@ -8474,7 +9041,7 @@ class UpdateParamsPaymentMethodOptionsCardStatementDetails(TypedDict): """ Please pass in an address that is within your Stripe user account country """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Phone number (e.g., a toll-free number that customers can call) """ @@ -8482,34 +9049,34 @@ class UpdateParamsPaymentMethodOptionsCardStatementDetails(TypedDict): class UpdateParamsPaymentMethodOptionsCardStatementDetailsAddress( TypedDict, ): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class UpdateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): ares_trans_status: NotRequired[ - "Literal['A', 'C', 'I', 'N', 'R', 'U', 'Y']" + Literal["A", "C", "I", "N", "R", "U", "Y"] ] """ The `transStatus` returned from the card Issuer's ACS in the ARes. @@ -8522,13 +9089,13 @@ class UpdateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): is what you should specify here.) """ electronic_commerce_indicator: NotRequired[ - "Literal['01', '02', '05', '06', '07']" + Literal["01", "02", "05", "06", "07"] ] """ The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed. """ - exemption_indicator: NotRequired["Literal['low_risk', 'none']"] + exemption_indicator: NotRequired[Literal["low_risk", "none"]] """ The exemption requested via 3DS and accepted by the issuer at authentication time. """ @@ -8540,7 +9107,7 @@ class UpdateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly """ - requestor_challenge_indicator: NotRequired["str"] + requestor_challenge_indicator: NotRequired[str] """ The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99. @@ -8574,14 +9141,14 @@ class UpdateParamsPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancai to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`. messageExtension: CB-AVALGO """ - cb_exemption: NotRequired["str"] + cb_exemption: NotRequired[str] """ The exemption indicator returned from Cartes Bancaires in the ARes. message extension: CB-EXEMPTION; string (4 characters) This is a 3 byte bitmap (low significant byte first and most significant bit first) that has been Base64 encoded """ - cb_score: NotRequired["int"] + cb_score: NotRequired[int] """ The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99 @@ -8616,11 +9183,11 @@ class UpdateParamsPaymentMethodOptionsCustomerBalance(TypedDict): """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["Literal['bank_transfer']"] + funding_type: NotRequired[Literal["bank_transfer"]] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8641,7 +9208,17 @@ class UpdateParamsPaymentMethodOptionsCustomerBalanceBankTransfer( Configuration for the eu_bank_transfer funding type. """ requested_address_types: NotRequired[ - "List[Literal['aba', 'iban', 'sepa', 'sort_code', 'spei', 'swift', 'zengin']]" + List[ + Literal[ + "aba", + "iban", + "sepa", + "sort_code", + "spei", + "swift", + "zengin", + ] + ] ] """ List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. @@ -8668,7 +9245,7 @@ class UpdateParamsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer( """ class UpdateParamsPaymentMethodOptionsEps(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8680,7 +9257,7 @@ class UpdateParamsPaymentMethodOptionsEps(TypedDict): """ class UpdateParamsPaymentMethodOptionsFpx(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8692,7 +9269,7 @@ class UpdateParamsPaymentMethodOptionsFpx(TypedDict): """ class UpdateParamsPaymentMethodOptionsGiropay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8704,7 +9281,7 @@ class UpdateParamsPaymentMethodOptionsGiropay(TypedDict): """ class UpdateParamsPaymentMethodOptionsGrabpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8742,12 +9319,57 @@ class UpdateParamsPaymentMethodOptionsKlarna(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-CH', 'de-DE', 'el-GR', 'en-AT', 'en-AU', 'en-BE', 'en-CA', 'en-CH', 'en-CZ', 'en-DE', 'en-DK', 'en-ES', 'en-FI', 'en-FR', 'en-GB', 'en-GR', 'en-IE', 'en-IT', 'en-NL', 'en-NO', 'en-NZ', 'en-PL', 'en-PT', 'en-SE', 'en-US', 'es-ES', 'es-US', 'fi-FI', 'fr-BE', 'fr-CA', 'fr-CH', 'fr-FR', 'it-CH', 'it-IT', 'nb-NO', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sv-FI', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-CH", + "de-DE", + "el-GR", + "en-AT", + "en-AU", + "en-BE", + "en-CA", + "en-CH", + "en-CZ", + "en-DE", + "en-DK", + "en-ES", + "en-FI", + "en-FR", + "en-GB", + "en-GR", + "en-IE", + "en-IT", + "en-NL", + "en-NO", + "en-NZ", + "en-PL", + "en-PT", + "en-SE", + "en-US", + "es-ES", + "es-US", + "fi-FI", + "fr-BE", + "fr-CA", + "fr-CH", + "fr-FR", + "it-CH", + "it-IT", + "nb-NO", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sv-FI", + "sv-SE", + ] ] """ Preferred language of the Klarna authorization page that the customer is redirected to """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8775,7 +9397,7 @@ class UpdateParamsPaymentMethodOptionsKonbini(TypedDict): """ A product descriptor of up to 22 characters, which will appear to customers at the convenience store. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8795,7 +9417,7 @@ class UpdateParamsPaymentMethodOptionsLink(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ @@ -8821,7 +9443,7 @@ class UpdateParamsPaymentMethodOptionsMobilepay(TypedDict): If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8833,7 +9455,7 @@ class UpdateParamsPaymentMethodOptionsMobilepay(TypedDict): """ class UpdateParamsPaymentMethodOptionsMultibanco(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8845,11 +9467,11 @@ class UpdateParamsPaymentMethodOptionsMultibanco(TypedDict): """ class UpdateParamsPaymentMethodOptionsOxxo(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8861,7 +9483,7 @@ class UpdateParamsPaymentMethodOptionsOxxo(TypedDict): """ class UpdateParamsPaymentMethodOptionsP24(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8871,13 +9493,13 @@ class UpdateParamsPaymentMethodOptionsP24(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - tos_shown_and_accepted: NotRequired["bool"] + tos_shown_and_accepted: NotRequired[bool] """ Confirm that the payer has accepted the P24 terms and conditions. """ class UpdateParamsPaymentMethodOptionsPaynow(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8894,20 +9516,42 @@ class UpdateParamsPaymentMethodOptionsPaypal(TypedDict): Controls when the funds will be captured from the customer's account. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-DE', 'de-LU', 'el-GR', 'en-GB', 'en-US', 'es-ES', 'fi-FI', 'fr-BE', 'fr-FR', 'fr-LU', 'hu-HU', 'it-IT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sk-SK', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-DE", + "de-LU", + "el-GR", + "en-GB", + "en-US", + "es-ES", + "fi-FI", + "fr-BE", + "fr-FR", + "fr-LU", + "hu-HU", + "it-IT", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sk-SK", + "sv-SE", + ] ] """ [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - reference_id: NotRequired["str"] + reference_id: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - risk_correlation_id: NotRequired["str"] + risk_correlation_id: NotRequired[str] """ The risk correlation ID for an on-session payment using a saved PayPal payment method. """ @@ -8923,7 +9567,7 @@ class UpdateParamsPaymentMethodOptionsPaypal(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - subsellers: NotRequired["List[str]"] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -8949,45 +9593,66 @@ class UpdateParamsPaymentMethodOptionsPayto(TypedDict): """ class UpdateParamsPaymentMethodOptionsPaytoMandateOptions(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount that will be collected. It is required when `amount_type` is `fixed`. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. """ - end_date: NotRequired["str"] + end_date: NotRequired[str] """ Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. """ payment_schedule: NotRequired[ - "Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] ] """ The periodicity at which payments will be collected. """ - payments_per_period: NotRequired["int"] + payments_per_period: NotRequired[int] """ The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. """ purpose: NotRequired[ - "Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] ] """ The purpose for which payments are made. Defaults to retail. """ class UpdateParamsPaymentMethodOptionsPix(TypedDict): - expires_after_seconds: NotRequired["int"] + expires_after_seconds: NotRequired[int] """ The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -8999,7 +9664,7 @@ class UpdateParamsPaymentMethodOptionsPix(TypedDict): """ class UpdateParamsPaymentMethodOptionsPromptpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -9070,7 +9735,7 @@ class UpdateParamsPaymentMethodOptionsSwish(TypedDict): """ The order ID displayed in the Swish app after the payment is authorized. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -9119,7 +9784,7 @@ class UpdateParamsPaymentMethodOptionsUsBankAccount(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -9135,18 +9800,29 @@ class UpdateParamsPaymentMethodOptionsUsBankAccountFinancialConnections( Customize manual entry behavior """ permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ @@ -9168,13 +9844,13 @@ class UpdateParamsPaymentMethodOptionsUsBankAccountMandateOptions( """ class UpdateParamsPaymentMethodOptionsUsBankAccountNetworks(TypedDict): - requested: NotRequired["List[Literal['ach', 'us_domestic_wire']]"] + requested: NotRequired[List[Literal["ach", "us_domestic_wire"]]] """ Triggers validations to run across the selected networks """ class UpdateParamsPaymentMethodOptionsWechatPay(TypedDict): - app_id: NotRequired["str"] + app_id: NotRequired[str] """ The app ID registered with WeChat Pay. Only required when client is ios or android. """ @@ -9182,7 +9858,7 @@ class UpdateParamsPaymentMethodOptionsWechatPay(TypedDict): """ The client type that the end customer will pay from """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -9194,7 +9870,7 @@ class UpdateParamsPaymentMethodOptionsWechatPay(TypedDict): """ class UpdateParamsPaymentMethodOptionsZip(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -9210,7 +9886,7 @@ class UpdateParamsShipping(TypedDict): """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ @@ -9218,57 +9894,57 @@ class UpdateParamsShipping(TypedDict): """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class UpdateParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class UpdateParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when a charge succeeds. """ class VerifyMicrodepositsParams(TypedDict): - amounts: NotRequired["List[int]"] + amounts: NotRequired[List[int]] """ Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. """ - descriptor_code: NotRequired["str"] + descriptor_code: NotRequired[str] """ A six-character code starting with SM present in the microdeposit sent to the bank account. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_payment_link.py b/stripe/_payment_link.py index 60403dfc3..b8d0ae6f2 100644 --- a/stripe/_payment_link.py +++ b/stripe/_payment_link.py @@ -684,15 +684,15 @@ class CreateParams(RequestOptions): """ Behavior after the purchase is complete. """ - allow_promotion_codes: NotRequired["bool"] + allow_promotion_codes: NotRequired[bool] """ Enables user redeemable promotion codes. """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Can only be applied when there are no line items with recurring prices. """ - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. """ @@ -700,7 +700,7 @@ class CreateParams(RequestOptions): """ Configuration for automatic tax collection. """ - billing_address_collection: NotRequired["Literal['auto', 'required']"] + billing_address_collection: NotRequired[Literal["auto", "required"]] """ Configuration for collecting the customer's billing address. Defaults to `auto`. """ @@ -710,11 +710,11 @@ class CreateParams(RequestOptions): """ Configure fields to gather active consent from customers. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price. """ - custom_fields: NotRequired["List[PaymentLink.CreateParamsCustomField]"] + custom_fields: NotRequired[List["PaymentLink.CreateParamsCustomField"]] """ Collect additional information from your customer using custom fields. Up to 3 fields are supported. """ @@ -722,15 +722,15 @@ class CreateParams(RequestOptions): """ Display additional text for your customers using custom text. """ - customer_creation: NotRequired["Literal['always', 'if_required']"] + customer_creation: NotRequired[Literal["always", "if_required"]] """ Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - inactive_message: NotRequired["str"] + inactive_message: NotRequired[str] """ The custom message to be displayed to a customer when a payment link is no longer active. """ @@ -744,11 +744,11 @@ class CreateParams(RequestOptions): """ The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. """ - metadata: NotRequired["Dict[str, str]"] + 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account on behalf of which to charge. """ @@ -759,7 +759,7 @@ class CreateParams(RequestOptions): A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. """ payment_method_collection: NotRequired[ - "Literal['always', 'if_required']" + Literal["always", "if_required"] ] """ Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. @@ -769,7 +769,39 @@ class CreateParams(RequestOptions): If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). """ payment_method_types: NotRequired[ - "List[Literal['affirm', 'afterpay_clearpay', 'alipay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'blik', 'boleto', 'card', 'cashapp', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'konbini', 'link', 'oxxo', 'p24', 'paynow', 'paypal', 'pix', 'promptpay', 'sepa_debit', 'sofort', 'swish', 'us_bank_account', 'wechat_pay']]" + List[ + Literal[ + "affirm", + "afterpay_clearpay", + "alipay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "card", + "cashapp", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "konbini", + "link", + "oxxo", + "p24", + "paynow", + "paypal", + "pix", + "promptpay", + "sepa_debit", + "sofort", + "swish", + "us_bank_account", + "wechat_pay", + ] + ] ] """ The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)). @@ -793,12 +825,12 @@ class CreateParams(RequestOptions): Configuration for collecting the customer's shipping address. """ shipping_options: NotRequired[ - "List[PaymentLink.CreateParamsShippingOption]" + List["PaymentLink.CreateParamsShippingOption"] ] """ The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. """ - submit_type: NotRequired["Literal['auto', 'book', 'donate', 'pay']"] + submit_type: NotRequired[Literal["auto", "book", "donate", "pay"]] """ Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`). """ @@ -838,7 +870,7 @@ class CreateParamsAfterCompletion(TypedDict): """ class CreateParamsAfterCompletionHostedConfirmation(TypedDict): - custom_message: NotRequired["str"] + custom_message: NotRequired[str] """ A custom message to display to the customer after the purchase is complete. """ @@ -860,7 +892,7 @@ class CreateParamsAutomaticTax(TypedDict): """ class CreateParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -876,13 +908,13 @@ class CreateParamsConsentCollection(TypedDict): """ Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method. """ - promotions: NotRequired["Literal['auto', 'none']"] + promotions: NotRequired[Literal["auto", "none"]] """ If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer's locale. Only available to US merchants. """ - terms_of_service: NotRequired["Literal['none', 'required']"] + terms_of_service: NotRequired[Literal["none", "required"]] """ If set to `required`, it requires customers to check a terms of service checkbox before being able to pay. There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public). @@ -912,7 +944,7 @@ class CreateParamsCustomField(TypedDict): """ Configuration for `type=numeric` fields. """ - optional: NotRequired["bool"] + optional: NotRequired[bool] """ Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. """ @@ -952,21 +984,21 @@ class CreateParamsCustomFieldLabel(TypedDict): """ class CreateParamsCustomFieldNumeric(TypedDict): - maximum_length: NotRequired["int"] + maximum_length: NotRequired[int] """ The maximum character length constraint for the customer's input. """ - minimum_length: NotRequired["int"] + minimum_length: NotRequired[int] """ The minimum character length requirement for the customer's input. """ class CreateParamsCustomFieldText(TypedDict): - maximum_length: NotRequired["int"] + maximum_length: NotRequired[int] """ The maximum character length constraint for the customer's input. """ - minimum_length: NotRequired["int"] + minimum_length: NotRequired[int] """ The minimum character length requirement for the customer's input. """ @@ -1044,11 +1076,11 @@ class CreateParamsInvoiceCreationInvoiceData(TypedDict): """ Default custom fields to be displayed on invoices for this customer. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - footer: NotRequired["str"] + footer: NotRequired[str] """ Default footer to be displayed on invoices for this customer. """ @@ -1080,7 +1112,7 @@ class CreateParamsInvoiceCreationInvoiceDataCustomField(TypedDict): """ class CreateParamsInvoiceCreationInvoiceDataIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1118,31 +1150,31 @@ class CreateParamsLineItemAdjustableQuantity(TypedDict): """ Set to true if the quantity can be adjusted to any non-negative Integer. """ - maximum: NotRequired["int"] + maximum: NotRequired[int] """ The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999. """ - minimum: NotRequired["int"] + minimum: NotRequired[int] """ The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0. """ class CreateParamsPaymentIntentData(TypedDict): capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values. """ - setup_future_usage: NotRequired["Literal['off_session', 'on_session']"] + setup_future_usage: NotRequired[Literal["off_session", "on_session"]] """ Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session. @@ -1156,15 +1188,15 @@ class CreateParamsPaymentIntentData(TypedDict): When processing card payments, Checkout also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. """ @@ -1435,13 +1467,13 @@ class CreateParamsShippingAddressCollection(TypedDict): """ class CreateParamsShippingOption(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the Shipping Rate to use for this shipping option. """ class CreateParamsSubscriptionData(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. """ @@ -1451,11 +1483,11 @@ class CreateParamsSubscriptionData(TypedDict): """ All invoices will be billed using the specified settings. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values. """ - trial_period_days: NotRequired["int"] + trial_period_days: NotRequired[int] """ Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1. """ @@ -1475,7 +1507,7 @@ class CreateParamsSubscriptionDataInvoiceSettings(TypedDict): """ class CreateParamsSubscriptionDataInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1503,7 +1535,7 @@ class CreateParamsTaxIdCollection(TypedDict): """ class CreateParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when a charge succeeds. """ @@ -1516,47 +1548,47 @@ class CreateParamsTransferData(TypedDict): """ class ListLineItemsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 ListParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links). """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated. """ @@ -1566,7 +1598,7 @@ class ModifyParams(RequestOptions): """ Behavior after the purchase is complete. """ - allow_promotion_codes: NotRequired["bool"] + allow_promotion_codes: NotRequired[bool] """ Enables user redeemable promotion codes. """ @@ -1574,7 +1606,7 @@ class ModifyParams(RequestOptions): """ Configuration for automatic tax collection. """ - billing_address_collection: NotRequired["Literal['auto', 'required']"] + billing_address_collection: NotRequired[Literal["auto", "required"]] """ Configuration for collecting the customer's billing address. Defaults to `auto`. """ @@ -1588,11 +1620,11 @@ class ModifyParams(RequestOptions): """ Display additional text for your customers using custom text. """ - customer_creation: NotRequired["Literal['always', 'if_required']"] + customer_creation: NotRequired[Literal["always", "if_required"]] """ Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1606,11 +1638,11 @@ class ModifyParams(RequestOptions): """ Generate a post-purchase Invoice for one-time payments. """ - line_items: NotRequired["List[PaymentLink.ModifyParamsLineItem]"] + line_items: NotRequired[List["PaymentLink.ModifyParamsLineItem"]] """ The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. """ - metadata: NotRequired["Dict[str, str]"] + 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. """ @@ -1621,7 +1653,7 @@ class ModifyParams(RequestOptions): A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. """ payment_method_collection: NotRequired[ - "Literal['always', 'if_required']" + Literal["always", "if_required"] ] """ Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. @@ -1674,7 +1706,7 @@ class ModifyParamsAfterCompletion(TypedDict): """ class ModifyParamsAfterCompletionHostedConfirmation(TypedDict): - custom_message: NotRequired["str"] + custom_message: NotRequired[str] """ A custom message to display to the customer after the purchase is complete. """ @@ -1696,7 +1728,7 @@ class ModifyParamsAutomaticTax(TypedDict): """ class ModifyParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1722,7 +1754,7 @@ class ModifyParamsCustomField(TypedDict): """ Configuration for `type=numeric` fields. """ - optional: NotRequired["bool"] + optional: NotRequired[bool] """ Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. """ @@ -1762,21 +1794,21 @@ class ModifyParamsCustomFieldLabel(TypedDict): """ class ModifyParamsCustomFieldNumeric(TypedDict): - maximum_length: NotRequired["int"] + maximum_length: NotRequired[int] """ The maximum character length constraint for the customer's input. """ - minimum_length: NotRequired["int"] + minimum_length: NotRequired[int] """ The minimum character length requirement for the customer's input. """ class ModifyParamsCustomFieldText(TypedDict): - maximum_length: NotRequired["int"] + maximum_length: NotRequired[int] """ The maximum character length constraint for the customer's input. """ - minimum_length: NotRequired["int"] + minimum_length: NotRequired[int] """ The minimum character length requirement for the customer's input. """ @@ -1854,11 +1886,11 @@ class ModifyParamsInvoiceCreationInvoiceData(TypedDict): """ Default custom fields to be displayed on invoices for this customer. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - footer: NotRequired["str"] + footer: NotRequired[str] """ Default footer to be displayed on invoices for this customer. """ @@ -1890,7 +1922,7 @@ class ModifyParamsInvoiceCreationInvoiceDataCustomField(TypedDict): """ class ModifyParamsInvoiceCreationInvoiceDataIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1918,7 +1950,7 @@ class ModifyParamsLineItem(TypedDict): """ The ID of an existing line item on the payment link. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item being purchased. """ @@ -1928,11 +1960,11 @@ class ModifyParamsLineItemAdjustableQuantity(TypedDict): """ Set to true if the quantity can be adjusted to any non-negative Integer. """ - maximum: NotRequired["int"] + maximum: NotRequired[int] """ The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999. """ - minimum: NotRequired["int"] + minimum: NotRequired[int] """ The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0. """ @@ -2245,7 +2277,7 @@ class ModifyParamsSubscriptionDataInvoiceSettings(TypedDict): """ class ModifyParamsSubscriptionDataInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -2267,7 +2299,7 @@ class ModifyParamsSubscriptionDataTrialSettingsEndBehavior(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_payment_link_line_item_service.py b/stripe/_payment_link_line_item_service.py index 5fa9cb174..93bdead2e 100644 --- a/stripe/_payment_link_line_item_service.py +++ b/stripe/_payment_link_line_item_service.py @@ -11,19 +11,19 @@ class PaymentLinkLineItemService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/_payment_link_service.py b/stripe/_payment_link_service.py index e1920ae67..cfcea8d8c 100644 --- a/stripe/_payment_link_service.py +++ b/stripe/_payment_link_service.py @@ -22,15 +22,15 @@ class CreateParams(TypedDict): """ Behavior after the purchase is complete. """ - allow_promotion_codes: NotRequired["bool"] + allow_promotion_codes: NotRequired[bool] """ Enables user redeemable promotion codes. """ - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Can only be applied when there are no line items with recurring prices. """ - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. """ @@ -40,7 +40,7 @@ class CreateParams(TypedDict): """ Configuration for automatic tax collection. """ - billing_address_collection: NotRequired["Literal['auto', 'required']"] + billing_address_collection: NotRequired[Literal["auto", "required"]] """ Configuration for collecting the customer's billing address. Defaults to `auto`. """ @@ -50,12 +50,12 @@ class CreateParams(TypedDict): """ Configure fields to gather active consent from customers. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price. """ custom_fields: NotRequired[ - "List[PaymentLinkService.CreateParamsCustomField]" + List["PaymentLinkService.CreateParamsCustomField"] ] """ Collect additional information from your customer using custom fields. Up to 3 fields are supported. @@ -64,15 +64,15 @@ class CreateParams(TypedDict): """ Display additional text for your customers using custom text. """ - customer_creation: NotRequired["Literal['always', 'if_required']"] + customer_creation: NotRequired[Literal["always", "if_required"]] """ Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - inactive_message: NotRequired["str"] + inactive_message: NotRequired[str] """ The custom message to be displayed to a customer when a payment link is no longer active. """ @@ -86,11 +86,11 @@ class CreateParams(TypedDict): """ The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. """ - metadata: NotRequired["Dict[str, str]"] + 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account on behalf of which to charge. """ @@ -101,7 +101,7 @@ class CreateParams(TypedDict): A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. """ payment_method_collection: NotRequired[ - "Literal['always', 'if_required']" + Literal["always", "if_required"] ] """ Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. @@ -111,7 +111,39 @@ class CreateParams(TypedDict): If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). """ payment_method_types: NotRequired[ - "List[Literal['affirm', 'afterpay_clearpay', 'alipay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'blik', 'boleto', 'card', 'cashapp', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'konbini', 'link', 'oxxo', 'p24', 'paynow', 'paypal', 'pix', 'promptpay', 'sepa_debit', 'sofort', 'swish', 'us_bank_account', 'wechat_pay']]" + List[ + Literal[ + "affirm", + "afterpay_clearpay", + "alipay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "card", + "cashapp", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "konbini", + "link", + "oxxo", + "p24", + "paynow", + "paypal", + "pix", + "promptpay", + "sepa_debit", + "sofort", + "swish", + "us_bank_account", + "wechat_pay", + ] + ] ] """ The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)). @@ -137,12 +169,12 @@ class CreateParams(TypedDict): Configuration for collecting the customer's shipping address. """ shipping_options: NotRequired[ - "List[PaymentLinkService.CreateParamsShippingOption]" + List["PaymentLinkService.CreateParamsShippingOption"] ] """ The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. """ - submit_type: NotRequired["Literal['auto', 'book', 'donate', 'pay']"] + submit_type: NotRequired[Literal["auto", "book", "donate", "pay"]] """ Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`). """ @@ -184,7 +216,7 @@ class CreateParamsAfterCompletion(TypedDict): """ class CreateParamsAfterCompletionHostedConfirmation(TypedDict): - custom_message: NotRequired["str"] + custom_message: NotRequired[str] """ A custom message to display to the customer after the purchase is complete. """ @@ -208,7 +240,7 @@ class CreateParamsAutomaticTax(TypedDict): """ class CreateParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -224,13 +256,13 @@ class CreateParamsConsentCollection(TypedDict): """ Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method. """ - promotions: NotRequired["Literal['auto', 'none']"] + promotions: NotRequired[Literal["auto", "none"]] """ If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer's locale. Only available to US merchants. """ - terms_of_service: NotRequired["Literal['none', 'required']"] + terms_of_service: NotRequired[Literal["none", "required"]] """ If set to `required`, it requires customers to check a terms of service checkbox before being able to pay. There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public). @@ -264,7 +296,7 @@ class CreateParamsCustomField(TypedDict): """ Configuration for `type=numeric` fields. """ - optional: NotRequired["bool"] + optional: NotRequired[bool] """ Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. """ @@ -306,21 +338,21 @@ class CreateParamsCustomFieldLabel(TypedDict): """ class CreateParamsCustomFieldNumeric(TypedDict): - maximum_length: NotRequired["int"] + maximum_length: NotRequired[int] """ The maximum character length constraint for the customer's input. """ - minimum_length: NotRequired["int"] + minimum_length: NotRequired[int] """ The minimum character length requirement for the customer's input. """ class CreateParamsCustomFieldText(TypedDict): - maximum_length: NotRequired["int"] + maximum_length: NotRequired[int] """ The maximum character length constraint for the customer's input. """ - minimum_length: NotRequired["int"] + minimum_length: NotRequired[int] """ The minimum character length requirement for the customer's input. """ @@ -398,11 +430,11 @@ class CreateParamsInvoiceCreationInvoiceData(TypedDict): """ Default custom fields to be displayed on invoices for this customer. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - footer: NotRequired["str"] + footer: NotRequired[str] """ Default footer to be displayed on invoices for this customer. """ @@ -434,7 +466,7 @@ class CreateParamsInvoiceCreationInvoiceDataCustomField(TypedDict): """ class CreateParamsInvoiceCreationInvoiceDataIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -472,31 +504,31 @@ class CreateParamsLineItemAdjustableQuantity(TypedDict): """ Set to true if the quantity can be adjusted to any non-negative Integer. """ - maximum: NotRequired["int"] + maximum: NotRequired[int] """ The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999. """ - minimum: NotRequired["int"] + minimum: NotRequired[int] """ The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0. """ class CreateParamsPaymentIntentData(TypedDict): capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values. """ - setup_future_usage: NotRequired["Literal['off_session', 'on_session']"] + setup_future_usage: NotRequired[Literal["off_session", "on_session"]] """ Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session. @@ -510,15 +542,15 @@ class CreateParamsPaymentIntentData(TypedDict): When processing card payments, Checkout also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. """ @@ -789,13 +821,13 @@ class CreateParamsShippingAddressCollection(TypedDict): """ class CreateParamsShippingOption(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the Shipping Rate to use for this shipping option. """ class CreateParamsSubscriptionData(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. """ @@ -805,11 +837,11 @@ class CreateParamsSubscriptionData(TypedDict): """ All invoices will be billed using the specified settings. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values. """ - trial_period_days: NotRequired["int"] + trial_period_days: NotRequired[int] """ Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1. """ @@ -829,7 +861,7 @@ class CreateParamsSubscriptionDataInvoiceSettings(TypedDict): """ class CreateParamsSubscriptionDataInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -857,7 +889,7 @@ class CreateParamsTaxIdCollection(TypedDict): """ class CreateParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when a charge succeeds. """ @@ -870,35 +902,35 @@ class CreateParamsTransferData(TypedDict): """ class ListParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links). """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated. """ @@ -908,7 +940,7 @@ class UpdateParams(TypedDict): """ Behavior after the purchase is complete. """ - allow_promotion_codes: NotRequired["bool"] + allow_promotion_codes: NotRequired[bool] """ Enables user redeemable promotion codes. """ @@ -918,7 +950,7 @@ class UpdateParams(TypedDict): """ Configuration for automatic tax collection. """ - billing_address_collection: NotRequired["Literal['auto', 'required']"] + billing_address_collection: NotRequired[Literal["auto", "required"]] """ Configuration for collecting the customer's billing address. Defaults to `auto`. """ @@ -932,11 +964,11 @@ class UpdateParams(TypedDict): """ Display additional text for your customers using custom text. """ - customer_creation: NotRequired["Literal['always', 'if_required']"] + customer_creation: NotRequired[Literal["always", "if_required"]] """ Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -951,12 +983,12 @@ class UpdateParams(TypedDict): Generate a post-purchase Invoice for one-time payments. """ line_items: NotRequired[ - "List[PaymentLinkService.UpdateParamsLineItem]" + List["PaymentLinkService.UpdateParamsLineItem"] ] """ The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. """ - metadata: NotRequired["Dict[str, str]"] + 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. """ @@ -967,7 +999,7 @@ class UpdateParams(TypedDict): A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. """ payment_method_collection: NotRequired[ - "Literal['always', 'if_required']" + Literal["always", "if_required"] ] """ Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. @@ -1020,7 +1052,7 @@ class UpdateParamsAfterCompletion(TypedDict): """ class UpdateParamsAfterCompletionHostedConfirmation(TypedDict): - custom_message: NotRequired["str"] + custom_message: NotRequired[str] """ A custom message to display to the customer after the purchase is complete. """ @@ -1044,7 +1076,7 @@ class UpdateParamsAutomaticTax(TypedDict): """ class UpdateParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1074,7 +1106,7 @@ class UpdateParamsCustomField(TypedDict): """ Configuration for `type=numeric` fields. """ - optional: NotRequired["bool"] + optional: NotRequired[bool] """ Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. """ @@ -1116,21 +1148,21 @@ class UpdateParamsCustomFieldLabel(TypedDict): """ class UpdateParamsCustomFieldNumeric(TypedDict): - maximum_length: NotRequired["int"] + maximum_length: NotRequired[int] """ The maximum character length constraint for the customer's input. """ - minimum_length: NotRequired["int"] + minimum_length: NotRequired[int] """ The minimum character length requirement for the customer's input. """ class UpdateParamsCustomFieldText(TypedDict): - maximum_length: NotRequired["int"] + maximum_length: NotRequired[int] """ The maximum character length constraint for the customer's input. """ - minimum_length: NotRequired["int"] + minimum_length: NotRequired[int] """ The minimum character length requirement for the customer's input. """ @@ -1208,11 +1240,11 @@ class UpdateParamsInvoiceCreationInvoiceData(TypedDict): """ Default custom fields to be displayed on invoices for this customer. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - footer: NotRequired["str"] + footer: NotRequired[str] """ Default footer to be displayed on invoices for this customer. """ @@ -1244,7 +1276,7 @@ class UpdateParamsInvoiceCreationInvoiceDataCustomField(TypedDict): """ class UpdateParamsInvoiceCreationInvoiceDataIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1272,7 +1304,7 @@ class UpdateParamsLineItem(TypedDict): """ The ID of an existing line item on the payment link. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item being purchased. """ @@ -1282,11 +1314,11 @@ class UpdateParamsLineItemAdjustableQuantity(TypedDict): """ Set to true if the quantity can be adjusted to any non-negative Integer. """ - maximum: NotRequired["int"] + maximum: NotRequired[int] """ The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999. """ - minimum: NotRequired["int"] + minimum: NotRequired[int] """ The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0. """ @@ -1599,7 +1631,7 @@ class UpdateParamsSubscriptionDataInvoiceSettings(TypedDict): """ class UpdateParamsSubscriptionDataInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ diff --git a/stripe/_payment_method.py b/stripe/_payment_method.py index 752ad33e5..1f1d8c643 100644 --- a/stripe/_payment_method.py +++ b/stripe/_payment_method.py @@ -1027,7 +1027,7 @@ class AttachParams(RequestOptions): """ The ID of the customer to which to attach the PaymentMethod. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1085,7 +1085,7 @@ class CreateParams(RequestOptions): """ If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The `Customer` to whom the original PaymentMethod is attached. """ @@ -1099,7 +1099,7 @@ class CreateParams(RequestOptions): """ If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1137,7 +1137,7 @@ class CreateParams(RequestOptions): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -1157,7 +1157,7 @@ class CreateParams(RequestOptions): """ If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ The PaymentMethod to share. """ @@ -1206,7 +1206,45 @@ class CreateParams(RequestOptions): If this is a Twint PaymentMethod, this hash contains details about the Twint payment method. """ type: NotRequired[ - "Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'blik', 'boleto', 'card', 'cashapp', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'konbini', 'link', 'mobilepay', 'multibanco', 'oxxo', 'p24', 'paynow', 'paypal', 'payto', 'pix', 'promptpay', 'revolut_pay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']" + Literal[ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "card", + "cashapp", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "konbini", + "link", + "mobilepay", + "multibanco", + "oxxo", + "p24", + "paynow", + "paypal", + "payto", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "us_bank_account", + "wechat_pay", + "zip", + ] ] """ The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. @@ -1258,11 +1296,11 @@ class CreateParamsAuBecsDebit(TypedDict): """ class CreateParamsBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -1291,27 +1329,27 @@ class CreateParamsBillingDetails(TypedDict): """ class CreateParamsBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1326,15 +1364,15 @@ class CreateParamsBoleto(TypedDict): """ class CreateParamsCard(TypedDict): - cvc: NotRequired["str"] + cvc: NotRequired[str] """ The card's CVC. It is highly recommended to always include this value. """ - exp_month: NotRequired["int"] + exp_month: NotRequired[int] """ Two-digit number representing the card's expiration month. """ - exp_year: NotRequired["int"] + exp_year: NotRequired[int] """ Four-digit number representing the card's expiration year. """ @@ -1342,18 +1380,18 @@ class CreateParamsCard(TypedDict): """ Contains information about card networks used to process the payment. """ - number: NotRequired["str"] + number: NotRequired[str] """ The card number, as a string without any separators. """ - token: NotRequired["str"] + token: NotRequired[str] """ For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format card: {token: "tok_visa"}. """ class CreateParamsCardNetworks(TypedDict): preferred: NotRequired[ - "Literal['cartes_bancaires', 'mastercard', 'visa']" + 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. @@ -1367,14 +1405,43 @@ class CreateParamsCustomerBalance(TypedDict): class CreateParamsEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class CreateParamsFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -1414,7 +1481,24 @@ class CreateParamsGrabpay(TypedDict): class CreateParamsIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -1460,7 +1544,34 @@ class CreateParamsOxxo(TypedDict): class CreateParamsP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -1473,15 +1584,15 @@ class CreateParamsPaypal(TypedDict): pass class CreateParamsPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -1493,7 +1604,7 @@ class CreateParamsPromptpay(TypedDict): pass class CreateParamsRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -1520,23 +1631,23 @@ class CreateParamsTwint(TypedDict): pass class CreateParamsUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -1548,34 +1659,72 @@ class CreateParamsZip(TypedDict): pass class DetachParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListParams(RequestOptions): - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of the customer whose PaymentMethods will be retrieved. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ type: NotRequired[ - "Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'blik', 'boleto', 'card', 'cashapp', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'konbini', 'link', 'mobilepay', 'multibanco', 'oxxo', 'p24', 'paynow', 'paypal', 'payto', 'pix', 'promptpay', 'revolut_pay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']" + Literal[ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "card", + "cashapp", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "konbini", + "link", + "mobilepay", + "multibanco", + "oxxo", + "p24", + "paynow", + "paypal", + "payto", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "us_bank_account", + "wechat_pay", + "zip", + ] ] """ An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. @@ -1592,7 +1741,7 @@ class ModifyParams(RequestOptions): """ If this is a `card` PaymentMethod, this hash contains the user's card details. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1634,37 +1783,37 @@ class ModifyParamsBillingDetails(TypedDict): """ class ModifyParamsBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ModifyParamsCard(TypedDict): - exp_month: NotRequired["int"] + exp_month: NotRequired[int] """ Two-digit number representing the card's expiration month. """ - exp_year: NotRequired["int"] + exp_year: NotRequired[int] """ Four-digit number representing the card's expiration year. """ @@ -1685,31 +1834,31 @@ class ModifyParamsLink(TypedDict): pass class ModifyParamsPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ class ModifyParamsUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Bank account holder type. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Bank account type. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_payment_method_configuration.py b/stripe/_payment_method_configuration.py index 27587ac03..b97eda042 100644 --- a/stripe/_payment_method_configuration.py +++ b/stripe/_payment_method_configuration.py @@ -978,7 +978,7 @@ class CreateParams(RequestOptions): """ EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1026,7 +1026,7 @@ class CreateParams(RequestOptions): """ Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method. """ - name: NotRequired["str"] + name: NotRequired[str] """ Configuration name. """ @@ -1038,7 +1038,7 @@ class CreateParams(RequestOptions): """ Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details. """ - parent: NotRequired["str"] + parent: NotRequired[str] """ Configuration's parent configuration. Specify to create a child configuration. """ @@ -1094,7 +1094,7 @@ class CreateParamsAcssDebit(TypedDict): """ class CreateParamsAcssDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1108,7 +1108,7 @@ class CreateParamsAffirm(TypedDict): """ class CreateParamsAffirmDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1122,7 +1122,7 @@ class CreateParamsAfterpayClearpay(TypedDict): """ class CreateParamsAfterpayClearpayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1136,7 +1136,7 @@ class CreateParamsAlipay(TypedDict): """ class CreateParamsAlipayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1150,7 +1150,7 @@ class CreateParamsApplePay(TypedDict): """ class CreateParamsApplePayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1164,7 +1164,7 @@ class CreateParamsApplePayLater(TypedDict): """ class CreateParamsApplePayLaterDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1178,7 +1178,7 @@ class CreateParamsAuBecsDebit(TypedDict): """ class CreateParamsAuBecsDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1192,7 +1192,7 @@ class CreateParamsBacsDebit(TypedDict): """ class CreateParamsBacsDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1206,7 +1206,7 @@ class CreateParamsBancontact(TypedDict): """ class CreateParamsBancontactDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1220,7 +1220,7 @@ class CreateParamsBlik(TypedDict): """ class CreateParamsBlikDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1234,7 +1234,7 @@ class CreateParamsBoleto(TypedDict): """ class CreateParamsBoletoDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1248,7 +1248,7 @@ class CreateParamsCard(TypedDict): """ class CreateParamsCardDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1262,7 +1262,7 @@ class CreateParamsCartesBancaires(TypedDict): """ class CreateParamsCartesBancairesDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1276,7 +1276,7 @@ class CreateParamsCashapp(TypedDict): """ class CreateParamsCashappDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1290,7 +1290,7 @@ class CreateParamsCustomerBalance(TypedDict): """ class CreateParamsCustomerBalanceDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1304,7 +1304,7 @@ class CreateParamsEps(TypedDict): """ class CreateParamsEpsDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1318,7 +1318,7 @@ class CreateParamsFpx(TypedDict): """ class CreateParamsFpxDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1332,7 +1332,7 @@ class CreateParamsGiropay(TypedDict): """ class CreateParamsGiropayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1346,7 +1346,7 @@ class CreateParamsGooglePay(TypedDict): """ class CreateParamsGooglePayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1360,7 +1360,7 @@ class CreateParamsGrabpay(TypedDict): """ class CreateParamsGrabpayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1374,7 +1374,7 @@ class CreateParamsIdeal(TypedDict): """ class CreateParamsIdealDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1388,7 +1388,7 @@ class CreateParamsJcb(TypedDict): """ class CreateParamsJcbDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1402,7 +1402,7 @@ class CreateParamsKlarna(TypedDict): """ class CreateParamsKlarnaDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1416,7 +1416,7 @@ class CreateParamsKonbini(TypedDict): """ class CreateParamsKonbiniDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1430,7 +1430,7 @@ class CreateParamsLink(TypedDict): """ class CreateParamsLinkDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1444,7 +1444,7 @@ class CreateParamsMultibanco(TypedDict): """ class CreateParamsMultibancoDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1458,7 +1458,7 @@ class CreateParamsOxxo(TypedDict): """ class CreateParamsOxxoDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1472,7 +1472,7 @@ class CreateParamsP24(TypedDict): """ class CreateParamsP24DisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1486,7 +1486,7 @@ class CreateParamsPaynow(TypedDict): """ class CreateParamsPaynowDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1500,7 +1500,7 @@ class CreateParamsPaypal(TypedDict): """ class CreateParamsPaypalDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1514,7 +1514,7 @@ class CreateParamsPromptpay(TypedDict): """ class CreateParamsPromptpayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1528,7 +1528,7 @@ class CreateParamsRevolutPay(TypedDict): """ class CreateParamsRevolutPayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1542,7 +1542,7 @@ class CreateParamsSepaDebit(TypedDict): """ class CreateParamsSepaDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1556,7 +1556,7 @@ class CreateParamsSofort(TypedDict): """ class CreateParamsSofortDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1570,7 +1570,7 @@ class CreateParamsUsBankAccount(TypedDict): """ class CreateParamsUsBankAccountDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1584,7 +1584,7 @@ class CreateParamsWechatPay(TypedDict): """ class CreateParamsWechatPayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1594,7 +1594,7 @@ class ListParams(RequestOptions): """ The Connect application to filter by. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1606,7 +1606,7 @@ class ModifyParams(RequestOptions): """ Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability. """ - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the configuration can be used for new payments. """ @@ -1686,7 +1686,7 @@ class ModifyParams(RequestOptions): """ EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1734,7 +1734,7 @@ class ModifyParams(RequestOptions): """ Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method. """ - name: NotRequired["str"] + name: NotRequired[str] """ Configuration name. """ @@ -1798,7 +1798,7 @@ class ModifyParamsAcssDebit(TypedDict): """ class ModifyParamsAcssDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1812,7 +1812,7 @@ class ModifyParamsAffirm(TypedDict): """ class ModifyParamsAffirmDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1826,7 +1826,7 @@ class ModifyParamsAfterpayClearpay(TypedDict): """ class ModifyParamsAfterpayClearpayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1840,7 +1840,7 @@ class ModifyParamsAlipay(TypedDict): """ class ModifyParamsAlipayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1854,7 +1854,7 @@ class ModifyParamsApplePay(TypedDict): """ class ModifyParamsApplePayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1868,7 +1868,7 @@ class ModifyParamsApplePayLater(TypedDict): """ class ModifyParamsApplePayLaterDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1882,7 +1882,7 @@ class ModifyParamsAuBecsDebit(TypedDict): """ class ModifyParamsAuBecsDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1896,7 +1896,7 @@ class ModifyParamsBacsDebit(TypedDict): """ class ModifyParamsBacsDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1910,7 +1910,7 @@ class ModifyParamsBancontact(TypedDict): """ class ModifyParamsBancontactDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1924,7 +1924,7 @@ class ModifyParamsBlik(TypedDict): """ class ModifyParamsBlikDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1938,7 +1938,7 @@ class ModifyParamsBoleto(TypedDict): """ class ModifyParamsBoletoDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1952,7 +1952,7 @@ class ModifyParamsCard(TypedDict): """ class ModifyParamsCardDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1966,7 +1966,7 @@ class ModifyParamsCartesBancaires(TypedDict): """ class ModifyParamsCartesBancairesDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1980,7 +1980,7 @@ class ModifyParamsCashapp(TypedDict): """ class ModifyParamsCashappDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1994,7 +1994,7 @@ class ModifyParamsCustomerBalance(TypedDict): """ class ModifyParamsCustomerBalanceDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2008,7 +2008,7 @@ class ModifyParamsEps(TypedDict): """ class ModifyParamsEpsDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2022,7 +2022,7 @@ class ModifyParamsFpx(TypedDict): """ class ModifyParamsFpxDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2036,7 +2036,7 @@ class ModifyParamsGiropay(TypedDict): """ class ModifyParamsGiropayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2050,7 +2050,7 @@ class ModifyParamsGooglePay(TypedDict): """ class ModifyParamsGooglePayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2064,7 +2064,7 @@ class ModifyParamsGrabpay(TypedDict): """ class ModifyParamsGrabpayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2078,7 +2078,7 @@ class ModifyParamsIdeal(TypedDict): """ class ModifyParamsIdealDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2092,7 +2092,7 @@ class ModifyParamsJcb(TypedDict): """ class ModifyParamsJcbDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2106,7 +2106,7 @@ class ModifyParamsKlarna(TypedDict): """ class ModifyParamsKlarnaDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2120,7 +2120,7 @@ class ModifyParamsKonbini(TypedDict): """ class ModifyParamsKonbiniDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2134,7 +2134,7 @@ class ModifyParamsLink(TypedDict): """ class ModifyParamsLinkDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2148,7 +2148,7 @@ class ModifyParamsMultibanco(TypedDict): """ class ModifyParamsMultibancoDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2162,7 +2162,7 @@ class ModifyParamsOxxo(TypedDict): """ class ModifyParamsOxxoDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2176,7 +2176,7 @@ class ModifyParamsP24(TypedDict): """ class ModifyParamsP24DisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2190,7 +2190,7 @@ class ModifyParamsPaynow(TypedDict): """ class ModifyParamsPaynowDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2204,7 +2204,7 @@ class ModifyParamsPaypal(TypedDict): """ class ModifyParamsPaypalDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2218,7 +2218,7 @@ class ModifyParamsPromptpay(TypedDict): """ class ModifyParamsPromptpayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2232,7 +2232,7 @@ class ModifyParamsRevolutPay(TypedDict): """ class ModifyParamsRevolutPayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2246,7 +2246,7 @@ class ModifyParamsSepaDebit(TypedDict): """ class ModifyParamsSepaDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2260,7 +2260,7 @@ class ModifyParamsSofort(TypedDict): """ class ModifyParamsSofortDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2274,7 +2274,7 @@ class ModifyParamsUsBankAccount(TypedDict): """ class ModifyParamsUsBankAccountDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -2288,13 +2288,13 @@ class ModifyParamsWechatPay(TypedDict): """ class ModifyParamsWechatPayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_payment_method_configuration_service.py b/stripe/_payment_method_configuration_service.py index 70025e9e3..e0f9d44a9 100644 --- a/stripe/_payment_method_configuration_service.py +++ b/stripe/_payment_method_configuration_service.py @@ -101,7 +101,7 @@ class CreateParams(TypedDict): """ EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -159,7 +159,7 @@ class CreateParams(TypedDict): """ Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method. """ - name: NotRequired["str"] + name: NotRequired[str] """ Configuration name. """ @@ -171,7 +171,7 @@ class CreateParams(TypedDict): """ Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details. """ - parent: NotRequired["str"] + parent: NotRequired[str] """ Configuration's parent configuration. Specify to create a child configuration. """ @@ -233,7 +233,7 @@ class CreateParamsAcssDebit(TypedDict): """ class CreateParamsAcssDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -247,7 +247,7 @@ class CreateParamsAffirm(TypedDict): """ class CreateParamsAffirmDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -261,7 +261,7 @@ class CreateParamsAfterpayClearpay(TypedDict): """ class CreateParamsAfterpayClearpayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -275,7 +275,7 @@ class CreateParamsAlipay(TypedDict): """ class CreateParamsAlipayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -289,7 +289,7 @@ class CreateParamsApplePay(TypedDict): """ class CreateParamsApplePayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -303,7 +303,7 @@ class CreateParamsApplePayLater(TypedDict): """ class CreateParamsApplePayLaterDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -317,7 +317,7 @@ class CreateParamsAuBecsDebit(TypedDict): """ class CreateParamsAuBecsDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -331,7 +331,7 @@ class CreateParamsBacsDebit(TypedDict): """ class CreateParamsBacsDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -345,7 +345,7 @@ class CreateParamsBancontact(TypedDict): """ class CreateParamsBancontactDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -359,7 +359,7 @@ class CreateParamsBlik(TypedDict): """ class CreateParamsBlikDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -373,7 +373,7 @@ class CreateParamsBoleto(TypedDict): """ class CreateParamsBoletoDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -387,7 +387,7 @@ class CreateParamsCard(TypedDict): """ class CreateParamsCardDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -401,7 +401,7 @@ class CreateParamsCartesBancaires(TypedDict): """ class CreateParamsCartesBancairesDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -415,7 +415,7 @@ class CreateParamsCashapp(TypedDict): """ class CreateParamsCashappDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -429,7 +429,7 @@ class CreateParamsCustomerBalance(TypedDict): """ class CreateParamsCustomerBalanceDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -443,7 +443,7 @@ class CreateParamsEps(TypedDict): """ class CreateParamsEpsDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -457,7 +457,7 @@ class CreateParamsFpx(TypedDict): """ class CreateParamsFpxDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -471,7 +471,7 @@ class CreateParamsGiropay(TypedDict): """ class CreateParamsGiropayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -485,7 +485,7 @@ class CreateParamsGooglePay(TypedDict): """ class CreateParamsGooglePayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -499,7 +499,7 @@ class CreateParamsGrabpay(TypedDict): """ class CreateParamsGrabpayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -513,7 +513,7 @@ class CreateParamsIdeal(TypedDict): """ class CreateParamsIdealDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -527,7 +527,7 @@ class CreateParamsJcb(TypedDict): """ class CreateParamsJcbDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -541,7 +541,7 @@ class CreateParamsKlarna(TypedDict): """ class CreateParamsKlarnaDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -555,7 +555,7 @@ class CreateParamsKonbini(TypedDict): """ class CreateParamsKonbiniDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -569,7 +569,7 @@ class CreateParamsLink(TypedDict): """ class CreateParamsLinkDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -583,7 +583,7 @@ class CreateParamsMultibanco(TypedDict): """ class CreateParamsMultibancoDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -597,7 +597,7 @@ class CreateParamsOxxo(TypedDict): """ class CreateParamsOxxoDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -611,7 +611,7 @@ class CreateParamsP24(TypedDict): """ class CreateParamsP24DisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -625,7 +625,7 @@ class CreateParamsPaynow(TypedDict): """ class CreateParamsPaynowDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -639,7 +639,7 @@ class CreateParamsPaypal(TypedDict): """ class CreateParamsPaypalDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -653,7 +653,7 @@ class CreateParamsPromptpay(TypedDict): """ class CreateParamsPromptpayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -667,7 +667,7 @@ class CreateParamsRevolutPay(TypedDict): """ class CreateParamsRevolutPayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -681,7 +681,7 @@ class CreateParamsSepaDebit(TypedDict): """ class CreateParamsSepaDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -695,7 +695,7 @@ class CreateParamsSofort(TypedDict): """ class CreateParamsSofortDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -709,7 +709,7 @@ class CreateParamsUsBankAccount(TypedDict): """ class CreateParamsUsBankAccountDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -723,7 +723,7 @@ class CreateParamsWechatPay(TypedDict): """ class CreateParamsWechatPayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -733,13 +733,13 @@ class ListParams(TypedDict): """ The Connect application to filter by. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -751,7 +751,7 @@ class UpdateParams(TypedDict): """ Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability. """ - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the configuration can be used for new payments. """ @@ -839,7 +839,7 @@ class UpdateParams(TypedDict): """ EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -897,7 +897,7 @@ class UpdateParams(TypedDict): """ Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method. """ - name: NotRequired["str"] + name: NotRequired[str] """ Configuration name. """ @@ -967,7 +967,7 @@ class UpdateParamsAcssDebit(TypedDict): """ class UpdateParamsAcssDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -981,7 +981,7 @@ class UpdateParamsAffirm(TypedDict): """ class UpdateParamsAffirmDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -995,7 +995,7 @@ class UpdateParamsAfterpayClearpay(TypedDict): """ class UpdateParamsAfterpayClearpayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1009,7 +1009,7 @@ class UpdateParamsAlipay(TypedDict): """ class UpdateParamsAlipayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1023,7 +1023,7 @@ class UpdateParamsApplePay(TypedDict): """ class UpdateParamsApplePayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1037,7 +1037,7 @@ class UpdateParamsApplePayLater(TypedDict): """ class UpdateParamsApplePayLaterDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1051,7 +1051,7 @@ class UpdateParamsAuBecsDebit(TypedDict): """ class UpdateParamsAuBecsDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1065,7 +1065,7 @@ class UpdateParamsBacsDebit(TypedDict): """ class UpdateParamsBacsDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1079,7 +1079,7 @@ class UpdateParamsBancontact(TypedDict): """ class UpdateParamsBancontactDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1093,7 +1093,7 @@ class UpdateParamsBlik(TypedDict): """ class UpdateParamsBlikDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1107,7 +1107,7 @@ class UpdateParamsBoleto(TypedDict): """ class UpdateParamsBoletoDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1121,7 +1121,7 @@ class UpdateParamsCard(TypedDict): """ class UpdateParamsCardDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1135,7 +1135,7 @@ class UpdateParamsCartesBancaires(TypedDict): """ class UpdateParamsCartesBancairesDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1149,7 +1149,7 @@ class UpdateParamsCashapp(TypedDict): """ class UpdateParamsCashappDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1163,7 +1163,7 @@ class UpdateParamsCustomerBalance(TypedDict): """ class UpdateParamsCustomerBalanceDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1177,7 +1177,7 @@ class UpdateParamsEps(TypedDict): """ class UpdateParamsEpsDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1191,7 +1191,7 @@ class UpdateParamsFpx(TypedDict): """ class UpdateParamsFpxDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1205,7 +1205,7 @@ class UpdateParamsGiropay(TypedDict): """ class UpdateParamsGiropayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1219,7 +1219,7 @@ class UpdateParamsGooglePay(TypedDict): """ class UpdateParamsGooglePayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1233,7 +1233,7 @@ class UpdateParamsGrabpay(TypedDict): """ class UpdateParamsGrabpayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1247,7 +1247,7 @@ class UpdateParamsIdeal(TypedDict): """ class UpdateParamsIdealDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1261,7 +1261,7 @@ class UpdateParamsJcb(TypedDict): """ class UpdateParamsJcbDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1275,7 +1275,7 @@ class UpdateParamsKlarna(TypedDict): """ class UpdateParamsKlarnaDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1289,7 +1289,7 @@ class UpdateParamsKonbini(TypedDict): """ class UpdateParamsKonbiniDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1303,7 +1303,7 @@ class UpdateParamsLink(TypedDict): """ class UpdateParamsLinkDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1317,7 +1317,7 @@ class UpdateParamsMultibanco(TypedDict): """ class UpdateParamsMultibancoDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1331,7 +1331,7 @@ class UpdateParamsOxxo(TypedDict): """ class UpdateParamsOxxoDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1345,7 +1345,7 @@ class UpdateParamsP24(TypedDict): """ class UpdateParamsP24DisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1359,7 +1359,7 @@ class UpdateParamsPaynow(TypedDict): """ class UpdateParamsPaynowDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1373,7 +1373,7 @@ class UpdateParamsPaypal(TypedDict): """ class UpdateParamsPaypalDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1387,7 +1387,7 @@ class UpdateParamsPromptpay(TypedDict): """ class UpdateParamsPromptpayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1401,7 +1401,7 @@ class UpdateParamsRevolutPay(TypedDict): """ class UpdateParamsRevolutPayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1415,7 +1415,7 @@ class UpdateParamsSepaDebit(TypedDict): """ class UpdateParamsSepaDebitDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1429,7 +1429,7 @@ class UpdateParamsSofort(TypedDict): """ class UpdateParamsSofortDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1443,7 +1443,7 @@ class UpdateParamsUsBankAccount(TypedDict): """ class UpdateParamsUsBankAccountDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ @@ -1457,7 +1457,7 @@ class UpdateParamsWechatPay(TypedDict): """ class UpdateParamsWechatPayDisplayPreference(TypedDict): - preference: NotRequired["Literal['none', 'off', 'on']"] + preference: NotRequired[Literal["none", "off", "on"]] """ The account's preference for whether or not to display this payment method. """ diff --git a/stripe/_payment_method_domain.py b/stripe/_payment_method_domain.py index 4ecf7d01c..c92a4c5c2 100644 --- a/stripe/_payment_method_domain.py +++ b/stripe/_payment_method_domain.py @@ -100,59 +100,59 @@ class CreateParams(RequestOptions): """ The domain name that this payment method domain object represents. """ - enabled: NotRequired["bool"] + 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. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListParams(RequestOptions): - domain_name: NotRequired["str"] + domain_name: NotRequired[str] """ The domain name that this payment method domain object represents. """ - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + 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. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ValidateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_payment_method_domain_service.py b/stripe/_payment_method_domain_service.py index 0882942c9..24692f54a 100644 --- a/stripe/_payment_method_domain_service.py +++ b/stripe/_payment_method_domain_service.py @@ -15,59 +15,59 @@ class CreateParams(TypedDict): """ The domain name that this payment method domain object represents. """ - enabled: NotRequired["bool"] + 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. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListParams(TypedDict): - domain_name: NotRequired["str"] + domain_name: NotRequired[str] """ The domain name that this payment method domain object represents. """ - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - enabled: NotRequired["bool"] + 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. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ValidateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_payment_method_service.py b/stripe/_payment_method_service.py index 5543cb06c..9c4160708 100644 --- a/stripe/_payment_method_service.py +++ b/stripe/_payment_method_service.py @@ -15,7 +15,7 @@ class AttachParams(TypedDict): """ The ID of the customer to which to attach the PaymentMethod. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -75,7 +75,7 @@ class CreateParams(TypedDict): """ If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The `Customer` to whom the original PaymentMethod is attached. """ @@ -89,7 +89,7 @@ class CreateParams(TypedDict): """ If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -127,7 +127,7 @@ class CreateParams(TypedDict): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -147,7 +147,7 @@ class CreateParams(TypedDict): """ If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ The PaymentMethod to share. """ @@ -198,7 +198,45 @@ class CreateParams(TypedDict): If this is a Twint PaymentMethod, this hash contains details about the Twint payment method. """ type: NotRequired[ - "Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'blik', 'boleto', 'card', 'cashapp', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'konbini', 'link', 'mobilepay', 'multibanco', 'oxxo', 'p24', 'paynow', 'paypal', 'payto', 'pix', 'promptpay', 'revolut_pay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']" + Literal[ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "card", + "cashapp", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "konbini", + "link", + "mobilepay", + "multibanco", + "oxxo", + "p24", + "paynow", + "paypal", + "payto", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "us_bank_account", + "wechat_pay", + "zip", + ] ] """ The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. @@ -252,11 +290,11 @@ class CreateParamsAuBecsDebit(TypedDict): """ class CreateParamsBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -285,27 +323,27 @@ class CreateParamsBillingDetails(TypedDict): """ class CreateParamsBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -320,15 +358,15 @@ class CreateParamsBoleto(TypedDict): """ class CreateParamsCard(TypedDict): - cvc: NotRequired["str"] + cvc: NotRequired[str] """ The card's CVC. It is highly recommended to always include this value. """ - exp_month: NotRequired["int"] + exp_month: NotRequired[int] """ Two-digit number representing the card's expiration month. """ - exp_year: NotRequired["int"] + exp_year: NotRequired[int] """ Four-digit number representing the card's expiration year. """ @@ -336,18 +374,18 @@ class CreateParamsCard(TypedDict): """ Contains information about card networks used to process the payment. """ - number: NotRequired["str"] + number: NotRequired[str] """ The card number, as a string without any separators. """ - token: NotRequired["str"] + token: NotRequired[str] """ For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format card: {token: "tok_visa"}. """ class CreateParamsCardNetworks(TypedDict): preferred: NotRequired[ - "Literal['cartes_bancaires', 'mastercard', 'visa']" + 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. @@ -361,14 +399,43 @@ class CreateParamsCustomerBalance(TypedDict): class CreateParamsEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class CreateParamsFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -408,7 +475,24 @@ class CreateParamsGrabpay(TypedDict): class CreateParamsIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -454,7 +538,34 @@ class CreateParamsOxxo(TypedDict): class CreateParamsP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -467,15 +578,15 @@ class CreateParamsPaypal(TypedDict): pass class CreateParamsPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -487,7 +598,7 @@ class CreateParamsPromptpay(TypedDict): pass class CreateParamsRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -514,23 +625,23 @@ class CreateParamsTwint(TypedDict): pass class CreateParamsUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -542,41 +653,79 @@ class CreateParamsZip(TypedDict): pass class DetachParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListParams(TypedDict): - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of the customer whose PaymentMethods will be retrieved. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ type: NotRequired[ - "Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'blik', 'boleto', 'card', 'cashapp', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'konbini', 'link', 'mobilepay', 'multibanco', 'oxxo', 'p24', 'paynow', 'paypal', 'payto', 'pix', 'promptpay', 'revolut_pay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']" + Literal[ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "card", + "cashapp", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "konbini", + "link", + "mobilepay", + "multibanco", + "oxxo", + "p24", + "paynow", + "paypal", + "payto", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "us_bank_account", + "wechat_pay", + "zip", + ] ] """ An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -592,7 +741,7 @@ class UpdateParams(TypedDict): """ If this is a `card` PaymentMethod, this hash contains the user's card details. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -636,37 +785,37 @@ class UpdateParamsBillingDetails(TypedDict): """ class UpdateParamsBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class UpdateParamsCard(TypedDict): - exp_month: NotRequired["int"] + exp_month: NotRequired[int] """ Two-digit number representing the card's expiration month. """ - exp_year: NotRequired["int"] + exp_year: NotRequired[int] """ Four-digit number representing the card's expiration year. """ @@ -687,25 +836,25 @@ class UpdateParamsLink(TypedDict): pass class UpdateParamsPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ class UpdateParamsUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Bank account holder type. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Bank account type. """ diff --git a/stripe/_payout.py b/stripe/_payout.py index 005f63d5b..6becddf37 100644 --- a/stripe/_payout.py +++ b/stripe/_payout.py @@ -41,7 +41,7 @@ class Payout( OBJECT_NAME: ClassVar[Literal["payout"]] = "payout" class CancelParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -55,31 +55,31 @@ class CreateParams(RequestOptions): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - destination: NotRequired["str"] + destination: NotRequired[str] """ The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - method: NotRequired["Literal['instant', 'standard']"] + method: NotRequired[Literal["instant", "standard"]] """ The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks). """ - source_type: NotRequired["Literal['bank_account', 'card', 'fpx']"] + source_type: NotRequired[Literal["bank_account", "card", "fpx"]] """ The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all. """ @@ -93,69 +93,69 @@ class ListParams(RequestOptions): """ Only return payouts that were created during the given date interval. """ - destination: NotRequired["str"] + destination: NotRequired[str] """ The ID of an external account - only return payouts sent to this external account. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - status: NotRequired["str"] + status: NotRequired[str] """ Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`. """ class ListParamsArrivalDate(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -165,17 +165,17 @@ class ModifyParams(RequestOptions): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ReverseParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ diff --git a/stripe/_payout_service.py b/stripe/_payout_service.py index cb6efc17b..2d579cd7a 100644 --- a/stripe/_payout_service.py +++ b/stripe/_payout_service.py @@ -11,7 +11,7 @@ class PayoutService(StripeService): class CancelParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -25,31 +25,31 @@ class CreateParams(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - destination: NotRequired["str"] + destination: NotRequired[str] """ The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - method: NotRequired["Literal['instant', 'standard']"] + method: NotRequired[Literal["instant", "standard"]] """ The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks). """ - source_type: NotRequired["Literal['bank_account', 'card', 'fpx']"] + source_type: NotRequired[Literal["bank_account", "card", "fpx"]] """ The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all. """ @@ -63,85 +63,85 @@ class ListParams(TypedDict): """ Only return payouts that were created during the given date interval. """ - destination: NotRequired["str"] + destination: NotRequired[str] """ The ID of an external account - only return payouts sent to this external account. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - status: NotRequired["str"] + status: NotRequired[str] """ Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`. """ class ListParamsArrivalDate(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ReverseParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ class UpdateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_plan.py b/stripe/_plan.py index ba6b9caa8..7d2343e04 100644 --- a/stripe/_plan.py +++ b/stripe/_plan.py @@ -74,25 +74,25 @@ class TransformUsage(StripeObject): """ class CreateParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the plan is currently available for new subscriptions. Defaults to `true`. """ aggregate_usage: NotRequired[ - "Literal['last_during_period', 'last_ever', 'max', 'sum']" + Literal["last_during_period", "last_ever", "max", "sum"] ] """ Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`. """ - amount: NotRequired["int"] + amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis. """ - amount_decimal: NotRequired["str"] + amount_decimal: NotRequired[str] """ Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set. """ - billing_scheme: NotRequired["Literal['per_unit', 'tiered']"] + billing_scheme: NotRequired[Literal["per_unit", "tiered"]] """ Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes. """ @@ -100,11 +100,11 @@ class CreateParams(RequestOptions): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - id: NotRequired["str"] + id: NotRequired[str] """ An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes. """ @@ -112,7 +112,7 @@ class CreateParams(RequestOptions): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -120,20 +120,20 @@ class CreateParams(RequestOptions): """ 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`. """ - meter: NotRequired["str"] + meter: NotRequired[str] """ The meter tracking the usage of a metered price """ - nickname: NotRequired["str"] + nickname: NotRequired[str] """ A brief description of the plan, hidden from customers. """ product: NotRequired["Plan.CreateParamsProduct|str"] - tiers: NotRequired["List[Plan.CreateParamsTier]"] + tiers: NotRequired[List["Plan.CreateParamsTier"]] """ Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. """ - tiers_mode: NotRequired["Literal['graduated', 'volume']"] + tiers_mode: NotRequired[Literal["graduated", "volume"]] """ Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows. """ @@ -141,25 +141,25 @@ class CreateParams(RequestOptions): """ Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. """ - trial_period_days: NotRequired["int"] + trial_period_days: NotRequired[int] """ Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). """ - usage_type: NotRequired["Literal['licensed', 'metered']"] + usage_type: NotRequired[Literal["licensed", "metered"]] """ Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. """ class CreateParamsProduct(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the product is currently available for purchase. Defaults to `true`. """ - id: NotRequired["str"] + id: NotRequired[str] """ The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -167,35 +167,35 @@ class CreateParamsProduct(TypedDict): """ The product's name, meant to be displayable to the customer. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ - unit_label: NotRequired["str"] + unit_label: NotRequired[str] """ A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. """ class CreateParamsTier(TypedDict): - flat_amount: NotRequired["int"] + flat_amount: NotRequired[int] """ The flat billing amount for an entire tier, regardless of the number of units in the tier. """ - flat_amount_decimal: NotRequired["str"] + flat_amount_decimal: NotRequired[str] """ Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The per unit billing amount for each individual unit for which this tier applies. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -218,7 +218,7 @@ class DeleteParams(RequestOptions): pass class ListParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans). """ @@ -226,51 +226,51 @@ class ListParams(RequestOptions): """ 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"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - product: NotRequired["str"] + product: NotRequired[str] """ Only return plans for the given product. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the plan is currently available for new subscriptions. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -278,21 +278,21 @@ class ModifyParams(RequestOptions): """ 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`. """ - nickname: NotRequired["str"] + nickname: NotRequired[str] """ A brief description of the plan, hidden from customers. """ - product: NotRequired["str"] + product: NotRequired[str] """ The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule. """ - trial_period_days: NotRequired["int"] + trial_period_days: NotRequired[int] """ Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_plan_service.py b/stripe/_plan_service.py index b9d01d715..1e6e35759 100644 --- a/stripe/_plan_service.py +++ b/stripe/_plan_service.py @@ -11,25 +11,25 @@ class PlanService(StripeService): class CreateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the plan is currently available for new subscriptions. Defaults to `true`. """ aggregate_usage: NotRequired[ - "Literal['last_during_period', 'last_ever', 'max', 'sum']" + Literal["last_during_period", "last_ever", "max", "sum"] ] """ Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`. """ - amount: NotRequired["int"] + amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis. """ - amount_decimal: NotRequired["str"] + amount_decimal: NotRequired[str] """ Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set. """ - billing_scheme: NotRequired["Literal['per_unit', 'tiered']"] + billing_scheme: NotRequired[Literal["per_unit", "tiered"]] """ Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes. """ @@ -37,11 +37,11 @@ class CreateParams(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - id: NotRequired["str"] + id: NotRequired[str] """ An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes. """ @@ -49,7 +49,7 @@ class CreateParams(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -57,20 +57,20 @@ class CreateParams(TypedDict): """ 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`. """ - meter: NotRequired["str"] + meter: NotRequired[str] """ The meter tracking the usage of a metered price """ - nickname: NotRequired["str"] + nickname: NotRequired[str] """ A brief description of the plan, hidden from customers. """ product: NotRequired["PlanService.CreateParamsProduct|str"] - tiers: NotRequired["List[PlanService.CreateParamsTier]"] + tiers: NotRequired[List["PlanService.CreateParamsTier"]] """ Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. """ - tiers_mode: NotRequired["Literal['graduated', 'volume']"] + tiers_mode: NotRequired[Literal["graduated", "volume"]] """ Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows. """ @@ -78,25 +78,25 @@ class CreateParams(TypedDict): """ Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. """ - trial_period_days: NotRequired["int"] + trial_period_days: NotRequired[int] """ Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). """ - usage_type: NotRequired["Literal['licensed', 'metered']"] + usage_type: NotRequired[Literal["licensed", "metered"]] """ Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. """ class CreateParamsProduct(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the product is currently available for purchase. Defaults to `true`. """ - id: NotRequired["str"] + id: NotRequired[str] """ The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -104,35 +104,35 @@ class CreateParamsProduct(TypedDict): """ The product's name, meant to be displayable to the customer. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ - unit_label: NotRequired["str"] + unit_label: NotRequired[str] """ A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. """ class CreateParamsTier(TypedDict): - flat_amount: NotRequired["int"] + flat_amount: NotRequired[int] """ The flat billing amount for an entire tier, regardless of the number of units in the tier. """ - flat_amount_decimal: NotRequired["str"] + flat_amount_decimal: NotRequired[str] """ Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The per unit billing amount for each individual unit for which this tier applies. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -155,7 +155,7 @@ class DeleteParams(TypedDict): pass class ListParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans). """ @@ -163,57 +163,57 @@ class ListParams(TypedDict): """ 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"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - product: NotRequired["str"] + product: NotRequired[str] """ Only return plans for the given product. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the plan is currently available for new subscriptions. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -221,15 +221,15 @@ class UpdateParams(TypedDict): """ 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`. """ - nickname: NotRequired["str"] + nickname: NotRequired[str] """ A brief description of the plan, hidden from customers. """ - product: NotRequired["str"] + product: NotRequired[str] """ The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule. """ - trial_period_days: NotRequired["int"] + trial_period_days: NotRequired[int] """ Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). """ diff --git a/stripe/_price.py b/stripe/_price.py index f97482c56..9be70b821 100644 --- a/stripe/_price.py +++ b/stripe/_price.py @@ -202,11 +202,11 @@ class TransformQuantity(StripeObject): """ class CreateParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the price can be used for new purchases. Defaults to `true`. """ - billing_scheme: NotRequired["Literal['per_unit', 'tiered']"] + billing_scheme: NotRequired[Literal["per_unit", "tiered"]] """ Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes. """ @@ -215,7 +215,7 @@ class CreateParams(RequestOptions): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, Price.CreateParamsCurrencyOptions]" + Dict[str, "Price.CreateParamsCurrencyOptions"] ] """ Prices 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). @@ -224,23 +224,23 @@ class CreateParams(RequestOptions): """ When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - lookup_key: NotRequired["str"] + lookup_key: NotRequired[str] """ A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - nickname: NotRequired["str"] + nickname: NotRequired[str] """ A brief description of the price, hidden from customers. """ - product: NotRequired["str"] + product: NotRequired[str] """ The ID of the product that this price will belong to. """ @@ -253,20 +253,20 @@ class CreateParams(RequestOptions): The recurring components of a price such as `interval` and `usage_type`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - tiers: NotRequired["List[Price.CreateParamsTier]"] + tiers: NotRequired[List["Price.CreateParamsTier"]] """ Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. """ - tiers_mode: NotRequired["Literal['graduated', 'volume']"] + tiers_mode: NotRequired[Literal["graduated", "volume"]] """ Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows. """ - transfer_lookup_key: NotRequired["bool"] + transfer_lookup_key: NotRequired[bool] """ If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. """ @@ -274,11 +274,11 @@ class CreateParams(RequestOptions): """ Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount` or `custom_unit_amount` is required, unless `billing_scheme=tiered`. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -291,20 +291,20 @@ class CreateParamsCurrencyOptions(TypedDict): When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - tiers: NotRequired["List[Price.CreateParamsCurrencyOptionsTier]"] + tiers: NotRequired[List["Price.CreateParamsCurrencyOptionsTier"]] """ Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -314,33 +314,33 @@ class CreateParamsCurrencyOptionsCustomUnitAmount(TypedDict): """ Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`. """ - maximum: NotRequired["int"] + maximum: NotRequired[int] """ The maximum unit amount the customer can specify for this item. """ - minimum: NotRequired["int"] + minimum: NotRequired[int] """ The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. """ - preset: NotRequired["int"] + preset: NotRequired[int] """ The starting unit amount which can be updated by the customer. """ class CreateParamsCurrencyOptionsTier(TypedDict): - flat_amount: NotRequired["int"] + flat_amount: NotRequired[int] """ The flat billing amount for an entire tier, regardless of the number of units in the tier. """ - flat_amount_decimal: NotRequired["str"] + flat_amount_decimal: NotRequired[str] """ Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The per unit billing amount for each individual unit for which this tier applies. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -354,29 +354,29 @@ class CreateParamsCustomUnitAmount(TypedDict): """ Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`. """ - maximum: NotRequired["int"] + maximum: NotRequired[int] """ The maximum unit amount the customer can specify for this item. """ - minimum: NotRequired["int"] + minimum: NotRequired[int] """ The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. """ - preset: NotRequired["int"] + preset: NotRequired[int] """ The starting unit amount which can be updated by the customer. """ class CreateParamsProductData(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the product is currently available for purchase. Defaults to `true`. """ - id: NotRequired["str"] + id: NotRequired[str] """ The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -384,24 +384,24 @@ class CreateParamsProductData(TypedDict): """ The product's name, meant to be displayable to the customer. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ - unit_label: NotRequired["str"] + unit_label: NotRequired[str] """ A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. """ class CreateParamsRecurring(TypedDict): aggregate_usage: NotRequired[ - "Literal['last_during_period', 'last_ever', 'max', 'sum']" + Literal["last_during_period", "last_ever", "max", "sum"] ] """ Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`. @@ -410,37 +410,37 @@ class CreateParamsRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ - meter: NotRequired["str"] + meter: NotRequired[str] """ The meter tracking the usage of a metered price """ - trial_period_days: NotRequired["int"] + trial_period_days: NotRequired[int] """ Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). """ - usage_type: NotRequired["Literal['licensed', 'metered']"] + usage_type: NotRequired[Literal["licensed", "metered"]] """ Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. """ class CreateParamsTier(TypedDict): - flat_amount: NotRequired["int"] + flat_amount: NotRequired[int] """ The flat billing amount for an entire tier, regardless of the number of units in the tier. """ - flat_amount_decimal: NotRequired["str"] + flat_amount_decimal: NotRequired[str] """ Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The per unit billing amount for each individual unit for which this tier applies. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -460,7 +460,7 @@ class CreateParamsTransformQuantity(TypedDict): """ class ListParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices). """ @@ -468,27 +468,27 @@ class ListParams(RequestOptions): """ 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. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Only return prices for the given currency. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - lookup_keys: NotRequired["List[str]"] + lookup_keys: NotRequired[List[str]] """ Only return the price with these lookup_keys, if any exist. """ - product: NotRequired["str"] + product: NotRequired[str] """ Only return prices for the given product. """ @@ -496,49 +496,49 @@ class ListParams(RequestOptions): """ Only return prices with these recurring fields. """ - starting_after: NotRequired["str"] + 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. """ - type: NotRequired["Literal['one_time', 'recurring']"] + type: NotRequired[Literal["one_time", "recurring"]] """ Only return prices of type `recurring` or `one_time`. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsRecurring(TypedDict): - interval: NotRequired["Literal['day', 'month', 'week', 'year']"] + interval: NotRequired[Literal["day", "month", "week", "year"]] """ Filter by billing frequency. Either `day`, `week`, `month` or `year`. """ - meter: NotRequired["str"] + meter: NotRequired[str] """ Filter by the price's meter. """ - usage_type: NotRequired["Literal['licensed', 'metered']"] + usage_type: NotRequired[Literal["licensed", "metered"]] """ Filter by the usage type for this price. Can be either `metered` or `licensed`. """ class ModifyParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the price can be used for new purchases. Defaults to `true`. """ @@ -548,11 +548,11 @@ class ModifyParams(RequestOptions): """ Prices 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). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - lookup_key: NotRequired["str"] + lookup_key: NotRequired[str] """ A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. """ @@ -564,17 +564,17 @@ class ModifyParams(RequestOptions): """ If specified, subscriptions using this price will be updated to use the new referenced price. """ - nickname: NotRequired["str"] + nickname: NotRequired[str] """ A brief description of the price, hidden from customers. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - transfer_lookup_key: NotRequired["bool"] + transfer_lookup_key: NotRequired[bool] """ If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. """ @@ -587,20 +587,20 @@ class ModifyParamsCurrencyOptions(TypedDict): When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - tiers: NotRequired["List[Price.ModifyParamsCurrencyOptionsTier]"] + tiers: NotRequired[List["Price.ModifyParamsCurrencyOptionsTier"]] """ Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -610,33 +610,33 @@ class ModifyParamsCurrencyOptionsCustomUnitAmount(TypedDict): """ Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`. """ - maximum: NotRequired["int"] + maximum: NotRequired[int] """ The maximum unit amount the customer can specify for this item. """ - minimum: NotRequired["int"] + minimum: NotRequired[int] """ The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. """ - preset: NotRequired["int"] + preset: NotRequired[int] """ The starting unit amount which can be updated by the customer. """ class ModifyParamsCurrencyOptionsTier(TypedDict): - flat_amount: NotRequired["int"] + flat_amount: NotRequired[int] """ The flat billing amount for an entire tier, regardless of the number of units in the tier. """ - flat_amount_decimal: NotRequired["str"] + flat_amount_decimal: NotRequired[str] """ Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The per unit billing amount for each individual unit for which this tier applies. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -650,7 +650,7 @@ class ModifyParamsMigrateTo(TypedDict): """ The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`. """ - effective_after: NotRequired["int"] + effective_after: NotRequired[int] """ The time after which subscriptions should start using the new price. """ @@ -660,21 +660,21 @@ class ModifyParamsMigrateTo(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SearchParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - page: NotRequired["str"] + page: NotRequired[str] """ A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. """ diff --git a/stripe/_price_service.py b/stripe/_price_service.py index 7e1979fa2..b4e49e767 100644 --- a/stripe/_price_service.py +++ b/stripe/_price_service.py @@ -12,11 +12,11 @@ class PriceService(StripeService): class CreateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the price can be used for new purchases. Defaults to `true`. """ - billing_scheme: NotRequired["Literal['per_unit', 'tiered']"] + billing_scheme: NotRequired[Literal["per_unit", "tiered"]] """ Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes. """ @@ -25,7 +25,7 @@ class CreateParams(TypedDict): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, PriceService.CreateParamsCurrencyOptions]" + Dict[str, "PriceService.CreateParamsCurrencyOptions"] ] """ Prices 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). @@ -36,23 +36,23 @@ class CreateParams(TypedDict): """ When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - lookup_key: NotRequired["str"] + lookup_key: NotRequired[str] """ A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - nickname: NotRequired["str"] + nickname: NotRequired[str] """ A brief description of the price, hidden from customers. """ - product: NotRequired["str"] + product: NotRequired[str] """ The ID of the product that this price will belong to. """ @@ -65,20 +65,20 @@ class CreateParams(TypedDict): The recurring components of a price such as `interval` and `usage_type`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - tiers: NotRequired["List[PriceService.CreateParamsTier]"] + tiers: NotRequired[List["PriceService.CreateParamsTier"]] """ Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. """ - tiers_mode: NotRequired["Literal['graduated', 'volume']"] + tiers_mode: NotRequired[Literal["graduated", "volume"]] """ Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows. """ - transfer_lookup_key: NotRequired["bool"] + transfer_lookup_key: NotRequired[bool] """ If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. """ @@ -88,11 +88,11 @@ class CreateParams(TypedDict): """ Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount` or `custom_unit_amount` is required, unless `billing_scheme=tiered`. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -105,22 +105,22 @@ class CreateParamsCurrencyOptions(TypedDict): When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ tiers: NotRequired[ - "List[PriceService.CreateParamsCurrencyOptionsTier]" + List["PriceService.CreateParamsCurrencyOptionsTier"] ] """ Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -130,33 +130,33 @@ class CreateParamsCurrencyOptionsCustomUnitAmount(TypedDict): """ Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`. """ - maximum: NotRequired["int"] + maximum: NotRequired[int] """ The maximum unit amount the customer can specify for this item. """ - minimum: NotRequired["int"] + minimum: NotRequired[int] """ The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. """ - preset: NotRequired["int"] + preset: NotRequired[int] """ The starting unit amount which can be updated by the customer. """ class CreateParamsCurrencyOptionsTier(TypedDict): - flat_amount: NotRequired["int"] + flat_amount: NotRequired[int] """ The flat billing amount for an entire tier, regardless of the number of units in the tier. """ - flat_amount_decimal: NotRequired["str"] + flat_amount_decimal: NotRequired[str] """ Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The per unit billing amount for each individual unit for which this tier applies. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -170,29 +170,29 @@ class CreateParamsCustomUnitAmount(TypedDict): """ Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`. """ - maximum: NotRequired["int"] + maximum: NotRequired[int] """ The maximum unit amount the customer can specify for this item. """ - minimum: NotRequired["int"] + minimum: NotRequired[int] """ The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. """ - preset: NotRequired["int"] + preset: NotRequired[int] """ The starting unit amount which can be updated by the customer. """ class CreateParamsProductData(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the product is currently available for purchase. Defaults to `true`. """ - id: NotRequired["str"] + id: NotRequired[str] """ The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -200,24 +200,24 @@ class CreateParamsProductData(TypedDict): """ The product's name, meant to be displayable to the customer. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ - unit_label: NotRequired["str"] + unit_label: NotRequired[str] """ A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. """ class CreateParamsRecurring(TypedDict): aggregate_usage: NotRequired[ - "Literal['last_during_period', 'last_ever', 'max', 'sum']" + Literal["last_during_period", "last_ever", "max", "sum"] ] """ Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`. @@ -226,37 +226,37 @@ class CreateParamsRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ - meter: NotRequired["str"] + meter: NotRequired[str] """ The meter tracking the usage of a metered price """ - trial_period_days: NotRequired["int"] + trial_period_days: NotRequired[int] """ Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). """ - usage_type: NotRequired["Literal['licensed', 'metered']"] + usage_type: NotRequired[Literal["licensed", "metered"]] """ Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. """ class CreateParamsTier(TypedDict): - flat_amount: NotRequired["int"] + flat_amount: NotRequired[int] """ The flat billing amount for an entire tier, regardless of the number of units in the tier. """ - flat_amount_decimal: NotRequired["str"] + flat_amount_decimal: NotRequired[str] """ Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The per unit billing amount for each individual unit for which this tier applies. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -276,7 +276,7 @@ class CreateParamsTransformQuantity(TypedDict): """ class ListParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices). """ @@ -284,27 +284,27 @@ class ListParams(TypedDict): """ 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. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Only return prices for the given currency. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - lookup_keys: NotRequired["List[str]"] + lookup_keys: NotRequired[List[str]] """ Only return the price with these lookup_keys, if any exist. """ - product: NotRequired["str"] + product: NotRequired[str] """ Only return prices for the given product. """ @@ -312,63 +312,63 @@ class ListParams(TypedDict): """ Only return prices with these recurring fields. """ - starting_after: NotRequired["str"] + 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. """ - type: NotRequired["Literal['one_time', 'recurring']"] + type: NotRequired[Literal["one_time", "recurring"]] """ Only return prices of type `recurring` or `one_time`. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsRecurring(TypedDict): - interval: NotRequired["Literal['day', 'month', 'week', 'year']"] + interval: NotRequired[Literal["day", "month", "week", "year"]] """ Filter by billing frequency. Either `day`, `week`, `month` or `year`. """ - meter: NotRequired["str"] + meter: NotRequired[str] """ Filter by the price's meter. """ - usage_type: NotRequired["Literal['licensed', 'metered']"] + usage_type: NotRequired[Literal["licensed", "metered"]] """ Filter by the usage type for this price. Can be either `metered` or `licensed`. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SearchParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - page: NotRequired["str"] + page: NotRequired[str] """ A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. """ @@ -378,7 +378,7 @@ class SearchParams(TypedDict): """ class UpdateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the price can be used for new purchases. Defaults to `true`. """ @@ -388,11 +388,11 @@ class UpdateParams(TypedDict): """ Prices 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). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - lookup_key: NotRequired["str"] + lookup_key: NotRequired[str] """ A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. """ @@ -406,17 +406,17 @@ class UpdateParams(TypedDict): """ If specified, subscriptions using this price will be updated to use the new referenced price. """ - nickname: NotRequired["str"] + nickname: NotRequired[str] """ A brief description of the price, hidden from customers. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - transfer_lookup_key: NotRequired["bool"] + transfer_lookup_key: NotRequired[bool] """ If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. """ @@ -429,22 +429,22 @@ class UpdateParamsCurrencyOptions(TypedDict): When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ tiers: NotRequired[ - "List[PriceService.UpdateParamsCurrencyOptionsTier]" + List["PriceService.UpdateParamsCurrencyOptionsTier"] ] """ Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -454,33 +454,33 @@ class UpdateParamsCurrencyOptionsCustomUnitAmount(TypedDict): """ Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`. """ - maximum: NotRequired["int"] + maximum: NotRequired[int] """ The maximum unit amount the customer can specify for this item. """ - minimum: NotRequired["int"] + minimum: NotRequired[int] """ The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. """ - preset: NotRequired["int"] + preset: NotRequired[int] """ The starting unit amount which can be updated by the customer. """ class UpdateParamsCurrencyOptionsTier(TypedDict): - flat_amount: NotRequired["int"] + flat_amount: NotRequired[int] """ The flat billing amount for an entire tier, regardless of the number of units in the tier. """ - flat_amount_decimal: NotRequired["str"] + flat_amount_decimal: NotRequired[str] """ Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The per unit billing amount for each individual unit for which this tier applies. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -494,7 +494,7 @@ class UpdateParamsMigrateTo(TypedDict): """ The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`. """ - effective_after: NotRequired["int"] + effective_after: NotRequired[int] """ The time after which subscriptions should start using the new price. """ diff --git a/stripe/_product.py b/stripe/_product.py index d9a5cab34..01e16f067 100644 --- a/stripe/_product.py +++ b/stripe/_product.py @@ -117,13 +117,13 @@ class CreateFeatureParams(RequestOptions): """ The ID of the [Feature](docs/api/entitlements/feature) object attached to this product. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CreateParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the product is currently available for purchase. Defaults to `true`. """ @@ -131,27 +131,27 @@ class CreateParams(RequestOptions): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product. """ - description: NotRequired["str"] + description: NotRequired[str] """ The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - features: NotRequired["List[Product.CreateParamsFeature]"] + features: NotRequired[List["Product.CreateParamsFeature"]] """ A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). """ - id: NotRequired["str"] + id: NotRequired[str] """ An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. """ - images: NotRequired["List[str]"] + images: NotRequired[List[str]] """ A list of up to 8 URLs of images for this product, meant to be displayable to the customer. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -169,30 +169,30 @@ class CreateParams(RequestOptions): """ Provisioning configuration for this product. """ - shippable: NotRequired["bool"] + shippable: NotRequired[bool] """ Whether this product is shipped (i.e., physical goods). """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ - type: NotRequired["Literal['good', 'service']"] + type: NotRequired[Literal["good", "service"]] """ The type of the product. Defaults to `service` if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to `good` to use this product with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons. """ - unit_label: NotRequired["str"] + unit_label: NotRequired[str] """ A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. """ - url: NotRequired["str"] + url: NotRequired[str] """ A URL of a publicly-accessible webpage for this product. """ @@ -203,7 +203,7 @@ class CreateParamsDefaultPriceData(TypedDict): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, Product.CreateParamsDefaultPriceDataCurrencyOptions]" + Dict[str, "Product.CreateParamsDefaultPriceDataCurrencyOptions"] ] """ Prices 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). @@ -213,16 +213,16 @@ class CreateParamsDefaultPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -235,22 +235,22 @@ class CreateParamsDefaultPriceDataCurrencyOptions(TypedDict): When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ tiers: NotRequired[ - "List[Product.CreateParamsDefaultPriceDataCurrencyOptionsTier]" + List["Product.CreateParamsDefaultPriceDataCurrencyOptionsTier"] ] """ Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -262,33 +262,33 @@ class CreateParamsDefaultPriceDataCurrencyOptionsCustomUnitAmount( """ Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`. """ - maximum: NotRequired["int"] + maximum: NotRequired[int] """ The maximum unit amount the customer can specify for this item. """ - minimum: NotRequired["int"] + minimum: NotRequired[int] """ The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. """ - preset: NotRequired["int"] + preset: NotRequired[int] """ The starting unit amount which can be updated by the customer. """ class CreateParamsDefaultPriceDataCurrencyOptionsTier(TypedDict): - flat_amount: NotRequired["int"] + flat_amount: NotRequired[int] """ The flat billing amount for an entire tier, regardless of the number of units in the tier. """ - flat_amount_decimal: NotRequired["str"] + flat_amount_decimal: NotRequired[str] """ Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The per unit billing amount for each individual unit for which this tier applies. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -302,13 +302,13 @@ class CreateParamsDefaultPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class CreateParamsFeature(TypedDict): - feature: NotRequired["str"] + feature: NotRequired[str] name: str """ The marketing feature name. Up to 80 characters long. @@ -362,25 +362,25 @@ class DeleteParams(RequestOptions): pass class ListFeaturesParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 ListParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Only return products that are active or inactive (e.g., pass `false` to list all inactive products). """ @@ -388,63 +388,63 @@ class ListParams(RequestOptions): """ Only return products that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - ids: NotRequired["List[str]"] + ids: NotRequired[List[str]] """ Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before). """ - limit: NotRequired["int"] + 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. """ - shippable: NotRequired["bool"] + shippable: NotRequired[bool] """ Only return products that can be shipped (i.e., physical, not digital products). """ - starting_after: NotRequired["str"] + 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. """ - type: NotRequired["Literal['good', 'service']"] + type: NotRequired[Literal["good", "service"]] """ Only return products of this type. """ - url: NotRequired["str"] + url: NotRequired[str] """ Only return products with the given url. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the product is available for purchase. """ - default_price: NotRequired["str"] + default_price: NotRequired[str] """ The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product. """ @@ -452,7 +452,7 @@ class ModifyParams(RequestOptions): """ The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -468,7 +468,7 @@ class ModifyParams(RequestOptions): """ 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: NotRequired[str] """ The product's name, meant to be displayable to the customer. """ @@ -478,11 +478,11 @@ class ModifyParams(RequestOptions): """ The dimensions of this product for shipping purposes. """ - shippable: NotRequired["bool"] + shippable: NotRequired[bool] """ Whether this product is shipped (i.e., physical goods). """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. @@ -503,7 +503,7 @@ class ModifyParams(RequestOptions): """ class ModifyParamsFeature(TypedDict): - feature: NotRequired["str"] + feature: NotRequired[str] name: str """ The marketing feature name. Up to 80 characters long. @@ -528,21 +528,21 @@ class ModifyParamsPackageDimensions(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SearchParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - page: NotRequired["str"] + page: NotRequired[str] """ A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. """ diff --git a/stripe/_product_feature_service.py b/stripe/_product_feature_service.py index d86977717..c2fa51f3b 100644 --- a/stripe/_product_feature_service.py +++ b/stripe/_product_feature_service.py @@ -15,7 +15,7 @@ class CreateParams(TypedDict): """ The ID of the [Feature](docs/api/entitlements/feature) object attached to this product. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -24,19 +24,19 @@ class DeleteParams(TypedDict): pass class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/_product_service.py b/stripe/_product_service.py index 4e40f45fa..120656ef3 100644 --- a/stripe/_product_service.py +++ b/stripe/_product_service.py @@ -17,7 +17,7 @@ def __init__(self, requestor): self.features = ProductFeatureService(self._requestor) class CreateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the product is currently available for purchase. Defaults to `true`. """ @@ -27,27 +27,27 @@ class CreateParams(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product. """ - description: NotRequired["str"] + description: NotRequired[str] """ The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - features: NotRequired["List[ProductService.CreateParamsFeature]"] + features: NotRequired[List["ProductService.CreateParamsFeature"]] """ A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). """ - id: NotRequired["str"] + id: NotRequired[str] """ An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. """ - images: NotRequired["List[str]"] + images: NotRequired[List[str]] """ A list of up to 8 URLs of images for this product, meant to be displayable to the customer. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -65,30 +65,30 @@ class CreateParams(TypedDict): """ Provisioning configuration for this product. """ - shippable: NotRequired["bool"] + shippable: NotRequired[bool] """ Whether this product is shipped (i.e., physical goods). """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ - type: NotRequired["Literal['good', 'service']"] + type: NotRequired[Literal["good", "service"]] """ The type of the product. Defaults to `service` if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to `good` to use this product with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons. """ - unit_label: NotRequired["str"] + unit_label: NotRequired[str] """ A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. """ - url: NotRequired["str"] + url: NotRequired[str] """ A URL of a publicly-accessible webpage for this product. """ @@ -99,7 +99,10 @@ class CreateParamsDefaultPriceData(TypedDict): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, ProductService.CreateParamsDefaultPriceDataCurrencyOptions]" + Dict[ + str, + "ProductService.CreateParamsDefaultPriceDataCurrencyOptions", + ] ] """ Prices 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). @@ -111,16 +114,16 @@ class CreateParamsDefaultPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -133,22 +136,24 @@ class CreateParamsDefaultPriceDataCurrencyOptions(TypedDict): When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ tiers: NotRequired[ - "List[ProductService.CreateParamsDefaultPriceDataCurrencyOptionsTier]" + List[ + "ProductService.CreateParamsDefaultPriceDataCurrencyOptionsTier" + ] ] """ Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -160,33 +165,33 @@ class CreateParamsDefaultPriceDataCurrencyOptionsCustomUnitAmount( """ Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`. """ - maximum: NotRequired["int"] + maximum: NotRequired[int] """ The maximum unit amount the customer can specify for this item. """ - minimum: NotRequired["int"] + minimum: NotRequired[int] """ The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. """ - preset: NotRequired["int"] + preset: NotRequired[int] """ The starting unit amount which can be updated by the customer. """ class CreateParamsDefaultPriceDataCurrencyOptionsTier(TypedDict): - flat_amount: NotRequired["int"] + flat_amount: NotRequired[int] """ The flat billing amount for an entire tier, regardless of the number of units in the tier. """ - flat_amount_decimal: NotRequired["str"] + flat_amount_decimal: NotRequired[str] """ Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ The per unit billing amount for each individual unit for which this tier applies. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -200,13 +205,13 @@ class CreateParamsDefaultPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class CreateParamsFeature(TypedDict): - feature: NotRequired["str"] + feature: NotRequired[str] name: str """ The marketing feature name. Up to 80 characters long. @@ -259,7 +264,7 @@ class DeleteParams(TypedDict): pass class ListParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Only return products that are active or inactive (e.g., pass `false` to list all inactive products). """ @@ -267,73 +272,73 @@ class ListParams(TypedDict): """ Only return products that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - ids: NotRequired["List[str]"] + ids: NotRequired[List[str]] """ Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before). """ - limit: NotRequired["int"] + 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. """ - shippable: NotRequired["bool"] + shippable: NotRequired[bool] """ Only return products that can be shipped (i.e., physical, not digital products). """ - starting_after: NotRequired["str"] + 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. """ - type: NotRequired["Literal['good', 'service']"] + type: NotRequired[Literal["good", "service"]] """ Only return products of this type. """ - url: NotRequired["str"] + url: NotRequired[str] """ Only return products with the given url. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SearchParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - page: NotRequired["str"] + page: NotRequired[str] """ A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. """ @@ -343,11 +348,11 @@ class SearchParams(TypedDict): """ class UpdateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the product is available for purchase. """ - default_price: NotRequired["str"] + default_price: NotRequired[str] """ The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product. """ @@ -355,7 +360,7 @@ class UpdateParams(TypedDict): """ The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -373,7 +378,7 @@ class UpdateParams(TypedDict): """ 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: NotRequired[str] """ The product's name, meant to be displayable to the customer. """ @@ -383,11 +388,11 @@ class UpdateParams(TypedDict): """ The dimensions of this product for shipping purposes. """ - shippable: NotRequired["bool"] + shippable: NotRequired[bool] """ Whether this product is shipped (i.e., physical goods). """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. @@ -408,7 +413,7 @@ class UpdateParams(TypedDict): """ class UpdateParamsFeature(TypedDict): - feature: NotRequired["str"] + feature: NotRequired[str] name: str """ The marketing feature name. Up to 80 characters long. diff --git a/stripe/_promotion_code.py b/stripe/_promotion_code.py index d96ad6988..f785facd4 100644 --- a/stripe/_promotion_code.py +++ b/stripe/_promotion_code.py @@ -61,11 +61,11 @@ class CurrencyOptions(StripeObject): _inner_class_dicts = ["currency_options"] class CreateParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the promotion code is currently active. """ - code: NotRequired["str"] + code: NotRequired[str] """ The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically. """ @@ -73,23 +73,23 @@ class CreateParams(RequestOptions): """ The coupon for this promotion code. """ - customer: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + 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"] + 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]"] + 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`. """ @@ -100,40 +100,40 @@ class CreateParams(RequestOptions): class CreateParamsRestrictions(TypedDict): currency_options: NotRequired[ - "Dict[str, PromotionCode.CreateParamsRestrictionsCurrencyOptions]" + 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"] + 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: 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"] + 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: 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"] + active: NotRequired[bool] """ Filter promotion codes by whether they are active. """ - code: NotRequired["str"] + code: NotRequired[str] """ Only return promotion codes that have this case-insensitive code. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ Only return promotion codes for this coupon. """ @@ -141,51 +141,51 @@ class ListParams(RequestOptions): """ 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"] + customer: NotRequired[str] """ Only return promotion codes that are restricted to this customer. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - active: NotRequired["bool"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -200,20 +200,20 @@ class ModifyParams(RequestOptions): class ModifyParamsRestrictions(TypedDict): currency_options: NotRequired[ - "Dict[str, PromotionCode.ModifyParamsRestrictionsCurrencyOptions]" + 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: 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_promotion_code_service.py b/stripe/_promotion_code_service.py index 98309aa57..bdd6734b2 100644 --- a/stripe/_promotion_code_service.py +++ b/stripe/_promotion_code_service.py @@ -11,11 +11,11 @@ class PromotionCodeService(StripeService): class CreateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the promotion code is currently active. """ - code: NotRequired["str"] + code: NotRequired[str] """ The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically. """ @@ -23,23 +23,23 @@ class CreateParams(TypedDict): """ The coupon for this promotion code. """ - customer: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + 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"] + 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]"] + 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`. """ @@ -52,40 +52,43 @@ class CreateParams(TypedDict): class CreateParamsRestrictions(TypedDict): currency_options: NotRequired[ - "Dict[str, PromotionCodeService.CreateParamsRestrictionsCurrencyOptions]" + Dict[ + str, + "PromotionCodeService.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"] + 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: 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"] + 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: 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(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Filter promotion codes by whether they are active. """ - code: NotRequired["str"] + code: NotRequired[str] """ Only return promotion codes that have this case-insensitive code. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ Only return promotion codes for this coupon. """ @@ -93,57 +96,57 @@ class ListParams(TypedDict): """ 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"] + customer: NotRequired[str] """ Only return promotion codes that are restricted to this customer. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - active: NotRequired["bool"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -160,14 +163,17 @@ class UpdateParams(TypedDict): class UpdateParamsRestrictions(TypedDict): currency_options: NotRequired[ - "Dict[str, PromotionCodeService.UpdateParamsRestrictionsCurrencyOptions]" + Dict[ + str, + "PromotionCodeService.UpdateParamsRestrictionsCurrencyOptions", + ] ] """ 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 UpdateParamsRestrictionsCurrencyOptions(TypedDict): - minimum_amount: NotRequired["int"] + 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). """ diff --git a/stripe/_quote.py b/stripe/_quote.py index 297b8fabc..d82d9d9cd 100644 --- a/stripe/_quote.py +++ b/stripe/_quote.py @@ -879,19 +879,19 @@ class TransferData(StripeObject): """ class AcceptParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CancelParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CreateParams(RequestOptions): - allow_backdated_lines: NotRequired["bool"] + allow_backdated_lines: NotRequired[bool] """ Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now. """ @@ -908,12 +908,12 @@ class CreateParams(RequestOptions): Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. """ @@ -929,11 +929,11 @@ class CreateParams(RequestOptions): """ The discounts applied to the quote. You can only set up to one discount. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. """ @@ -953,15 +953,15 @@ class CreateParams(RequestOptions): """ All invoices will be billed using the specified settings. """ - line_items: NotRequired["List[Quote.CreateParamsLineItem]"] + line_items: NotRequired[List["Quote.CreateParamsLineItem"]] """ A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. """ - lines: NotRequired["List[Quote.CreateParamsLine]"] + lines: NotRequired[List["Quote.CreateParamsLine"]] """ A list of lines on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -969,7 +969,7 @@ class CreateParams(RequestOptions): """ The account on behalf of which to charge. """ - phases: NotRequired["List[Quote.CreateParamsPhase]"] + phases: NotRequired[List["Quote.CreateParamsPhase"]] """ List representing phases of the Quote. Each phase can be customized to have different durations, prices, and coupons. """ @@ -978,12 +978,12 @@ class CreateParams(RequestOptions): When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. """ subscription_data_overrides: NotRequired[ - "List[Quote.CreateParamsSubscriptionDataOverride]" + List["Quote.CreateParamsSubscriptionDataOverride"] ] """ List representing overrides for `subscription_data` configurations for specific subscription schedules. """ - test_clock: NotRequired["str"] + test_clock: NotRequired[str] """ ID of the test clock to attach to the quote. """ @@ -1005,7 +1005,7 @@ class CreateParamsAutomaticTax(TypedDict): """ class CreateParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1015,11 +1015,11 @@ class CreateParamsAutomaticTaxLiability(TypedDict): """ class CreateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1033,7 +1033,7 @@ class CreateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1053,7 +1053,7 @@ class CreateParamsDiscountDiscountEndDuration(TypedDict): """ class CreateParamsFromQuote(TypedDict): - is_revision: NotRequired["bool"] + is_revision: NotRequired[bool] """ Whether this quote is a revision of the previous quote. """ @@ -1063,7 +1063,7 @@ class CreateParamsFromQuote(TypedDict): """ class CreateParamsInvoiceSettings(TypedDict): - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`. """ @@ -1073,7 +1073,7 @@ class CreateParamsInvoiceSettings(TypedDict): """ class CreateParamsInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1083,7 +1083,7 @@ class CreateParamsInvoiceSettingsIssuer(TypedDict): """ class CreateParamsLine(TypedDict): - actions: NotRequired["List[Quote.CreateParamsLineAction]"] + actions: NotRequired[List["Quote.CreateParamsLineAction"]] """ An array of operations the quote line performs. """ @@ -1092,7 +1092,7 @@ class CreateParamsLine(TypedDict): Details to identify the subscription schedule the quote line applies to. """ billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'line_starts_at']" + Literal["automatic", "line_starts_at"] ] """ For a point-in-time operation, this attribute lets you set or update whether the subscription's billing cycle anchor is reset at the `starts_at` timestamp. @@ -1102,7 +1102,7 @@ class CreateParamsLine(TypedDict): Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts. @@ -1114,7 +1114,7 @@ class CreateParamsLine(TypedDict): Defines how to pause collection for the underlying subscription throughout the duration of the amendment. """ set_schedule_end: NotRequired[ - "Literal['line_ends_at', 'line_starts_at']" + Literal["line_ends_at", "line_starts_at"] ] """ Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date. @@ -1137,7 +1137,7 @@ class CreateParamsLineAction(TypedDict): """ Details for the `add_item` type. """ - add_metadata: NotRequired["Dict[str, str]"] + add_metadata: NotRequired[Dict[str, str]] """ Details for the `add_metadata` type: specify a hash of key-value pairs. """ @@ -1151,17 +1151,17 @@ class CreateParamsLineAction(TypedDict): """ Details for the `remove_item` type. """ - remove_metadata: NotRequired["List[str]"] + remove_metadata: NotRequired[List[str]] """ Details for the `remove_metadata` type: specify an array of metadata keys. """ set_discounts: NotRequired[ - "List[Quote.CreateParamsLineActionSetDiscount]" + List["Quote.CreateParamsLineActionSetDiscount"] ] """ Details for the `set_discounts` type. """ - set_items: NotRequired["List[Quote.CreateParamsLineActionSetItem]"] + set_items: NotRequired[List["Quote.CreateParamsLineActionSetItem"]] """ Details for the `set_items` type. """ @@ -1187,11 +1187,11 @@ class CreateParamsLineAction(TypedDict): """ class CreateParamsLineActionAddDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to redeem. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount for a coupon that was already redeemed. """ @@ -1201,7 +1201,7 @@ class CreateParamsLineActionAddDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - index: NotRequired["int"] + index: NotRequired[int] """ The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array. """ @@ -1214,12 +1214,12 @@ class CreateParamsLineActionAddDiscountDiscountEnd(TypedDict): class CreateParamsLineActionAddItem(TypedDict): discounts: NotRequired[ - "List[Quote.CreateParamsLineActionAddItemDiscount]" + List["Quote.CreateParamsLineActionAddItemDiscount"] ] """ The discounts applied to the item. Subscription item discounts are applied before subscription discounts. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -1227,11 +1227,11 @@ class CreateParamsLineActionAddItem(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. """ @@ -1241,11 +1241,11 @@ class CreateParamsLineActionAddItem(TypedDict): """ class CreateParamsLineActionAddItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1255,7 +1255,7 @@ class CreateParamsLineActionAddItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1267,7 +1267,7 @@ class CreateParamsLineActionAddItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1287,7 +1287,7 @@ class CreateParamsLineActionAddItemDiscountDiscountEndDuration(TypedDict): """ class CreateParamsLineActionAddItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -1297,15 +1297,15 @@ class CreateParamsLineActionAddItemTrial(TypedDict): """ class CreateParamsLineActionRemoveDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to remove from the `discounts` array. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ The ID of a discount to remove from the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to remove from the `discounts` array. """ @@ -1317,27 +1317,27 @@ class CreateParamsLineActionRemoveItem(TypedDict): """ class CreateParamsLineActionSetDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to replace the `discounts` array with. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount to replace the `discounts` array with. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ An ID of an existing promotion code to replace the `discounts` array with. """ class CreateParamsLineActionSetItem(TypedDict): discounts: NotRequired[ - "List[Quote.CreateParamsLineActionSetItemDiscount]" + List["Quote.CreateParamsLineActionSetItemDiscount"] ] """ If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`. """ @@ -1345,11 +1345,11 @@ class CreateParamsLineActionSetItem(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`. """ @@ -1359,11 +1359,11 @@ class CreateParamsLineActionSetItem(TypedDict): """ class CreateParamsLineActionSetItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1373,7 +1373,7 @@ class CreateParamsLineActionSetItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1385,7 +1385,7 @@ class CreateParamsLineActionSetItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1405,7 +1405,7 @@ class CreateParamsLineActionSetItemDiscountDiscountEndDuration(TypedDict): """ class CreateParamsLineActionSetItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -1415,11 +1415,11 @@ class CreateParamsLineActionSetItemTrial(TypedDict): """ class CreateParamsLineAppliesTo(TypedDict): - new_reference: NotRequired["str"] + new_reference: NotRequired[str] """ A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule. """ - subscription_schedule: NotRequired["str"] + subscription_schedule: NotRequired[str] """ The ID of the schedule the line applies to. """ @@ -1437,7 +1437,7 @@ class CreateParamsLineEndsAt(TypedDict): """ Time span for the quote line starting from the `starts_at` date. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -1477,7 +1477,7 @@ class CreateParamsLineItem(TypedDict): """ The discounts applied to this line item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. One of `price` or `price_data` is required. """ @@ -1485,7 +1485,7 @@ class CreateParamsLineItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item. """ @@ -1495,11 +1495,11 @@ class CreateParamsLineItem(TypedDict): """ class CreateParamsLineItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1517,7 +1517,7 @@ class CreateParamsLineItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1550,16 +1550,16 @@ class CreateParamsLineItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1569,7 +1569,7 @@ class CreateParamsLineItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -1599,7 +1599,7 @@ class CreateParamsLineStartsAt(TypedDict): """ The timestamp the given line ends at. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -1623,7 +1623,7 @@ class CreateParamsLineStartsAtDiscountEnd(TypedDict): """ class CreateParamsLineStartsAtLineEndsAt(TypedDict): - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -1637,18 +1637,18 @@ class CreateParamsLineTrialSettings(TypedDict): """ class CreateParamsLineTrialSettingsEndBehavior(TypedDict): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ class CreateParamsPhase(TypedDict): - billing_cycle_anchor: NotRequired["Literal['reset']"] + billing_cycle_anchor: NotRequired[Literal["reset"]] """ When specified as `reset`, the subscription will always start a new billing period when the quote is accepted. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. @@ -1663,7 +1663,7 @@ class CreateParamsPhase(TypedDict): """ The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ The date at which this phase of the quote ends. If set, `iterations` must not be set. """ @@ -1671,7 +1671,7 @@ class CreateParamsPhase(TypedDict): """ All invoices will be billed using the specified settings. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. """ @@ -1679,31 +1679,31 @@ class CreateParamsPhase(TypedDict): """ A list of line items the customer is being quoted for within this phase. Each line item includes information about the product, the quantity, and the resulting cost. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on the subscription schedule's phases when the quote is accepted. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`. """ - trial: NotRequired["bool"] + trial: NotRequired[bool] """ If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. """ - trial_end: NotRequired["int"] + trial_end: NotRequired[int] """ Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`. """ class CreateParamsPhaseDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1711,7 +1711,7 @@ class CreateParamsPhaseDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1723,7 +1723,7 @@ class CreateParamsPhaseDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1743,7 +1743,7 @@ class CreateParamsPhaseDiscountDiscountEndDuration(TypedDict): """ class CreateParamsPhaseInvoiceSettings(TypedDict): - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. """ @@ -1755,7 +1755,7 @@ class CreateParamsPhaseLineItem(TypedDict): """ The discounts applied to this line item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. One of `price` or `price_data` is required. """ @@ -1763,7 +1763,7 @@ class CreateParamsPhaseLineItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item. """ @@ -1773,11 +1773,11 @@ class CreateParamsPhaseLineItem(TypedDict): """ class CreateParamsPhaseLineItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1795,7 +1795,7 @@ class CreateParamsPhaseLineItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1830,16 +1830,16 @@ class CreateParamsPhaseLineItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1849,7 +1849,7 @@ class CreateParamsPhaseLineItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -1862,7 +1862,7 @@ class CreateParamsSubscriptionData(TypedDict): Describes the period to bill for upon accepting the quote. """ billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. @@ -1871,7 +1871,7 @@ class CreateParamsSubscriptionData(TypedDict): """ When specified as `reset`, the subscription will always start a new billing period when the quote is accepted. """ - description: NotRequired["str"] + description: NotRequired[str] """ The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. """ @@ -1881,19 +1881,19 @@ class CreateParamsSubscriptionData(TypedDict): """ When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted. """ - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. """ - from_schedule: NotRequired["str"] + from_schedule: NotRequired[str] """ The id of a subscription schedule the quote will update. The quote will inherit the state of the subscription schedule, such as `phases`. Cannot be combined with other parameters. """ - from_subscription: NotRequired["str"] + from_subscription: NotRequired[str] """ The id of a subscription that the quote will update. By default, the quote will contain the state of the subscription (such as line items, collection method and billing thresholds) unless overridden. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values. """ @@ -1904,7 +1904,7 @@ class CreateParamsSubscriptionData(TypedDict): If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`. @@ -1941,7 +1941,7 @@ class CreateParamsSubscriptionDataBillOnAcceptanceBillFrom(TypedDict): """ Details of a Quote line to start the bill period from. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -1959,11 +1959,11 @@ class CreateParamsSubscriptionDataBillOnAcceptanceBillFrom(TypedDict): class CreateParamsSubscriptionDataBillOnAcceptanceBillFromLineStartsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -1981,7 +1981,7 @@ class CreateParamsSubscriptionDataBillOnAcceptanceBillUntil(TypedDict): """ Details of a Quote line item from which to bill until. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -2011,11 +2011,11 @@ class CreateParamsSubscriptionDataBillOnAcceptanceBillUntilDuration( class CreateParamsSubscriptionDataBillOnAcceptanceBillUntilLineEndsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -2032,25 +2032,25 @@ class CreateParamsSubscriptionDataOverride(TypedDict): Describes the period to bill for upon accepting the quote. """ billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The customer the Subscription Data override applies to. This is only relevant when `applies_to.type=new_reference`. """ - description: NotRequired["str"] + description: NotRequired[str] """ The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. """ - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`. @@ -2063,11 +2063,11 @@ class CreateParamsSubscriptionDataOverride(TypedDict): """ class CreateParamsSubscriptionDataOverrideAppliesTo(TypedDict): - new_reference: NotRequired["str"] + new_reference: NotRequired[str] """ A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule. """ - subscription_schedule: NotRequired["str"] + subscription_schedule: NotRequired[str] """ The ID of the schedule the line applies to. """ @@ -2099,7 +2099,7 @@ class CreateParamsSubscriptionDataOverrideBillOnAcceptanceBillFrom( """ Details of a Quote line to start the bill period from. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -2117,11 +2117,11 @@ class CreateParamsSubscriptionDataOverrideBillOnAcceptanceBillFrom( class CreateParamsSubscriptionDataOverrideBillOnAcceptanceBillFromLineStartsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -2141,7 +2141,7 @@ class CreateParamsSubscriptionDataOverrideBillOnAcceptanceBillUntil( """ Details of a Quote line item from which to bill until. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -2171,11 +2171,11 @@ class CreateParamsSubscriptionDataOverrideBillOnAcceptanceBillUntilDuration( class CreateParamsSubscriptionDataOverrideBillOnAcceptanceBillUntilLineEndsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -2187,11 +2187,11 @@ class CreateParamsSubscriptionDataPrebilling(TypedDict): """ class CreateParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field. """ - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field. """ @@ -2201,177 +2201,179 @@ class CreateParamsTransferData(TypedDict): """ class FinalizeQuoteParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. """ class ListComputedUpfrontLineItemsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 ListLineItemsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 ListLinesParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 ListParams(RequestOptions): - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of the customer whose quotes will be retrieved. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - from_subscription: NotRequired["str"] + from_subscription: NotRequired[str] """ The subscription which the quote updates. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['accepted', 'accepting', 'canceled', 'draft', 'open', 'stale']" + Literal[ + "accepted", "accepting", "canceled", "draft", "open", "stale" + ] ] """ The status of the quote. """ - test_clock: NotRequired["str"] + test_clock: NotRequired[str] """ Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set. """ class ListPreviewInvoiceLinesParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 ListPreviewInvoicesParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 ListPreviewSubscriptionSchedulesParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 MarkDraftParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class MarkStaleParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - reason: NotRequired["str"] + reason: NotRequired[str] """ Reason the Quote is being marked stale. """ class ModifyParams(RequestOptions): - allow_backdated_lines: NotRequired["bool"] + allow_backdated_lines: NotRequired[bool] """ Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now. """ @@ -2388,12 +2390,12 @@ class ModifyParams(RequestOptions): Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. """ @@ -2409,11 +2411,11 @@ class ModifyParams(RequestOptions): """ The discounts applied to the quote. You can only set up to one discount. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. """ @@ -2429,15 +2431,15 @@ class ModifyParams(RequestOptions): """ All invoices will be billed using the specified settings. """ - line_items: NotRequired["List[Quote.ModifyParamsLineItem]"] + line_items: NotRequired[List["Quote.ModifyParamsLineItem"]] """ A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. """ - lines: NotRequired["List[Quote.ModifyParamsLine]"] + lines: NotRequired[List["Quote.ModifyParamsLine"]] """ A list of lines on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -2445,7 +2447,7 @@ class ModifyParams(RequestOptions): """ The account on behalf of which to charge. """ - phases: NotRequired["List[Quote.ModifyParamsPhase]"] + phases: NotRequired[List["Quote.ModifyParamsPhase"]] """ List representing phases of the Quote. Each phase can be customized to have different durations, prices, and coupons. """ @@ -2477,7 +2479,7 @@ class ModifyParamsAutomaticTax(TypedDict): """ class ModifyParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -2487,11 +2489,11 @@ class ModifyParamsAutomaticTaxLiability(TypedDict): """ class ModifyParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2505,7 +2507,7 @@ class ModifyParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2525,7 +2527,7 @@ class ModifyParamsDiscountDiscountEndDuration(TypedDict): """ class ModifyParamsInvoiceSettings(TypedDict): - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`. """ @@ -2535,7 +2537,7 @@ class ModifyParamsInvoiceSettings(TypedDict): """ class ModifyParamsInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -2545,7 +2547,7 @@ class ModifyParamsInvoiceSettingsIssuer(TypedDict): """ class ModifyParamsLine(TypedDict): - actions: NotRequired["List[Quote.ModifyParamsLineAction]"] + actions: NotRequired[List["Quote.ModifyParamsLineAction"]] """ An array of operations the quote line performs. """ @@ -2554,7 +2556,7 @@ class ModifyParamsLine(TypedDict): Details to identify the subscription schedule the quote line applies to. """ billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'line_starts_at']" + Literal["automatic", "line_starts_at"] ] """ For a point-in-time operation, this attribute lets you set or update whether the subscription's billing cycle anchor is reset at the `starts_at` timestamp. @@ -2563,12 +2565,12 @@ class ModifyParamsLine(TypedDict): """ Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line. """ - id: NotRequired["str"] + id: NotRequired[str] """ The ID of an existing line on the quote. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts. @@ -2580,7 +2582,7 @@ class ModifyParamsLine(TypedDict): Defines how to pause collection for the underlying subscription throughout the duration of the amendment. """ set_schedule_end: NotRequired[ - "Literal['line_ends_at', 'line_starts_at']" + Literal["line_ends_at", "line_starts_at"] ] """ Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date. @@ -2603,7 +2605,7 @@ class ModifyParamsLineAction(TypedDict): """ Details for the `add_item` type. """ - add_metadata: NotRequired["Dict[str, str]"] + add_metadata: NotRequired[Dict[str, str]] """ Details for the `add_metadata` type: specify a hash of key-value pairs. """ @@ -2617,17 +2619,17 @@ class ModifyParamsLineAction(TypedDict): """ Details for the `remove_item` type. """ - remove_metadata: NotRequired["List[str]"] + remove_metadata: NotRequired[List[str]] """ Details for the `remove_metadata` type: specify an array of metadata keys. """ set_discounts: NotRequired[ - "List[Quote.ModifyParamsLineActionSetDiscount]" + List["Quote.ModifyParamsLineActionSetDiscount"] ] """ Details for the `set_discounts` type. """ - set_items: NotRequired["List[Quote.ModifyParamsLineActionSetItem]"] + set_items: NotRequired[List["Quote.ModifyParamsLineActionSetItem"]] """ Details for the `set_items` type. """ @@ -2653,11 +2655,11 @@ class ModifyParamsLineAction(TypedDict): """ class ModifyParamsLineActionAddDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to redeem. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount for a coupon that was already redeemed. """ @@ -2667,7 +2669,7 @@ class ModifyParamsLineActionAddDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - index: NotRequired["int"] + index: NotRequired[int] """ The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array. """ @@ -2680,12 +2682,12 @@ class ModifyParamsLineActionAddDiscountDiscountEnd(TypedDict): class ModifyParamsLineActionAddItem(TypedDict): discounts: NotRequired[ - "List[Quote.ModifyParamsLineActionAddItemDiscount]" + List["Quote.ModifyParamsLineActionAddItemDiscount"] ] """ The discounts applied to the item. Subscription item discounts are applied before subscription discounts. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -2693,11 +2695,11 @@ class ModifyParamsLineActionAddItem(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. """ @@ -2707,11 +2709,11 @@ class ModifyParamsLineActionAddItem(TypedDict): """ class ModifyParamsLineActionAddItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2721,7 +2723,7 @@ class ModifyParamsLineActionAddItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2733,7 +2735,7 @@ class ModifyParamsLineActionAddItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2753,7 +2755,7 @@ class ModifyParamsLineActionAddItemDiscountDiscountEndDuration(TypedDict): """ class ModifyParamsLineActionAddItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -2763,15 +2765,15 @@ class ModifyParamsLineActionAddItemTrial(TypedDict): """ class ModifyParamsLineActionRemoveDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to remove from the `discounts` array. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ The ID of a discount to remove from the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to remove from the `discounts` array. """ @@ -2783,27 +2785,27 @@ class ModifyParamsLineActionRemoveItem(TypedDict): """ class ModifyParamsLineActionSetDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to replace the `discounts` array with. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount to replace the `discounts` array with. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ An ID of an existing promotion code to replace the `discounts` array with. """ class ModifyParamsLineActionSetItem(TypedDict): discounts: NotRequired[ - "List[Quote.ModifyParamsLineActionSetItemDiscount]" + List["Quote.ModifyParamsLineActionSetItemDiscount"] ] """ If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`. """ @@ -2811,11 +2813,11 @@ class ModifyParamsLineActionSetItem(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`. """ @@ -2825,11 +2827,11 @@ class ModifyParamsLineActionSetItem(TypedDict): """ class ModifyParamsLineActionSetItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2839,7 +2841,7 @@ class ModifyParamsLineActionSetItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2851,7 +2853,7 @@ class ModifyParamsLineActionSetItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2871,7 +2873,7 @@ class ModifyParamsLineActionSetItemDiscountDiscountEndDuration(TypedDict): """ class ModifyParamsLineActionSetItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -2881,11 +2883,11 @@ class ModifyParamsLineActionSetItemTrial(TypedDict): """ class ModifyParamsLineAppliesTo(TypedDict): - new_reference: NotRequired["str"] + new_reference: NotRequired[str] """ A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule. """ - subscription_schedule: NotRequired["str"] + subscription_schedule: NotRequired[str] """ The ID of the schedule the line applies to. """ @@ -2903,7 +2905,7 @@ class ModifyParamsLineEndsAt(TypedDict): """ Time span for the quote line starting from the `starts_at` date. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -2943,11 +2945,11 @@ class ModifyParamsLineItem(TypedDict): """ The discounts applied to this line item. """ - id: NotRequired["str"] + id: NotRequired[str] """ The ID of an existing line item on the quote. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. One of `price` or `price_data` is required. """ @@ -2955,7 +2957,7 @@ class ModifyParamsLineItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item. """ @@ -2965,11 +2967,11 @@ class ModifyParamsLineItem(TypedDict): """ class ModifyParamsLineItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2987,7 +2989,7 @@ class ModifyParamsLineItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -3020,16 +3022,16 @@ class ModifyParamsLineItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -3039,7 +3041,7 @@ class ModifyParamsLineItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -3069,7 +3071,7 @@ class ModifyParamsLineStartsAt(TypedDict): """ The timestamp the given line ends at. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -3093,11 +3095,11 @@ class ModifyParamsLineStartsAtDiscountEnd(TypedDict): """ class ModifyParamsLineStartsAtLineEndsAt(TypedDict): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -3111,18 +3113,18 @@ class ModifyParamsLineTrialSettings(TypedDict): """ class ModifyParamsLineTrialSettingsEndBehavior(TypedDict): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ class ModifyParamsPhase(TypedDict): - billing_cycle_anchor: NotRequired["Literal['reset']"] + billing_cycle_anchor: NotRequired[Literal["reset"]] """ When specified as `reset`, the subscription will always start a new billing period when the quote is accepted. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. @@ -3137,7 +3139,7 @@ class ModifyParamsPhase(TypedDict): """ The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ The date at which this phase of the quote ends. If set, `iterations` must not be set. """ @@ -3145,7 +3147,7 @@ class ModifyParamsPhase(TypedDict): """ All invoices will be billed using the specified settings. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. """ @@ -3153,31 +3155,31 @@ class ModifyParamsPhase(TypedDict): """ A list of line items the customer is being quoted for within this phase. Each line item includes information about the product, the quantity, and the resulting cost. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on the subscription schedule's phases when the quote is accepted. After a quote has been finalized, this field can be updated by specifying an identical set of quote phases to what was on the quote originally, excluding changes in metadata and phases that are now in the past. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`. """ - trial: NotRequired["bool"] + trial: NotRequired[bool] """ If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. """ - trial_end: NotRequired["int"] + trial_end: NotRequired[int] """ Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`. """ class ModifyParamsPhaseDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -3185,7 +3187,7 @@ class ModifyParamsPhaseDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -3197,7 +3199,7 @@ class ModifyParamsPhaseDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -3217,7 +3219,7 @@ class ModifyParamsPhaseDiscountDiscountEndDuration(TypedDict): """ class ModifyParamsPhaseInvoiceSettings(TypedDict): - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. """ @@ -3229,7 +3231,7 @@ class ModifyParamsPhaseLineItem(TypedDict): """ The discounts applied to this line item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. One of `price` or `price_data` is required. """ @@ -3237,7 +3239,7 @@ class ModifyParamsPhaseLineItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item. """ @@ -3247,11 +3249,11 @@ class ModifyParamsPhaseLineItem(TypedDict): """ class ModifyParamsPhaseLineItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -3269,7 +3271,7 @@ class ModifyParamsPhaseLineItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -3304,16 +3306,16 @@ class ModifyParamsPhaseLineItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -3323,7 +3325,7 @@ class ModifyParamsPhaseLineItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -3336,7 +3338,7 @@ class ModifyParamsSubscriptionData(TypedDict): Describes the period to bill for upon accepting the quote. """ billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. @@ -3355,11 +3357,11 @@ class ModifyParamsSubscriptionData(TypedDict): """ When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted. """ - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values. """ @@ -3370,7 +3372,7 @@ class ModifyParamsSubscriptionData(TypedDict): If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`. @@ -3407,7 +3409,7 @@ class ModifyParamsSubscriptionDataBillOnAcceptanceBillFrom(TypedDict): """ Details of a Quote line to start the bill period from. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -3425,11 +3427,11 @@ class ModifyParamsSubscriptionDataBillOnAcceptanceBillFrom(TypedDict): class ModifyParamsSubscriptionDataBillOnAcceptanceBillFromLineStartsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -3447,7 +3449,7 @@ class ModifyParamsSubscriptionDataBillOnAcceptanceBillUntil(TypedDict): """ Details of a Quote line item from which to bill until. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -3477,11 +3479,11 @@ class ModifyParamsSubscriptionDataBillOnAcceptanceBillUntilDuration( class ModifyParamsSubscriptionDataBillOnAcceptanceBillUntilLineEndsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -3498,12 +3500,12 @@ class ModifyParamsSubscriptionDataOverride(TypedDict): Describes the period to bill for upon accepting the quote. """ billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The customer the Subscription Data override applies to. """ @@ -3511,12 +3513,12 @@ class ModifyParamsSubscriptionDataOverride(TypedDict): """ The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. """ - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`. @@ -3529,11 +3531,11 @@ class ModifyParamsSubscriptionDataOverride(TypedDict): """ class ModifyParamsSubscriptionDataOverrideAppliesTo(TypedDict): - new_reference: NotRequired["str"] + new_reference: NotRequired[str] """ A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule. """ - subscription_schedule: NotRequired["str"] + subscription_schedule: NotRequired[str] """ The ID of the schedule the line applies to. """ @@ -3565,7 +3567,7 @@ class ModifyParamsSubscriptionDataOverrideBillOnAcceptanceBillFrom( """ Details of a Quote line to start the bill period from. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -3583,11 +3585,11 @@ class ModifyParamsSubscriptionDataOverrideBillOnAcceptanceBillFrom( class ModifyParamsSubscriptionDataOverrideBillOnAcceptanceBillFromLineStartsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -3607,7 +3609,7 @@ class ModifyParamsSubscriptionDataOverrideBillOnAcceptanceBillUntil( """ Details of a Quote line item from which to bill until. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -3637,11 +3639,11 @@ class ModifyParamsSubscriptionDataOverrideBillOnAcceptanceBillUntilDuration( class ModifyParamsSubscriptionDataOverrideBillOnAcceptanceBillUntilLineEndsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -3653,11 +3655,11 @@ class ModifyParamsSubscriptionDataPrebilling(TypedDict): """ class ModifyParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field. """ - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field. """ @@ -3667,19 +3669,19 @@ class ModifyParamsTransferData(TypedDict): """ class PdfParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ReestimateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_quote_computed_upfront_line_items_service.py b/stripe/_quote_computed_upfront_line_items_service.py index 33e6718f4..f653aeac3 100644 --- a/stripe/_quote_computed_upfront_line_items_service.py +++ b/stripe/_quote_computed_upfront_line_items_service.py @@ -11,19 +11,19 @@ class QuoteComputedUpfrontLineItemsService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/_quote_line_item_service.py b/stripe/_quote_line_item_service.py index e637de3d2..b69093b44 100644 --- a/stripe/_quote_line_item_service.py +++ b/stripe/_quote_line_item_service.py @@ -11,19 +11,19 @@ class QuoteLineItemService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/_quote_line_service.py b/stripe/_quote_line_service.py index d3c9994ac..ffecb818e 100644 --- a/stripe/_quote_line_service.py +++ b/stripe/_quote_line_service.py @@ -11,19 +11,19 @@ class QuoteLineService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/_quote_phase.py b/stripe/_quote_phase.py index e033ac7e6..ac3dabd71 100644 --- a/stripe/_quote_phase.py +++ b/stripe/_quote_phase.py @@ -107,33 +107,33 @@ class Tax(StripeObject): _inner_class_types = {"breakdown": Breakdown} class ListLineItemsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -141,13 +141,13 @@ class ListParams(RequestOptions): """ The ID of the quote whose phases will be retrieved. """ - starting_after: NotRequired["str"] + 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 RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_quote_phase_line_item_service.py b/stripe/_quote_phase_line_item_service.py index e2a9f421f..ded76ba7d 100644 --- a/stripe/_quote_phase_line_item_service.py +++ b/stripe/_quote_phase_line_item_service.py @@ -11,19 +11,19 @@ class QuotePhaseLineItemService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/_quote_phase_service.py b/stripe/_quote_phase_service.py index 43bddabab..f83f5708c 100644 --- a/stripe/_quote_phase_service.py +++ b/stripe/_quote_phase_service.py @@ -16,15 +16,15 @@ def __init__(self, requestor): self.line_items = QuotePhaseLineItemService(self._requestor) class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -32,13 +32,13 @@ class ListParams(TypedDict): """ The ID of the quote whose phases will be retrieved. """ - starting_after: NotRequired["str"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_quote_preview_invoice_service.py b/stripe/_quote_preview_invoice_service.py index a2dc1f107..6e911b9cd 100644 --- a/stripe/_quote_preview_invoice_service.py +++ b/stripe/_quote_preview_invoice_service.py @@ -11,19 +11,19 @@ class QuotePreviewInvoiceService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/_quote_preview_subscription_schedule_service.py b/stripe/_quote_preview_subscription_schedule_service.py index 3415537f7..53b2afdf5 100644 --- a/stripe/_quote_preview_subscription_schedule_service.py +++ b/stripe/_quote_preview_subscription_schedule_service.py @@ -13,19 +13,19 @@ class QuotePreviewSubscriptionScheduleService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/_quote_service.py b/stripe/_quote_service.py index 900f1b227..e8de794f6 100644 --- a/stripe/_quote_service.py +++ b/stripe/_quote_service.py @@ -37,19 +37,19 @@ def __init__(self, requestor): ) class AcceptParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CancelParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CreateParams(TypedDict): - allow_backdated_lines: NotRequired["bool"] + allow_backdated_lines: NotRequired[bool] """ Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now. """ @@ -66,12 +66,12 @@ class CreateParams(TypedDict): Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. """ @@ -89,11 +89,11 @@ class CreateParams(TypedDict): """ The discounts applied to the quote. You can only set up to one discount. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. """ @@ -115,15 +115,15 @@ class CreateParams(TypedDict): """ All invoices will be billed using the specified settings. """ - line_items: NotRequired["List[QuoteService.CreateParamsLineItem]"] + line_items: NotRequired[List["QuoteService.CreateParamsLineItem"]] """ A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. """ - lines: NotRequired["List[QuoteService.CreateParamsLine]"] + lines: NotRequired[List["QuoteService.CreateParamsLine"]] """ A list of lines on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -131,7 +131,7 @@ class CreateParams(TypedDict): """ The account on behalf of which to charge. """ - phases: NotRequired["List[QuoteService.CreateParamsPhase]"] + phases: NotRequired[List["QuoteService.CreateParamsPhase"]] """ List representing phases of the Quote. Each phase can be customized to have different durations, prices, and coupons. """ @@ -142,12 +142,12 @@ class CreateParams(TypedDict): When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. """ subscription_data_overrides: NotRequired[ - "List[QuoteService.CreateParamsSubscriptionDataOverride]" + List["QuoteService.CreateParamsSubscriptionDataOverride"] ] """ List representing overrides for `subscription_data` configurations for specific subscription schedules. """ - test_clock: NotRequired["str"] + test_clock: NotRequired[str] """ ID of the test clock to attach to the quote. """ @@ -171,7 +171,7 @@ class CreateParamsAutomaticTax(TypedDict): """ class CreateParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -181,11 +181,11 @@ class CreateParamsAutomaticTaxLiability(TypedDict): """ class CreateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -203,7 +203,7 @@ class CreateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -223,7 +223,7 @@ class CreateParamsDiscountDiscountEndDuration(TypedDict): """ class CreateParamsFromQuote(TypedDict): - is_revision: NotRequired["bool"] + is_revision: NotRequired[bool] """ Whether this quote is a revision of the previous quote. """ @@ -233,7 +233,7 @@ class CreateParamsFromQuote(TypedDict): """ class CreateParamsInvoiceSettings(TypedDict): - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`. """ @@ -243,7 +243,7 @@ class CreateParamsInvoiceSettings(TypedDict): """ class CreateParamsInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -253,7 +253,7 @@ class CreateParamsInvoiceSettingsIssuer(TypedDict): """ class CreateParamsLine(TypedDict): - actions: NotRequired["List[QuoteService.CreateParamsLineAction]"] + actions: NotRequired[List["QuoteService.CreateParamsLineAction"]] """ An array of operations the quote line performs. """ @@ -262,7 +262,7 @@ class CreateParamsLine(TypedDict): Details to identify the subscription schedule the quote line applies to. """ billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'line_starts_at']" + Literal["automatic", "line_starts_at"] ] """ For a point-in-time operation, this attribute lets you set or update whether the subscription's billing cycle anchor is reset at the `starts_at` timestamp. @@ -272,7 +272,7 @@ class CreateParamsLine(TypedDict): Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts. @@ -284,7 +284,7 @@ class CreateParamsLine(TypedDict): Defines how to pause collection for the underlying subscription throughout the duration of the amendment. """ set_schedule_end: NotRequired[ - "Literal['line_ends_at', 'line_starts_at']" + Literal["line_ends_at", "line_starts_at"] ] """ Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date. @@ -311,7 +311,7 @@ class CreateParamsLineAction(TypedDict): """ Details for the `add_item` type. """ - add_metadata: NotRequired["Dict[str, str]"] + add_metadata: NotRequired[Dict[str, str]] """ Details for the `add_metadata` type: specify a hash of key-value pairs. """ @@ -327,18 +327,18 @@ class CreateParamsLineAction(TypedDict): """ Details for the `remove_item` type. """ - remove_metadata: NotRequired["List[str]"] + remove_metadata: NotRequired[List[str]] """ Details for the `remove_metadata` type: specify an array of metadata keys. """ set_discounts: NotRequired[ - "List[QuoteService.CreateParamsLineActionSetDiscount]" + List["QuoteService.CreateParamsLineActionSetDiscount"] ] """ Details for the `set_discounts` type. """ set_items: NotRequired[ - "List[QuoteService.CreateParamsLineActionSetItem]" + List["QuoteService.CreateParamsLineActionSetItem"] ] """ Details for the `set_items` type. @@ -365,11 +365,11 @@ class CreateParamsLineAction(TypedDict): """ class CreateParamsLineActionAddDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to redeem. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount for a coupon that was already redeemed. """ @@ -379,7 +379,7 @@ class CreateParamsLineActionAddDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - index: NotRequired["int"] + index: NotRequired[int] """ The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array. """ @@ -392,12 +392,12 @@ class CreateParamsLineActionAddDiscountDiscountEnd(TypedDict): class CreateParamsLineActionAddItem(TypedDict): discounts: NotRequired[ - "List[QuoteService.CreateParamsLineActionAddItemDiscount]" + List["QuoteService.CreateParamsLineActionAddItemDiscount"] ] """ The discounts applied to the item. Subscription item discounts are applied before subscription discounts. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -405,11 +405,11 @@ class CreateParamsLineActionAddItem(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. """ @@ -419,11 +419,11 @@ class CreateParamsLineActionAddItem(TypedDict): """ class CreateParamsLineActionAddItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -433,7 +433,7 @@ class CreateParamsLineActionAddItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -445,7 +445,7 @@ class CreateParamsLineActionAddItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -465,7 +465,7 @@ class CreateParamsLineActionAddItemDiscountDiscountEndDuration(TypedDict): """ class CreateParamsLineActionAddItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -475,15 +475,15 @@ class CreateParamsLineActionAddItemTrial(TypedDict): """ class CreateParamsLineActionRemoveDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to remove from the `discounts` array. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ The ID of a discount to remove from the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to remove from the `discounts` array. """ @@ -495,27 +495,27 @@ class CreateParamsLineActionRemoveItem(TypedDict): """ class CreateParamsLineActionSetDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to replace the `discounts` array with. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount to replace the `discounts` array with. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ An ID of an existing promotion code to replace the `discounts` array with. """ class CreateParamsLineActionSetItem(TypedDict): discounts: NotRequired[ - "List[QuoteService.CreateParamsLineActionSetItemDiscount]" + List["QuoteService.CreateParamsLineActionSetItemDiscount"] ] """ If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`. """ @@ -523,11 +523,11 @@ class CreateParamsLineActionSetItem(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`. """ @@ -537,11 +537,11 @@ class CreateParamsLineActionSetItem(TypedDict): """ class CreateParamsLineActionSetItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -551,7 +551,7 @@ class CreateParamsLineActionSetItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -563,7 +563,7 @@ class CreateParamsLineActionSetItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -583,7 +583,7 @@ class CreateParamsLineActionSetItemDiscountDiscountEndDuration(TypedDict): """ class CreateParamsLineActionSetItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -593,11 +593,11 @@ class CreateParamsLineActionSetItemTrial(TypedDict): """ class CreateParamsLineAppliesTo(TypedDict): - new_reference: NotRequired["str"] + new_reference: NotRequired[str] """ A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule. """ - subscription_schedule: NotRequired["str"] + subscription_schedule: NotRequired[str] """ The ID of the schedule the line applies to. """ @@ -617,7 +617,7 @@ class CreateParamsLineEndsAt(TypedDict): """ Time span for the quote line starting from the `starts_at` date. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -657,7 +657,7 @@ class CreateParamsLineItem(TypedDict): """ The discounts applied to this line item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. One of `price` or `price_data` is required. """ @@ -665,7 +665,7 @@ class CreateParamsLineItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item. """ @@ -675,11 +675,11 @@ class CreateParamsLineItem(TypedDict): """ class CreateParamsLineItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -697,7 +697,7 @@ class CreateParamsLineItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -732,16 +732,16 @@ class CreateParamsLineItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -751,7 +751,7 @@ class CreateParamsLineItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -785,7 +785,7 @@ class CreateParamsLineStartsAt(TypedDict): """ The timestamp the given line ends at. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -809,7 +809,7 @@ class CreateParamsLineStartsAtDiscountEnd(TypedDict): """ class CreateParamsLineStartsAtLineEndsAt(TypedDict): - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -823,18 +823,18 @@ class CreateParamsLineTrialSettings(TypedDict): """ class CreateParamsLineTrialSettingsEndBehavior(TypedDict): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ class CreateParamsPhase(TypedDict): - billing_cycle_anchor: NotRequired["Literal['reset']"] + billing_cycle_anchor: NotRequired[Literal["reset"]] """ When specified as `reset`, the subscription will always start a new billing period when the quote is accepted. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. @@ -849,7 +849,7 @@ class CreateParamsPhase(TypedDict): """ The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ The date at which this phase of the quote ends. If set, `iterations` must not be set. """ @@ -859,7 +859,7 @@ class CreateParamsPhase(TypedDict): """ All invoices will be billed using the specified settings. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. """ @@ -867,31 +867,31 @@ class CreateParamsPhase(TypedDict): """ A list of line items the customer is being quoted for within this phase. Each line item includes information about the product, the quantity, and the resulting cost. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on the subscription schedule's phases when the quote is accepted. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`. """ - trial: NotRequired["bool"] + trial: NotRequired[bool] """ If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. """ - trial_end: NotRequired["int"] + trial_end: NotRequired[int] """ Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`. """ class CreateParamsPhaseDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -901,7 +901,7 @@ class CreateParamsPhaseDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -913,7 +913,7 @@ class CreateParamsPhaseDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -933,7 +933,7 @@ class CreateParamsPhaseDiscountDiscountEndDuration(TypedDict): """ class CreateParamsPhaseInvoiceSettings(TypedDict): - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. """ @@ -945,7 +945,7 @@ class CreateParamsPhaseLineItem(TypedDict): """ The discounts applied to this line item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. One of `price` or `price_data` is required. """ @@ -955,7 +955,7 @@ class CreateParamsPhaseLineItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item. """ @@ -965,11 +965,11 @@ class CreateParamsPhaseLineItem(TypedDict): """ class CreateParamsPhaseLineItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -987,7 +987,7 @@ class CreateParamsPhaseLineItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1022,16 +1022,16 @@ class CreateParamsPhaseLineItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1041,7 +1041,7 @@ class CreateParamsPhaseLineItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -1054,7 +1054,7 @@ class CreateParamsSubscriptionData(TypedDict): Describes the period to bill for upon accepting the quote. """ billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. @@ -1063,7 +1063,7 @@ class CreateParamsSubscriptionData(TypedDict): """ When specified as `reset`, the subscription will always start a new billing period when the quote is accepted. """ - description: NotRequired["str"] + description: NotRequired[str] """ The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. """ @@ -1073,19 +1073,19 @@ class CreateParamsSubscriptionData(TypedDict): """ When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted. """ - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. """ - from_schedule: NotRequired["str"] + from_schedule: NotRequired[str] """ The id of a subscription schedule the quote will update. The quote will inherit the state of the subscription schedule, such as `phases`. Cannot be combined with other parameters. """ - from_subscription: NotRequired["str"] + from_subscription: NotRequired[str] """ The id of a subscription that the quote will update. By default, the quote will contain the state of the subscription (such as line items, collection method and billing thresholds) unless overridden. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values. """ @@ -1096,7 +1096,7 @@ class CreateParamsSubscriptionData(TypedDict): If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`. @@ -1133,7 +1133,7 @@ class CreateParamsSubscriptionDataBillOnAcceptanceBillFrom(TypedDict): """ Details of a Quote line to start the bill period from. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -1151,11 +1151,11 @@ class CreateParamsSubscriptionDataBillOnAcceptanceBillFrom(TypedDict): class CreateParamsSubscriptionDataBillOnAcceptanceBillFromLineStartsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -1173,7 +1173,7 @@ class CreateParamsSubscriptionDataBillOnAcceptanceBillUntil(TypedDict): """ Details of a Quote line item from which to bill until. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -1203,11 +1203,11 @@ class CreateParamsSubscriptionDataBillOnAcceptanceBillUntilDuration( class CreateParamsSubscriptionDataBillOnAcceptanceBillUntilLineEndsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -1224,25 +1224,25 @@ class CreateParamsSubscriptionDataOverride(TypedDict): Describes the period to bill for upon accepting the quote. """ billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The customer the Subscription Data override applies to. This is only relevant when `applies_to.type=new_reference`. """ - description: NotRequired["str"] + description: NotRequired[str] """ The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. """ - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`. @@ -1255,11 +1255,11 @@ class CreateParamsSubscriptionDataOverride(TypedDict): """ class CreateParamsSubscriptionDataOverrideAppliesTo(TypedDict): - new_reference: NotRequired["str"] + new_reference: NotRequired[str] """ A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule. """ - subscription_schedule: NotRequired["str"] + subscription_schedule: NotRequired[str] """ The ID of the schedule the line applies to. """ @@ -1291,7 +1291,7 @@ class CreateParamsSubscriptionDataOverrideBillOnAcceptanceBillFrom( """ Details of a Quote line to start the bill period from. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -1309,11 +1309,11 @@ class CreateParamsSubscriptionDataOverrideBillOnAcceptanceBillFrom( class CreateParamsSubscriptionDataOverrideBillOnAcceptanceBillFromLineStartsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -1333,7 +1333,7 @@ class CreateParamsSubscriptionDataOverrideBillOnAcceptanceBillUntil( """ Details of a Quote line item from which to bill until. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -1363,11 +1363,11 @@ class CreateParamsSubscriptionDataOverrideBillOnAcceptanceBillUntilDuration( class CreateParamsSubscriptionDataOverrideBillOnAcceptanceBillUntilLineEndsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -1379,11 +1379,11 @@ class CreateParamsSubscriptionDataPrebilling(TypedDict): """ class CreateParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field. """ - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field. """ @@ -1393,105 +1393,107 @@ class CreateParamsTransferData(TypedDict): """ class FinalizeQuoteParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. """ class ListParams(TypedDict): - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of the customer whose quotes will be retrieved. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - from_subscription: NotRequired["str"] + from_subscription: NotRequired[str] """ The subscription which the quote updates. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['accepted', 'accepting', 'canceled', 'draft', 'open', 'stale']" + Literal[ + "accepted", "accepting", "canceled", "draft", "open", "stale" + ] ] """ The status of the quote. """ - test_clock: NotRequired["str"] + test_clock: NotRequired[str] """ Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set. """ class ListPreviewInvoiceLinesParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 MarkDraftParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class MarkStaleParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - reason: NotRequired["str"] + reason: NotRequired[str] """ Reason the Quote is being marked stale. """ class PdfParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ReestimateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - allow_backdated_lines: NotRequired["bool"] + allow_backdated_lines: NotRequired[bool] """ Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now. """ @@ -1508,12 +1510,12 @@ class UpdateParams(TypedDict): Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. """ @@ -1531,11 +1533,11 @@ class UpdateParams(TypedDict): """ The discounts applied to the quote. You can only set up to one discount. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. """ @@ -1553,15 +1555,15 @@ class UpdateParams(TypedDict): """ All invoices will be billed using the specified settings. """ - line_items: NotRequired["List[QuoteService.UpdateParamsLineItem]"] + line_items: NotRequired[List["QuoteService.UpdateParamsLineItem"]] """ A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. """ - lines: NotRequired["List[QuoteService.UpdateParamsLine]"] + lines: NotRequired[List["QuoteService.UpdateParamsLine"]] """ A list of lines on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -1569,7 +1571,7 @@ class UpdateParams(TypedDict): """ The account on behalf of which to charge. """ - phases: NotRequired["List[QuoteService.UpdateParamsPhase]"] + phases: NotRequired[List["QuoteService.UpdateParamsPhase"]] """ List representing phases of the Quote. Each phase can be customized to have different durations, prices, and coupons. """ @@ -1605,7 +1607,7 @@ class UpdateParamsAutomaticTax(TypedDict): """ class UpdateParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1615,11 +1617,11 @@ class UpdateParamsAutomaticTaxLiability(TypedDict): """ class UpdateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1637,7 +1639,7 @@ class UpdateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1657,7 +1659,7 @@ class UpdateParamsDiscountDiscountEndDuration(TypedDict): """ class UpdateParamsInvoiceSettings(TypedDict): - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`. """ @@ -1667,7 +1669,7 @@ class UpdateParamsInvoiceSettings(TypedDict): """ class UpdateParamsInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1677,7 +1679,7 @@ class UpdateParamsInvoiceSettingsIssuer(TypedDict): """ class UpdateParamsLine(TypedDict): - actions: NotRequired["List[QuoteService.UpdateParamsLineAction]"] + actions: NotRequired[List["QuoteService.UpdateParamsLineAction"]] """ An array of operations the quote line performs. """ @@ -1686,7 +1688,7 @@ class UpdateParamsLine(TypedDict): Details to identify the subscription schedule the quote line applies to. """ billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'line_starts_at']" + Literal["automatic", "line_starts_at"] ] """ For a point-in-time operation, this attribute lets you set or update whether the subscription's billing cycle anchor is reset at the `starts_at` timestamp. @@ -1695,12 +1697,12 @@ class UpdateParamsLine(TypedDict): """ Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line. """ - id: NotRequired["str"] + id: NotRequired[str] """ The ID of an existing line on the quote. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts. @@ -1712,7 +1714,7 @@ class UpdateParamsLine(TypedDict): Defines how to pause collection for the underlying subscription throughout the duration of the amendment. """ set_schedule_end: NotRequired[ - "Literal['line_ends_at', 'line_starts_at']" + Literal["line_ends_at", "line_starts_at"] ] """ Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date. @@ -1739,7 +1741,7 @@ class UpdateParamsLineAction(TypedDict): """ Details for the `add_item` type. """ - add_metadata: NotRequired["Dict[str, str]"] + add_metadata: NotRequired[Dict[str, str]] """ Details for the `add_metadata` type: specify a hash of key-value pairs. """ @@ -1755,18 +1757,18 @@ class UpdateParamsLineAction(TypedDict): """ Details for the `remove_item` type. """ - remove_metadata: NotRequired["List[str]"] + remove_metadata: NotRequired[List[str]] """ Details for the `remove_metadata` type: specify an array of metadata keys. """ set_discounts: NotRequired[ - "List[QuoteService.UpdateParamsLineActionSetDiscount]" + List["QuoteService.UpdateParamsLineActionSetDiscount"] ] """ Details for the `set_discounts` type. """ set_items: NotRequired[ - "List[QuoteService.UpdateParamsLineActionSetItem]" + List["QuoteService.UpdateParamsLineActionSetItem"] ] """ Details for the `set_items` type. @@ -1793,11 +1795,11 @@ class UpdateParamsLineAction(TypedDict): """ class UpdateParamsLineActionAddDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to redeem. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount for a coupon that was already redeemed. """ @@ -1807,7 +1809,7 @@ class UpdateParamsLineActionAddDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - index: NotRequired["int"] + index: NotRequired[int] """ The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array. """ @@ -1820,12 +1822,12 @@ class UpdateParamsLineActionAddDiscountDiscountEnd(TypedDict): class UpdateParamsLineActionAddItem(TypedDict): discounts: NotRequired[ - "List[QuoteService.UpdateParamsLineActionAddItemDiscount]" + List["QuoteService.UpdateParamsLineActionAddItemDiscount"] ] """ The discounts applied to the item. Subscription item discounts are applied before subscription discounts. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -1833,11 +1835,11 @@ class UpdateParamsLineActionAddItem(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. """ @@ -1847,11 +1849,11 @@ class UpdateParamsLineActionAddItem(TypedDict): """ class UpdateParamsLineActionAddItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1861,7 +1863,7 @@ class UpdateParamsLineActionAddItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1873,7 +1875,7 @@ class UpdateParamsLineActionAddItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1893,7 +1895,7 @@ class UpdateParamsLineActionAddItemDiscountDiscountEndDuration(TypedDict): """ class UpdateParamsLineActionAddItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -1903,15 +1905,15 @@ class UpdateParamsLineActionAddItemTrial(TypedDict): """ class UpdateParamsLineActionRemoveDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to remove from the `discounts` array. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ The ID of a discount to remove from the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to remove from the `discounts` array. """ @@ -1923,27 +1925,27 @@ class UpdateParamsLineActionRemoveItem(TypedDict): """ class UpdateParamsLineActionSetDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to replace the `discounts` array with. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount to replace the `discounts` array with. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ An ID of an existing promotion code to replace the `discounts` array with. """ class UpdateParamsLineActionSetItem(TypedDict): discounts: NotRequired[ - "List[QuoteService.UpdateParamsLineActionSetItemDiscount]" + List["QuoteService.UpdateParamsLineActionSetItemDiscount"] ] """ If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`. """ @@ -1951,11 +1953,11 @@ class UpdateParamsLineActionSetItem(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`. """ @@ -1965,11 +1967,11 @@ class UpdateParamsLineActionSetItem(TypedDict): """ class UpdateParamsLineActionSetItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1979,7 +1981,7 @@ class UpdateParamsLineActionSetItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1991,7 +1993,7 @@ class UpdateParamsLineActionSetItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2011,7 +2013,7 @@ class UpdateParamsLineActionSetItemDiscountDiscountEndDuration(TypedDict): """ class UpdateParamsLineActionSetItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -2021,11 +2023,11 @@ class UpdateParamsLineActionSetItemTrial(TypedDict): """ class UpdateParamsLineAppliesTo(TypedDict): - new_reference: NotRequired["str"] + new_reference: NotRequired[str] """ A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule. """ - subscription_schedule: NotRequired["str"] + subscription_schedule: NotRequired[str] """ The ID of the schedule the line applies to. """ @@ -2045,7 +2047,7 @@ class UpdateParamsLineEndsAt(TypedDict): """ Time span for the quote line starting from the `starts_at` date. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -2085,11 +2087,11 @@ class UpdateParamsLineItem(TypedDict): """ The discounts applied to this line item. """ - id: NotRequired["str"] + id: NotRequired[str] """ The ID of an existing line item on the quote. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. One of `price` or `price_data` is required. """ @@ -2097,7 +2099,7 @@ class UpdateParamsLineItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item. """ @@ -2107,11 +2109,11 @@ class UpdateParamsLineItem(TypedDict): """ class UpdateParamsLineItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2129,7 +2131,7 @@ class UpdateParamsLineItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2164,16 +2166,16 @@ class UpdateParamsLineItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -2183,7 +2185,7 @@ class UpdateParamsLineItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -2217,7 +2219,7 @@ class UpdateParamsLineStartsAt(TypedDict): """ The timestamp the given line ends at. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -2241,11 +2243,11 @@ class UpdateParamsLineStartsAtDiscountEnd(TypedDict): """ class UpdateParamsLineStartsAtLineEndsAt(TypedDict): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -2259,18 +2261,18 @@ class UpdateParamsLineTrialSettings(TypedDict): """ class UpdateParamsLineTrialSettingsEndBehavior(TypedDict): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ class UpdateParamsPhase(TypedDict): - billing_cycle_anchor: NotRequired["Literal['reset']"] + billing_cycle_anchor: NotRequired[Literal["reset"]] """ When specified as `reset`, the subscription will always start a new billing period when the quote is accepted. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. @@ -2285,7 +2287,7 @@ class UpdateParamsPhase(TypedDict): """ The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ The date at which this phase of the quote ends. If set, `iterations` must not be set. """ @@ -2295,7 +2297,7 @@ class UpdateParamsPhase(TypedDict): """ All invoices will be billed using the specified settings. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. """ @@ -2303,31 +2305,31 @@ class UpdateParamsPhase(TypedDict): """ A list of line items the customer is being quoted for within this phase. Each line item includes information about the product, the quantity, and the resulting cost. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on the subscription schedule's phases when the quote is accepted. After a quote has been finalized, this field can be updated by specifying an identical set of quote phases to what was on the quote originally, excluding changes in metadata and phases that are now in the past. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`. """ - trial: NotRequired["bool"] + trial: NotRequired[bool] """ If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. """ - trial_end: NotRequired["int"] + trial_end: NotRequired[int] """ Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`. """ class UpdateParamsPhaseDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2337,7 +2339,7 @@ class UpdateParamsPhaseDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2349,7 +2351,7 @@ class UpdateParamsPhaseDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2369,7 +2371,7 @@ class UpdateParamsPhaseDiscountDiscountEndDuration(TypedDict): """ class UpdateParamsPhaseInvoiceSettings(TypedDict): - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. """ @@ -2381,7 +2383,7 @@ class UpdateParamsPhaseLineItem(TypedDict): """ The discounts applied to this line item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. One of `price` or `price_data` is required. """ @@ -2391,7 +2393,7 @@ class UpdateParamsPhaseLineItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item. """ @@ -2401,11 +2403,11 @@ class UpdateParamsPhaseLineItem(TypedDict): """ class UpdateParamsPhaseLineItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2423,7 +2425,7 @@ class UpdateParamsPhaseLineItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2458,16 +2460,16 @@ class UpdateParamsPhaseLineItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -2477,7 +2479,7 @@ class UpdateParamsPhaseLineItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -2490,7 +2492,7 @@ class UpdateParamsSubscriptionData(TypedDict): Describes the period to bill for upon accepting the quote. """ billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. @@ -2509,11 +2511,11 @@ class UpdateParamsSubscriptionData(TypedDict): """ When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted. """ - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values. """ @@ -2524,7 +2526,7 @@ class UpdateParamsSubscriptionData(TypedDict): If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`. @@ -2561,7 +2563,7 @@ class UpdateParamsSubscriptionDataBillOnAcceptanceBillFrom(TypedDict): """ Details of a Quote line to start the bill period from. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -2579,11 +2581,11 @@ class UpdateParamsSubscriptionDataBillOnAcceptanceBillFrom(TypedDict): class UpdateParamsSubscriptionDataBillOnAcceptanceBillFromLineStartsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -2601,7 +2603,7 @@ class UpdateParamsSubscriptionDataBillOnAcceptanceBillUntil(TypedDict): """ Details of a Quote line item from which to bill until. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -2631,11 +2633,11 @@ class UpdateParamsSubscriptionDataBillOnAcceptanceBillUntilDuration( class UpdateParamsSubscriptionDataBillOnAcceptanceBillUntilLineEndsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -2652,12 +2654,12 @@ class UpdateParamsSubscriptionDataOverride(TypedDict): Describes the period to bill for upon accepting the quote. """ billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The customer the Subscription Data override applies to. """ @@ -2665,12 +2667,12 @@ class UpdateParamsSubscriptionDataOverride(TypedDict): """ The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. """ - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`. @@ -2683,11 +2685,11 @@ class UpdateParamsSubscriptionDataOverride(TypedDict): """ class UpdateParamsSubscriptionDataOverrideAppliesTo(TypedDict): - new_reference: NotRequired["str"] + new_reference: NotRequired[str] """ A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule. """ - subscription_schedule: NotRequired["str"] + subscription_schedule: NotRequired[str] """ The ID of the schedule the line applies to. """ @@ -2719,7 +2721,7 @@ class UpdateParamsSubscriptionDataOverrideBillOnAcceptanceBillFrom( """ Details of a Quote line to start the bill period from. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -2737,11 +2739,11 @@ class UpdateParamsSubscriptionDataOverrideBillOnAcceptanceBillFrom( class UpdateParamsSubscriptionDataOverrideBillOnAcceptanceBillFromLineStartsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -2761,7 +2763,7 @@ class UpdateParamsSubscriptionDataOverrideBillOnAcceptanceBillUntil( """ Details of a Quote line item from which to bill until. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp. """ @@ -2791,11 +2793,11 @@ class UpdateParamsSubscriptionDataOverrideBillOnAcceptanceBillUntilDuration( class UpdateParamsSubscriptionDataOverrideBillOnAcceptanceBillUntilLineEndsAt( TypedDict, ): - id: NotRequired["str"] + id: NotRequired[str] """ The ID of a quote line. """ - index: NotRequired["int"] + index: NotRequired[int] """ The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array. """ @@ -2807,11 +2809,11 @@ class UpdateParamsSubscriptionDataPrebilling(TypedDict): """ class UpdateParamsTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field. """ - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field. """ diff --git a/stripe/_refund.py b/stripe/_refund.py index 7cf31bee4..e43a35ebb 100644 --- a/stripe/_refund.py +++ b/stripe/_refund.py @@ -316,30 +316,30 @@ class EmailSent(StripeObject): _inner_class_types = {"display_details": DisplayDetails} class CancelParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CreateParams(RequestOptions): - amount: NotRequired["int"] - charge: NotRequired["str"] + amount: NotRequired[int] + charge: NotRequired[str] """ The identifier of the charge to refund. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Customer whose customer balance to refund from. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - instructions_email: NotRequired["str"] + instructions_email: NotRequired[str] """ For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions. """ @@ -347,25 +347,25 @@ class CreateParams(RequestOptions): """ 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`. """ - origin: NotRequired["Literal['customer_balance']"] + origin: NotRequired[Literal["customer_balance"]] """ Origin of the refund """ - payment_intent: NotRequired["str"] + payment_intent: NotRequired[str] """ The identifier of the PaymentIntent to refund. """ reason: NotRequired[ - "Literal['duplicate', 'fraudulent', 'requested_by_customer']" + Literal["duplicate", "fraudulent", "requested_by_customer"] ] """ String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms. """ - refund_application_fee: NotRequired["bool"] + refund_application_fee: NotRequired[bool] """ Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. """ - reverse_transfer: NotRequired["bool"] + reverse_transfer: NotRequired[bool] """ Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). @@ -373,13 +373,13 @@ class CreateParams(RequestOptions): """ class ExpireParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListParams(RequestOptions): - charge: NotRequired["str"] + charge: NotRequired[str] """ Only return refunds for the charge specified by this charge ID. """ @@ -387,47 +387,47 @@ class ListParams(RequestOptions): """ Only return refunds that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - payment_intent: NotRequired["str"] + payment_intent: NotRequired[str] """ Only return refunds for the PaymentIntent specified by this ID. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -437,7 +437,7 @@ class ModifyParams(RequestOptions): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_refund_service.py b/stripe/_refund_service.py index ba1a53cc3..42a240ea5 100644 --- a/stripe/_refund_service.py +++ b/stripe/_refund_service.py @@ -11,30 +11,30 @@ class RefundService(StripeService): class CancelParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CreateParams(TypedDict): - amount: NotRequired["int"] - charge: NotRequired["str"] + amount: NotRequired[int] + charge: NotRequired[str] """ The identifier of the charge to refund. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Customer whose customer balance to refund from. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - instructions_email: NotRequired["str"] + instructions_email: NotRequired[str] """ For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions. """ @@ -42,25 +42,25 @@ class CreateParams(TypedDict): """ 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`. """ - origin: NotRequired["Literal['customer_balance']"] + origin: NotRequired[Literal["customer_balance"]] """ Origin of the refund """ - payment_intent: NotRequired["str"] + payment_intent: NotRequired[str] """ The identifier of the PaymentIntent to refund. """ reason: NotRequired[ - "Literal['duplicate', 'fraudulent', 'requested_by_customer']" + Literal["duplicate", "fraudulent", "requested_by_customer"] ] """ String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms. """ - refund_application_fee: NotRequired["bool"] + refund_application_fee: NotRequired[bool] """ Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. """ - reverse_transfer: NotRequired["bool"] + reverse_transfer: NotRequired[bool] """ Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). @@ -68,7 +68,7 @@ class CreateParams(TypedDict): """ class ListParams(TypedDict): - charge: NotRequired["str"] + charge: NotRequired[str] """ Only return refunds for the charge specified by this charge ID. """ @@ -76,53 +76,53 @@ class ListParams(TypedDict): """ Only return refunds that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - payment_intent: NotRequired["str"] + payment_intent: NotRequired[str] """ Only return refunds for the PaymentIntent specified by this ID. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_review.py b/stripe/_review.py index a75317153..82c4a8cf6 100644 --- a/stripe/_review.py +++ b/stripe/_review.py @@ -71,7 +71,7 @@ class Session(StripeObject): """ class ApproveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -81,43 +81,43 @@ class ListParams(RequestOptions): """ Only return reviews that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_review_service.py b/stripe/_review_service.py index 20c48ddf0..5d09a3301 100644 --- a/stripe/_review_service.py +++ b/stripe/_review_service.py @@ -11,7 +11,7 @@ class ReviewService(StripeService): class ApproveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -21,43 +21,43 @@ class ListParams(TypedDict): """ Only return reviews that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_setup_attempt.py b/stripe/_setup_attempt.py index 7bf6d2229..99341d017 100644 --- a/stripe/_setup_attempt.py +++ b/stripe/_setup_attempt.py @@ -678,15 +678,15 @@ class ListParams(RequestOptions): can be a string with an integer Unix timestamp or a dictionary with a number of different query options. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -695,25 +695,25 @@ class ListParams(RequestOptions): Only return SetupAttempts created by the SetupIntent specified by this ID. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ diff --git a/stripe/_setup_attempt_service.py b/stripe/_setup_attempt_service.py index 4ec076da6..ba3ff2065 100644 --- a/stripe/_setup_attempt_service.py +++ b/stripe/_setup_attempt_service.py @@ -16,15 +16,15 @@ class ListParams(TypedDict): can be a string with an integer Unix timestamp or a dictionary with a number of different query options. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -33,25 +33,25 @@ class ListParams(TypedDict): Only return SetupAttempts created by the SetupIntent specified by this ID. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ diff --git a/stripe/_setup_intent.py b/stripe/_setup_intent.py index 0882a67da..a93f3c304 100644 --- a/stripe/_setup_intent.py +++ b/stripe/_setup_intent.py @@ -697,31 +697,31 @@ class MandateOptions(StripeObject): class CancelParams(RequestOptions): cancellation_reason: NotRequired[ - "Literal['abandoned', 'duplicate', 'requested_by_customer']" + Literal["abandoned", "duplicate", "requested_by_customer"] ] """ Reason for canceling this SetupIntent. Possible values are: `abandoned`, `requested_by_customer`, or `duplicate` """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ConfirmParams(RequestOptions): - confirmation_token: NotRequired["str"] + confirmation_token: NotRequired[str] """ ID of the ConfirmationToken used to confirm this SetupIntent. If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ mandate_data: NotRequired[ "Literal['']|SetupIntent.ConfirmParamsMandateData" ] - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. """ @@ -738,13 +738,13 @@ class ConfirmParams(RequestOptions): """ Payment method-specific configuration for this SetupIntent. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL to redirect your customer back to after they authenticate on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods. """ - use_stripe_sdk: NotRequired["bool"] + use_stripe_sdk: NotRequired[bool] """ Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. """ @@ -758,7 +758,7 @@ class ConfirmParamsMandateData(TypedDict): """ class ConfirmParamsMandateDataCustomerAcceptance(TypedDict): - accepted_at: NotRequired["int"] + accepted_at: NotRequired[int] """ The time at which the customer accepted the Mandate. """ @@ -783,11 +783,11 @@ class ConfirmParamsMandateDataCustomerAcceptanceOffline(TypedDict): pass class ConfirmParamsMandateDataCustomerAcceptanceOnline(TypedDict): - ip_address: NotRequired["str"] + ip_address: NotRequired[str] """ The IP address from which the Mandate was accepted by the customer. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the Mandate was accepted by the customer. """ @@ -901,7 +901,7 @@ class ConfirmParamsPaymentMethodData(TypedDict): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -1069,11 +1069,11 @@ class ConfirmParamsPaymentMethodDataAuBecsDebit(TypedDict): """ class ConfirmParamsPaymentMethodDataBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -1102,27 +1102,27 @@ class ConfirmParamsPaymentMethodDataBillingDetails(TypedDict): """ class ConfirmParamsPaymentMethodDataBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1144,14 +1144,43 @@ class ConfirmParamsPaymentMethodDataCustomerBalance(TypedDict): class ConfirmParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class ConfirmParamsPaymentMethodDataFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -1191,7 +1220,24 @@ class ConfirmParamsPaymentMethodDataGrabpay(TypedDict): class ConfirmParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -1237,7 +1283,34 @@ class ConfirmParamsPaymentMethodDataOxxo(TypedDict): class ConfirmParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -1250,15 +1323,15 @@ class ConfirmParamsPaymentMethodDataPaypal(TypedDict): pass class ConfirmParamsPaymentMethodDataPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -1270,7 +1343,7 @@ class ConfirmParamsPaymentMethodDataPromptpay(TypedDict): pass class ConfirmParamsPaymentMethodDataRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -1297,23 +1370,23 @@ class ConfirmParamsPaymentMethodDataTwint(TypedDict): pass class ConfirmParamsPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -1365,7 +1438,7 @@ class ConfirmParamsPaymentMethodOptions(TypedDict): """ class ConfirmParamsPaymentMethodOptionsAcssDebit(TypedDict): - currency: NotRequired["Literal['cad', 'usd']"] + currency: NotRequired[Literal["cad", "usd"]] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ @@ -1376,7 +1449,7 @@ class ConfirmParamsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -1389,21 +1462,21 @@ class ConfirmParamsPaymentMethodOptionsAcssDebitMandateOptions(TypedDict): The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - default_for: NotRequired["List[Literal['invoice', 'subscription']]"] + default_for: NotRequired[List[Literal["invoice", "subscription"]]] """ List of Stripe products where this mandate can be selected automatically. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -1415,20 +1488,32 @@ class ConfirmParamsPaymentMethodOptionsCard(TypedDict): """ Configuration options for setting up an eMandate for cards issued in India. """ - moto: NotRequired["bool"] + moto: NotRequired[bool] """ When specified, this parameter signals that a card has been collected as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. @@ -1454,11 +1539,11 @@ class ConfirmParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ @@ -1466,7 +1551,7 @@ class ConfirmParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ @@ -1478,19 +1563,19 @@ class ConfirmParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ - supported_types: NotRequired["List[Literal['india']]"] + supported_types: NotRequired[List[Literal["india"]]] """ Specifies the type of mandates supported. Possible values are `india`. """ class ConfirmParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): ares_trans_status: NotRequired[ - "Literal['A', 'C', 'I', 'N', 'R', 'U', 'Y']" + Literal["A", "C", "I", "N", "R", "U", "Y"] ] """ The `transStatus` returned from the card Issuer's ACS in the ARes. """ - cryptogram: NotRequired["str"] + cryptogram: NotRequired[str] """ The cryptogram, also known as the "authentication value" (AAV, CAVV or AEVV). This value is 20 bytes, base64-encoded into a 28-character string. @@ -1498,7 +1583,7 @@ class ConfirmParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): is what you should specify here.) """ electronic_commerce_indicator: NotRequired[ - "Literal['01', '02', '05', '06', '07']" + Literal["01", "02", "05", "06", "07"] ] """ The Electronic Commerce Indicator (ECI) is returned by your 3D Secure @@ -1512,17 +1597,17 @@ class ConfirmParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly """ - requestor_challenge_indicator: NotRequired["str"] + requestor_challenge_indicator: NotRequired[str] """ The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99. """ - transaction_id: NotRequired["str"] + transaction_id: NotRequired[str] """ For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID). """ - version: NotRequired["Literal['1.0.2', '2.1.0', '2.2.0']"] + version: NotRequired[Literal["1.0.2", "2.1.0", "2.2.0"]] """ The version of 3D Secure that was performed. """ @@ -1546,32 +1631,32 @@ class ConfirmParamsPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBanca to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`. messageExtension: CB-AVALGO """ - cb_exemption: NotRequired["str"] + cb_exemption: NotRequired[str] """ The exemption indicator returned from Cartes Bancaires in the ARes. message extension: CB-EXEMPTION; string (4 characters) This is a 3 byte bitmap (low significant byte first and most significant bit first) that has been Base64 encoded """ - cb_score: NotRequired["int"] + cb_score: NotRequired[int] """ The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99 """ class ConfirmParamsPaymentMethodOptionsLink(TypedDict): - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ class ConfirmParamsPaymentMethodOptionsPaypal(TypedDict): - billing_agreement_id: NotRequired["str"] + billing_agreement_id: NotRequired[str] """ The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. """ - currency: NotRequired["str"] - subsellers: NotRequired["List[str]"] + currency: NotRequired[str] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -1585,35 +1670,56 @@ class ConfirmParamsPaymentMethodOptionsPayto(TypedDict): """ class ConfirmParamsPaymentMethodOptionsPaytoMandateOptions(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount that will be collected. It is required when `amount_type` is `fixed`. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. """ - end_date: NotRequired["str"] + end_date: NotRequired[str] """ Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. """ payment_schedule: NotRequired[ - "Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] ] """ The periodicity at which payments will be collected. """ - payments_per_period: NotRequired["int"] + payments_per_period: NotRequired[int] """ The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. """ purpose: NotRequired[ - "Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] ] """ The purpose for which payments are made. Defaults to retail. """ - start_date: NotRequired["str"] + start_date: NotRequired[str] """ Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. """ @@ -1649,7 +1755,7 @@ class ConfirmParamsPaymentMethodOptionsUsBankAccount(TypedDict): Additional fields for network related functions """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -1665,18 +1771,29 @@ class ConfirmParamsPaymentMethodOptionsUsBankAccountFinancialConnections( Customize manual entry behavior """ permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ @@ -1698,13 +1815,13 @@ class ConfirmParamsPaymentMethodOptionsUsBankAccountMandateOptions( """ class ConfirmParamsPaymentMethodOptionsUsBankAccountNetworks(TypedDict): - requested: NotRequired["List[Literal['ach', 'us_domestic_wire']]"] + requested: NotRequired[List[Literal["ach", "us_domestic_wire"]]] """ Triggers validations to run across the selected networks """ class CreateParams(RequestOptions): - attach_to_self: NotRequired["bool"] + attach_to_self: NotRequired[bool] """ If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. @@ -1716,31 +1833,31 @@ class CreateParams(RequestOptions): """ When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters. """ - confirm: NotRequired["bool"] + confirm: NotRequired[bool] """ Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary. """ - confirmation_token: NotRequired["str"] + confirmation_token: NotRequired[str] """ ID of the ConfirmationToken used to confirm this SetupIntent. If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ ID of the Customer this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - flow_directions: NotRequired["List[Literal['inbound', 'outbound']]"] + flow_directions: NotRequired[List[Literal["inbound", "outbound"]]] """ Indicates the directions of money movement for which this payment method is intended to be used. @@ -1752,19 +1869,19 @@ class CreateParams(RequestOptions): """ This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The Stripe account ID created for this SetupIntent. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. """ - payment_method_configuration: NotRequired["str"] + payment_method_configuration: NotRequired[str] """ The ID of the payment method configuration to use with this SetupIntent. """ @@ -1781,11 +1898,11 @@ class CreateParams(RequestOptions): """ Payment method-specific configuration for this SetupIntent. """ - payment_method_types: NotRequired["List[str]"] + payment_method_types: NotRequired[List[str]] """ The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, it defaults to ["card"]. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). """ @@ -1793,17 +1910,17 @@ class CreateParams(RequestOptions): """ If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion. """ - usage: NotRequired["Literal['off_session', 'on_session']"] + usage: NotRequired[Literal["off_session", "on_session"]] """ Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`. """ - use_stripe_sdk: NotRequired["bool"] + use_stripe_sdk: NotRequired[bool] """ Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. """ class CreateParamsAutomaticPaymentMethods(TypedDict): - allow_redirects: NotRequired["Literal['always', 'never']"] + allow_redirects: NotRequired[Literal["always", "never"]] """ Controls whether this SetupIntent will accept redirect-based payment methods. @@ -1821,7 +1938,7 @@ class CreateParamsMandateData(TypedDict): """ class CreateParamsMandateDataCustomerAcceptance(TypedDict): - accepted_at: NotRequired["int"] + accepted_at: NotRequired[int] """ The time at which the customer accepted the Mandate. """ @@ -1964,7 +2081,7 @@ class CreateParamsPaymentMethodData(TypedDict): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -2132,11 +2249,11 @@ class CreateParamsPaymentMethodDataAuBecsDebit(TypedDict): """ class CreateParamsPaymentMethodDataBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -2165,27 +2282,27 @@ class CreateParamsPaymentMethodDataBillingDetails(TypedDict): """ class CreateParamsPaymentMethodDataBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -2207,14 +2324,43 @@ class CreateParamsPaymentMethodDataCustomerBalance(TypedDict): class CreateParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class CreateParamsPaymentMethodDataFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -2254,7 +2400,24 @@ class CreateParamsPaymentMethodDataGrabpay(TypedDict): class CreateParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -2300,7 +2463,34 @@ class CreateParamsPaymentMethodDataOxxo(TypedDict): class CreateParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -2313,15 +2503,15 @@ class CreateParamsPaymentMethodDataPaypal(TypedDict): pass class CreateParamsPaymentMethodDataPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -2333,7 +2523,7 @@ class CreateParamsPaymentMethodDataPromptpay(TypedDict): pass class CreateParamsPaymentMethodDataRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -2360,23 +2550,23 @@ class CreateParamsPaymentMethodDataTwint(TypedDict): pass class CreateParamsPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -2426,7 +2616,7 @@ class CreateParamsPaymentMethodOptions(TypedDict): """ class CreateParamsPaymentMethodOptionsAcssDebit(TypedDict): - currency: NotRequired["Literal['cad', 'usd']"] + currency: NotRequired[Literal["cad", "usd"]] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ @@ -2437,7 +2627,7 @@ class CreateParamsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -2450,21 +2640,21 @@ class CreateParamsPaymentMethodOptionsAcssDebitMandateOptions(TypedDict): The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - default_for: NotRequired["List[Literal['invoice', 'subscription']]"] + default_for: NotRequired[List[Literal["invoice", "subscription"]]] """ List of Stripe products where this mandate can be selected automatically. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -2476,20 +2666,32 @@ class CreateParamsPaymentMethodOptionsCard(TypedDict): """ Configuration options for setting up an eMandate for cards issued in India. """ - moto: NotRequired["bool"] + moto: NotRequired[bool] """ When specified, this parameter signals that a card has been collected as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. @@ -2515,11 +2717,11 @@ class CreateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ @@ -2527,7 +2729,7 @@ class CreateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ @@ -2539,19 +2741,19 @@ class CreateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ - supported_types: NotRequired["List[Literal['india']]"] + supported_types: NotRequired[List[Literal["india"]]] """ Specifies the type of mandates supported. Possible values are `india`. """ class CreateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): ares_trans_status: NotRequired[ - "Literal['A', 'C', 'I', 'N', 'R', 'U', 'Y']" + Literal["A", "C", "I", "N", "R", "U", "Y"] ] """ The `transStatus` returned from the card Issuer's ACS in the ARes. """ - cryptogram: NotRequired["str"] + cryptogram: NotRequired[str] """ The cryptogram, also known as the "authentication value" (AAV, CAVV or AEVV). This value is 20 bytes, base64-encoded into a 28-character string. @@ -2559,7 +2761,7 @@ class CreateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): is what you should specify here.) """ electronic_commerce_indicator: NotRequired[ - "Literal['01', '02', '05', '06', '07']" + Literal["01", "02", "05", "06", "07"] ] """ The Electronic Commerce Indicator (ECI) is returned by your 3D Secure @@ -2573,17 +2775,17 @@ class CreateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly """ - requestor_challenge_indicator: NotRequired["str"] + requestor_challenge_indicator: NotRequired[str] """ The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99. """ - transaction_id: NotRequired["str"] + transaction_id: NotRequired[str] """ For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID). """ - version: NotRequired["Literal['1.0.2', '2.1.0', '2.2.0']"] + version: NotRequired[Literal["1.0.2", "2.1.0", "2.2.0"]] """ The version of 3D Secure that was performed. """ @@ -2607,32 +2809,32 @@ class CreateParamsPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancai to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`. messageExtension: CB-AVALGO """ - cb_exemption: NotRequired["str"] + cb_exemption: NotRequired[str] """ The exemption indicator returned from Cartes Bancaires in the ARes. message extension: CB-EXEMPTION; string (4 characters) This is a 3 byte bitmap (low significant byte first and most significant bit first) that has been Base64 encoded """ - cb_score: NotRequired["int"] + cb_score: NotRequired[int] """ The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99 """ class CreateParamsPaymentMethodOptionsLink(TypedDict): - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ class CreateParamsPaymentMethodOptionsPaypal(TypedDict): - billing_agreement_id: NotRequired["str"] + billing_agreement_id: NotRequired[str] """ The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. """ - currency: NotRequired["str"] - subsellers: NotRequired["List[str]"] + currency: NotRequired[str] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -2646,35 +2848,56 @@ class CreateParamsPaymentMethodOptionsPayto(TypedDict): """ class CreateParamsPaymentMethodOptionsPaytoMandateOptions(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount that will be collected. It is required when `amount_type` is `fixed`. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. """ - end_date: NotRequired["str"] + end_date: NotRequired[str] """ Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. """ payment_schedule: NotRequired[ - "Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] ] """ The periodicity at which payments will be collected. """ - payments_per_period: NotRequired["int"] + payments_per_period: NotRequired[int] """ The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. """ purpose: NotRequired[ - "Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] ] """ The purpose for which payments are made. Defaults to retail. """ - start_date: NotRequired["str"] + start_date: NotRequired[str] """ Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. """ @@ -2710,7 +2933,7 @@ class CreateParamsPaymentMethodOptionsUsBankAccount(TypedDict): Additional fields for network related functions """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -2726,18 +2949,29 @@ class CreateParamsPaymentMethodOptionsUsBankAccountFinancialConnections( Customize manual entry behavior """ permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ @@ -2759,7 +2993,7 @@ class CreateParamsPaymentMethodOptionsUsBankAccountMandateOptions( """ class CreateParamsPaymentMethodOptionsUsBankAccountNetworks(TypedDict): - requested: NotRequired["List[Literal['ach', 'us_domestic_wire']]"] + requested: NotRequired[List[Literal["ach", "us_domestic_wire"]]] """ Triggers validations to run across the selected networks """ @@ -2775,7 +3009,7 @@ class CreateParamsSingleUse(TypedDict): """ class ListParams(RequestOptions): - attach_to_self: NotRequired["bool"] + attach_to_self: NotRequired[bool] """ If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. @@ -2785,71 +3019,71 @@ class ListParams(RequestOptions): """ 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"] + customer: NotRequired[str] """ Only return SetupIntents for the customer specified by this customer ID. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ Only return SetupIntents that associate with the specified payment method. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - attach_to_self: NotRequired["bool"] + attach_to_self: NotRequired[bool] """ If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. It can only be used for this Stripe Account's own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ ID of the Customer this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - flow_directions: NotRequired["List[Literal['inbound', 'outbound']]"] + flow_directions: NotRequired[List[Literal["inbound", "outbound"]]] """ Indicates the directions of money movement for which this payment method is intended to be used. @@ -2859,11 +3093,11 @@ class ModifyParams(RequestOptions): """ 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`. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. """ - payment_method_configuration: NotRequired["str"] + payment_method_configuration: NotRequired[str] """ The ID of the payment method configuration to use with this SetupIntent. """ @@ -2880,7 +3114,7 @@ class ModifyParams(RequestOptions): """ Payment method-specific configuration for this SetupIntent. """ - payment_method_types: NotRequired["List[str]"] + payment_method_types: NotRequired[List[str]] """ The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this array, it defaults to ["card"]. """ @@ -2994,7 +3228,7 @@ class ModifyParamsPaymentMethodData(TypedDict): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -3162,11 +3396,11 @@ class ModifyParamsPaymentMethodDataAuBecsDebit(TypedDict): """ class ModifyParamsPaymentMethodDataBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -3195,27 +3429,27 @@ class ModifyParamsPaymentMethodDataBillingDetails(TypedDict): """ class ModifyParamsPaymentMethodDataBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -3237,14 +3471,43 @@ class ModifyParamsPaymentMethodDataCustomerBalance(TypedDict): class ModifyParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class ModifyParamsPaymentMethodDataFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -3284,7 +3547,24 @@ class ModifyParamsPaymentMethodDataGrabpay(TypedDict): class ModifyParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -3330,7 +3610,34 @@ class ModifyParamsPaymentMethodDataOxxo(TypedDict): class ModifyParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -3343,15 +3650,15 @@ class ModifyParamsPaymentMethodDataPaypal(TypedDict): pass class ModifyParamsPaymentMethodDataPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -3363,7 +3670,7 @@ class ModifyParamsPaymentMethodDataPromptpay(TypedDict): pass class ModifyParamsPaymentMethodDataRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -3390,23 +3697,23 @@ class ModifyParamsPaymentMethodDataTwint(TypedDict): pass class ModifyParamsPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -3456,7 +3763,7 @@ class ModifyParamsPaymentMethodOptions(TypedDict): """ class ModifyParamsPaymentMethodOptionsAcssDebit(TypedDict): - currency: NotRequired["Literal['cad', 'usd']"] + currency: NotRequired[Literal["cad", "usd"]] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ @@ -3467,7 +3774,7 @@ class ModifyParamsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -3480,21 +3787,21 @@ class ModifyParamsPaymentMethodOptionsAcssDebitMandateOptions(TypedDict): The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - default_for: NotRequired["List[Literal['invoice', 'subscription']]"] + default_for: NotRequired[List[Literal["invoice", "subscription"]]] """ List of Stripe products where this mandate can be selected automatically. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -3506,20 +3813,32 @@ class ModifyParamsPaymentMethodOptionsCard(TypedDict): """ Configuration options for setting up an eMandate for cards issued in India. """ - moto: NotRequired["bool"] + moto: NotRequired[bool] """ When specified, this parameter signals that a card has been collected as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. @@ -3545,11 +3864,11 @@ class ModifyParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ @@ -3557,7 +3876,7 @@ class ModifyParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ @@ -3569,19 +3888,19 @@ class ModifyParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ - supported_types: NotRequired["List[Literal['india']]"] + supported_types: NotRequired[List[Literal["india"]]] """ Specifies the type of mandates supported. Possible values are `india`. """ class ModifyParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): ares_trans_status: NotRequired[ - "Literal['A', 'C', 'I', 'N', 'R', 'U', 'Y']" + Literal["A", "C", "I", "N", "R", "U", "Y"] ] """ The `transStatus` returned from the card Issuer's ACS in the ARes. """ - cryptogram: NotRequired["str"] + cryptogram: NotRequired[str] """ The cryptogram, also known as the "authentication value" (AAV, CAVV or AEVV). This value is 20 bytes, base64-encoded into a 28-character string. @@ -3589,7 +3908,7 @@ class ModifyParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): is what you should specify here.) """ electronic_commerce_indicator: NotRequired[ - "Literal['01', '02', '05', '06', '07']" + Literal["01", "02", "05", "06", "07"] ] """ The Electronic Commerce Indicator (ECI) is returned by your 3D Secure @@ -3603,17 +3922,17 @@ class ModifyParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly """ - requestor_challenge_indicator: NotRequired["str"] + requestor_challenge_indicator: NotRequired[str] """ The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99. """ - transaction_id: NotRequired["str"] + transaction_id: NotRequired[str] """ For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID). """ - version: NotRequired["Literal['1.0.2', '2.1.0', '2.2.0']"] + version: NotRequired[Literal["1.0.2", "2.1.0", "2.2.0"]] """ The version of 3D Secure that was performed. """ @@ -3637,32 +3956,32 @@ class ModifyParamsPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancai to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`. messageExtension: CB-AVALGO """ - cb_exemption: NotRequired["str"] + cb_exemption: NotRequired[str] """ The exemption indicator returned from Cartes Bancaires in the ARes. message extension: CB-EXEMPTION; string (4 characters) This is a 3 byte bitmap (low significant byte first and most significant bit first) that has been Base64 encoded """ - cb_score: NotRequired["int"] + cb_score: NotRequired[int] """ The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99 """ class ModifyParamsPaymentMethodOptionsLink(TypedDict): - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ class ModifyParamsPaymentMethodOptionsPaypal(TypedDict): - billing_agreement_id: NotRequired["str"] + billing_agreement_id: NotRequired[str] """ The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. """ - currency: NotRequired["str"] - subsellers: NotRequired["List[str]"] + currency: NotRequired[str] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -3676,35 +3995,56 @@ class ModifyParamsPaymentMethodOptionsPayto(TypedDict): """ class ModifyParamsPaymentMethodOptionsPaytoMandateOptions(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount that will be collected. It is required when `amount_type` is `fixed`. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. """ - end_date: NotRequired["str"] + end_date: NotRequired[str] """ Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. """ payment_schedule: NotRequired[ - "Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] ] """ The periodicity at which payments will be collected. """ - payments_per_period: NotRequired["int"] + payments_per_period: NotRequired[int] """ The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. """ purpose: NotRequired[ - "Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] ] """ The purpose for which payments are made. Defaults to retail. """ - start_date: NotRequired["str"] + start_date: NotRequired[str] """ Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. """ @@ -3740,7 +4080,7 @@ class ModifyParamsPaymentMethodOptionsUsBankAccount(TypedDict): Additional fields for network related functions """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -3756,18 +4096,29 @@ class ModifyParamsPaymentMethodOptionsUsBankAccountFinancialConnections( Customize manual entry behavior """ permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ @@ -3789,31 +4140,31 @@ class ModifyParamsPaymentMethodOptionsUsBankAccountMandateOptions( """ class ModifyParamsPaymentMethodOptionsUsBankAccountNetworks(TypedDict): - requested: NotRequired["List[Literal['ach', 'us_domestic_wire']]"] + requested: NotRequired[List[Literal["ach", "us_domestic_wire"]]] """ Triggers validations to run across the selected networks """ class RetrieveParams(RequestOptions): - client_secret: NotRequired["str"] + client_secret: NotRequired[str] """ The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class VerifyMicrodepositsParams(RequestOptions): - amounts: NotRequired["List[int]"] + amounts: NotRequired[List[int]] """ Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. """ - descriptor_code: NotRequired["str"] + descriptor_code: NotRequired[str] """ A six-character code starting with SM present in the microdeposit sent to the bank account. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_setup_intent_service.py b/stripe/_setup_intent_service.py index 8f156fd2a..e71209b8e 100644 --- a/stripe/_setup_intent_service.py +++ b/stripe/_setup_intent_service.py @@ -12,31 +12,31 @@ class SetupIntentService(StripeService): class CancelParams(TypedDict): cancellation_reason: NotRequired[ - "Literal['abandoned', 'duplicate', 'requested_by_customer']" + Literal["abandoned", "duplicate", "requested_by_customer"] ] """ Reason for canceling this SetupIntent. Possible values are: `abandoned`, `requested_by_customer`, or `duplicate` """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ConfirmParams(TypedDict): - confirmation_token: NotRequired["str"] + confirmation_token: NotRequired[str] """ ID of the ConfirmationToken used to confirm this SetupIntent. If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ mandate_data: NotRequired[ "Literal['']|SetupIntentService.ConfirmParamsMandateData" ] - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. """ @@ -53,13 +53,13 @@ class ConfirmParams(TypedDict): """ Payment method-specific configuration for this SetupIntent. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL to redirect your customer back to after they authenticate on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods. """ - use_stripe_sdk: NotRequired["bool"] + use_stripe_sdk: NotRequired[bool] """ Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. """ @@ -73,7 +73,7 @@ class ConfirmParamsMandateData(TypedDict): """ class ConfirmParamsMandateDataCustomerAcceptance(TypedDict): - accepted_at: NotRequired["int"] + accepted_at: NotRequired[int] """ The time at which the customer accepted the Mandate. """ @@ -98,11 +98,11 @@ class ConfirmParamsMandateDataCustomerAcceptanceOffline(TypedDict): pass class ConfirmParamsMandateDataCustomerAcceptanceOnline(TypedDict): - ip_address: NotRequired["str"] + ip_address: NotRequired[str] """ The IP address from which the Mandate was accepted by the customer. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the Mandate was accepted by the customer. """ @@ -234,7 +234,7 @@ class ConfirmParamsPaymentMethodData(TypedDict): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -422,11 +422,11 @@ class ConfirmParamsPaymentMethodDataAuBecsDebit(TypedDict): """ class ConfirmParamsPaymentMethodDataBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -455,27 +455,27 @@ class ConfirmParamsPaymentMethodDataBillingDetails(TypedDict): """ class ConfirmParamsPaymentMethodDataBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -497,14 +497,43 @@ class ConfirmParamsPaymentMethodDataCustomerBalance(TypedDict): class ConfirmParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class ConfirmParamsPaymentMethodDataFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -544,7 +573,24 @@ class ConfirmParamsPaymentMethodDataGrabpay(TypedDict): class ConfirmParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -592,7 +638,34 @@ class ConfirmParamsPaymentMethodDataOxxo(TypedDict): class ConfirmParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -605,15 +678,15 @@ class ConfirmParamsPaymentMethodDataPaypal(TypedDict): pass class ConfirmParamsPaymentMethodDataPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -625,7 +698,7 @@ class ConfirmParamsPaymentMethodDataPromptpay(TypedDict): pass class ConfirmParamsPaymentMethodDataRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -652,23 +725,23 @@ class ConfirmParamsPaymentMethodDataTwint(TypedDict): pass class ConfirmParamsPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -724,7 +797,7 @@ class ConfirmParamsPaymentMethodOptions(TypedDict): """ class ConfirmParamsPaymentMethodOptionsAcssDebit(TypedDict): - currency: NotRequired["Literal['cad', 'usd']"] + currency: NotRequired[Literal["cad", "usd"]] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ @@ -735,7 +808,7 @@ class ConfirmParamsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -748,21 +821,21 @@ class ConfirmParamsPaymentMethodOptionsAcssDebitMandateOptions(TypedDict): The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - default_for: NotRequired["List[Literal['invoice', 'subscription']]"] + default_for: NotRequired[List[Literal["invoice", "subscription"]]] """ List of Stripe products where this mandate can be selected automatically. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -774,20 +847,32 @@ class ConfirmParamsPaymentMethodOptionsCard(TypedDict): """ Configuration options for setting up an eMandate for cards issued in India. """ - moto: NotRequired["bool"] + moto: NotRequired[bool] """ When specified, this parameter signals that a card has been collected as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. @@ -813,11 +898,11 @@ class ConfirmParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ @@ -825,7 +910,7 @@ class ConfirmParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ @@ -837,19 +922,19 @@ class ConfirmParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ - supported_types: NotRequired["List[Literal['india']]"] + supported_types: NotRequired[List[Literal["india"]]] """ Specifies the type of mandates supported. Possible values are `india`. """ class ConfirmParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): ares_trans_status: NotRequired[ - "Literal['A', 'C', 'I', 'N', 'R', 'U', 'Y']" + Literal["A", "C", "I", "N", "R", "U", "Y"] ] """ The `transStatus` returned from the card Issuer's ACS in the ARes. """ - cryptogram: NotRequired["str"] + cryptogram: NotRequired[str] """ The cryptogram, also known as the "authentication value" (AAV, CAVV or AEVV). This value is 20 bytes, base64-encoded into a 28-character string. @@ -857,7 +942,7 @@ class ConfirmParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): is what you should specify here.) """ electronic_commerce_indicator: NotRequired[ - "Literal['01', '02', '05', '06', '07']" + Literal["01", "02", "05", "06", "07"] ] """ The Electronic Commerce Indicator (ECI) is returned by your 3D Secure @@ -871,17 +956,17 @@ class ConfirmParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly """ - requestor_challenge_indicator: NotRequired["str"] + requestor_challenge_indicator: NotRequired[str] """ The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99. """ - transaction_id: NotRequired["str"] + transaction_id: NotRequired[str] """ For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID). """ - version: NotRequired["Literal['1.0.2', '2.1.0', '2.2.0']"] + version: NotRequired[Literal["1.0.2", "2.1.0", "2.2.0"]] """ The version of 3D Secure that was performed. """ @@ -905,32 +990,32 @@ class ConfirmParamsPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBanca to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`. messageExtension: CB-AVALGO """ - cb_exemption: NotRequired["str"] + cb_exemption: NotRequired[str] """ The exemption indicator returned from Cartes Bancaires in the ARes. message extension: CB-EXEMPTION; string (4 characters) This is a 3 byte bitmap (low significant byte first and most significant bit first) that has been Base64 encoded """ - cb_score: NotRequired["int"] + cb_score: NotRequired[int] """ The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99 """ class ConfirmParamsPaymentMethodOptionsLink(TypedDict): - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ class ConfirmParamsPaymentMethodOptionsPaypal(TypedDict): - billing_agreement_id: NotRequired["str"] + billing_agreement_id: NotRequired[str] """ The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. """ - currency: NotRequired["str"] - subsellers: NotRequired["List[str]"] + currency: NotRequired[str] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -944,35 +1029,56 @@ class ConfirmParamsPaymentMethodOptionsPayto(TypedDict): """ class ConfirmParamsPaymentMethodOptionsPaytoMandateOptions(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount that will be collected. It is required when `amount_type` is `fixed`. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. """ - end_date: NotRequired["str"] + end_date: NotRequired[str] """ Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. """ payment_schedule: NotRequired[ - "Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] ] """ The periodicity at which payments will be collected. """ - payments_per_period: NotRequired["int"] + payments_per_period: NotRequired[int] """ The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. """ purpose: NotRequired[ - "Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] ] """ The purpose for which payments are made. Defaults to retail. """ - start_date: NotRequired["str"] + start_date: NotRequired[str] """ Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. """ @@ -1008,7 +1114,7 @@ class ConfirmParamsPaymentMethodOptionsUsBankAccount(TypedDict): Additional fields for network related functions """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -1024,18 +1130,29 @@ class ConfirmParamsPaymentMethodOptionsUsBankAccountFinancialConnections( Customize manual entry behavior """ permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ @@ -1057,13 +1174,13 @@ class ConfirmParamsPaymentMethodOptionsUsBankAccountMandateOptions( """ class ConfirmParamsPaymentMethodOptionsUsBankAccountNetworks(TypedDict): - requested: NotRequired["List[Literal['ach', 'us_domestic_wire']]"] + requested: NotRequired[List[Literal["ach", "us_domestic_wire"]]] """ Triggers validations to run across the selected networks """ class CreateParams(TypedDict): - attach_to_self: NotRequired["bool"] + attach_to_self: NotRequired[bool] """ If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. @@ -1075,31 +1192,31 @@ class CreateParams(TypedDict): """ When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters. """ - confirm: NotRequired["bool"] + confirm: NotRequired[bool] """ Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary. """ - confirmation_token: NotRequired["str"] + confirmation_token: NotRequired[str] """ ID of the ConfirmationToken used to confirm this SetupIntent. If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ ID of the Customer this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - flow_directions: NotRequired["List[Literal['inbound', 'outbound']]"] + flow_directions: NotRequired[List[Literal["inbound", "outbound"]]] """ Indicates the directions of money movement for which this payment method is intended to be used. @@ -1111,19 +1228,19 @@ class CreateParams(TypedDict): """ This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The Stripe account ID created for this SetupIntent. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. """ - payment_method_configuration: NotRequired["str"] + payment_method_configuration: NotRequired[str] """ The ID of the payment method configuration to use with this SetupIntent. """ @@ -1140,11 +1257,11 @@ class CreateParams(TypedDict): """ Payment method-specific configuration for this SetupIntent. """ - payment_method_types: NotRequired["List[str]"] + payment_method_types: NotRequired[List[str]] """ The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, it defaults to ["card"]. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). """ @@ -1152,17 +1269,17 @@ class CreateParams(TypedDict): """ If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion. """ - usage: NotRequired["Literal['off_session', 'on_session']"] + usage: NotRequired[Literal["off_session", "on_session"]] """ Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`. """ - use_stripe_sdk: NotRequired["bool"] + use_stripe_sdk: NotRequired[bool] """ Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. """ class CreateParamsAutomaticPaymentMethods(TypedDict): - allow_redirects: NotRequired["Literal['always', 'never']"] + allow_redirects: NotRequired[Literal["always", "never"]] """ Controls whether this SetupIntent will accept redirect-based payment methods. @@ -1180,7 +1297,7 @@ class CreateParamsMandateData(TypedDict): """ class CreateParamsMandateDataCustomerAcceptance(TypedDict): - accepted_at: NotRequired["int"] + accepted_at: NotRequired[int] """ The time at which the customer accepted the Mandate. """ @@ -1337,7 +1454,7 @@ class CreateParamsPaymentMethodData(TypedDict): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -1519,11 +1636,11 @@ class CreateParamsPaymentMethodDataAuBecsDebit(TypedDict): """ class CreateParamsPaymentMethodDataBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -1552,27 +1669,27 @@ class CreateParamsPaymentMethodDataBillingDetails(TypedDict): """ class CreateParamsPaymentMethodDataBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1594,14 +1711,43 @@ class CreateParamsPaymentMethodDataCustomerBalance(TypedDict): class CreateParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class CreateParamsPaymentMethodDataFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -1641,7 +1787,24 @@ class CreateParamsPaymentMethodDataGrabpay(TypedDict): class CreateParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -1689,7 +1852,34 @@ class CreateParamsPaymentMethodDataOxxo(TypedDict): class CreateParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -1702,15 +1892,15 @@ class CreateParamsPaymentMethodDataPaypal(TypedDict): pass class CreateParamsPaymentMethodDataPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -1722,7 +1912,7 @@ class CreateParamsPaymentMethodDataPromptpay(TypedDict): pass class CreateParamsPaymentMethodDataRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -1749,23 +1939,23 @@ class CreateParamsPaymentMethodDataTwint(TypedDict): pass class CreateParamsPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -1821,7 +2011,7 @@ class CreateParamsPaymentMethodOptions(TypedDict): """ class CreateParamsPaymentMethodOptionsAcssDebit(TypedDict): - currency: NotRequired["Literal['cad', 'usd']"] + currency: NotRequired[Literal["cad", "usd"]] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ @@ -1832,7 +2022,7 @@ class CreateParamsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -1845,21 +2035,21 @@ class CreateParamsPaymentMethodOptionsAcssDebitMandateOptions(TypedDict): The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - default_for: NotRequired["List[Literal['invoice', 'subscription']]"] + default_for: NotRequired[List[Literal["invoice", "subscription"]]] """ List of Stripe products where this mandate can be selected automatically. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -1871,20 +2061,32 @@ class CreateParamsPaymentMethodOptionsCard(TypedDict): """ Configuration options for setting up an eMandate for cards issued in India. """ - moto: NotRequired["bool"] + moto: NotRequired[bool] """ When specified, this parameter signals that a card has been collected as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. @@ -1910,11 +2112,11 @@ class CreateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ @@ -1922,7 +2124,7 @@ class CreateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ @@ -1934,19 +2136,19 @@ class CreateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ - supported_types: NotRequired["List[Literal['india']]"] + supported_types: NotRequired[List[Literal["india"]]] """ Specifies the type of mandates supported. Possible values are `india`. """ class CreateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): ares_trans_status: NotRequired[ - "Literal['A', 'C', 'I', 'N', 'R', 'U', 'Y']" + Literal["A", "C", "I", "N", "R", "U", "Y"] ] """ The `transStatus` returned from the card Issuer's ACS in the ARes. """ - cryptogram: NotRequired["str"] + cryptogram: NotRequired[str] """ The cryptogram, also known as the "authentication value" (AAV, CAVV or AEVV). This value is 20 bytes, base64-encoded into a 28-character string. @@ -1954,7 +2156,7 @@ class CreateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): is what you should specify here.) """ electronic_commerce_indicator: NotRequired[ - "Literal['01', '02', '05', '06', '07']" + Literal["01", "02", "05", "06", "07"] ] """ The Electronic Commerce Indicator (ECI) is returned by your 3D Secure @@ -1968,17 +2170,17 @@ class CreateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly """ - requestor_challenge_indicator: NotRequired["str"] + requestor_challenge_indicator: NotRequired[str] """ The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99. """ - transaction_id: NotRequired["str"] + transaction_id: NotRequired[str] """ For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID). """ - version: NotRequired["Literal['1.0.2', '2.1.0', '2.2.0']"] + version: NotRequired[Literal["1.0.2", "2.1.0", "2.2.0"]] """ The version of 3D Secure that was performed. """ @@ -2002,32 +2204,32 @@ class CreateParamsPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancai to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`. messageExtension: CB-AVALGO """ - cb_exemption: NotRequired["str"] + cb_exemption: NotRequired[str] """ The exemption indicator returned from Cartes Bancaires in the ARes. message extension: CB-EXEMPTION; string (4 characters) This is a 3 byte bitmap (low significant byte first and most significant bit first) that has been Base64 encoded """ - cb_score: NotRequired["int"] + cb_score: NotRequired[int] """ The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99 """ class CreateParamsPaymentMethodOptionsLink(TypedDict): - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ class CreateParamsPaymentMethodOptionsPaypal(TypedDict): - billing_agreement_id: NotRequired["str"] + billing_agreement_id: NotRequired[str] """ The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. """ - currency: NotRequired["str"] - subsellers: NotRequired["List[str]"] + currency: NotRequired[str] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -2041,35 +2243,56 @@ class CreateParamsPaymentMethodOptionsPayto(TypedDict): """ class CreateParamsPaymentMethodOptionsPaytoMandateOptions(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount that will be collected. It is required when `amount_type` is `fixed`. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. """ - end_date: NotRequired["str"] + end_date: NotRequired[str] """ Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. """ payment_schedule: NotRequired[ - "Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] ] """ The periodicity at which payments will be collected. """ - payments_per_period: NotRequired["int"] + payments_per_period: NotRequired[int] """ The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. """ purpose: NotRequired[ - "Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] ] """ The purpose for which payments are made. Defaults to retail. """ - start_date: NotRequired["str"] + start_date: NotRequired[str] """ Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. """ @@ -2105,7 +2328,7 @@ class CreateParamsPaymentMethodOptionsUsBankAccount(TypedDict): Additional fields for network related functions """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -2121,18 +2344,29 @@ class CreateParamsPaymentMethodOptionsUsBankAccountFinancialConnections( Customize manual entry behavior """ permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ @@ -2154,7 +2388,7 @@ class CreateParamsPaymentMethodOptionsUsBankAccountMandateOptions( """ class CreateParamsPaymentMethodOptionsUsBankAccountNetworks(TypedDict): - requested: NotRequired["List[Literal['ach', 'us_domestic_wire']]"] + requested: NotRequired[List[Literal["ach", "us_domestic_wire"]]] """ Triggers validations to run across the selected networks """ @@ -2170,7 +2404,7 @@ class CreateParamsSingleUse(TypedDict): """ class ListParams(TypedDict): - attach_to_self: NotRequired["bool"] + attach_to_self: NotRequired[bool] """ If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. @@ -2180,81 +2414,81 @@ class ListParams(TypedDict): """ 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"] + customer: NotRequired[str] """ Only return SetupIntents for the customer specified by this customer ID. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ Only return SetupIntents that associate with the specified payment method. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - client_secret: NotRequired["str"] + client_secret: NotRequired[str] """ The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - attach_to_self: NotRequired["bool"] + attach_to_self: NotRequired[bool] """ If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. It can only be used for this Stripe Account's own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ ID of the Customer this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - flow_directions: NotRequired["List[Literal['inbound', 'outbound']]"] + flow_directions: NotRequired[List[Literal["inbound", "outbound"]]] """ Indicates the directions of money movement for which this payment method is intended to be used. @@ -2264,11 +2498,11 @@ class UpdateParams(TypedDict): """ 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`. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. """ - payment_method_configuration: NotRequired["str"] + payment_method_configuration: NotRequired[str] """ The ID of the payment method configuration to use with this SetupIntent. """ @@ -2285,7 +2519,7 @@ class UpdateParams(TypedDict): """ Payment method-specific configuration for this SetupIntent. """ - payment_method_types: NotRequired["List[str]"] + payment_method_types: NotRequired[List[str]] """ The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this array, it defaults to ["card"]. """ @@ -2413,7 +2647,7 @@ class UpdateParamsPaymentMethodData(TypedDict): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -2595,11 +2829,11 @@ class UpdateParamsPaymentMethodDataAuBecsDebit(TypedDict): """ class UpdateParamsPaymentMethodDataBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -2628,27 +2862,27 @@ class UpdateParamsPaymentMethodDataBillingDetails(TypedDict): """ class UpdateParamsPaymentMethodDataBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -2670,14 +2904,43 @@ class UpdateParamsPaymentMethodDataCustomerBalance(TypedDict): class UpdateParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class UpdateParamsPaymentMethodDataFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -2717,7 +2980,24 @@ class UpdateParamsPaymentMethodDataGrabpay(TypedDict): class UpdateParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -2765,7 +3045,34 @@ class UpdateParamsPaymentMethodDataOxxo(TypedDict): class UpdateParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -2778,15 +3085,15 @@ class UpdateParamsPaymentMethodDataPaypal(TypedDict): pass class UpdateParamsPaymentMethodDataPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -2798,7 +3105,7 @@ class UpdateParamsPaymentMethodDataPromptpay(TypedDict): pass class UpdateParamsPaymentMethodDataRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -2825,23 +3132,23 @@ class UpdateParamsPaymentMethodDataTwint(TypedDict): pass class UpdateParamsPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -2897,7 +3204,7 @@ class UpdateParamsPaymentMethodOptions(TypedDict): """ class UpdateParamsPaymentMethodOptionsAcssDebit(TypedDict): - currency: NotRequired["Literal['cad', 'usd']"] + currency: NotRequired[Literal["cad", "usd"]] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ @@ -2908,7 +3215,7 @@ class UpdateParamsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -2921,21 +3228,21 @@ class UpdateParamsPaymentMethodOptionsAcssDebitMandateOptions(TypedDict): The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - default_for: NotRequired["List[Literal['invoice', 'subscription']]"] + default_for: NotRequired[List[Literal["invoice", "subscription"]]] """ List of Stripe products where this mandate can be selected automatically. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ @@ -2947,20 +3254,32 @@ class UpdateParamsPaymentMethodOptionsCard(TypedDict): """ Configuration options for setting up an eMandate for cards issued in India. """ - moto: NotRequired["bool"] + moto: NotRequired[bool] """ When specified, this parameter signals that a card has been collected as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. @@ -2986,11 +3305,11 @@ class UpdateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ @@ -2998,7 +3317,7 @@ class UpdateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ @@ -3010,19 +3329,19 @@ class UpdateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ - supported_types: NotRequired["List[Literal['india']]"] + supported_types: NotRequired[List[Literal["india"]]] """ Specifies the type of mandates supported. Possible values are `india`. """ class UpdateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): ares_trans_status: NotRequired[ - "Literal['A', 'C', 'I', 'N', 'R', 'U', 'Y']" + Literal["A", "C", "I", "N", "R", "U", "Y"] ] """ The `transStatus` returned from the card Issuer's ACS in the ARes. """ - cryptogram: NotRequired["str"] + cryptogram: NotRequired[str] """ The cryptogram, also known as the "authentication value" (AAV, CAVV or AEVV). This value is 20 bytes, base64-encoded into a 28-character string. @@ -3030,7 +3349,7 @@ class UpdateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): is what you should specify here.) """ electronic_commerce_indicator: NotRequired[ - "Literal['01', '02', '05', '06', '07']" + Literal["01", "02", "05", "06", "07"] ] """ The Electronic Commerce Indicator (ECI) is returned by your 3D Secure @@ -3044,17 +3363,17 @@ class UpdateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict): explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly """ - requestor_challenge_indicator: NotRequired["str"] + requestor_challenge_indicator: NotRequired[str] """ The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99. """ - transaction_id: NotRequired["str"] + transaction_id: NotRequired[str] """ For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID). """ - version: NotRequired["Literal['1.0.2', '2.1.0', '2.2.0']"] + version: NotRequired[Literal["1.0.2", "2.1.0", "2.2.0"]] """ The version of 3D Secure that was performed. """ @@ -3078,32 +3397,32 @@ class UpdateParamsPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancai to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`. messageExtension: CB-AVALGO """ - cb_exemption: NotRequired["str"] + cb_exemption: NotRequired[str] """ The exemption indicator returned from Cartes Bancaires in the ARes. message extension: CB-EXEMPTION; string (4 characters) This is a 3 byte bitmap (low significant byte first and most significant bit first) that has been Base64 encoded """ - cb_score: NotRequired["int"] + cb_score: NotRequired[int] """ The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99 """ class UpdateParamsPaymentMethodOptionsLink(TypedDict): - persistent_token: NotRequired["str"] + persistent_token: NotRequired[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ class UpdateParamsPaymentMethodOptionsPaypal(TypedDict): - billing_agreement_id: NotRequired["str"] + billing_agreement_id: NotRequired[str] """ The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. """ - currency: NotRequired["str"] - subsellers: NotRequired["List[str]"] + currency: NotRequired[str] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ @@ -3117,35 +3436,56 @@ class UpdateParamsPaymentMethodOptionsPayto(TypedDict): """ class UpdateParamsPaymentMethodOptionsPaytoMandateOptions(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount that will be collected. It is required when `amount_type` is `fixed`. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. """ - end_date: NotRequired["str"] + end_date: NotRequired[str] """ Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. """ payment_schedule: NotRequired[ - "Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] ] """ The periodicity at which payments will be collected. """ - payments_per_period: NotRequired["int"] + payments_per_period: NotRequired[int] """ The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. """ purpose: NotRequired[ - "Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] ] """ The purpose for which payments are made. Defaults to retail. """ - start_date: NotRequired["str"] + start_date: NotRequired[str] """ Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. """ @@ -3181,7 +3521,7 @@ class UpdateParamsPaymentMethodOptionsUsBankAccount(TypedDict): Additional fields for network related functions """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. @@ -3197,18 +3537,29 @@ class UpdateParamsPaymentMethodOptionsUsBankAccountFinancialConnections( Customize manual entry behavior """ permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ @@ -3230,21 +3581,21 @@ class UpdateParamsPaymentMethodOptionsUsBankAccountMandateOptions( """ class UpdateParamsPaymentMethodOptionsUsBankAccountNetworks(TypedDict): - requested: NotRequired["List[Literal['ach', 'us_domestic_wire']]"] + requested: NotRequired[List[Literal["ach", "us_domestic_wire"]]] """ Triggers validations to run across the selected networks """ class VerifyMicrodepositsParams(TypedDict): - amounts: NotRequired["List[int]"] + amounts: NotRequired[List[int]] """ Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. """ - descriptor_code: NotRequired["str"] + descriptor_code: NotRequired[str] """ A six-character code starting with SM present in the microdeposit sent to the bank account. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_shipping_rate.py b/stripe/_shipping_rate.py index ed96ee0d9..fa424e3c9 100644 --- a/stripe/_shipping_rate.py +++ b/stripe/_shipping_rate.py @@ -101,7 +101,7 @@ class CreateParams(RequestOptions): """ The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -109,21 +109,21 @@ class CreateParams(RequestOptions): """ Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ - type: NotRequired["Literal['fixed_amount']"] + type: NotRequired[Literal["fixed_amount"]] """ The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. """ @@ -172,7 +172,7 @@ class CreateParamsFixedAmount(TypedDict): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, ShippingRate.CreateParamsFixedAmountCurrencyOptions]" + Dict[str, "ShippingRate.CreateParamsFixedAmountCurrencyOptions"] ] """ Shipping rates 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). @@ -184,14 +184,14 @@ class CreateParamsFixedAmountCurrencyOptions(TypedDict): A non-negative integer in cents representing how much to charge. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ class ListParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Only return shipping rates that are active or inactive. """ @@ -199,51 +199,51 @@ class ListParams(RequestOptions): """ 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. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Only return shipping rates for the given currency. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the shipping rate can be used for new purchases. Defaults to `true`. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -256,7 +256,7 @@ class ModifyParams(RequestOptions): 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`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. @@ -264,26 +264,26 @@ class ModifyParams(RequestOptions): class ModifyParamsFixedAmount(TypedDict): currency_options: NotRequired[ - "Dict[str, ShippingRate.ModifyParamsFixedAmountCurrencyOptions]" + Dict[str, "ShippingRate.ModifyParamsFixedAmountCurrencyOptions"] ] """ Shipping rates 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 ModifyParamsFixedAmountCurrencyOptions(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ A non-negative integer in cents representing how much to charge. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_shipping_rate_service.py b/stripe/_shipping_rate_service.py index 488a1859f..962d50b24 100644 --- a/stripe/_shipping_rate_service.py +++ b/stripe/_shipping_rate_service.py @@ -21,7 +21,7 @@ class CreateParams(TypedDict): """ The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -31,21 +31,21 @@ class CreateParams(TypedDict): """ Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ - type: NotRequired["Literal['fixed_amount']"] + type: NotRequired[Literal["fixed_amount"]] """ The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. """ @@ -94,7 +94,10 @@ class CreateParamsFixedAmount(TypedDict): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, ShippingRateService.CreateParamsFixedAmountCurrencyOptions]" + Dict[ + str, + "ShippingRateService.CreateParamsFixedAmountCurrencyOptions", + ] ] """ Shipping rates 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). @@ -106,14 +109,14 @@ class CreateParamsFixedAmountCurrencyOptions(TypedDict): A non-negative integer in cents representing how much to charge. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ class ListParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Only return shipping rates that are active or inactive. """ @@ -121,57 +124,57 @@ class ListParams(TypedDict): """ 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. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Only return shipping rates for the given currency. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the shipping rate can be used for new purchases. Defaults to `true`. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -186,7 +189,7 @@ class UpdateParams(TypedDict): 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`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. @@ -194,19 +197,22 @@ class UpdateParams(TypedDict): class UpdateParamsFixedAmount(TypedDict): currency_options: NotRequired[ - "Dict[str, ShippingRateService.UpdateParamsFixedAmountCurrencyOptions]" + Dict[ + str, + "ShippingRateService.UpdateParamsFixedAmountCurrencyOptions", + ] ] """ Shipping rates 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 UpdateParamsFixedAmountCurrencyOptions(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ A non-negative integer in cents representing how much to charge. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. diff --git a/stripe/_source.py b/stripe/_source.py index 2287cfe74..cd5d444e8 100644 --- a/stripe/_source.py +++ b/stripe/_source.py @@ -497,24 +497,24 @@ class Wechat(StripeObject): statement_descriptor: Optional[str] class CreateParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ flow: NotRequired[ - "Literal['code_verification', 'none', 'receiver', 'redirect']" + Literal["code_verification", "none", "receiver", "redirect"] ] """ The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows. @@ -523,8 +523,8 @@ class CreateParams(RequestOptions): """ Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. """ - metadata: NotRequired["Dict[str, str]"] - original_source: NotRequired["str"] + metadata: NotRequired[Dict[str, str]] + original_source: NotRequired[str] """ The source to share. """ @@ -544,19 +544,19 @@ class CreateParams(RequestOptions): """ Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all. """ - token: NotRequired["str"] + token: NotRequired[str] """ An optional token used to create the source. When passed, token properties will override source parameters. """ - type: NotRequired["str"] + type: NotRequired[str] """ The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide) """ - usage: NotRequired["Literal['reusable', 'single_use']"] + usage: NotRequired[Literal["reusable", "single_use"]] class CreateParamsMandate(TypedDict): acceptance: NotRequired["Source.CreateParamsMandateAcceptance"] @@ -567,27 +567,29 @@ class CreateParamsMandate(TypedDict): """ The amount specified by the mandate. (Leave null for a mandate covering all amounts) """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency specified by the mandate. (Must match `currency` of the source) """ - interval: NotRequired["Literal['one_time', 'scheduled', 'variable']"] + interval: NotRequired[Literal["one_time", "scheduled", "variable"]] """ The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency) """ notification_method: NotRequired[ - "Literal['deprecated_none', 'email', 'manual', 'none', 'stripe_email']" + Literal[ + "deprecated_none", "email", "manual", "none", "stripe_email" + ] ] """ The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification). """ class CreateParamsMandateAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the mandate was accepted or refused by the customer. """ @@ -603,11 +605,11 @@ class CreateParamsMandateAcceptance(TypedDict): """ The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused). """ - type: NotRequired["Literal['offline', 'online']"] + type: NotRequired[Literal["offline", "online"]] """ The type of acceptance information included with the mandate. Either `online` or `offline` """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the mandate was accepted or refused by the customer. """ @@ -619,15 +621,15 @@ class CreateParamsMandateAcceptanceOffline(TypedDict): """ class CreateParamsMandateAcceptanceOnline(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the mandate was accepted or refused by the customer. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the mandate was accepted or refused by the customer. """ @@ -637,48 +639,48 @@ class CreateParamsOwner(TypedDict): """ Owner's address. """ - email: NotRequired["str"] + email: NotRequired[str] """ Owner's email address. """ - name: NotRequired["str"] + name: NotRequired[str] """ Owner's full name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Owner's phone number. """ class CreateParamsOwnerAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsReceiver(TypedDict): refund_attributes_method: NotRequired[ - "Literal['email', 'manual', 'none']" + Literal["email", "manual", "none"] ] """ The method Stripe should use to request information needed to process a refund or mispayment. Either `email` (an email is sent directly to the customer) or `manual` (a `source.refund_attributes_required` event is sent to your webhooks endpoint). Refer to each payment method's documentation to learn which refund attributes may be required. @@ -691,7 +693,7 @@ class CreateParamsRedirect(TypedDict): """ class CreateParamsSourceOrder(TypedDict): - items: NotRequired["List[Source.CreateParamsSourceOrderItem]"] + items: NotRequired[List["Source.CreateParamsSourceOrderItem"]] """ List of items constituting the order. """ @@ -701,47 +703,47 @@ class CreateParamsSourceOrder(TypedDict): """ class CreateParamsSourceOrderItem(TypedDict): - amount: NotRequired["int"] - currency: NotRequired["str"] - description: NotRequired["str"] - parent: NotRequired["str"] + amount: NotRequired[int] + currency: NotRequired[str] + description: NotRequired[str] + parent: NotRequired[str] """ The ID of the SKU being ordered. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. """ - type: NotRequired["Literal['discount', 'shipping', 'sku', 'tax']"] + type: NotRequired[Literal["discount", "shipping", "sku", "tax"]] class CreateParamsSourceOrderShipping(TypedDict): address: "Source.CreateParamsSourceOrderShippingAddress" """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ - name: NotRequired["str"] + name: NotRequired[str] """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class CreateParamsSourceOrderShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ @@ -749,43 +751,43 @@ class CreateParamsSourceOrderShippingAddress(TypedDict): """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ListSourceTransactionsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount associated with the source. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -815,27 +817,29 @@ class ModifyParamsMandate(TypedDict): """ The amount specified by the mandate. (Leave null for a mandate covering all amounts) """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency specified by the mandate. (Must match `currency` of the source) """ - interval: NotRequired["Literal['one_time', 'scheduled', 'variable']"] + interval: NotRequired[Literal["one_time", "scheduled", "variable"]] """ The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency) """ notification_method: NotRequired[ - "Literal['deprecated_none', 'email', 'manual', 'none', 'stripe_email']" + Literal[ + "deprecated_none", "email", "manual", "none", "stripe_email" + ] ] """ The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification). """ class ModifyParamsMandateAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the mandate was accepted or refused by the customer. """ @@ -851,11 +855,11 @@ class ModifyParamsMandateAcceptance(TypedDict): """ The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused). """ - type: NotRequired["Literal['offline', 'online']"] + type: NotRequired[Literal["offline", "online"]] """ The type of acceptance information included with the mandate. Either `online` or `offline` """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the mandate was accepted or refused by the customer. """ @@ -867,15 +871,15 @@ class ModifyParamsMandateAcceptanceOffline(TypedDict): """ class ModifyParamsMandateAcceptanceOnline(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the mandate was accepted or refused by the customer. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the mandate was accepted or refused by the customer. """ @@ -885,47 +889,47 @@ class ModifyParamsOwner(TypedDict): """ Owner's address. """ - email: NotRequired["str"] + email: NotRequired[str] """ Owner's email address. """ - name: NotRequired["str"] + name: NotRequired[str] """ Owner's full name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Owner's phone number. """ class ModifyParamsOwnerAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ModifyParamsSourceOrder(TypedDict): - items: NotRequired["List[Source.ModifyParamsSourceOrderItem]"] + items: NotRequired[List["Source.ModifyParamsSourceOrderItem"]] """ List of items constituting the order. """ @@ -935,47 +939,47 @@ class ModifyParamsSourceOrder(TypedDict): """ class ModifyParamsSourceOrderItem(TypedDict): - amount: NotRequired["int"] - currency: NotRequired["str"] - description: NotRequired["str"] - parent: NotRequired["str"] + amount: NotRequired[int] + currency: NotRequired[str] + description: NotRequired[str] + parent: NotRequired[str] """ The ID of the SKU being ordered. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. """ - type: NotRequired["Literal['discount', 'shipping', 'sku', 'tax']"] + type: NotRequired[Literal["discount", "shipping", "sku", "tax"]] class ModifyParamsSourceOrderShipping(TypedDict): address: "Source.ModifyParamsSourceOrderShippingAddress" """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ - name: NotRequired["str"] + name: NotRequired[str] """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class ModifyParamsSourceOrderShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ @@ -983,31 +987,31 @@ class ModifyParamsSourceOrderShippingAddress(TypedDict): """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class RetrieveParams(RequestOptions): - client_secret: NotRequired["str"] + client_secret: NotRequired[str] """ The client secret of the source. Required if a publishable key is used to retrieve the source. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class VerifyParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_source_service.py b/stripe/_source_service.py index 97e502f8e..d5444be03 100644 --- a/stripe/_source_service.py +++ b/stripe/_source_service.py @@ -18,24 +18,24 @@ def __init__(self, requestor): self.transactions = SourceTransactionService(self._requestor) class CreateParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ flow: NotRequired[ - "Literal['code_verification', 'none', 'receiver', 'redirect']" + Literal["code_verification", "none", "receiver", "redirect"] ] """ The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows. @@ -44,8 +44,8 @@ class CreateParams(TypedDict): """ Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. """ - metadata: NotRequired["Dict[str, str]"] - original_source: NotRequired["str"] + metadata: NotRequired[Dict[str, str]] + original_source: NotRequired[str] """ The source to share. """ @@ -65,19 +65,19 @@ class CreateParams(TypedDict): """ Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all. """ - token: NotRequired["str"] + token: NotRequired[str] """ An optional token used to create the source. When passed, token properties will override source parameters. """ - type: NotRequired["str"] + type: NotRequired[str] """ The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide) """ - usage: NotRequired["Literal['reusable', 'single_use']"] + usage: NotRequired[Literal["reusable", "single_use"]] class CreateParamsMandate(TypedDict): acceptance: NotRequired["SourceService.CreateParamsMandateAcceptance"] @@ -88,27 +88,29 @@ class CreateParamsMandate(TypedDict): """ The amount specified by the mandate. (Leave null for a mandate covering all amounts) """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency specified by the mandate. (Must match `currency` of the source) """ - interval: NotRequired["Literal['one_time', 'scheduled', 'variable']"] + interval: NotRequired[Literal["one_time", "scheduled", "variable"]] """ The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency) """ notification_method: NotRequired[ - "Literal['deprecated_none', 'email', 'manual', 'none', 'stripe_email']" + Literal[ + "deprecated_none", "email", "manual", "none", "stripe_email" + ] ] """ The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification). """ class CreateParamsMandateAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the mandate was accepted or refused by the customer. """ @@ -128,11 +130,11 @@ class CreateParamsMandateAcceptance(TypedDict): """ The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused). """ - type: NotRequired["Literal['offline', 'online']"] + type: NotRequired[Literal["offline", "online"]] """ The type of acceptance information included with the mandate. Either `online` or `offline` """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the mandate was accepted or refused by the customer. """ @@ -144,15 +146,15 @@ class CreateParamsMandateAcceptanceOffline(TypedDict): """ class CreateParamsMandateAcceptanceOnline(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the mandate was accepted or refused by the customer. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the mandate was accepted or refused by the customer. """ @@ -162,48 +164,48 @@ class CreateParamsOwner(TypedDict): """ Owner's address. """ - email: NotRequired["str"] + email: NotRequired[str] """ Owner's email address. """ - name: NotRequired["str"] + name: NotRequired[str] """ Owner's full name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Owner's phone number. """ class CreateParamsOwnerAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsReceiver(TypedDict): refund_attributes_method: NotRequired[ - "Literal['email', 'manual', 'none']" + Literal["email", "manual", "none"] ] """ The method Stripe should use to request information needed to process a refund or mispayment. Either `email` (an email is sent directly to the customer) or `manual` (a `source.refund_attributes_required` event is sent to your webhooks endpoint). Refer to each payment method's documentation to learn which refund attributes may be required. @@ -216,7 +218,7 @@ class CreateParamsRedirect(TypedDict): """ class CreateParamsSourceOrder(TypedDict): - items: NotRequired["List[SourceService.CreateParamsSourceOrderItem]"] + items: NotRequired[List["SourceService.CreateParamsSourceOrderItem"]] """ List of items constituting the order. """ @@ -226,47 +228,47 @@ class CreateParamsSourceOrder(TypedDict): """ class CreateParamsSourceOrderItem(TypedDict): - amount: NotRequired["int"] - currency: NotRequired["str"] - description: NotRequired["str"] - parent: NotRequired["str"] + amount: NotRequired[int] + currency: NotRequired[str] + description: NotRequired[str] + parent: NotRequired[str] """ The ID of the SKU being ordered. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. """ - type: NotRequired["Literal['discount', 'shipping', 'sku', 'tax']"] + type: NotRequired[Literal["discount", "shipping", "sku", "tax"]] class CreateParamsSourceOrderShipping(TypedDict): address: "SourceService.CreateParamsSourceOrderShippingAddress" """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ - name: NotRequired["str"] + name: NotRequired[str] """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class CreateParamsSourceOrderShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ @@ -274,41 +276,41 @@ class CreateParamsSourceOrderShippingAddress(TypedDict): """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class DetachParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(TypedDict): - client_secret: NotRequired["str"] + client_secret: NotRequired[str] """ The client secret of the source. Required if a publishable key is used to retrieve the source. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount associated with the source. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -338,27 +340,29 @@ class UpdateParamsMandate(TypedDict): """ The amount specified by the mandate. (Leave null for a mandate covering all amounts) """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency specified by the mandate. (Must match `currency` of the source) """ - interval: NotRequired["Literal['one_time', 'scheduled', 'variable']"] + interval: NotRequired[Literal["one_time", "scheduled", "variable"]] """ The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency) """ notification_method: NotRequired[ - "Literal['deprecated_none', 'email', 'manual', 'none', 'stripe_email']" + Literal[ + "deprecated_none", "email", "manual", "none", "stripe_email" + ] ] """ The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification). """ class UpdateParamsMandateAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the mandate was accepted or refused by the customer. """ @@ -378,11 +382,11 @@ class UpdateParamsMandateAcceptance(TypedDict): """ The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused). """ - type: NotRequired["Literal['offline', 'online']"] + type: NotRequired[Literal["offline", "online"]] """ The type of acceptance information included with the mandate. Either `online` or `offline` """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the mandate was accepted or refused by the customer. """ @@ -394,15 +398,15 @@ class UpdateParamsMandateAcceptanceOffline(TypedDict): """ class UpdateParamsMandateAcceptanceOnline(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the mandate was accepted or refused by the customer. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the mandate was accepted or refused by the customer. """ @@ -412,47 +416,47 @@ class UpdateParamsOwner(TypedDict): """ Owner's address. """ - email: NotRequired["str"] + email: NotRequired[str] """ Owner's email address. """ - name: NotRequired["str"] + name: NotRequired[str] """ Owner's full name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Owner's phone number. """ class UpdateParamsOwnerAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class UpdateParamsSourceOrder(TypedDict): - items: NotRequired["List[SourceService.UpdateParamsSourceOrderItem]"] + items: NotRequired[List["SourceService.UpdateParamsSourceOrderItem"]] """ List of items constituting the order. """ @@ -462,47 +466,47 @@ class UpdateParamsSourceOrder(TypedDict): """ class UpdateParamsSourceOrderItem(TypedDict): - amount: NotRequired["int"] - currency: NotRequired["str"] - description: NotRequired["str"] - parent: NotRequired["str"] + amount: NotRequired[int] + currency: NotRequired[str] + description: NotRequired[str] + parent: NotRequired[str] """ The ID of the SKU being ordered. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. """ - type: NotRequired["Literal['discount', 'shipping', 'sku', 'tax']"] + type: NotRequired[Literal["discount", "shipping", "sku", "tax"]] class UpdateParamsSourceOrderShipping(TypedDict): address: "SourceService.UpdateParamsSourceOrderShippingAddress" """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ - name: NotRequired["str"] + name: NotRequired[str] """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class UpdateParamsSourceOrderShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ @@ -510,21 +514,21 @@ class UpdateParamsSourceOrderShippingAddress(TypedDict): """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class VerifyParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_source_transaction_service.py b/stripe/_source_transaction_service.py index 928bac9bf..022868032 100644 --- a/stripe/_source_transaction_service.py +++ b/stripe/_source_transaction_service.py @@ -11,19 +11,19 @@ class SourceTransactionService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/_subscription.py b/stripe/_subscription.py index cad6ac2b1..94613484b 100644 --- a/stripe/_subscription.py +++ b/stripe/_subscription.py @@ -459,15 +459,15 @@ class CancelParams(RequestOptions): """ Details about why this subscription was cancelled """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - invoice_now: NotRequired["bool"] + invoice_now: NotRequired[bool] """ Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. """ - prorate: NotRequired["bool"] + prorate: NotRequired[bool] """ Will generate a proration invoice item that credits remaining unused time until the subscription period end. """ @@ -486,7 +486,7 @@ class CancelParamsCancellationDetails(TypedDict): class CreateParams(RequestOptions): add_invoice_items: NotRequired[ - "List[Subscription.CreateParamsAddInvoiceItem]" + List["Subscription.CreateParamsAddInvoiceItem"] ] """ A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items. @@ -499,11 +499,11 @@ class CreateParams(RequestOptions): """ Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed. """ - backdate_start_date: NotRequired["int"] + backdate_start_date: NotRequired[int] """ For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. """ - billing_cycle_anchor: NotRequired["int"] + billing_cycle_anchor: NotRequired[int] """ A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. """ @@ -519,25 +519,25 @@ class CreateParams(RequestOptions): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ - cancel_at: NotRequired["int"] + cancel_at: NotRequired[int] """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. """ - cancel_at_period_end: NotRequired["bool"] + cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ @@ -545,15 +545,15 @@ class CreateParams(RequestOptions): """ The identifier of the customer to subscribe. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). """ - default_source: NotRequired["str"] + default_source: NotRequired[str] """ ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). """ @@ -561,7 +561,7 @@ class CreateParams(RequestOptions): """ The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. """ - description: NotRequired["str"] + description: NotRequired[str] """ The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. """ @@ -571,7 +571,7 @@ class CreateParams(RequestOptions): """ The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -581,7 +581,7 @@ class CreateParams(RequestOptions): """ All invoices will be billed using the specified settings. """ - items: NotRequired["List[Subscription.CreateParamsItem]"] + items: NotRequired[List["Subscription.CreateParamsItem"]] """ A list of up to 20 subscription items, each with an attached price. """ @@ -589,7 +589,7 @@ class CreateParams(RequestOptions): """ 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`. """ - off_session: NotRequired["bool"] + off_session: NotRequired[bool] """ Indicates if a customer is on or off-session while an invoice payment is attempted. """ @@ -598,7 +598,12 @@ class CreateParams(RequestOptions): The account on behalf of which to charge, for each of the subscription's invoices. """ payment_behavior: NotRequired[ - "Literal['allow_incomplete', 'default_incomplete', 'error_if_incomplete', 'pending_if_incomplete']" + Literal[ + "allow_incomplete", + "default_incomplete", + "error_if_incomplete", + "pending_if_incomplete", + ] ] """ Only applies to subscriptions with `collection_method=charge_automatically`. @@ -629,12 +634,12 @@ class CreateParams(RequestOptions): """ If specified, the invoicing for the given billing cycle iterations will be processed now. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. @@ -647,11 +652,11 @@ class CreateParams(RequestOptions): """ Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. """ - trial_from_plan: NotRequired["bool"] + trial_from_plan: NotRequired[bool] """ Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. """ - trial_period_days: NotRequired["int"] + trial_period_days: NotRequired[int] """ Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. """ @@ -662,12 +667,12 @@ class CreateParams(RequestOptions): class CreateParamsAddInvoiceItem(TypedDict): discounts: NotRequired[ - "List[Subscription.CreateParamsAddInvoiceItemDiscount]" + List["Subscription.CreateParamsAddInvoiceItemDiscount"] ] """ The coupons to redeem into discounts for the item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -677,7 +682,7 @@ class CreateParamsAddInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. Defaults to 1. """ @@ -687,11 +692,11 @@ class CreateParamsAddInvoiceItem(TypedDict): """ class CreateParamsAddInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -701,7 +706,7 @@ class CreateParamsAddInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -713,7 +718,7 @@ class CreateParamsAddInvoiceItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -742,16 +747,16 @@ class CreateParamsAddInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -769,7 +774,7 @@ class CreateParamsAutomaticTax(TypedDict): """ class CreateParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -783,39 +788,39 @@ class CreateParamsBillingCycleAnchorConfig(TypedDict): """ The day of the month the billing_cycle_anchor should be. Ranges from 1 to 31. """ - hour: NotRequired["int"] + hour: NotRequired[int] """ The hour of the day the billing_cycle_anchor should be. Ranges from 0 to 23. """ - minute: NotRequired["int"] + minute: NotRequired[int] """ The minute of the hour the billing_cycle_anchor should be. Ranges from 0 to 59. """ - month: NotRequired["int"] + month: NotRequired[int] """ The month to start full cycle billing periods. Ranges from 1 to 12. """ - second: NotRequired["int"] + second: NotRequired[int] """ The second of the minute the billing_cycle_anchor should be. Ranges from 0 to 59. """ class CreateParamsBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ class CreateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -825,7 +830,7 @@ class CreateParamsDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -837,7 +842,7 @@ class CreateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -867,7 +872,7 @@ class CreateParamsInvoiceSettings(TypedDict): """ class CreateParamsInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -889,15 +894,15 @@ class CreateParamsItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -905,7 +910,7 @@ class CreateParamsItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -925,11 +930,11 @@ class CreateParamsItemBillingThresholds(TypedDict): """ class CreateParamsItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -939,7 +944,7 @@ class CreateParamsItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -951,7 +956,7 @@ class CreateParamsItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -984,16 +989,16 @@ class CreateParamsItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1003,13 +1008,13 @@ class CreateParamsItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class CreateParamsItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -1032,7 +1037,7 @@ class CreateParamsPaymentSettings(TypedDict): The list of payment method types (e.g. card) to provide to the invoice's PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice's default payment method, the subscription's default payment method, the customer's default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). """ save_default_payment_method: NotRequired[ - "Literal['off', 'on_subscription']" + Literal["off", "on_subscription"] ] """ Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds. @@ -1090,7 +1095,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -1099,13 +1104,13 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions( TypedDict, ): - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ class CreateParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -1118,13 +1123,25 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): Configuration options for setting up an eMandate for cards issued in India. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. @@ -1133,15 +1150,15 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): class CreateParamsPaymentSettingsPaymentMethodOptionsCardMandateOptions( TypedDict, ): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount to be charged for future payments. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ @@ -1155,7 +1172,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalance( """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["str"] + funding_type: NotRequired[str] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ @@ -1169,7 +1186,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer """ Configuration for eu_bank_transfer funding type. """ - type: NotRequired["str"] + type: NotRequired[str] """ The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. """ @@ -1198,7 +1215,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccount( Additional fields for Financial Connections Session creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -1208,13 +1225,24 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConne TypedDict, ): permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. @@ -1225,7 +1253,7 @@ class CreateParamsPendingInvoiceItemInterval(TypedDict): """ Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). """ @@ -1235,13 +1263,13 @@ class CreateParamsPrebilling(TypedDict): """ This is used to determine the number of billing cycles to prebill. """ - update_behavior: NotRequired["Literal['prebill', 'reset']"] + update_behavior: NotRequired[Literal["prebill", "reset"]] """ Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`. """ class CreateParamsTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -1271,7 +1299,7 @@ class ListParams(RequestOptions): Filter subscriptions by their automatic tax settings. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`. @@ -1286,41 +1314,52 @@ class ListParams(RequestOptions): current_period_start: NotRequired[ "Subscription.ListParamsCurrentPeriodStart|int" ] - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of the customer whose subscriptions will be retrieved. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The ID of the plan whose subscriptions will be retrieved. """ - price: NotRequired["str"] + price: NotRequired[str] """ Filter for subscriptions that contain this recurring price ID. """ - starting_after: NotRequired["str"] + 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. """ status: NotRequired[ - "Literal['active', 'all', 'canceled', 'ended', 'incomplete', 'incomplete_expired', 'past_due', 'paused', 'trialing', 'unpaid']" + Literal[ + "active", + "all", + "canceled", + "ended", + "incomplete", + "incomplete_expired", + "past_due", + "paused", + "trialing", + "unpaid", + ] ] """ The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned. """ - test_clock: NotRequired["str"] + test_clock: NotRequired[str] """ Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set. """ @@ -1332,62 +1371,62 @@ class ListParamsAutomaticTax(TypedDict): """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsCurrentPeriodEnd(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsCurrentPeriodStart(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): add_invoice_items: NotRequired[ - "List[Subscription.ModifyParamsAddInvoiceItem]" + List["Subscription.ModifyParamsAddInvoiceItem"] ] """ A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items. @@ -1400,7 +1439,7 @@ class ModifyParams(RequestOptions): """ Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed. """ - billing_cycle_anchor: NotRequired["Literal['now', 'unchanged']"] + billing_cycle_anchor: NotRequired[Literal["now", "unchanged"]] """ Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -1414,7 +1453,7 @@ class ModifyParams(RequestOptions): """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. """ - cancel_at_period_end: NotRequired["bool"] + cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. """ @@ -1425,20 +1464,20 @@ class ModifyParams(RequestOptions): Details about why this subscription was cancelled """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). """ @@ -1460,7 +1499,7 @@ class ModifyParams(RequestOptions): """ The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1470,7 +1509,7 @@ class ModifyParams(RequestOptions): """ All invoices will be billed using the specified settings. """ - items: NotRequired["List[Subscription.ModifyParamsItem]"] + items: NotRequired[List["Subscription.ModifyParamsItem"]] """ A list of up to 20 subscription items, each with an attached price. """ @@ -1478,7 +1517,7 @@ class ModifyParams(RequestOptions): """ 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`. """ - off_session: NotRequired["bool"] + off_session: NotRequired[bool] """ Indicates if a customer is on or off-session while an invoice payment is attempted. """ @@ -1493,7 +1532,12 @@ class ModifyParams(RequestOptions): If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/billing/subscriptions/pause-payment). """ payment_behavior: NotRequired[ - "Literal['allow_incomplete', 'default_incomplete', 'error_if_incomplete', 'pending_if_incomplete']" + Literal[ + "allow_incomplete", + "default_incomplete", + "error_if_incomplete", + "pending_if_incomplete", + ] ] """ Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -1520,17 +1564,17 @@ class ModifyParams(RequestOptions): """ If specified, the invoicing for the given billing cycle iterations will be processed now. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. """ @@ -1544,7 +1588,7 @@ class ModifyParams(RequestOptions): """ Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. """ - trial_from_plan: NotRequired["bool"] + trial_from_plan: NotRequired[bool] """ Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. """ @@ -1555,12 +1599,12 @@ class ModifyParams(RequestOptions): class ModifyParamsAddInvoiceItem(TypedDict): discounts: NotRequired[ - "List[Subscription.ModifyParamsAddInvoiceItemDiscount]" + List["Subscription.ModifyParamsAddInvoiceItemDiscount"] ] """ The coupons to redeem into discounts for the item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -1570,7 +1614,7 @@ class ModifyParamsAddInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. Defaults to 1. """ @@ -1580,11 +1624,11 @@ class ModifyParamsAddInvoiceItem(TypedDict): """ class ModifyParamsAddInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1594,7 +1638,7 @@ class ModifyParamsAddInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1606,7 +1650,7 @@ class ModifyParamsAddInvoiceItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1635,16 +1679,16 @@ class ModifyParamsAddInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1662,7 +1706,7 @@ class ModifyParamsAutomaticTax(TypedDict): """ class ModifyParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1672,11 +1716,11 @@ class ModifyParamsAutomaticTaxLiability(TypedDict): """ class ModifyParamsBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ @@ -1694,11 +1738,11 @@ class ModifyParamsCancellationDetails(TypedDict): """ class ModifyParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1708,7 +1752,7 @@ class ModifyParamsDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1720,7 +1764,7 @@ class ModifyParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1750,7 +1794,7 @@ class ModifyParamsInvoiceSettings(TypedDict): """ class ModifyParamsInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1766,11 +1810,11 @@ class ModifyParamsItem(TypedDict): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. """ - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`. """ - deleted: NotRequired["bool"] + deleted: NotRequired[bool] """ A flag that, if set to `true`, will delete the specified item. """ @@ -1780,7 +1824,7 @@ class ModifyParamsItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - id: NotRequired["str"] + id: NotRequired[str] """ Subscription item to update. """ @@ -1788,11 +1832,11 @@ class ModifyParamsItem(TypedDict): """ 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -1800,7 +1844,7 @@ class ModifyParamsItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -1816,11 +1860,11 @@ class ModifyParamsItemBillingThresholds(TypedDict): """ class ModifyParamsItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1830,7 +1874,7 @@ class ModifyParamsItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1842,7 +1886,7 @@ class ModifyParamsItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1875,16 +1919,16 @@ class ModifyParamsItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1894,7 +1938,7 @@ class ModifyParamsItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -1904,7 +1948,7 @@ class ModifyParamsPauseCollection(TypedDict): """ The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. """ - resumes_at: NotRequired["int"] + resumes_at: NotRequired[int] """ The time after which the subscription will resume collecting payments. """ @@ -1923,7 +1967,7 @@ class ModifyParamsPaymentSettings(TypedDict): The list of payment method types (e.g. card) to provide to the invoice's PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice's default payment method, the subscription's default payment method, the customer's default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). """ save_default_payment_method: NotRequired[ - "Literal['off', 'on_subscription']" + Literal["off", "on_subscription"] ] """ Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds. @@ -1981,7 +2025,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -1990,13 +2034,13 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): class ModifyParamsPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions( TypedDict, ): - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ class ModifyParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -2009,13 +2053,25 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): Configuration options for setting up an eMandate for cards issued in India. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. @@ -2024,15 +2080,15 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): class ModifyParamsPaymentSettingsPaymentMethodOptionsCardMandateOptions( TypedDict, ): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount to be charged for future payments. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ @@ -2046,7 +2102,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsCustomerBalance( """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["str"] + funding_type: NotRequired[str] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ @@ -2060,7 +2116,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer """ Configuration for eu_bank_transfer funding type. """ - type: NotRequired["str"] + type: NotRequired[str] """ The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. """ @@ -2089,7 +2145,7 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsUsBankAccount( Additional fields for Financial Connections Session creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -2099,13 +2155,24 @@ class ModifyParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConne TypedDict, ): permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. @@ -2116,7 +2183,7 @@ class ModifyParamsPendingInvoiceItemInterval(TypedDict): """ Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). """ @@ -2126,13 +2193,13 @@ class ModifyParamsPrebilling(TypedDict): """ This is used to determine the number of billing cycles to prebill. """ - update_behavior: NotRequired["Literal['prebill', 'reset']"] + update_behavior: NotRequired[Literal["prebill", "reset"]] """ Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`. """ class ModifyParamsTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -2154,41 +2221,41 @@ class ModifyParamsTrialSettingsEndBehavior(TypedDict): """ class ResumeParams(RequestOptions): - billing_cycle_anchor: NotRequired["Literal['now', 'unchanged']"] + billing_cycle_anchor: NotRequired[Literal["now", "unchanged"]] """ Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). Setting the value to `unchanged` advances the subscription's billing cycle anchor to the period that surrounds the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SearchParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - page: NotRequired["str"] + page: NotRequired[str] """ A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. """ diff --git a/stripe/_subscription_item.py b/stripe/_subscription_item.py index bff78a51e..38c3e69c8 100644 --- a/stripe/_subscription_item.py +++ b/stripe/_subscription_item.py @@ -72,16 +72,21 @@ class CreateParams(RequestOptions): """ The coupons to redeem into discounts for the subscription item. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ payment_behavior: NotRequired[ - "Literal['allow_incomplete', 'default_incomplete', 'error_if_incomplete', 'pending_if_incomplete']" + Literal[ + "allow_incomplete", + "default_incomplete", + "error_if_incomplete", + "pending_if_incomplete", + ] ] """ Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -92,11 +97,11 @@ class CreateParams(RequestOptions): Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The identifier of the plan to add to the subscription. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -105,16 +110,16 @@ class CreateParams(RequestOptions): Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity you'd like to apply to the subscription item you're creating. """ @@ -138,11 +143,11 @@ class CreateParamsBillingThresholds(TypedDict): """ class CreateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -152,7 +157,7 @@ class CreateParamsDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -164,7 +169,7 @@ class CreateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -197,16 +202,16 @@ class CreateParamsPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -216,13 +221,13 @@ class CreateParamsPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class CreateParamsTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -232,11 +237,11 @@ class CreateParamsTrial(TypedDict): """ class CreateUsageRecordParams(RequestOptions): - action: NotRequired["Literal['increment', 'set']"] + action: NotRequired[Literal["increment", "set"]] """ Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -250,35 +255,35 @@ class CreateUsageRecordParams(RequestOptions): """ class DeleteParams(RequestOptions): - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ @@ -288,19 +293,19 @@ class ListParams(RequestOptions): """ class ListUsageRecordSummariesParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ @@ -318,7 +323,7 @@ class ModifyParams(RequestOptions): """ The coupons to redeem into discounts for the subscription item. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -326,12 +331,17 @@ class ModifyParams(RequestOptions): """ 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`. """ - off_session: NotRequired["bool"] + off_session: NotRequired[bool] """ Indicates if a customer is on or off-session while an invoice payment is attempted. """ payment_behavior: NotRequired[ - "Literal['allow_incomplete', 'default_incomplete', 'error_if_incomplete', 'pending_if_incomplete']" + Literal[ + "allow_incomplete", + "default_incomplete", + "error_if_incomplete", + "pending_if_incomplete", + ] ] """ Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -342,11 +352,11 @@ class ModifyParams(RequestOptions): Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The identifier of the new plan for this subscription item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -355,16 +365,16 @@ class ModifyParams(RequestOptions): Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity you'd like to apply to the subscription item you're creating. """ @@ -380,11 +390,11 @@ class ModifyParamsBillingThresholds(TypedDict): """ class ModifyParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -394,7 +404,7 @@ class ModifyParamsDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -406,7 +416,7 @@ class ModifyParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -439,16 +449,16 @@ class ModifyParamsPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -458,13 +468,13 @@ class ModifyParamsPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_subscription_item_service.py b/stripe/_subscription_item_service.py index 239345cf1..f8349ed99 100644 --- a/stripe/_subscription_item_service.py +++ b/stripe/_subscription_item_service.py @@ -40,16 +40,21 @@ class CreateParams(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ payment_behavior: NotRequired[ - "Literal['allow_incomplete', 'default_incomplete', 'error_if_incomplete', 'pending_if_incomplete']" + Literal[ + "allow_incomplete", + "default_incomplete", + "error_if_incomplete", + "pending_if_incomplete", + ] ] """ Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -60,11 +65,11 @@ class CreateParams(TypedDict): Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The identifier of the plan to add to the subscription. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -75,16 +80,16 @@ class CreateParams(TypedDict): Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity you'd like to apply to the subscription item you're creating. """ @@ -108,11 +113,11 @@ class CreateParamsBillingThresholds(TypedDict): """ class CreateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -122,7 +127,7 @@ class CreateParamsDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -134,7 +139,7 @@ class CreateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -167,16 +172,16 @@ class CreateParamsPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -186,13 +191,13 @@ class CreateParamsPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class CreateParamsTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -202,35 +207,35 @@ class CreateParamsTrial(TypedDict): """ class DeleteParams(TypedDict): - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ @@ -240,7 +245,7 @@ class ListParams(TypedDict): """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -258,7 +263,7 @@ class UpdateParams(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -266,12 +271,17 @@ class UpdateParams(TypedDict): """ 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`. """ - off_session: NotRequired["bool"] + off_session: NotRequired[bool] """ Indicates if a customer is on or off-session while an invoice payment is attempted. """ payment_behavior: NotRequired[ - "Literal['allow_incomplete', 'default_incomplete', 'error_if_incomplete', 'pending_if_incomplete']" + Literal[ + "allow_incomplete", + "default_incomplete", + "error_if_incomplete", + "pending_if_incomplete", + ] ] """ Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -282,11 +292,11 @@ class UpdateParams(TypedDict): Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The identifier of the new plan for this subscription item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -297,16 +307,16 @@ class UpdateParams(TypedDict): Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity you'd like to apply to the subscription item you're creating. """ @@ -322,11 +332,11 @@ class UpdateParamsBillingThresholds(TypedDict): """ class UpdateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -336,7 +346,7 @@ class UpdateParamsDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -348,7 +358,7 @@ class UpdateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -381,16 +391,16 @@ class UpdateParamsPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -400,7 +410,7 @@ class UpdateParamsPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ diff --git a/stripe/_subscription_item_usage_record_service.py b/stripe/_subscription_item_usage_record_service.py index ba08ebe1c..85c41210d 100644 --- a/stripe/_subscription_item_usage_record_service.py +++ b/stripe/_subscription_item_usage_record_service.py @@ -10,11 +10,11 @@ class SubscriptionItemUsageRecordService(StripeService): class CreateParams(TypedDict): - action: NotRequired["Literal['increment', 'set']"] + action: NotRequired[Literal["increment", "set"]] """ Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_subscription_item_usage_record_summary_service.py b/stripe/_subscription_item_usage_record_summary_service.py index 48ddacbdc..4eb3cfd31 100644 --- a/stripe/_subscription_item_usage_record_summary_service.py +++ b/stripe/_subscription_item_usage_record_summary_service.py @@ -11,19 +11,19 @@ class SubscriptionItemUsageRecordSummaryService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/_subscription_schedule.py b/stripe/_subscription_schedule.py index cf1330ff7..fbdded8e6 100644 --- a/stripe/_subscription_schedule.py +++ b/stripe/_subscription_schedule.py @@ -542,12 +542,12 @@ class Prebilling(StripeObject): class AmendParams(RequestOptions): amendments: NotRequired[ - "List[SubscriptionSchedule.AmendParamsAmendment]" + List["SubscriptionSchedule.AmendParamsAmendment"] ] """ Changes to apply to the phases of the subscription schedule, in the order provided. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -558,7 +558,7 @@ class AmendParams(RequestOptions): Provide any time periods to bill in advance. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ In cases where the amendment changes the currently active phase, @@ -583,31 +583,31 @@ class AmendParamsAmendment(TypedDict): Details to identify the earliest timestamp where the proposed change should take effect. """ billing_cycle_anchor: NotRequired[ - "Literal['amendment_start', 'automatic']" + Literal["amendment_start", "automatic"] ] """ For a point-in-time amendment, this attribute lets you set or update whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp. """ discount_actions: NotRequired[ - "List[SubscriptionSchedule.AmendParamsAmendmentDiscountAction]" + List["SubscriptionSchedule.AmendParamsAmendmentDiscountAction"] ] """ Changes to the coupons being redeemed or discounts being applied during the amendment time span. """ item_actions: NotRequired[ - "List[SubscriptionSchedule.AmendParamsAmendmentItemAction]" + List["SubscriptionSchedule.AmendParamsAmendmentItemAction"] ] """ Changes to the subscription items during the amendment time span. """ metadata_actions: NotRequired[ - "List[SubscriptionSchedule.AmendParamsAmendmentMetadataAction]" + List["SubscriptionSchedule.AmendParamsAmendmentMetadataAction"] ] """ Instructions for how to modify phase metadata """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`. @@ -619,7 +619,7 @@ class AmendParamsAmendment(TypedDict): Defines how to pause collection for the underlying subscription throughout the duration of the amendment. """ set_schedule_end: NotRequired[ - "Literal['amendment_end', 'amendment_start']" + Literal["amendment_end", "amendment_start"] ] """ Ends the subscription schedule early as dictated by either the accompanying amendment's start or end. @@ -644,7 +644,7 @@ class AmendParamsAmendmentAmendmentEnd(TypedDict): """ Time span for the amendment starting from the `amendment_start`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`. """ @@ -690,7 +690,7 @@ class AmendParamsAmendmentAmendmentStart(TypedDict): """ Use the `end` time of a given discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to start. """ @@ -745,11 +745,11 @@ class AmendParamsAmendmentDiscountAction(TypedDict): """ class AmendParamsAmendmentDiscountActionAdd(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to redeem. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount for a coupon that was already redeemed. """ @@ -759,11 +759,11 @@ class AmendParamsAmendmentDiscountActionAdd(TypedDict): """ Details to determine how long the discount should be applied for. """ - index: NotRequired["int"] + index: NotRequired[int] """ The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The promotion code to redeem. """ @@ -775,29 +775,29 @@ class AmendParamsAmendmentDiscountActionAddDiscountEnd(TypedDict): """ class AmendParamsAmendmentDiscountActionRemove(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to remove from the `discounts` array. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ The ID of a discount to remove from the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to remove from the `discounts` array. """ class AmendParamsAmendmentDiscountActionSet(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to replace the `discounts` array with. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount to replace the `discounts` array with. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ An ID of an existing promotion code to replace the `discounts` array with. """ @@ -828,12 +828,14 @@ class AmendParamsAmendmentItemAction(TypedDict): class AmendParamsAmendmentItemActionAdd(TypedDict): discounts: NotRequired[ - "List[SubscriptionSchedule.AmendParamsAmendmentItemActionAddDiscount]" + List[ + "SubscriptionSchedule.AmendParamsAmendmentItemActionAddDiscount" + ] ] """ The discounts applied to the item. Subscription item discounts are applied before subscription discounts. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -841,11 +843,11 @@ class AmendParamsAmendmentItemActionAdd(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. """ @@ -857,11 +859,11 @@ class AmendParamsAmendmentItemActionAdd(TypedDict): """ class AmendParamsAmendmentItemActionAddDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -871,7 +873,7 @@ class AmendParamsAmendmentItemActionAddDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -883,7 +885,7 @@ class AmendParamsAmendmentItemActionAddDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -905,7 +907,7 @@ class AmendParamsAmendmentItemActionAddDiscountDiscountEndDuration( """ class AmendParamsAmendmentItemActionAddTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -922,12 +924,14 @@ class AmendParamsAmendmentItemActionRemove(TypedDict): class AmendParamsAmendmentItemActionSet(TypedDict): discounts: NotRequired[ - "List[SubscriptionSchedule.AmendParamsAmendmentItemActionSetDiscount]" + List[ + "SubscriptionSchedule.AmendParamsAmendmentItemActionSetDiscount" + ] ] """ If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`. """ @@ -935,11 +939,11 @@ class AmendParamsAmendmentItemActionSet(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`. """ @@ -951,11 +955,11 @@ class AmendParamsAmendmentItemActionSet(TypedDict): """ class AmendParamsAmendmentItemActionSetDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -965,7 +969,7 @@ class AmendParamsAmendmentItemActionSetDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -977,7 +981,7 @@ class AmendParamsAmendmentItemActionSetDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -999,7 +1003,7 @@ class AmendParamsAmendmentItemActionSetDiscountDiscountEndDuration( """ class AmendParamsAmendmentItemActionSetTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -1009,11 +1013,11 @@ class AmendParamsAmendmentItemActionSetTrial(TypedDict): """ class AmendParamsAmendmentMetadataAction(TypedDict): - add: NotRequired["Dict[str, str]"] + add: NotRequired[Dict[str, str]] """ Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata. """ - remove: NotRequired["List[str]"] + remove: NotRequired[List[str]] """ Keys to remove from schedule phase metadata. """ @@ -1053,7 +1057,7 @@ class AmendParamsAmendmentTrialSettings(TypedDict): """ class AmendParamsAmendmentTrialSettingsEndBehavior(TypedDict): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ @@ -1071,11 +1075,11 @@ class AmendParamsPrebilling(TypedDict): """ The end of the prebilled time period. """ - invoice_at: NotRequired["Literal['now']"] + invoice_at: NotRequired[Literal["now"]] """ When the prebilling invoice should be created. The default value is `now`. """ - update_behavior: NotRequired["Literal['prebill', 'reset']"] + update_behavior: NotRequired[Literal["prebill", "reset"]] """ Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`. """ @@ -1087,7 +1091,7 @@ class AmendParamsPrebillingBillFrom(TypedDict): """ Start the prebilled period when a specified amendment begins. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ Start the prebilled period at a precise integer timestamp, starting from the Unix epoch. """ @@ -1115,7 +1119,7 @@ class AmendParamsPrebillingBillUntil(TypedDict): """ Time span for prebilling, starting from `bill_from`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ End the prebilled period at a precise integer timestamp, starting from the Unix epoch. """ @@ -1141,33 +1145,33 @@ class AmendParamsPrebillingBillUntilDuration(TypedDict): """ class AmendParamsScheduleSettings(TypedDict): - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. """ class CancelParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - invoice_now: NotRequired["bool"] + invoice_now: NotRequired[bool] """ If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`. """ - prorate: NotRequired["bool"] + prorate: NotRequired[bool] """ If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`. """ class CreateParams(RequestOptions): billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The identifier of the customer to create the subscription schedule for. """ @@ -1178,16 +1182,16 @@ class CreateParams(RequestOptions): Object representing the subscription schedule's default settings. """ end_behavior: NotRequired[ - "Literal['cancel', 'none', 'release', 'renew']" + Literal["cancel", "none", "release", "renew"] ] """ Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - from_subscription: NotRequired["str"] + from_subscription: NotRequired[str] """ Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. """ @@ -1195,7 +1199,7 @@ class CreateParams(RequestOptions): """ 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`. """ - phases: NotRequired["List[SubscriptionSchedule.CreateParamsPhase]"] + phases: NotRequired[List["SubscriptionSchedule.CreateParamsPhase"]] """ List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. """ @@ -1209,7 +1213,7 @@ class CreateParams(RequestOptions): """ class CreateParamsDefaultSettings(TypedDict): - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ @@ -1219,9 +1223,7 @@ class CreateParamsDefaultSettings(TypedDict): """ Default settings for automatic tax computation. """ - billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'phase_start']" - ] + billing_cycle_anchor: NotRequired[Literal["automatic", "phase_start"]] """ Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -1232,12 +1234,12 @@ class CreateParamsDefaultSettings(TypedDict): Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. """ @@ -1275,7 +1277,7 @@ class CreateParamsDefaultSettingsAutomaticTax(TypedDict): """ class CreateParamsDefaultSettingsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1285,11 +1287,11 @@ class CreateParamsDefaultSettingsAutomaticTaxLiability(TypedDict): """ class CreateParamsDefaultSettingsBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ @@ -1299,7 +1301,7 @@ class CreateParamsDefaultSettingsInvoiceSettings(TypedDict): """ The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`. """ @@ -1311,7 +1313,7 @@ class CreateParamsDefaultSettingsInvoiceSettings(TypedDict): """ class CreateParamsDefaultSettingsInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1321,7 +1323,7 @@ class CreateParamsDefaultSettingsInvoiceSettingsIssuer(TypedDict): """ class CreateParamsDefaultSettingsTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -1332,12 +1334,12 @@ class CreateParamsDefaultSettingsTransferData(TypedDict): class CreateParamsPhase(TypedDict): add_invoice_items: NotRequired[ - "List[SubscriptionSchedule.CreateParamsPhaseAddInvoiceItem]" + List["SubscriptionSchedule.CreateParamsPhaseAddInvoiceItem"] ] """ A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items. """ - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ @@ -1347,9 +1349,7 @@ class CreateParamsPhase(TypedDict): """ Automatic tax settings for this phase. """ - billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'phase_start']" - ] + billing_cycle_anchor: NotRequired[Literal["automatic", "phase_start"]] """ Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -1360,20 +1360,20 @@ class CreateParamsPhase(TypedDict): Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. """ @@ -1391,7 +1391,7 @@ class CreateParamsPhase(TypedDict): """ The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set. """ @@ -1405,15 +1405,15 @@ class CreateParamsPhase(TypedDict): """ List of configuration items, each with an attached price, to apply during this phase of the subscription schedule. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account on behalf of which to charge, for each of the associated subscription's invoices. """ @@ -1424,7 +1424,7 @@ class CreateParamsPhase(TypedDict): If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/billing/subscriptions/pause-payment). """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. @@ -1435,15 +1435,15 @@ class CreateParamsPhase(TypedDict): """ The data with which to automatically create a Transfer for each of the associated subscription's invoices. """ - trial: NotRequired["bool"] + trial: NotRequired[bool] """ If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. """ - trial_continuation: NotRequired["Literal['continue', 'none']"] + trial_continuation: NotRequired[Literal["continue", "none"]] """ Specify trial behavior when crossing phase boundaries """ - trial_end: NotRequired["int"] + trial_end: NotRequired[int] """ Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial` """ @@ -1456,12 +1456,14 @@ class CreateParamsPhase(TypedDict): class CreateParamsPhaseAddInvoiceItem(TypedDict): discounts: NotRequired[ - "List[SubscriptionSchedule.CreateParamsPhaseAddInvoiceItemDiscount]" + List[ + "SubscriptionSchedule.CreateParamsPhaseAddInvoiceItemDiscount" + ] ] """ The coupons to redeem into discounts for the item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -1471,7 +1473,7 @@ class CreateParamsPhaseAddInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. Defaults to 1. """ @@ -1481,11 +1483,11 @@ class CreateParamsPhaseAddInvoiceItem(TypedDict): """ class CreateParamsPhaseAddInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1495,7 +1497,7 @@ class CreateParamsPhaseAddInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1507,7 +1509,7 @@ class CreateParamsPhaseAddInvoiceItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1538,16 +1540,16 @@ class CreateParamsPhaseAddInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1565,7 +1567,7 @@ class CreateParamsPhaseAutomaticTax(TypedDict): """ class CreateParamsPhaseAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1575,21 +1577,21 @@ class CreateParamsPhaseAutomaticTaxLiability(TypedDict): """ class CreateParamsPhaseBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ class CreateParamsPhaseDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1599,7 +1601,7 @@ class CreateParamsPhaseDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1611,7 +1613,7 @@ class CreateParamsPhaseDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1635,7 +1637,7 @@ class CreateParamsPhaseInvoiceSettings(TypedDict): """ The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. """ @@ -1647,7 +1649,7 @@ class CreateParamsPhaseInvoiceSettings(TypedDict): """ class CreateParamsPhaseInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1669,15 +1671,15 @@ class CreateParamsPhaseItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The plan ID to subscribe to. You may specify the same ID in `plan` and `price`. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -1687,7 +1689,7 @@ class CreateParamsPhaseItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`. """ @@ -1707,11 +1709,11 @@ class CreateParamsPhaseItemBillingThresholds(TypedDict): """ class CreateParamsPhaseItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1721,7 +1723,7 @@ class CreateParamsPhaseItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1733,7 +1735,7 @@ class CreateParamsPhaseItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1766,16 +1768,16 @@ class CreateParamsPhaseItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1785,13 +1787,13 @@ class CreateParamsPhaseItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class CreateParamsPhaseItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -1807,7 +1809,7 @@ class CreateParamsPhasePauseCollection(TypedDict): """ class CreateParamsPhaseTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -1825,7 +1827,7 @@ class CreateParamsPhaseTrialSettings(TypedDict): """ class CreateParamsPhaseTrialSettingsEndBehavior(TypedDict): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ @@ -1835,7 +1837,7 @@ class CreateParamsPrebilling(TypedDict): """ This is used to determine the number of billing cycles to prebill. """ - update_behavior: NotRequired["Literal['prebill', 'reset']"] + update_behavior: NotRequired[Literal["prebill", "reset"]] """ Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`. """ @@ -1857,19 +1859,19 @@ class ListParams(RequestOptions): """ Only return subscription schedules that were created during the given date interval. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return subscription schedules for the given customer. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -1879,90 +1881,90 @@ class ListParams(RequestOptions): """ Only return subscription schedules that were released during the given date interval. """ - scheduled: NotRequired["bool"] + scheduled: NotRequired[bool] """ Only return subscription schedules that have not started yet. """ - starting_after: NotRequired["str"] + 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 ListParamsCanceledAt(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsCompletedAt(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsReleasedAt(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. @@ -1974,12 +1976,12 @@ class ModifyParams(RequestOptions): Object representing the subscription schedule's default settings. """ end_behavior: NotRequired[ - "Literal['cancel', 'none', 'release', 'renew']" + Literal["cancel", "none", "release", "renew"] ] """ Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1987,7 +1989,7 @@ class ModifyParams(RequestOptions): """ 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`. """ - phases: NotRequired["List[SubscriptionSchedule.ModifyParamsPhase]"] + phases: NotRequired[List["SubscriptionSchedule.ModifyParamsPhase"]] """ List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. """ @@ -1996,14 +1998,14 @@ class ModifyParams(RequestOptions): If specified, the invoicing for the given billing cycle iterations will be processed now. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`. """ class ModifyParamsDefaultSettings(TypedDict): - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ @@ -2013,9 +2015,7 @@ class ModifyParamsDefaultSettings(TypedDict): """ Default settings for automatic tax computation. """ - billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'phase_start']" - ] + billing_cycle_anchor: NotRequired[Literal["automatic", "phase_start"]] """ Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -2026,12 +2026,12 @@ class ModifyParamsDefaultSettings(TypedDict): Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. """ @@ -2069,7 +2069,7 @@ class ModifyParamsDefaultSettingsAutomaticTax(TypedDict): """ class ModifyParamsDefaultSettingsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -2079,11 +2079,11 @@ class ModifyParamsDefaultSettingsAutomaticTaxLiability(TypedDict): """ class ModifyParamsDefaultSettingsBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ @@ -2093,7 +2093,7 @@ class ModifyParamsDefaultSettingsInvoiceSettings(TypedDict): """ The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`. """ @@ -2105,7 +2105,7 @@ class ModifyParamsDefaultSettingsInvoiceSettings(TypedDict): """ class ModifyParamsDefaultSettingsInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -2115,7 +2115,7 @@ class ModifyParamsDefaultSettingsInvoiceSettingsIssuer(TypedDict): """ class ModifyParamsDefaultSettingsTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -2126,12 +2126,12 @@ class ModifyParamsDefaultSettingsTransferData(TypedDict): class ModifyParamsPhase(TypedDict): add_invoice_items: NotRequired[ - "List[SubscriptionSchedule.ModifyParamsPhaseAddInvoiceItem]" + List["SubscriptionSchedule.ModifyParamsPhaseAddInvoiceItem"] ] """ A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items. """ - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ @@ -2141,9 +2141,7 @@ class ModifyParamsPhase(TypedDict): """ Automatic tax settings for this phase. """ - billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'phase_start']" - ] + billing_cycle_anchor: NotRequired[Literal["automatic", "phase_start"]] """ Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -2154,20 +2152,20 @@ class ModifyParamsPhase(TypedDict): Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. """ @@ -2199,15 +2197,15 @@ class ModifyParamsPhase(TypedDict): """ List of configuration items, each with an attached price, to apply during this phase of the subscription schedule. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account on behalf of which to charge, for each of the associated subscription's invoices. """ @@ -2218,7 +2216,7 @@ class ModifyParamsPhase(TypedDict): If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/billing/subscriptions/pause-payment). """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. @@ -2233,11 +2231,11 @@ class ModifyParamsPhase(TypedDict): """ The data with which to automatically create a Transfer for each of the associated subscription's invoices. """ - trial: NotRequired["bool"] + trial: NotRequired[bool] """ If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. """ - trial_continuation: NotRequired["Literal['continue', 'none']"] + trial_continuation: NotRequired[Literal["continue", "none"]] """ Specify trial behavior when crossing phase boundaries """ @@ -2254,12 +2252,14 @@ class ModifyParamsPhase(TypedDict): class ModifyParamsPhaseAddInvoiceItem(TypedDict): discounts: NotRequired[ - "List[SubscriptionSchedule.ModifyParamsPhaseAddInvoiceItemDiscount]" + List[ + "SubscriptionSchedule.ModifyParamsPhaseAddInvoiceItemDiscount" + ] ] """ The coupons to redeem into discounts for the item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -2269,7 +2269,7 @@ class ModifyParamsPhaseAddInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. Defaults to 1. """ @@ -2279,11 +2279,11 @@ class ModifyParamsPhaseAddInvoiceItem(TypedDict): """ class ModifyParamsPhaseAddInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2293,7 +2293,7 @@ class ModifyParamsPhaseAddInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2305,7 +2305,7 @@ class ModifyParamsPhaseAddInvoiceItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2336,16 +2336,16 @@ class ModifyParamsPhaseAddInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -2363,7 +2363,7 @@ class ModifyParamsPhaseAutomaticTax(TypedDict): """ class ModifyParamsPhaseAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -2373,21 +2373,21 @@ class ModifyParamsPhaseAutomaticTaxLiability(TypedDict): """ class ModifyParamsPhaseBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ class ModifyParamsPhaseDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2397,7 +2397,7 @@ class ModifyParamsPhaseDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2409,7 +2409,7 @@ class ModifyParamsPhaseDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2433,7 +2433,7 @@ class ModifyParamsPhaseInvoiceSettings(TypedDict): """ The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. """ @@ -2445,7 +2445,7 @@ class ModifyParamsPhaseInvoiceSettings(TypedDict): """ class ModifyParamsPhaseInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -2467,15 +2467,15 @@ class ModifyParamsPhaseItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The plan ID to subscribe to. You may specify the same ID in `plan` and `price`. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -2485,7 +2485,7 @@ class ModifyParamsPhaseItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`. """ @@ -2505,11 +2505,11 @@ class ModifyParamsPhaseItemBillingThresholds(TypedDict): """ class ModifyParamsPhaseItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2519,7 +2519,7 @@ class ModifyParamsPhaseItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2531,7 +2531,7 @@ class ModifyParamsPhaseItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2564,16 +2564,16 @@ class ModifyParamsPhaseItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -2583,13 +2583,13 @@ class ModifyParamsPhaseItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class ModifyParamsPhaseItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -2605,7 +2605,7 @@ class ModifyParamsPhasePauseCollection(TypedDict): """ class ModifyParamsPhaseTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -2623,7 +2623,7 @@ class ModifyParamsPhaseTrialSettings(TypedDict): """ class ModifyParamsPhaseTrialSettingsEndBehavior(TypedDict): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ @@ -2633,23 +2633,23 @@ class ModifyParamsPrebilling(TypedDict): """ This is used to determine the number of billing cycles to prebill. """ - update_behavior: NotRequired["Literal['prebill', 'reset']"] + update_behavior: NotRequired[Literal["prebill", "reset"]] """ Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`. """ class ReleaseParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - preserve_cancel_date: NotRequired["bool"] + preserve_cancel_date: NotRequired[bool] """ Keep any cancellation on the subscription that the schedule has set """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_subscription_schedule_service.py b/stripe/_subscription_schedule_service.py index 7538caa3d..575c92144 100644 --- a/stripe/_subscription_schedule_service.py +++ b/stripe/_subscription_schedule_service.py @@ -12,12 +12,12 @@ class SubscriptionScheduleService(StripeService): class AmendParams(TypedDict): amendments: NotRequired[ - "List[SubscriptionScheduleService.AmendParamsAmendment]" + List["SubscriptionScheduleService.AmendParamsAmendment"] ] """ Changes to apply to the phases of the subscription schedule, in the order provided. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -28,7 +28,7 @@ class AmendParams(TypedDict): Provide any time periods to bill in advance. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ In cases where the amendment changes the currently active phase, @@ -53,31 +53,35 @@ class AmendParamsAmendment(TypedDict): Details to identify the earliest timestamp where the proposed change should take effect. """ billing_cycle_anchor: NotRequired[ - "Literal['amendment_start', 'automatic']" + Literal["amendment_start", "automatic"] ] """ For a point-in-time amendment, this attribute lets you set or update whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp. """ discount_actions: NotRequired[ - "List[SubscriptionScheduleService.AmendParamsAmendmentDiscountAction]" + List[ + "SubscriptionScheduleService.AmendParamsAmendmentDiscountAction" + ] ] """ Changes to the coupons being redeemed or discounts being applied during the amendment time span. """ item_actions: NotRequired[ - "List[SubscriptionScheduleService.AmendParamsAmendmentItemAction]" + List["SubscriptionScheduleService.AmendParamsAmendmentItemAction"] ] """ Changes to the subscription items during the amendment time span. """ metadata_actions: NotRequired[ - "List[SubscriptionScheduleService.AmendParamsAmendmentMetadataAction]" + List[ + "SubscriptionScheduleService.AmendParamsAmendmentMetadataAction" + ] ] """ Instructions for how to modify phase metadata """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`. @@ -89,7 +93,7 @@ class AmendParamsAmendment(TypedDict): Defines how to pause collection for the underlying subscription throughout the duration of the amendment. """ set_schedule_end: NotRequired[ - "Literal['amendment_end', 'amendment_start']" + Literal["amendment_end", "amendment_start"] ] """ Ends the subscription schedule early as dictated by either the accompanying amendment's start or end. @@ -114,7 +118,7 @@ class AmendParamsAmendmentAmendmentEnd(TypedDict): """ Time span for the amendment starting from the `amendment_start`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`. """ @@ -160,7 +164,7 @@ class AmendParamsAmendmentAmendmentStart(TypedDict): """ Use the `end` time of a given discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the amendment to start. """ @@ -215,11 +219,11 @@ class AmendParamsAmendmentDiscountAction(TypedDict): """ class AmendParamsAmendmentDiscountActionAdd(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to redeem. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount for a coupon that was already redeemed. """ @@ -229,11 +233,11 @@ class AmendParamsAmendmentDiscountActionAdd(TypedDict): """ Details to determine how long the discount should be applied for. """ - index: NotRequired["int"] + index: NotRequired[int] """ The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The promotion code to redeem. """ @@ -245,29 +249,29 @@ class AmendParamsAmendmentDiscountActionAddDiscountEnd(TypedDict): """ class AmendParamsAmendmentDiscountActionRemove(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to remove from the `discounts` array. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ The ID of a discount to remove from the `discounts` array. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to remove from the `discounts` array. """ class AmendParamsAmendmentDiscountActionSet(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The coupon code to replace the `discounts` array with. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ An ID of an existing discount to replace the `discounts` array with. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ An ID of an existing promotion code to replace the `discounts` array with. """ @@ -298,12 +302,14 @@ class AmendParamsAmendmentItemAction(TypedDict): class AmendParamsAmendmentItemActionAdd(TypedDict): discounts: NotRequired[ - "List[SubscriptionScheduleService.AmendParamsAmendmentItemActionAddDiscount]" + List[ + "SubscriptionScheduleService.AmendParamsAmendmentItemActionAddDiscount" + ] ] """ The discounts applied to the item. Subscription item discounts are applied before subscription discounts. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -311,11 +317,11 @@ class AmendParamsAmendmentItemActionAdd(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. """ @@ -327,11 +333,11 @@ class AmendParamsAmendmentItemActionAdd(TypedDict): """ class AmendParamsAmendmentItemActionAddDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -341,7 +347,7 @@ class AmendParamsAmendmentItemActionAddDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -353,7 +359,7 @@ class AmendParamsAmendmentItemActionAddDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -375,7 +381,7 @@ class AmendParamsAmendmentItemActionAddDiscountDiscountEndDuration( """ class AmendParamsAmendmentItemActionAddTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -392,12 +398,14 @@ class AmendParamsAmendmentItemActionRemove(TypedDict): class AmendParamsAmendmentItemActionSet(TypedDict): discounts: NotRequired[ - "List[SubscriptionScheduleService.AmendParamsAmendmentItemActionSetDiscount]" + List[ + "SubscriptionScheduleService.AmendParamsAmendmentItemActionSetDiscount" + ] ] """ If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`. """ @@ -405,11 +413,11 @@ class AmendParamsAmendmentItemActionSet(TypedDict): """ The ID of the price object. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`. """ @@ -421,11 +429,11 @@ class AmendParamsAmendmentItemActionSet(TypedDict): """ class AmendParamsAmendmentItemActionSetDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -435,7 +443,7 @@ class AmendParamsAmendmentItemActionSetDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -447,7 +455,7 @@ class AmendParamsAmendmentItemActionSetDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -469,7 +477,7 @@ class AmendParamsAmendmentItemActionSetDiscountDiscountEndDuration( """ class AmendParamsAmendmentItemActionSetTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -479,11 +487,11 @@ class AmendParamsAmendmentItemActionSetTrial(TypedDict): """ class AmendParamsAmendmentMetadataAction(TypedDict): - add: NotRequired["Dict[str, str]"] + add: NotRequired[Dict[str, str]] """ Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata. """ - remove: NotRequired["List[str]"] + remove: NotRequired[List[str]] """ Keys to remove from schedule phase metadata. """ @@ -523,7 +531,7 @@ class AmendParamsAmendmentTrialSettings(TypedDict): """ class AmendParamsAmendmentTrialSettingsEndBehavior(TypedDict): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ @@ -541,11 +549,11 @@ class AmendParamsPrebilling(TypedDict): """ The end of the prebilled time period. """ - invoice_at: NotRequired["Literal['now']"] + invoice_at: NotRequired[Literal["now"]] """ When the prebilling invoice should be created. The default value is `now`. """ - update_behavior: NotRequired["Literal['prebill', 'reset']"] + update_behavior: NotRequired[Literal["prebill", "reset"]] """ Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`. """ @@ -557,7 +565,7 @@ class AmendParamsPrebillingBillFrom(TypedDict): """ Start the prebilled period when a specified amendment begins. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ Start the prebilled period at a precise integer timestamp, starting from the Unix epoch. """ @@ -585,7 +593,7 @@ class AmendParamsPrebillingBillUntil(TypedDict): """ Time span for prebilling, starting from `bill_from`. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ End the prebilled period at a precise integer timestamp, starting from the Unix epoch. """ @@ -611,33 +619,33 @@ class AmendParamsPrebillingBillUntilDuration(TypedDict): """ class AmendParamsScheduleSettings(TypedDict): - end_behavior: NotRequired["Literal['cancel', 'release']"] + end_behavior: NotRequired[Literal["cancel", "release"]] """ Behavior of the subscription schedule and underlying subscription when it ends. """ class CancelParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - invoice_now: NotRequired["bool"] + invoice_now: NotRequired[bool] """ If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`. """ - prorate: NotRequired["bool"] + prorate: NotRequired[bool] """ If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`. """ class CreateParams(TypedDict): billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The identifier of the customer to create the subscription schedule for. """ @@ -648,16 +656,16 @@ class CreateParams(TypedDict): Object representing the subscription schedule's default settings. """ end_behavior: NotRequired[ - "Literal['cancel', 'none', 'release', 'renew']" + Literal["cancel", "none", "release", "renew"] ] """ Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - from_subscription: NotRequired["str"] + from_subscription: NotRequired[str] """ Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. """ @@ -666,7 +674,7 @@ class CreateParams(TypedDict): 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`. """ phases: NotRequired[ - "List[SubscriptionScheduleService.CreateParamsPhase]" + List["SubscriptionScheduleService.CreateParamsPhase"] ] """ List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. @@ -683,7 +691,7 @@ class CreateParams(TypedDict): """ class CreateParamsDefaultSettings(TypedDict): - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ @@ -693,9 +701,7 @@ class CreateParamsDefaultSettings(TypedDict): """ Default settings for automatic tax computation. """ - billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'phase_start']" - ] + billing_cycle_anchor: NotRequired[Literal["automatic", "phase_start"]] """ Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -706,12 +712,12 @@ class CreateParamsDefaultSettings(TypedDict): Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. """ @@ -749,7 +755,7 @@ class CreateParamsDefaultSettingsAutomaticTax(TypedDict): """ class CreateParamsDefaultSettingsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -759,11 +765,11 @@ class CreateParamsDefaultSettingsAutomaticTaxLiability(TypedDict): """ class CreateParamsDefaultSettingsBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ @@ -773,7 +779,7 @@ class CreateParamsDefaultSettingsInvoiceSettings(TypedDict): """ The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`. """ @@ -785,7 +791,7 @@ class CreateParamsDefaultSettingsInvoiceSettings(TypedDict): """ class CreateParamsDefaultSettingsInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -795,7 +801,7 @@ class CreateParamsDefaultSettingsInvoiceSettingsIssuer(TypedDict): """ class CreateParamsDefaultSettingsTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -806,12 +812,12 @@ class CreateParamsDefaultSettingsTransferData(TypedDict): class CreateParamsPhase(TypedDict): add_invoice_items: NotRequired[ - "List[SubscriptionScheduleService.CreateParamsPhaseAddInvoiceItem]" + List["SubscriptionScheduleService.CreateParamsPhaseAddInvoiceItem"] ] """ A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items. """ - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ @@ -821,9 +827,7 @@ class CreateParamsPhase(TypedDict): """ Automatic tax settings for this phase. """ - billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'phase_start']" - ] + billing_cycle_anchor: NotRequired[Literal["automatic", "phase_start"]] """ Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -834,20 +838,20 @@ class CreateParamsPhase(TypedDict): Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. """ @@ -865,7 +869,7 @@ class CreateParamsPhase(TypedDict): """ The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts. """ - end_date: NotRequired["int"] + end_date: NotRequired[int] """ The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set. """ @@ -879,15 +883,15 @@ class CreateParamsPhase(TypedDict): """ List of configuration items, each with an attached price, to apply during this phase of the subscription schedule. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account on behalf of which to charge, for each of the associated subscription's invoices. """ @@ -898,7 +902,7 @@ class CreateParamsPhase(TypedDict): If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/billing/subscriptions/pause-payment). """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. @@ -909,15 +913,15 @@ class CreateParamsPhase(TypedDict): """ The data with which to automatically create a Transfer for each of the associated subscription's invoices. """ - trial: NotRequired["bool"] + trial: NotRequired[bool] """ If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. """ - trial_continuation: NotRequired["Literal['continue', 'none']"] + trial_continuation: NotRequired[Literal["continue", "none"]] """ Specify trial behavior when crossing phase boundaries """ - trial_end: NotRequired["int"] + trial_end: NotRequired[int] """ Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial` """ @@ -930,12 +934,14 @@ class CreateParamsPhase(TypedDict): class CreateParamsPhaseAddInvoiceItem(TypedDict): discounts: NotRequired[ - "List[SubscriptionScheduleService.CreateParamsPhaseAddInvoiceItemDiscount]" + List[ + "SubscriptionScheduleService.CreateParamsPhaseAddInvoiceItemDiscount" + ] ] """ The coupons to redeem into discounts for the item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -945,7 +951,7 @@ class CreateParamsPhaseAddInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. Defaults to 1. """ @@ -955,11 +961,11 @@ class CreateParamsPhaseAddInvoiceItem(TypedDict): """ class CreateParamsPhaseAddInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -969,7 +975,7 @@ class CreateParamsPhaseAddInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -981,7 +987,7 @@ class CreateParamsPhaseAddInvoiceItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1012,16 +1018,16 @@ class CreateParamsPhaseAddInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1039,7 +1045,7 @@ class CreateParamsPhaseAutomaticTax(TypedDict): """ class CreateParamsPhaseAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1049,21 +1055,21 @@ class CreateParamsPhaseAutomaticTaxLiability(TypedDict): """ class CreateParamsPhaseBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ class CreateParamsPhaseDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1073,7 +1079,7 @@ class CreateParamsPhaseDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1085,7 +1091,7 @@ class CreateParamsPhaseDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1109,7 +1115,7 @@ class CreateParamsPhaseInvoiceSettings(TypedDict): """ The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. """ @@ -1121,7 +1127,7 @@ class CreateParamsPhaseInvoiceSettings(TypedDict): """ class CreateParamsPhaseInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1143,15 +1149,15 @@ class CreateParamsPhaseItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The plan ID to subscribe to. You may specify the same ID in `plan` and `price`. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -1161,7 +1167,7 @@ class CreateParamsPhaseItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`. """ @@ -1183,11 +1189,11 @@ class CreateParamsPhaseItemBillingThresholds(TypedDict): """ class CreateParamsPhaseItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1197,7 +1203,7 @@ class CreateParamsPhaseItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1209,7 +1215,7 @@ class CreateParamsPhaseItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1242,16 +1248,16 @@ class CreateParamsPhaseItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1261,13 +1267,13 @@ class CreateParamsPhaseItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class CreateParamsPhaseItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -1283,7 +1289,7 @@ class CreateParamsPhasePauseCollection(TypedDict): """ class CreateParamsPhaseTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -1301,7 +1307,7 @@ class CreateParamsPhaseTrialSettings(TypedDict): """ class CreateParamsPhaseTrialSettingsEndBehavior(TypedDict): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ @@ -1311,7 +1317,7 @@ class CreateParamsPrebilling(TypedDict): """ This is used to determine the number of billing cycles to prebill. """ - update_behavior: NotRequired["Literal['prebill', 'reset']"] + update_behavior: NotRequired[Literal["prebill", "reset"]] """ Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`. """ @@ -1335,19 +1341,19 @@ class ListParams(TypedDict): """ Only return subscription schedules that were created during the given date interval. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return subscription schedules for the given customer. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -1357,106 +1363,106 @@ class ListParams(TypedDict): """ Only return subscription schedules that were released during the given date interval. """ - scheduled: NotRequired["bool"] + scheduled: NotRequired[bool] """ Only return subscription schedules that have not started yet. """ - starting_after: NotRequired["str"] + 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 ListParamsCanceledAt(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsCompletedAt(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsReleasedAt(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ReleaseParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - preserve_cancel_date: NotRequired["bool"] + preserve_cancel_date: NotRequired[bool] """ Keep any cancellation on the subscription that the schedule has set """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): billing_behavior: NotRequired[ - "Literal['prorate_on_next_phase', 'prorate_up_front']" + Literal["prorate_on_next_phase", "prorate_up_front"] ] """ Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front. @@ -1468,12 +1474,12 @@ class UpdateParams(TypedDict): Object representing the subscription schedule's default settings. """ end_behavior: NotRequired[ - "Literal['cancel', 'none', 'release', 'renew']" + Literal["cancel", "none", "release", "renew"] ] """ Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1482,7 +1488,7 @@ class UpdateParams(TypedDict): 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`. """ phases: NotRequired[ - "List[SubscriptionScheduleService.UpdateParamsPhase]" + List["SubscriptionScheduleService.UpdateParamsPhase"] ] """ List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. @@ -1494,14 +1500,14 @@ class UpdateParams(TypedDict): If specified, the invoicing for the given billing cycle iterations will be processed now. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`. """ class UpdateParamsDefaultSettings(TypedDict): - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ @@ -1511,9 +1517,7 @@ class UpdateParamsDefaultSettings(TypedDict): """ Default settings for automatic tax computation. """ - billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'phase_start']" - ] + billing_cycle_anchor: NotRequired[Literal["automatic", "phase_start"]] """ Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -1524,12 +1528,12 @@ class UpdateParamsDefaultSettings(TypedDict): Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. """ @@ -1567,7 +1571,7 @@ class UpdateParamsDefaultSettingsAutomaticTax(TypedDict): """ class UpdateParamsDefaultSettingsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1577,11 +1581,11 @@ class UpdateParamsDefaultSettingsAutomaticTaxLiability(TypedDict): """ class UpdateParamsDefaultSettingsBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ @@ -1591,7 +1595,7 @@ class UpdateParamsDefaultSettingsInvoiceSettings(TypedDict): """ The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`. """ @@ -1603,7 +1607,7 @@ class UpdateParamsDefaultSettingsInvoiceSettings(TypedDict): """ class UpdateParamsDefaultSettingsInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1613,7 +1617,7 @@ class UpdateParamsDefaultSettingsInvoiceSettingsIssuer(TypedDict): """ class UpdateParamsDefaultSettingsTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -1624,12 +1628,12 @@ class UpdateParamsDefaultSettingsTransferData(TypedDict): class UpdateParamsPhase(TypedDict): add_invoice_items: NotRequired[ - "List[SubscriptionScheduleService.UpdateParamsPhaseAddInvoiceItem]" + List["SubscriptionScheduleService.UpdateParamsPhaseAddInvoiceItem"] ] """ A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items. """ - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ @@ -1639,9 +1643,7 @@ class UpdateParamsPhase(TypedDict): """ Automatic tax settings for this phase. """ - billing_cycle_anchor: NotRequired[ - "Literal['automatic', 'phase_start']" - ] + billing_cycle_anchor: NotRequired[Literal["automatic", "phase_start"]] """ Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -1652,20 +1654,20 @@ class UpdateParamsPhase(TypedDict): Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. """ @@ -1697,15 +1699,15 @@ class UpdateParamsPhase(TypedDict): """ List of configuration items, each with an attached price, to apply during this phase of the subscription schedule. """ - iterations: NotRequired["int"] + iterations: NotRequired[int] """ Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account on behalf of which to charge, for each of the associated subscription's invoices. """ @@ -1716,7 +1718,7 @@ class UpdateParamsPhase(TypedDict): If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/billing/subscriptions/pause-payment). """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. @@ -1731,11 +1733,11 @@ class UpdateParamsPhase(TypedDict): """ The data with which to automatically create a Transfer for each of the associated subscription's invoices. """ - trial: NotRequired["bool"] + trial: NotRequired[bool] """ If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. """ - trial_continuation: NotRequired["Literal['continue', 'none']"] + trial_continuation: NotRequired[Literal["continue", "none"]] """ Specify trial behavior when crossing phase boundaries """ @@ -1752,12 +1754,14 @@ class UpdateParamsPhase(TypedDict): class UpdateParamsPhaseAddInvoiceItem(TypedDict): discounts: NotRequired[ - "List[SubscriptionScheduleService.UpdateParamsPhaseAddInvoiceItemDiscount]" + List[ + "SubscriptionScheduleService.UpdateParamsPhaseAddInvoiceItemDiscount" + ] ] """ The coupons to redeem into discounts for the item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -1767,7 +1771,7 @@ class UpdateParamsPhaseAddInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. Defaults to 1. """ @@ -1777,11 +1781,11 @@ class UpdateParamsPhaseAddInvoiceItem(TypedDict): """ class UpdateParamsPhaseAddInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1791,7 +1795,7 @@ class UpdateParamsPhaseAddInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1803,7 +1807,7 @@ class UpdateParamsPhaseAddInvoiceItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1834,16 +1838,16 @@ class UpdateParamsPhaseAddInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1861,7 +1865,7 @@ class UpdateParamsPhaseAutomaticTax(TypedDict): """ class UpdateParamsPhaseAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1871,21 +1875,21 @@ class UpdateParamsPhaseAutomaticTaxLiability(TypedDict): """ class UpdateParamsPhaseBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ class UpdateParamsPhaseDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1895,7 +1899,7 @@ class UpdateParamsPhaseDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1907,7 +1911,7 @@ class UpdateParamsPhaseDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1931,7 +1935,7 @@ class UpdateParamsPhaseInvoiceSettings(TypedDict): """ The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. """ @@ -1943,7 +1947,7 @@ class UpdateParamsPhaseInvoiceSettings(TypedDict): """ class UpdateParamsPhaseInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1965,15 +1969,15 @@ class UpdateParamsPhaseItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The plan ID to subscribe to. You may specify the same ID in `plan` and `price`. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -1983,7 +1987,7 @@ class UpdateParamsPhaseItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`. """ @@ -2005,11 +2009,11 @@ class UpdateParamsPhaseItemBillingThresholds(TypedDict): """ class UpdateParamsPhaseItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -2019,7 +2023,7 @@ class UpdateParamsPhaseItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -2031,7 +2035,7 @@ class UpdateParamsPhaseItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -2064,16 +2068,16 @@ class UpdateParamsPhaseItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -2083,13 +2087,13 @@ class UpdateParamsPhaseItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class UpdateParamsPhaseItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -2105,7 +2109,7 @@ class UpdateParamsPhasePauseCollection(TypedDict): """ class UpdateParamsPhaseTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -2123,7 +2127,7 @@ class UpdateParamsPhaseTrialSettings(TypedDict): """ class UpdateParamsPhaseTrialSettingsEndBehavior(TypedDict): - prorate_up_front: NotRequired["Literal['defer', 'include']"] + prorate_up_front: NotRequired[Literal["defer", "include"]] """ Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`. """ @@ -2133,7 +2137,7 @@ class UpdateParamsPrebilling(TypedDict): """ This is used to determine the number of billing cycles to prebill. """ - update_behavior: NotRequired["Literal['prebill', 'reset']"] + update_behavior: NotRequired[Literal["prebill", "reset"]] """ Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`. """ diff --git a/stripe/_subscription_service.py b/stripe/_subscription_service.py index b55d775c1..6aee9b9ff 100644 --- a/stripe/_subscription_service.py +++ b/stripe/_subscription_service.py @@ -19,15 +19,15 @@ class CancelParams(TypedDict): """ Details about why this subscription was cancelled """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - invoice_now: NotRequired["bool"] + invoice_now: NotRequired[bool] """ Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. """ - prorate: NotRequired["bool"] + prorate: NotRequired[bool] """ Will generate a proration invoice item that credits remaining unused time until the subscription period end. """ @@ -46,7 +46,7 @@ class CancelParamsCancellationDetails(TypedDict): class CreateParams(TypedDict): add_invoice_items: NotRequired[ - "List[SubscriptionService.CreateParamsAddInvoiceItem]" + List["SubscriptionService.CreateParamsAddInvoiceItem"] ] """ A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items. @@ -61,11 +61,11 @@ class CreateParams(TypedDict): """ Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed. """ - backdate_start_date: NotRequired["int"] + backdate_start_date: NotRequired[int] """ For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. """ - billing_cycle_anchor: NotRequired["int"] + billing_cycle_anchor: NotRequired[int] """ A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. """ @@ -81,25 +81,25 @@ class CreateParams(TypedDict): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. """ - cancel_at: NotRequired["int"] + cancel_at: NotRequired[int] """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. """ - cancel_at_period_end: NotRequired["bool"] + cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ @@ -107,15 +107,15 @@ class CreateParams(TypedDict): """ The identifier of the customer to subscribe. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). """ - default_source: NotRequired["str"] + default_source: NotRequired[str] """ ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). """ @@ -123,7 +123,7 @@ class CreateParams(TypedDict): """ The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. """ - description: NotRequired["str"] + description: NotRequired[str] """ The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. """ @@ -133,7 +133,7 @@ class CreateParams(TypedDict): """ The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -143,7 +143,7 @@ class CreateParams(TypedDict): """ All invoices will be billed using the specified settings. """ - items: NotRequired["List[SubscriptionService.CreateParamsItem]"] + items: NotRequired[List["SubscriptionService.CreateParamsItem"]] """ A list of up to 20 subscription items, each with an attached price. """ @@ -151,7 +151,7 @@ class CreateParams(TypedDict): """ 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`. """ - off_session: NotRequired["bool"] + off_session: NotRequired[bool] """ Indicates if a customer is on or off-session while an invoice payment is attempted. """ @@ -160,7 +160,12 @@ class CreateParams(TypedDict): The account on behalf of which to charge, for each of the subscription's invoices. """ payment_behavior: NotRequired[ - "Literal['allow_incomplete', 'default_incomplete', 'error_if_incomplete', 'pending_if_incomplete']" + Literal[ + "allow_incomplete", + "default_incomplete", + "error_if_incomplete", + "pending_if_incomplete", + ] ] """ Only applies to subscriptions with `collection_method=charge_automatically`. @@ -191,12 +196,12 @@ class CreateParams(TypedDict): """ If specified, the invoicing for the given billing cycle iterations will be processed now. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. @@ -211,11 +216,11 @@ class CreateParams(TypedDict): """ Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. """ - trial_from_plan: NotRequired["bool"] + trial_from_plan: NotRequired[bool] """ Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. """ - trial_period_days: NotRequired["int"] + trial_period_days: NotRequired[int] """ Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. """ @@ -228,12 +233,12 @@ class CreateParams(TypedDict): class CreateParamsAddInvoiceItem(TypedDict): discounts: NotRequired[ - "List[SubscriptionService.CreateParamsAddInvoiceItemDiscount]" + List["SubscriptionService.CreateParamsAddInvoiceItemDiscount"] ] """ The coupons to redeem into discounts for the item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -243,7 +248,7 @@ class CreateParamsAddInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. Defaults to 1. """ @@ -253,11 +258,11 @@ class CreateParamsAddInvoiceItem(TypedDict): """ class CreateParamsAddInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -267,7 +272,7 @@ class CreateParamsAddInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -279,7 +284,7 @@ class CreateParamsAddInvoiceItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -308,16 +313,16 @@ class CreateParamsAddInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -335,7 +340,7 @@ class CreateParamsAutomaticTax(TypedDict): """ class CreateParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -349,39 +354,39 @@ class CreateParamsBillingCycleAnchorConfig(TypedDict): """ The day of the month the billing_cycle_anchor should be. Ranges from 1 to 31. """ - hour: NotRequired["int"] + hour: NotRequired[int] """ The hour of the day the billing_cycle_anchor should be. Ranges from 0 to 23. """ - minute: NotRequired["int"] + minute: NotRequired[int] """ The minute of the hour the billing_cycle_anchor should be. Ranges from 0 to 59. """ - month: NotRequired["int"] + month: NotRequired[int] """ The month to start full cycle billing periods. Ranges from 1 to 12. """ - second: NotRequired["int"] + second: NotRequired[int] """ The second of the minute the billing_cycle_anchor should be. Ranges from 0 to 59. """ class CreateParamsBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ class CreateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -391,7 +396,7 @@ class CreateParamsDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -403,7 +408,7 @@ class CreateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -435,7 +440,7 @@ class CreateParamsInvoiceSettings(TypedDict): """ class CreateParamsInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -457,15 +462,15 @@ class CreateParamsItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -475,7 +480,7 @@ class CreateParamsItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -495,11 +500,11 @@ class CreateParamsItemBillingThresholds(TypedDict): """ class CreateParamsItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -509,7 +514,7 @@ class CreateParamsItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -521,7 +526,7 @@ class CreateParamsItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -554,16 +559,16 @@ class CreateParamsItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -573,13 +578,13 @@ class CreateParamsItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class CreateParamsItemTrial(TypedDict): - converts_to: NotRequired["List[str]"] + converts_to: NotRequired[List[str]] """ List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. """ @@ -602,7 +607,7 @@ class CreateParamsPaymentSettings(TypedDict): The list of payment method types (e.g. card) to provide to the invoice's PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice's default payment method, the subscription's default payment method, the customer's default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). """ save_default_payment_method: NotRequired[ - "Literal['off', 'on_subscription']" + Literal["off", "on_subscription"] ] """ Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds. @@ -660,7 +665,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -669,13 +674,13 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): class CreateParamsPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions( TypedDict, ): - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ class CreateParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -688,13 +693,25 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): Configuration options for setting up an eMandate for cards issued in India. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. @@ -703,15 +720,15 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): class CreateParamsPaymentSettingsPaymentMethodOptionsCardMandateOptions( TypedDict, ): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount to be charged for future payments. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ @@ -725,7 +742,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalance( """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["str"] + funding_type: NotRequired[str] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ @@ -739,7 +756,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer """ Configuration for eu_bank_transfer funding type. """ - type: NotRequired["str"] + type: NotRequired[str] """ The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. """ @@ -768,7 +785,7 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccount( Additional fields for Financial Connections Session creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -778,13 +795,24 @@ class CreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConne TypedDict, ): permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. @@ -795,7 +823,7 @@ class CreateParamsPendingInvoiceItemInterval(TypedDict): """ Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). """ @@ -805,13 +833,13 @@ class CreateParamsPrebilling(TypedDict): """ This is used to determine the number of billing cycles to prebill. """ - update_behavior: NotRequired["Literal['prebill', 'reset']"] + update_behavior: NotRequired[Literal["prebill", "reset"]] """ Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`. """ class CreateParamsTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -843,7 +871,7 @@ class ListParams(TypedDict): Filter subscriptions by their automatic tax settings. """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`. @@ -858,41 +886,52 @@ class ListParams(TypedDict): current_period_start: NotRequired[ "SubscriptionService.ListParamsCurrentPeriodStart|int" ] - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of the customer whose subscriptions will be retrieved. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ The ID of the plan whose subscriptions will be retrieved. """ - price: NotRequired["str"] + price: NotRequired[str] """ Filter for subscriptions that contain this recurring price ID. """ - starting_after: NotRequired["str"] + 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. """ status: NotRequired[ - "Literal['active', 'all', 'canceled', 'ended', 'incomplete', 'incomplete_expired', 'past_due', 'paused', 'trialing', 'unpaid']" + Literal[ + "active", + "all", + "canceled", + "ended", + "incomplete", + "incomplete_expired", + "past_due", + "paused", + "trialing", + "unpaid", + ] ] """ The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned. """ - test_clock: NotRequired["str"] + test_clock: NotRequired[str] """ Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set. """ @@ -904,95 +943,95 @@ class ListParamsAutomaticTax(TypedDict): """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsCurrentPeriodEnd(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsCurrentPeriodStart(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ResumeParams(TypedDict): - billing_cycle_anchor: NotRequired["Literal['now', 'unchanged']"] + billing_cycle_anchor: NotRequired[Literal["now", "unchanged"]] """ Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). Setting the value to `unchanged` advances the subscription's billing cycle anchor to the period that surrounds the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SearchParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - page: NotRequired["str"] + page: NotRequired[str] """ A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. """ @@ -1003,7 +1042,7 @@ class SearchParams(TypedDict): class UpdateParams(TypedDict): add_invoice_items: NotRequired[ - "List[SubscriptionService.UpdateParamsAddInvoiceItem]" + List["SubscriptionService.UpdateParamsAddInvoiceItem"] ] """ A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items. @@ -1018,7 +1057,7 @@ class UpdateParams(TypedDict): """ Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed. """ - billing_cycle_anchor: NotRequired["Literal['now', 'unchanged']"] + billing_cycle_anchor: NotRequired[Literal["now", "unchanged"]] """ Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). """ @@ -1032,7 +1071,7 @@ class UpdateParams(TypedDict): """ A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. """ - cancel_at_period_end: NotRequired["bool"] + cancel_at_period_end: NotRequired[bool] """ Boolean indicating whether this subscription should cancel at the end of the current period. """ @@ -1043,20 +1082,20 @@ class UpdateParams(TypedDict): Details about why this subscription was cancelled """ collection_method: NotRequired[ - "Literal['charge_automatically', 'send_invoice']" + Literal["charge_automatically", "send_invoice"] ] """ Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. """ - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. """ - days_until_due: NotRequired["int"] + days_until_due: NotRequired[int] """ Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. """ - default_payment_method: NotRequired["str"] + default_payment_method: NotRequired[str] """ ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). """ @@ -1078,7 +1117,7 @@ class UpdateParams(TypedDict): """ The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1088,7 +1127,7 @@ class UpdateParams(TypedDict): """ All invoices will be billed using the specified settings. """ - items: NotRequired["List[SubscriptionService.UpdateParamsItem]"] + items: NotRequired[List["SubscriptionService.UpdateParamsItem"]] """ A list of up to 20 subscription items, each with an attached price. """ @@ -1096,7 +1135,7 @@ class UpdateParams(TypedDict): """ 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`. """ - off_session: NotRequired["bool"] + off_session: NotRequired[bool] """ Indicates if a customer is on or off-session while an invoice payment is attempted. """ @@ -1111,7 +1150,12 @@ class UpdateParams(TypedDict): If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/billing/subscriptions/pause-payment). """ payment_behavior: NotRequired[ - "Literal['allow_incomplete', 'default_incomplete', 'error_if_incomplete', 'pending_if_incomplete']" + Literal[ + "allow_incomplete", + "default_incomplete", + "error_if_incomplete", + "pending_if_incomplete", + ] ] """ Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -1138,17 +1182,17 @@ class UpdateParams(TypedDict): """ If specified, the invoicing for the given billing cycle iterations will be processed now. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. """ - proration_date: NotRequired["int"] + proration_date: NotRequired[int] """ If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. """ @@ -1162,7 +1206,7 @@ class UpdateParams(TypedDict): """ Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. """ - trial_from_plan: NotRequired["bool"] + trial_from_plan: NotRequired[bool] """ Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. """ @@ -1175,12 +1219,12 @@ class UpdateParams(TypedDict): class UpdateParamsAddInvoiceItem(TypedDict): discounts: NotRequired[ - "List[SubscriptionService.UpdateParamsAddInvoiceItemDiscount]" + List["SubscriptionService.UpdateParamsAddInvoiceItemDiscount"] ] """ The coupons to redeem into discounts for the item. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. """ @@ -1190,7 +1234,7 @@ class UpdateParamsAddInvoiceItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. Defaults to 1. """ @@ -1200,11 +1244,11 @@ class UpdateParamsAddInvoiceItem(TypedDict): """ class UpdateParamsAddInvoiceItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1214,7 +1258,7 @@ class UpdateParamsAddInvoiceItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1226,7 +1270,7 @@ class UpdateParamsAddInvoiceItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1255,16 +1299,16 @@ class UpdateParamsAddInvoiceItemPriceData(TypedDict): The ID of the product that this price will belong to. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1282,7 +1326,7 @@ class UpdateParamsAutomaticTax(TypedDict): """ class UpdateParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1292,11 +1336,11 @@ class UpdateParamsAutomaticTaxLiability(TypedDict): """ class UpdateParamsBillingThresholds(TypedDict): - amount_gte: NotRequired["int"] + amount_gte: NotRequired[int] """ Monetary threshold that triggers the subscription to advance to a new billing period """ - reset_billing_cycle_anchor: NotRequired["bool"] + reset_billing_cycle_anchor: NotRequired[bool] """ Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. """ @@ -1314,11 +1358,11 @@ class UpdateParamsCancellationDetails(TypedDict): """ class UpdateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1328,7 +1372,7 @@ class UpdateParamsDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1340,7 +1384,7 @@ class UpdateParamsDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1372,7 +1416,7 @@ class UpdateParamsInvoiceSettings(TypedDict): """ class UpdateParamsInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1388,11 +1432,11 @@ class UpdateParamsItem(TypedDict): """ Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. """ - clear_usage: NotRequired["bool"] + clear_usage: NotRequired[bool] """ Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`. """ - deleted: NotRequired["bool"] + deleted: NotRequired[bool] """ A flag that, if set to `true`, will delete the specified item. """ @@ -1402,7 +1446,7 @@ class UpdateParamsItem(TypedDict): """ The coupons to redeem into discounts for the subscription item. """ - id: NotRequired["str"] + id: NotRequired[str] """ Subscription item to update. """ @@ -1410,11 +1454,11 @@ class UpdateParamsItem(TypedDict): """ 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`. """ - plan: NotRequired["str"] + plan: NotRequired[str] """ Plan ID for this item, as a string. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. """ @@ -1424,7 +1468,7 @@ class UpdateParamsItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ Quantity for this item. """ @@ -1440,11 +1484,11 @@ class UpdateParamsItemBillingThresholds(TypedDict): """ class UpdateParamsItemDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ ID of the coupon to create a new discount for. """ - discount: NotRequired["str"] + discount: NotRequired[str] """ ID of an existing discount on the object (or one of its ancestors) to reuse. """ @@ -1454,7 +1498,7 @@ class UpdateParamsItemDiscount(TypedDict): """ Details to determine how long the discount should be applied for. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ ID of the promotion code to create a new discount for. """ @@ -1466,7 +1510,7 @@ class UpdateParamsItemDiscountDiscountEnd(TypedDict): """ Time span for the redeemed discount. """ - timestamp: NotRequired["int"] + timestamp: NotRequired[int] """ A precise Unix timestamp for the discount to end. Must be in the future. """ @@ -1499,16 +1543,16 @@ class UpdateParamsItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ @@ -1518,7 +1562,7 @@ class UpdateParamsItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ @@ -1528,7 +1572,7 @@ class UpdateParamsPauseCollection(TypedDict): """ The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. """ - resumes_at: NotRequired["int"] + resumes_at: NotRequired[int] """ The time after which the subscription will resume collecting payments. """ @@ -1547,7 +1591,7 @@ class UpdateParamsPaymentSettings(TypedDict): The list of payment method types (e.g. card) to provide to the invoice's PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice's default payment method, the subscription's default payment method, the customer's default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). """ save_default_payment_method: NotRequired[ - "Literal['off', 'on_subscription']" + Literal["off", "on_subscription"] ] """ Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds. @@ -1605,7 +1649,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -1614,13 +1658,13 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsAcssDebit(TypedDict): class UpdateParamsPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions( TypedDict, ): - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ class UpdateParamsPaymentSettingsPaymentMethodOptionsBancontact(TypedDict): - preferred_language: NotRequired["Literal['de', 'en', 'fr', 'nl']"] + preferred_language: NotRequired[Literal["de", "en", "fr", "nl"]] """ Preferred language of the Bancontact authorization page that the customer is redirected to. """ @@ -1633,13 +1677,25 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): Configuration options for setting up an eMandate for cards issued in India. """ network: NotRequired[ - "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" + Literal[ + "amex", + "cartes_bancaires", + "diners", + "discover", + "eftpos_au", + "interac", + "jcb", + "mastercard", + "unionpay", + "unknown", + "visa", + ] ] """ Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time. """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. @@ -1648,15 +1704,15 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): class UpdateParamsPaymentSettingsPaymentMethodOptionsCardMandateOptions( TypedDict, ): - amount: NotRequired["int"] + amount: NotRequired[int] """ Amount to be charged for future payments. """ - amount_type: NotRequired["Literal['fixed', 'maximum']"] + amount_type: NotRequired[Literal["fixed", "maximum"]] """ One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. """ - description: NotRequired["str"] + description: NotRequired[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ @@ -1670,7 +1726,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsCustomerBalance( """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["str"] + funding_type: NotRequired[str] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ @@ -1684,7 +1740,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer """ Configuration for eu_bank_transfer funding type. """ - type: NotRequired["str"] + type: NotRequired[str] """ The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. """ @@ -1713,7 +1769,7 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsUsBankAccount( Additional fields for Financial Connections Session creation """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -1723,13 +1779,24 @@ class UpdateParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConne TypedDict, ): permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. @@ -1740,7 +1807,7 @@ class UpdateParamsPendingInvoiceItemInterval(TypedDict): """ Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). """ @@ -1750,13 +1817,13 @@ class UpdateParamsPrebilling(TypedDict): """ This is used to determine the number of billing cycles to prebill. """ - update_behavior: NotRequired["Literal['prebill', 'reset']"] + update_behavior: NotRequired[Literal["prebill", "reset"]] """ Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`. """ class UpdateParamsTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ diff --git a/stripe/_tax_code.py b/stripe/_tax_code.py index 7ac651f1e..a20795230 100644 --- a/stripe/_tax_code.py +++ b/stripe/_tax_code.py @@ -15,25 +15,25 @@ class TaxCode(ListableAPIResource["TaxCode"]): OBJECT_NAME: ClassVar[Literal["tax_code"]] = "tax_code" class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_tax_code_service.py b/stripe/_tax_code_service.py index b6ad40390..4ed661d52 100644 --- a/stripe/_tax_code_service.py +++ b/stripe/_tax_code_service.py @@ -11,25 +11,25 @@ class TaxCodeService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_tax_id.py b/stripe/_tax_id.py index 5100d9dad..a220f3d7a 100644 --- a/stripe/_tax_id.py +++ b/stripe/_tax_id.py @@ -70,7 +70,7 @@ class Verification(StripeObject): """ class CreateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -156,11 +156,11 @@ class CreateParams(RequestOptions): """ class CreateParamsOwner(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ Account the tax ID belongs to. Required when `type=account` """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Customer the tax ID belongs to. Required when `type=customer` """ @@ -173,15 +173,15 @@ class DeleteParams(RequestOptions): pass class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -189,17 +189,17 @@ class ListParams(RequestOptions): """ The account or customer the tax ID belongs to. Defaults to `owner[type]=self`. """ - starting_after: NotRequired["str"] + 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 ListParamsOwner(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ Account the tax ID belongs to. Required when `type=account` """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Customer the tax ID belongs to. Required when `type=customer` """ @@ -209,7 +209,7 @@ class ListParamsOwner(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_tax_id_service.py b/stripe/_tax_id_service.py index cc2f3d53b..237ff8554 100644 --- a/stripe/_tax_id_service.py +++ b/stripe/_tax_id_service.py @@ -11,7 +11,7 @@ class TaxIdService(StripeService): class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -97,11 +97,11 @@ class CreateParams(TypedDict): """ class CreateParamsOwner(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ Account the tax ID belongs to. Required when `type=account` """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Customer the tax ID belongs to. Required when `type=customer` """ @@ -114,15 +114,15 @@ class DeleteParams(TypedDict): pass class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -130,17 +130,17 @@ class ListParams(TypedDict): """ The account or customer the tax ID belongs to. Defaults to `owner[type]=self`. """ - starting_after: NotRequired["str"] + 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 ListParamsOwner(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ Account the tax ID belongs to. Required when `type=account` """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Customer the tax ID belongs to. Required when `type=customer` """ @@ -150,7 +150,7 @@ class ListParamsOwner(TypedDict): """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_tax_rate.py b/stripe/_tax_rate.py index de889cab8..3c7bd7bb3 100644 --- a/stripe/_tax_rate.py +++ b/stripe/_tax_rate.py @@ -24,15 +24,15 @@ class TaxRate( OBJECT_NAME: ClassVar[Literal["tax_rate"]] = "tax_rate" class CreateParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. """ - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. """ @@ -40,7 +40,7 @@ class CreateParams(RequestOptions): """ The display name of the tax rate, which will be shown to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -48,11 +48,11 @@ class CreateParams(RequestOptions): """ This specifies if the tax rate is inclusive or exclusive. """ - jurisdiction: NotRequired["str"] + jurisdiction: NotRequired[str] """ The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -60,19 +60,33 @@ class CreateParams(RequestOptions): """ This represents the tax rate percent out of 100. """ - state: NotRequired["str"] + state: NotRequired[str] """ [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. """ tax_type: NotRequired[ - "Literal['amusement_tax', 'communications_tax', 'gst', 'hst', 'igst', 'jct', 'lease_tax', 'pst', 'qst', 'rst', 'sales_tax', 'vat', 'service_tax']" + Literal[ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat", + "service_tax", + ] ] """ The high-level tax type, such as `vat` or `sales_tax`. """ class ListParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Optional flag to filter by tax rates that are either active or inactive (archived). """ @@ -80,67 +94,67 @@ class ListParams(RequestOptions): """ Optional range for filtering created date. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - inclusive: NotRequired["bool"] + inclusive: NotRequired[bool] """ Optional flag to filter by tax rates that are inclusive (or those that are not inclusive). """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. """ - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. """ - display_name: NotRequired["str"] + display_name: NotRequired[str] """ The display name of the tax rate, which will be shown to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - jurisdiction: NotRequired["str"] + jurisdiction: NotRequired[str] """ The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice. """ @@ -148,19 +162,33 @@ class ModifyParams(RequestOptions): """ 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`. """ - state: NotRequired["str"] + state: NotRequired[str] """ [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. """ tax_type: NotRequired[ - "Literal['amusement_tax', 'communications_tax', 'gst', 'hst', 'igst', 'jct', 'lease_tax', 'pst', 'qst', 'rst', 'sales_tax', 'vat', 'service_tax']" + Literal[ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat", + "service_tax", + ] ] """ The high-level tax type, such as `vat` or `sales_tax`. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_tax_rate_service.py b/stripe/_tax_rate_service.py index c75e6d489..b8d0b0d8d 100644 --- a/stripe/_tax_rate_service.py +++ b/stripe/_tax_rate_service.py @@ -11,15 +11,15 @@ class TaxRateService(StripeService): class CreateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. """ - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. """ @@ -27,7 +27,7 @@ class CreateParams(TypedDict): """ The display name of the tax rate, which will be shown to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -35,11 +35,11 @@ class CreateParams(TypedDict): """ This specifies if the tax rate is inclusive or exclusive. """ - jurisdiction: NotRequired["str"] + jurisdiction: NotRequired[str] """ The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -47,19 +47,33 @@ class CreateParams(TypedDict): """ This represents the tax rate percent out of 100. """ - state: NotRequired["str"] + state: NotRequired[str] """ [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. """ tax_type: NotRequired[ - "Literal['amusement_tax', 'communications_tax', 'gst', 'hst', 'igst', 'jct', 'lease_tax', 'pst', 'qst', 'rst', 'sales_tax', 'vat', 'service_tax']" + Literal[ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat", + "service_tax", + ] ] """ The high-level tax type, such as `vat` or `sales_tax`. """ class ListParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Optional flag to filter by tax rates that are either active or inactive (archived). """ @@ -67,73 +81,73 @@ class ListParams(TypedDict): """ Optional range for filtering created date. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - inclusive: NotRequired["bool"] + inclusive: NotRequired[bool] """ Optional flag to filter by tax rates that are inclusive (or those that are not inclusive). """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. """ - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. """ - display_name: NotRequired["str"] + display_name: NotRequired[str] """ The display name of the tax rate, which will be shown to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - jurisdiction: NotRequired["str"] + jurisdiction: NotRequired[str] """ The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice. """ @@ -141,12 +155,26 @@ class UpdateParams(TypedDict): """ 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`. """ - state: NotRequired["str"] + state: NotRequired[str] """ [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. """ tax_type: NotRequired[ - "Literal['amusement_tax', 'communications_tax', 'gst', 'hst', 'igst', 'jct', 'lease_tax', 'pst', 'qst', 'rst', 'sales_tax', 'vat', 'service_tax']" + Literal[ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat", + "service_tax", + ] ] """ The high-level tax type, such as `vat` or `sales_tax`. diff --git a/stripe/_token.py b/stripe/_token.py index 5e0e51cc5..13c9c1244 100644 --- a/stripe/_token.py +++ b/stripe/_token.py @@ -55,7 +55,7 @@ class CreateParams(RequestOptions): """ The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user's credit card details, with the options described below. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). Learn more about [cloning saved payment methods](https://stripe.com/docs/connect/cloning-saved-payment-methods). """ @@ -63,7 +63,7 @@ class CreateParams(RequestOptions): """ The updated CVC value this token represents. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -78,7 +78,7 @@ class CreateParams(RequestOptions): class CreateParamsAccount(TypedDict): business_type: NotRequired[ - "Literal['company', 'government_entity', 'individual', 'non_profit']" + Literal["company", "government_entity", "individual", "non_profit"] ] """ The business type. @@ -91,7 +91,7 @@ class CreateParamsAccount(TypedDict): """ Information about the person represented by the account. """ - tos_shown_and_accepted: NotRequired["bool"] + tos_shown_and_accepted: NotRequired[bool] """ Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](https://stripe.com/docs/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`. """ @@ -113,35 +113,35 @@ class CreateParamsAccountCompany(TypedDict): """ The Kanji variation of the company's primary address (Japan only). """ - directors_provided: NotRequired["bool"] + directors_provided: NotRequired[bool] """ Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided. """ - executives_provided: NotRequired["bool"] + executives_provided: NotRequired[bool] """ Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` requirement. """ - export_license_id: NotRequired["str"] + export_license_id: NotRequired[str] """ The export license ID number of the company, also referred as Import Export Code (India only). """ - export_purpose_code: NotRequired["str"] + export_purpose_code: NotRequired[str] """ The purpose code to use for export transactions (India only). """ - name: NotRequired["str"] + name: NotRequired[str] """ The company's legal name. """ - name_kana: NotRequired["str"] + name_kana: NotRequired[str] """ The Kana variation of the company's legal name (Japan only). """ - name_kanji: NotRequired["str"] + name_kanji: NotRequired[str] """ The Kanji variation of the company's legal name (Japan only). """ - owners_provided: NotRequired["bool"] + owners_provided: NotRequired[bool] """ Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.owner` requirement. """ @@ -151,15 +151,15 @@ class CreateParamsAccountCompany(TypedDict): """ This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. """ - ownership_declaration_shown_and_signed: NotRequired["bool"] + ownership_declaration_shown_and_signed: NotRequired[bool] """ Whether the user described by the data in the token has been shown the Ownership Declaration and indicated that it is correct. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The company's phone number (used for verification). """ - registration_number: NotRequired["str"] + registration_number: NotRequired[str] """ The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong). """ @@ -169,15 +169,15 @@ class CreateParamsAccountCompany(TypedDict): """ The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value. """ - tax_id: NotRequired["str"] + tax_id: NotRequired[str] """ The business ID number of the company, as appropriate for the company's country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.) """ - tax_id_registrar: NotRequired["str"] + tax_id_registrar: NotRequired[str] """ The jurisdiction in which the `tax_id` is registered (Germany-based companies only). """ - vat_id: NotRequired["str"] + vat_id: NotRequired[str] """ The VAT number of the company. """ @@ -189,101 +189,101 @@ class CreateParamsAccountCompany(TypedDict): """ class CreateParamsAccountCompanyAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsAccountCompanyAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreateParamsAccountCompanyAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreateParamsAccountCompanyOwnershipDeclaration(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the beneficial owner attestation was made. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the beneficial owner attestation was made. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the beneficial owner attestation was made. """ @@ -297,11 +297,11 @@ class CreateParamsAccountCompanyVerification(TypedDict): """ class CreateParamsAccountCompanyVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ @@ -327,19 +327,19 @@ class CreateParamsAccountIndividual(TypedDict): """ The individual's date of birth. """ - email: NotRequired["str"] + email: NotRequired[str] """ The individual's email address. """ - first_name: NotRequired["str"] + first_name: NotRequired[str] """ The individual's first name. """ - first_name_kana: NotRequired["str"] + first_name_kana: NotRequired[str] """ The Kana variation of the the individual's first name (Japan only). """ - first_name_kanji: NotRequired["str"] + first_name_kanji: NotRequired[str] """ The Kanji variation of the individual's first name (Japan only). """ @@ -347,31 +347,31 @@ class CreateParamsAccountIndividual(TypedDict): """ A list of alternate names or aliases that the individual is known by. """ - gender: NotRequired["str"] + gender: NotRequired[str] """ The individual's gender (International regulations require either "male" or "female"). """ - id_number: NotRequired["str"] + id_number: NotRequired[str] """ The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - id_number_secondary: NotRequired["str"] + id_number_secondary: NotRequired[str] """ The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - last_name: NotRequired["str"] + last_name: NotRequired[str] """ The individual's last name. """ - last_name_kana: NotRequired["str"] + last_name_kana: NotRequired[str] """ The Kana variation of the individual's last name (Japan only). """ - last_name_kanji: NotRequired["str"] + last_name_kanji: NotRequired[str] """ The Kanji variation of the individual's last name (Japan only). """ - maiden_name: NotRequired["str"] + maiden_name: NotRequired[str] """ The individual's maiden name. """ @@ -379,11 +379,11 @@ class CreateParamsAccountIndividual(TypedDict): """ 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`. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The individual's phone number. """ - political_exposure: NotRequired["Literal['existing', 'none']"] + political_exposure: NotRequired[Literal["existing", "none"]] """ Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. """ @@ -399,7 +399,7 @@ class CreateParamsAccountIndividual(TypedDict): """ Describes the person's relationship to the account. """ - ssn_last_4: NotRequired["str"] + ssn_last_4: NotRequired[str] """ The last four digits of the individual's Social Security Number (U.S. only). """ @@ -411,87 +411,87 @@ class CreateParamsAccountIndividual(TypedDict): """ class CreateParamsAccountIndividualAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsAccountIndividualAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreateParamsAccountIndividualAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ @@ -511,41 +511,41 @@ class CreateParamsAccountIndividualDob(TypedDict): """ class CreateParamsAccountIndividualRegisteredAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsAccountIndividualRelationship(TypedDict): - director: NotRequired["bool"] + director: NotRequired[bool] """ Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. """ - executive: NotRequired["bool"] + executive: NotRequired[bool] """ Whether the person has significant responsibility to control, manage, or direct the organization. """ - owner: NotRequired["bool"] + owner: NotRequired[bool] """ Whether the person is an owner of the account's legal entity. """ @@ -553,7 +553,7 @@ class CreateParamsAccountIndividualRelationship(TypedDict): """ The percent owned by the person of the account's legal entity. """ - title: NotRequired["str"] + title: NotRequired[str] """ The person's title (e.g., CEO, Support Engineer). """ @@ -575,31 +575,31 @@ class CreateParamsAccountIndividualVerification(TypedDict): class CreateParamsAccountIndividualVerificationAdditionalDocument( TypedDict, ): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class CreateParamsAccountIndividualVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class CreateParamsBankAccount(TypedDict): - account_holder_name: NotRequired["str"] + account_holder_name: NotRequired[str] """ The name of the person or business that owns the bank account. This field is required when attaching the bank account to a `Customer` object. """ - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object. """ @@ -608,7 +608,7 @@ class CreateParamsBankAccount(TypedDict): The account number for the bank account, in string form. Must be a checking account. """ account_type: NotRequired[ - "Literal['checking', 'futsu', 'savings', 'toza']" + Literal["checking", "futsu", "savings", "toza"] ] """ The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. @@ -617,49 +617,49 @@ class CreateParamsBankAccount(TypedDict): """ The country in which the bank account is located. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](https://stripe.com/docs/payouts) """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ The ID of a Payment Method with a `type` of `us_bank_account`. The Payment Method's bank account information will be copied and returned as a Bank Account Token. This parameter is exclusive with respect to all other parameters in the `bank_account` hash. You must include the top-level `customer` parameter if the Payment Method is attached to a `Customer` object. If the Payment Method is not attached to a `Customer` object, it will be consumed and cannot be used again. You may not use Payment Methods which were created by a Setup Intent with `attach_to_self=true`. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ The routing number, sort code, or other country-appropriateinstitution number for the bank account. For US bank accounts, this is required and should bethe ACH routing number, not the wire routing number. If you are providing an IBAN for`account_number`, this field is not required. """ class CreateParamsCard(TypedDict): - address_city: NotRequired["str"] + address_city: NotRequired[str] """ City / District / Suburb / Town / Village. """ - address_country: NotRequired["str"] + address_country: NotRequired[str] """ Billing address country, if provided. """ - address_line1: NotRequired["str"] + address_line1: NotRequired[str] """ Address line 1 (Street address / PO Box / Company name). """ - address_line2: NotRequired["str"] + address_line2: NotRequired[str] """ Address line 2 (Apartment / Suite / Unit / Building). """ - address_state: NotRequired["str"] + address_state: NotRequired[str] """ State / County / Province / Region. """ - address_zip: NotRequired["str"] + address_zip: NotRequired[str] """ ZIP or postal code. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Required in order to add the card to an account; in all other cases, this parameter is not used. When added to an account, the card (which must be a debit card) can be used as a transfer destination for funds in this currency. """ - cvc: NotRequired["str"] + cvc: NotRequired[str] """ Card security code. Highly recommended to always include this value. """ @@ -671,7 +671,7 @@ class CreateParamsCard(TypedDict): """ Two- or four-digit number representing the card's expiration year. """ - name: NotRequired["str"] + name: NotRequired[str] """ Cardholder's full name. """ @@ -686,7 +686,7 @@ class CreateParamsCard(TypedDict): class CreateParamsCardNetworks(TypedDict): preferred: NotRequired[ - "Literal['cartes_bancaires', 'mastercard', 'visa']" + 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. @@ -725,19 +725,19 @@ class CreateParamsPerson(TypedDict): """ Documents that may be submitted to satisfy various informational requests. """ - email: NotRequired["str"] + email: NotRequired[str] """ The person's email address. """ - first_name: NotRequired["str"] + first_name: NotRequired[str] """ The person's first name. """ - first_name_kana: NotRequired["str"] + first_name_kana: NotRequired[str] """ The Kana variation of the person's first name (Japan only). """ - first_name_kanji: NotRequired["str"] + first_name_kanji: NotRequired[str] """ The Kanji variation of the person's first name (Japan only). """ @@ -745,31 +745,31 @@ class CreateParamsPerson(TypedDict): """ A list of alternate names or aliases that the person is known by. """ - gender: NotRequired["str"] + gender: NotRequired[str] """ The person's gender (International regulations require either "male" or "female"). """ - id_number: NotRequired["str"] + id_number: NotRequired[str] """ The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - id_number_secondary: NotRequired["str"] + id_number_secondary: NotRequired[str] """ The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - last_name: NotRequired["str"] + last_name: NotRequired[str] """ The person's last name. """ - last_name_kana: NotRequired["str"] + last_name_kana: NotRequired[str] """ The Kana variation of the person's last name (Japan only). """ - last_name_kanji: NotRequired["str"] + last_name_kanji: NotRequired[str] """ The Kanji variation of the person's last name (Japan only). """ - maiden_name: NotRequired["str"] + maiden_name: NotRequired[str] """ The person's maiden name. """ @@ -777,15 +777,15 @@ class CreateParamsPerson(TypedDict): """ 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`. """ - nationality: NotRequired["str"] + nationality: NotRequired[str] """ The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The person's phone number. """ - political_exposure: NotRequired["str"] + political_exposure: NotRequired[str] """ Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. """ @@ -799,7 +799,7 @@ class CreateParamsPerson(TypedDict): """ The relationship that this person has with the account's legal entity. """ - ssn_last_4: NotRequired["str"] + ssn_last_4: NotRequired[str] """ The last four digits of the person's Social Security number (U.S. only). """ @@ -817,11 +817,11 @@ class CreateParamsPersonAdditionalTosAcceptances(TypedDict): """ class CreateParamsPersonAdditionalTosAcceptancesAccount(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the account representative accepted the service agreement. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the account representative accepted the service agreement. """ @@ -831,87 +831,87 @@ class CreateParamsPersonAdditionalTosAcceptancesAccount(TypedDict): """ class CreateParamsPersonAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsPersonAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreateParamsPersonAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ @@ -947,63 +947,63 @@ class CreateParamsPersonDocuments(TypedDict): """ class CreateParamsPersonDocumentsCompanyAuthorization(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsPersonDocumentsPassport(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsPersonDocumentsVisa(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsPersonRegisteredAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsPersonRelationship(TypedDict): - director: NotRequired["bool"] + director: NotRequired[bool] """ Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. """ - executive: NotRequired["bool"] + executive: NotRequired[bool] """ Whether the person has significant responsibility to control, manage, or direct the organization. """ - legal_guardian: NotRequired["bool"] + legal_guardian: NotRequired[bool] """ Whether the person is the legal guardian of the account's representative. """ - owner: NotRequired["bool"] + owner: NotRequired[bool] """ Whether the person is an owner of the account's legal entity. """ @@ -1011,11 +1011,11 @@ class CreateParamsPersonRelationship(TypedDict): """ The percent owned by the person of the account's legal entity. """ - representative: NotRequired["bool"] + representative: NotRequired[bool] """ Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account. """ - title: NotRequired["str"] + title: NotRequired[str] """ The person's title (e.g., CEO, Support Engineer). """ @@ -1033,33 +1033,33 @@ class CreateParamsPersonVerification(TypedDict): """ class CreateParamsPersonVerificationAdditionalDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class CreateParamsPersonVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class CreateParamsPii(TypedDict): - id_number: NotRequired["str"] + id_number: NotRequired[str] """ The `id_number` for the PII, in string form. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_token_service.py b/stripe/_token_service.py index 54df515d7..455ab070b 100644 --- a/stripe/_token_service.py +++ b/stripe/_token_service.py @@ -22,7 +22,7 @@ class CreateParams(TypedDict): """ The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user's credit card details, with the options described below. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). Learn more about [cloning saved payment methods](https://stripe.com/docs/connect/cloning-saved-payment-methods). """ @@ -30,7 +30,7 @@ class CreateParams(TypedDict): """ The updated CVC value this token represents. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -45,7 +45,7 @@ class CreateParams(TypedDict): class CreateParamsAccount(TypedDict): business_type: NotRequired[ - "Literal['company', 'government_entity', 'individual', 'non_profit']" + Literal["company", "government_entity", "individual", "non_profit"] ] """ The business type. @@ -58,7 +58,7 @@ class CreateParamsAccount(TypedDict): """ Information about the person represented by the account. """ - tos_shown_and_accepted: NotRequired["bool"] + tos_shown_and_accepted: NotRequired[bool] """ Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](https://stripe.com/docs/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`. """ @@ -80,35 +80,35 @@ class CreateParamsAccountCompany(TypedDict): """ The Kanji variation of the company's primary address (Japan only). """ - directors_provided: NotRequired["bool"] + directors_provided: NotRequired[bool] """ Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided. """ - executives_provided: NotRequired["bool"] + executives_provided: NotRequired[bool] """ Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` requirement. """ - export_license_id: NotRequired["str"] + export_license_id: NotRequired[str] """ The export license ID number of the company, also referred as Import Export Code (India only). """ - export_purpose_code: NotRequired["str"] + export_purpose_code: NotRequired[str] """ The purpose code to use for export transactions (India only). """ - name: NotRequired["str"] + name: NotRequired[str] """ The company's legal name. """ - name_kana: NotRequired["str"] + name_kana: NotRequired[str] """ The Kana variation of the company's legal name (Japan only). """ - name_kanji: NotRequired["str"] + name_kanji: NotRequired[str] """ The Kanji variation of the company's legal name (Japan only). """ - owners_provided: NotRequired["bool"] + owners_provided: NotRequired[bool] """ Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.owner` requirement. """ @@ -118,15 +118,15 @@ class CreateParamsAccountCompany(TypedDict): """ This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. """ - ownership_declaration_shown_and_signed: NotRequired["bool"] + ownership_declaration_shown_and_signed: NotRequired[bool] """ Whether the user described by the data in the token has been shown the Ownership Declaration and indicated that it is correct. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The company's phone number (used for verification). """ - registration_number: NotRequired["str"] + registration_number: NotRequired[str] """ The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong). """ @@ -136,15 +136,15 @@ class CreateParamsAccountCompany(TypedDict): """ The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value. """ - tax_id: NotRequired["str"] + tax_id: NotRequired[str] """ The business ID number of the company, as appropriate for the company's country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.) """ - tax_id_registrar: NotRequired["str"] + tax_id_registrar: NotRequired[str] """ The jurisdiction in which the `tax_id` is registered (Germany-based companies only). """ - vat_id: NotRequired["str"] + vat_id: NotRequired[str] """ The VAT number of the company. """ @@ -156,101 +156,101 @@ class CreateParamsAccountCompany(TypedDict): """ class CreateParamsAccountCompanyAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsAccountCompanyAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreateParamsAccountCompanyAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreateParamsAccountCompanyOwnershipDeclaration(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the beneficial owner attestation was made. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the beneficial owner attestation was made. """ - user_agent: NotRequired["str"] + user_agent: NotRequired[str] """ The user agent of the browser from which the beneficial owner attestation was made. """ @@ -264,11 +264,11 @@ class CreateParamsAccountCompanyVerification(TypedDict): """ class CreateParamsAccountCompanyVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ @@ -298,19 +298,19 @@ class CreateParamsAccountIndividual(TypedDict): """ The individual's date of birth. """ - email: NotRequired["str"] + email: NotRequired[str] """ The individual's email address. """ - first_name: NotRequired["str"] + first_name: NotRequired[str] """ The individual's first name. """ - first_name_kana: NotRequired["str"] + first_name_kana: NotRequired[str] """ The Kana variation of the the individual's first name (Japan only). """ - first_name_kanji: NotRequired["str"] + first_name_kanji: NotRequired[str] """ The Kanji variation of the individual's first name (Japan only). """ @@ -318,31 +318,31 @@ class CreateParamsAccountIndividual(TypedDict): """ A list of alternate names or aliases that the individual is known by. """ - gender: NotRequired["str"] + gender: NotRequired[str] """ The individual's gender (International regulations require either "male" or "female"). """ - id_number: NotRequired["str"] + id_number: NotRequired[str] """ The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - id_number_secondary: NotRequired["str"] + id_number_secondary: NotRequired[str] """ The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - last_name: NotRequired["str"] + last_name: NotRequired[str] """ The individual's last name. """ - last_name_kana: NotRequired["str"] + last_name_kana: NotRequired[str] """ The Kana variation of the individual's last name (Japan only). """ - last_name_kanji: NotRequired["str"] + last_name_kanji: NotRequired[str] """ The Kanji variation of the individual's last name (Japan only). """ - maiden_name: NotRequired["str"] + maiden_name: NotRequired[str] """ The individual's maiden name. """ @@ -350,11 +350,11 @@ class CreateParamsAccountIndividual(TypedDict): """ 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`. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The individual's phone number. """ - political_exposure: NotRequired["Literal['existing', 'none']"] + political_exposure: NotRequired[Literal["existing", "none"]] """ Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. """ @@ -370,7 +370,7 @@ class CreateParamsAccountIndividual(TypedDict): """ Describes the person's relationship to the account. """ - ssn_last_4: NotRequired["str"] + ssn_last_4: NotRequired[str] """ The last four digits of the individual's Social Security Number (U.S. only). """ @@ -382,87 +382,87 @@ class CreateParamsAccountIndividual(TypedDict): """ class CreateParamsAccountIndividualAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsAccountIndividualAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreateParamsAccountIndividualAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ @@ -482,41 +482,41 @@ class CreateParamsAccountIndividualDob(TypedDict): """ class CreateParamsAccountIndividualRegisteredAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsAccountIndividualRelationship(TypedDict): - director: NotRequired["bool"] + director: NotRequired[bool] """ Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. """ - executive: NotRequired["bool"] + executive: NotRequired[bool] """ Whether the person has significant responsibility to control, manage, or direct the organization. """ - owner: NotRequired["bool"] + owner: NotRequired[bool] """ Whether the person is an owner of the account's legal entity. """ @@ -524,7 +524,7 @@ class CreateParamsAccountIndividualRelationship(TypedDict): """ The percent owned by the person of the account's legal entity. """ - title: NotRequired["str"] + title: NotRequired[str] """ The person's title (e.g., CEO, Support Engineer). """ @@ -546,31 +546,31 @@ class CreateParamsAccountIndividualVerification(TypedDict): class CreateParamsAccountIndividualVerificationAdditionalDocument( TypedDict, ): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class CreateParamsAccountIndividualVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class CreateParamsBankAccount(TypedDict): - account_holder_name: NotRequired["str"] + account_holder_name: NotRequired[str] """ The name of the person or business that owns the bank account. This field is required when attaching the bank account to a `Customer` object. """ - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object. """ @@ -579,7 +579,7 @@ class CreateParamsBankAccount(TypedDict): The account number for the bank account, in string form. Must be a checking account. """ account_type: NotRequired[ - "Literal['checking', 'futsu', 'savings', 'toza']" + Literal["checking", "futsu", "savings", "toza"] ] """ The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. @@ -588,49 +588,49 @@ class CreateParamsBankAccount(TypedDict): """ The country in which the bank account is located. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](https://stripe.com/docs/payouts) """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ The ID of a Payment Method with a `type` of `us_bank_account`. The Payment Method's bank account information will be copied and returned as a Bank Account Token. This parameter is exclusive with respect to all other parameters in the `bank_account` hash. You must include the top-level `customer` parameter if the Payment Method is attached to a `Customer` object. If the Payment Method is not attached to a `Customer` object, it will be consumed and cannot be used again. You may not use Payment Methods which were created by a Setup Intent with `attach_to_self=true`. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ The routing number, sort code, or other country-appropriateinstitution number for the bank account. For US bank accounts, this is required and should bethe ACH routing number, not the wire routing number. If you are providing an IBAN for`account_number`, this field is not required. """ class CreateParamsCard(TypedDict): - address_city: NotRequired["str"] + address_city: NotRequired[str] """ City / District / Suburb / Town / Village. """ - address_country: NotRequired["str"] + address_country: NotRequired[str] """ Billing address country, if provided. """ - address_line1: NotRequired["str"] + address_line1: NotRequired[str] """ Address line 1 (Street address / PO Box / Company name). """ - address_line2: NotRequired["str"] + address_line2: NotRequired[str] """ Address line 2 (Apartment / Suite / Unit / Building). """ - address_state: NotRequired["str"] + address_state: NotRequired[str] """ State / County / Province / Region. """ - address_zip: NotRequired["str"] + address_zip: NotRequired[str] """ ZIP or postal code. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Required in order to add the card to an account; in all other cases, this parameter is not used. When added to an account, the card (which must be a debit card) can be used as a transfer destination for funds in this currency. """ - cvc: NotRequired["str"] + cvc: NotRequired[str] """ Card security code. Highly recommended to always include this value. """ @@ -642,7 +642,7 @@ class CreateParamsCard(TypedDict): """ Two- or four-digit number representing the card's expiration year. """ - name: NotRequired["str"] + name: NotRequired[str] """ Cardholder's full name. """ @@ -657,7 +657,7 @@ class CreateParamsCard(TypedDict): class CreateParamsCardNetworks(TypedDict): preferred: NotRequired[ - "Literal['cartes_bancaires', 'mastercard', 'visa']" + 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. @@ -698,19 +698,19 @@ class CreateParamsPerson(TypedDict): """ Documents that may be submitted to satisfy various informational requests. """ - email: NotRequired["str"] + email: NotRequired[str] """ The person's email address. """ - first_name: NotRequired["str"] + first_name: NotRequired[str] """ The person's first name. """ - first_name_kana: NotRequired["str"] + first_name_kana: NotRequired[str] """ The Kana variation of the person's first name (Japan only). """ - first_name_kanji: NotRequired["str"] + first_name_kanji: NotRequired[str] """ The Kanji variation of the person's first name (Japan only). """ @@ -718,31 +718,31 @@ class CreateParamsPerson(TypedDict): """ A list of alternate names or aliases that the person is known by. """ - gender: NotRequired["str"] + gender: NotRequired[str] """ The person's gender (International regulations require either "male" or "female"). """ - id_number: NotRequired["str"] + id_number: NotRequired[str] """ The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - id_number_secondary: NotRequired["str"] + id_number_secondary: NotRequired[str] """ The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). """ - last_name: NotRequired["str"] + last_name: NotRequired[str] """ The person's last name. """ - last_name_kana: NotRequired["str"] + last_name_kana: NotRequired[str] """ The Kana variation of the person's last name (Japan only). """ - last_name_kanji: NotRequired["str"] + last_name_kanji: NotRequired[str] """ The Kanji variation of the person's last name (Japan only). """ - maiden_name: NotRequired["str"] + maiden_name: NotRequired[str] """ The person's maiden name. """ @@ -750,15 +750,15 @@ class CreateParamsPerson(TypedDict): """ 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`. """ - nationality: NotRequired["str"] + nationality: NotRequired[str] """ The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ The person's phone number. """ - political_exposure: NotRequired["str"] + political_exposure: NotRequired[str] """ Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. """ @@ -774,7 +774,7 @@ class CreateParamsPerson(TypedDict): """ The relationship that this person has with the account's legal entity. """ - ssn_last_4: NotRequired["str"] + ssn_last_4: NotRequired[str] """ The last four digits of the person's Social Security number (U.S. only). """ @@ -794,11 +794,11 @@ class CreateParamsPersonAdditionalTosAcceptances(TypedDict): """ class CreateParamsPersonAdditionalTosAcceptancesAccount(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the account representative accepted the service agreement. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the account representative accepted the service agreement. """ @@ -808,87 +808,87 @@ class CreateParamsPersonAdditionalTosAcceptancesAccount(TypedDict): """ class CreateParamsPersonAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsPersonAddressKana(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ class CreateParamsPersonAddressKanji(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City or ward. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Block or building number. """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Building details. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ Prefecture. """ - town: NotRequired["str"] + town: NotRequired[str] """ Town or cho-me. """ @@ -926,63 +926,63 @@ class CreateParamsPersonDocuments(TypedDict): """ class CreateParamsPersonDocumentsCompanyAuthorization(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsPersonDocumentsPassport(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsPersonDocumentsVisa(TypedDict): - files: NotRequired["List[str]"] + files: NotRequired[List[str]] """ One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`. """ class CreateParamsPersonRegisteredAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsPersonRelationship(TypedDict): - director: NotRequired["bool"] + director: NotRequired[bool] """ Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. """ - executive: NotRequired["bool"] + executive: NotRequired[bool] """ Whether the person has significant responsibility to control, manage, or direct the organization. """ - legal_guardian: NotRequired["bool"] + legal_guardian: NotRequired[bool] """ Whether the person is the legal guardian of the account's representative. """ - owner: NotRequired["bool"] + owner: NotRequired[bool] """ Whether the person is an owner of the account's legal entity. """ @@ -990,11 +990,11 @@ class CreateParamsPersonRelationship(TypedDict): """ The percent owned by the person of the account's legal entity. """ - representative: NotRequired["bool"] + representative: NotRequired[bool] """ Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account. """ - title: NotRequired["str"] + title: NotRequired[str] """ The person's title (e.g., CEO, Support Engineer). """ @@ -1014,33 +1014,33 @@ class CreateParamsPersonVerification(TypedDict): """ class CreateParamsPersonVerificationAdditionalDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class CreateParamsPersonVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. """ class CreateParamsPii(TypedDict): - id_number: NotRequired["str"] + id_number: NotRequired[str] """ The `id_number` for the PII, in string form. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_topup.py b/stripe/_topup.py index 336d9b5f8..c6404973e 100644 --- a/stripe/_topup.py +++ b/stripe/_topup.py @@ -37,7 +37,7 @@ class Topup( OBJECT_NAME: ClassVar[Literal["topup"]] = "topup" class CancelParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -51,11 +51,11 @@ class CreateParams(RequestOptions): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -63,15 +63,15 @@ class CreateParams(RequestOptions): """ 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`. """ - source: NotRequired["str"] + source: NotRequired[str] """ The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)). """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies this top-up as part of a group. """ @@ -85,71 +85,71 @@ class ListParams(RequestOptions): """ 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"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['canceled', 'failed', 'pending', 'succeeded']" + Literal["canceled", "failed", "pending", "succeeded"] ] """ Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`. """ class ListParamsAmount(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -159,7 +159,7 @@ class ModifyParams(RequestOptions): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_topup_service.py b/stripe/_topup_service.py index 94a5c9ccc..eeeeae7d9 100644 --- a/stripe/_topup_service.py +++ b/stripe/_topup_service.py @@ -11,7 +11,7 @@ class TopupService(StripeService): class CancelParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -25,11 +25,11 @@ class CreateParams(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -37,15 +37,15 @@ class CreateParams(TypedDict): """ 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`. """ - source: NotRequired["str"] + source: NotRequired[str] """ The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)). """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies this top-up as part of a group. """ @@ -59,77 +59,77 @@ class ListParams(TypedDict): """ 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"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['canceled', 'failed', 'pending', 'succeeded']" + Literal["canceled", "failed", "pending", "succeeded"] ] """ Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`. """ class ListParamsAmount(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_transfer.py b/stripe/_transfer.py index b22ce09ac..222d59d72 100644 --- a/stripe/_transfer.py +++ b/stripe/_transfer.py @@ -46,7 +46,7 @@ class Transfer( OBJECT_NAME: ClassVar[Literal["transfer"]] = "transfer" class CreateParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ A positive integer in cents (or local equivalent) representing how much to transfer. """ @@ -54,7 +54,7 @@ class CreateParams(RequestOptions): """ 3-letter [ISO code for currency](https://stripe.com/docs/payouts). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ @@ -62,37 +62,37 @@ class CreateParams(RequestOptions): """ The ID of a connected Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - source_transaction: NotRequired["str"] + source_transaction: NotRequired[str] """ You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details. """ - source_type: NotRequired["Literal['bank_account', 'card', 'fpx']"] + source_type: NotRequired[Literal["bank_account", "card", "fpx"]] """ The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. """ class CreateReversalParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the Dashboard. This will be unset if you POST an empty value. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -100,7 +100,7 @@ class CreateReversalParams(RequestOptions): """ 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`. """ - refund_application_fee: NotRequired["bool"] + refund_application_fee: NotRequired[bool] """ Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed. """ @@ -110,73 +110,73 @@ class ListParams(RequestOptions): """ Only return transfers that were created during the given date interval. """ - destination: NotRequired["str"] + destination: NotRequired[str] """ Only return transfers for the destination specified by this account ID. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ Only return transfers with the specified transfer group. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListReversalsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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): - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -186,7 +186,7 @@ class ModifyParams(RequestOptions): """ class ModifyReversalParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -196,13 +196,13 @@ class ModifyReversalParams(RequestOptions): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveReversalParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_transfer_reversal_service.py b/stripe/_transfer_reversal_service.py index c0360c6a2..2159726ef 100644 --- a/stripe/_transfer_reversal_service.py +++ b/stripe/_transfer_reversal_service.py @@ -11,15 +11,15 @@ class TransferReversalService(StripeService): class CreateParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the Dashboard. This will be unset if you POST an empty value. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -27,37 +27,37 @@ class CreateParams(TypedDict): """ 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`. """ - refund_application_fee: NotRequired["bool"] + refund_application_fee: NotRequired[bool] """ Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed. """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_transfer_service.py b/stripe/_transfer_service.py index 48b6983ea..a78d77486 100644 --- a/stripe/_transfer_service.py +++ b/stripe/_transfer_service.py @@ -16,7 +16,7 @@ def __init__(self, requestor): self.reversals = TransferReversalService(self._requestor) class CreateParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ A positive integer in cents (or local equivalent) representing how much to transfer. """ @@ -24,7 +24,7 @@ class CreateParams(TypedDict): """ 3-letter [ISO code for currency](https://stripe.com/docs/payouts). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ @@ -32,23 +32,23 @@ class CreateParams(TypedDict): """ The ID of a connected Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - source_transaction: NotRequired["str"] + source_transaction: NotRequired[str] """ You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details. """ - source_type: NotRequired["Literal['bank_account', 'card', 'fpx']"] + source_type: NotRequired[Literal["bank_account", "card", "fpx"]] """ The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. """ @@ -58,61 +58,61 @@ class ListParams(TypedDict): """ Only return transfers that were created during the given date interval. """ - destination: NotRequired["str"] + destination: NotRequired[str] """ Only return transfers for the destination specified by this account ID. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ Only return transfers with the specified transfer group. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_webhook_endpoint.py b/stripe/_webhook_endpoint.py index 8f59dc866..baf178f50 100644 --- a/stripe/_webhook_endpoint.py +++ b/stripe/_webhook_endpoint.py @@ -31,12 +31,113 @@ class WebhookEndpoint( class CreateParams(RequestOptions): api_version: NotRequired[ - "Literal['2011-01-01', '2011-06-21', '2011-06-28', '2011-08-01', '2011-09-15', '2011-11-17', '2012-02-23', '2012-03-25', '2012-06-18', '2012-06-28', '2012-07-09', '2012-09-24', '2012-10-26', '2012-11-07', '2013-02-11', '2013-02-13', '2013-07-05', '2013-08-12', '2013-08-13', '2013-10-29', '2013-12-03', '2014-01-31', '2014-03-13', '2014-03-28', '2014-05-19', '2014-06-13', '2014-06-17', '2014-07-22', '2014-07-26', '2014-08-04', '2014-08-20', '2014-09-08', '2014-10-07', '2014-11-05', '2014-11-20', '2014-12-08', '2014-12-17', '2014-12-22', '2015-01-11', '2015-01-26', '2015-02-10', '2015-02-16', '2015-02-18', '2015-03-24', '2015-04-07', '2015-06-15', '2015-07-07', '2015-07-13', '2015-07-28', '2015-08-07', '2015-08-19', '2015-09-03', '2015-09-08', '2015-09-23', '2015-10-01', '2015-10-12', '2015-10-16', '2016-02-03', '2016-02-19', '2016-02-22', '2016-02-23', '2016-02-29', '2016-03-07', '2016-06-15', '2016-07-06', '2016-10-19', '2017-01-27', '2017-02-14', '2017-04-06', '2017-05-25', '2017-06-05', '2017-08-15', '2017-12-14', '2018-01-23', '2018-02-05', '2018-02-06', '2018-02-28', '2018-05-21', '2018-07-27', '2018-08-23', '2018-09-06', '2018-09-24', '2018-10-31', '2018-11-08', '2019-02-11', '2019-02-19', '2019-03-14', '2019-05-16', '2019-08-14', '2019-09-09', '2019-10-08', '2019-10-17', '2019-11-05', '2019-12-03', '2020-03-02', '2020-08-27', '2022-08-01', '2022-11-15', '2023-08-16', '2023-10-16']" + Literal[ + "2011-01-01", + "2011-06-21", + "2011-06-28", + "2011-08-01", + "2011-09-15", + "2011-11-17", + "2012-02-23", + "2012-03-25", + "2012-06-18", + "2012-06-28", + "2012-07-09", + "2012-09-24", + "2012-10-26", + "2012-11-07", + "2013-02-11", + "2013-02-13", + "2013-07-05", + "2013-08-12", + "2013-08-13", + "2013-10-29", + "2013-12-03", + "2014-01-31", + "2014-03-13", + "2014-03-28", + "2014-05-19", + "2014-06-13", + "2014-06-17", + "2014-07-22", + "2014-07-26", + "2014-08-04", + "2014-08-20", + "2014-09-08", + "2014-10-07", + "2014-11-05", + "2014-11-20", + "2014-12-08", + "2014-12-17", + "2014-12-22", + "2015-01-11", + "2015-01-26", + "2015-02-10", + "2015-02-16", + "2015-02-18", + "2015-03-24", + "2015-04-07", + "2015-06-15", + "2015-07-07", + "2015-07-13", + "2015-07-28", + "2015-08-07", + "2015-08-19", + "2015-09-03", + "2015-09-08", + "2015-09-23", + "2015-10-01", + "2015-10-12", + "2015-10-16", + "2016-02-03", + "2016-02-19", + "2016-02-22", + "2016-02-23", + "2016-02-29", + "2016-03-07", + "2016-06-15", + "2016-07-06", + "2016-10-19", + "2017-01-27", + "2017-02-14", + "2017-04-06", + "2017-05-25", + "2017-06-05", + "2017-08-15", + "2017-12-14", + "2018-01-23", + "2018-02-05", + "2018-02-06", + "2018-02-28", + "2018-05-21", + "2018-07-27", + "2018-08-23", + "2018-09-06", + "2018-09-24", + "2018-10-31", + "2018-11-08", + "2019-02-11", + "2019-02-19", + "2019-03-14", + "2019-05-16", + "2019-08-14", + "2019-09-09", + "2019-10-08", + "2019-10-17", + "2019-11-05", + "2019-12-03", + "2020-03-02", + "2020-08-27", + "2022-08-01", + "2022-11-15", + "2023-08-16", + "2023-10-16", + ] ] """ Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version. """ - connect: NotRequired["bool"] + connect: NotRequired[bool] """ Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`. """ @@ -316,7 +417,7 @@ class CreateParams(RequestOptions): """ The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -333,19 +434,19 @@ class DeleteParams(RequestOptions): pass class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ @@ -355,17 +456,285 @@ class ModifyParams(RequestOptions): """ An optional description of what the webhook is used for. """ - disabled: NotRequired["bool"] + disabled: NotRequired[bool] """ Disable the webhook endpoint if set to true. """ enabled_events: NotRequired[ - "List[Literal['*', 'account.application.authorized', 'account.application.deauthorized', 'account.external_account.created', 'account.external_account.deleted', 'account.external_account.updated', 'account.updated', 'account_notice.created', 'account_notice.updated', 'application_fee.created', 'application_fee.refund.updated', 'application_fee.refunded', 'balance.available', 'billing_portal.configuration.created', 'billing_portal.configuration.updated', 'billing_portal.session.created', 'capability.updated', 'capital.financing_offer.accepted', 'capital.financing_offer.canceled', 'capital.financing_offer.created', 'capital.financing_offer.expired', 'capital.financing_offer.fully_repaid', 'capital.financing_offer.paid_out', 'capital.financing_offer.rejected', 'capital.financing_offer.replacement_created', 'capital.financing_transaction.created', 'cash_balance.funds_available', 'charge.captured', 'charge.dispute.closed', 'charge.dispute.created', 'charge.dispute.funds_reinstated', 'charge.dispute.funds_withdrawn', 'charge.dispute.updated', 'charge.expired', 'charge.failed', 'charge.pending', 'charge.refund.updated', 'charge.refunded', 'charge.succeeded', 'charge.updated', 'checkout.session.async_payment_failed', 'checkout.session.async_payment_succeeded', 'checkout.session.completed', 'checkout.session.expired', 'climate.order.canceled', 'climate.order.created', 'climate.order.delayed', 'climate.order.delivered', 'climate.order.product_substituted', 'climate.product.created', 'climate.product.pricing_updated', 'coupon.created', 'coupon.deleted', 'coupon.updated', 'credit_note.created', 'credit_note.updated', 'credit_note.voided', 'customer.created', 'customer.deleted', 'customer.discount.created', 'customer.discount.deleted', 'customer.discount.updated', 'customer.source.created', 'customer.source.deleted', 'customer.source.expiring', 'customer.source.updated', 'customer.subscription.collection_paused', 'customer.subscription.collection_resumed', 'customer.subscription.created', 'customer.subscription.custom_event', 'customer.subscription.deleted', 'customer.subscription.paused', 'customer.subscription.pending_update_applied', 'customer.subscription.pending_update_expired', 'customer.subscription.resumed', 'customer.subscription.trial_will_end', 'customer.subscription.updated', 'customer.tax_id.created', 'customer.tax_id.deleted', 'customer.tax_id.updated', 'customer.updated', 'customer_cash_balance_transaction.created', 'entitlements.active_entitlement_summary.updated', 'file.created', 'financial_connections.account.created', 'financial_connections.account.deactivated', 'financial_connections.account.disconnected', 'financial_connections.account.reactivated', 'financial_connections.account.refreshed_balance', 'financial_connections.account.refreshed_inferred_balances', 'financial_connections.account.refreshed_ownership', 'financial_connections.account.refreshed_transactions', 'financial_connections.session.updated', 'identity.verification_session.canceled', 'identity.verification_session.created', 'identity.verification_session.processing', 'identity.verification_session.redacted', 'identity.verification_session.requires_input', 'identity.verification_session.verified', 'invoice.created', 'invoice.deleted', 'invoice.finalization_failed', 'invoice.finalized', 'invoice.marked_uncollectible', 'invoice.paid', 'invoice.payment.overpaid', 'invoice.payment_action_required', 'invoice.payment_failed', 'invoice.payment_succeeded', 'invoice.sent', 'invoice.upcoming', 'invoice.updated', 'invoice.voided', 'invoiceitem.created', 'invoiceitem.deleted', 'issuing_authorization.created', 'issuing_authorization.request', 'issuing_authorization.updated', 'issuing_card.created', 'issuing_card.updated', 'issuing_cardholder.created', 'issuing_cardholder.updated', 'issuing_dispute.closed', 'issuing_dispute.created', 'issuing_dispute.funds_reinstated', 'issuing_dispute.submitted', 'issuing_dispute.updated', 'issuing_personalization_design.activated', 'issuing_personalization_design.deactivated', 'issuing_personalization_design.rejected', 'issuing_personalization_design.updated', 'issuing_token.created', 'issuing_token.updated', 'issuing_transaction.created', 'issuing_transaction.updated', 'mandate.updated', 'payment_intent.amount_capturable_updated', 'payment_intent.canceled', 'payment_intent.created', 'payment_intent.partially_funded', 'payment_intent.payment_failed', 'payment_intent.processing', 'payment_intent.requires_action', 'payment_intent.succeeded', 'payment_link.created', 'payment_link.updated', 'payment_method.attached', 'payment_method.automatically_updated', 'payment_method.detached', 'payment_method.updated', 'payout.canceled', 'payout.created', 'payout.failed', 'payout.paid', 'payout.reconciliation_completed', 'payout.updated', 'person.created', 'person.deleted', 'person.updated', 'plan.created', 'plan.deleted', 'plan.updated', 'price.created', 'price.deleted', 'price.updated', 'product.created', 'product.deleted', 'product.updated', 'promotion_code.created', 'promotion_code.updated', 'quote.accept_failed', 'quote.accepted', 'quote.accepting', 'quote.canceled', 'quote.created', 'quote.draft', 'quote.finalized', 'quote.reestimate_failed', 'quote.reestimated', 'quote.stale', 'radar.early_fraud_warning.created', 'radar.early_fraud_warning.updated', 'refund.created', 'refund.updated', 'reporting.report_run.failed', 'reporting.report_run.succeeded', 'reporting.report_type.updated', 'review.closed', 'review.opened', 'setup_intent.canceled', 'setup_intent.created', 'setup_intent.requires_action', 'setup_intent.setup_failed', 'setup_intent.succeeded', 'sigma.scheduled_query_run.created', 'source.canceled', 'source.chargeable', 'source.failed', 'source.mandate_notification', 'source.refund_attributes_required', 'source.transaction.created', 'source.transaction.updated', 'subscription_schedule.aborted', 'subscription_schedule.canceled', 'subscription_schedule.completed', 'subscription_schedule.created', 'subscription_schedule.expiring', 'subscription_schedule.released', 'subscription_schedule.updated', 'tax.form.updated', 'tax.settings.updated', 'tax_rate.created', 'tax_rate.updated', 'terminal.reader.action_failed', 'terminal.reader.action_succeeded', 'terminal.reader.action_updated', 'test_helpers.test_clock.advancing', 'test_helpers.test_clock.created', 'test_helpers.test_clock.deleted', 'test_helpers.test_clock.internal_failure', 'test_helpers.test_clock.ready', 'topup.canceled', 'topup.created', 'topup.failed', 'topup.reversed', 'topup.succeeded', 'transfer.created', 'transfer.reversed', 'transfer.updated', 'treasury.credit_reversal.created', 'treasury.credit_reversal.posted', 'treasury.debit_reversal.completed', 'treasury.debit_reversal.created', 'treasury.debit_reversal.initial_credit_granted', 'treasury.financial_account.closed', 'treasury.financial_account.created', 'treasury.financial_account.features_status_updated', 'treasury.inbound_transfer.canceled', 'treasury.inbound_transfer.created', 'treasury.inbound_transfer.failed', 'treasury.inbound_transfer.succeeded', 'treasury.outbound_payment.canceled', 'treasury.outbound_payment.created', 'treasury.outbound_payment.expected_arrival_date_updated', 'treasury.outbound_payment.failed', 'treasury.outbound_payment.posted', 'treasury.outbound_payment.returned', 'treasury.outbound_transfer.canceled', 'treasury.outbound_transfer.created', 'treasury.outbound_transfer.expected_arrival_date_updated', 'treasury.outbound_transfer.failed', 'treasury.outbound_transfer.posted', 'treasury.outbound_transfer.returned', 'treasury.received_credit.created', 'treasury.received_credit.failed', 'treasury.received_credit.succeeded', 'treasury.received_debit.created', 'invoiceitem.updated', 'order.created', 'recipient.created', 'recipient.deleted', 'recipient.updated', 'sku.created', 'sku.deleted', 'sku.updated']]" + List[ + Literal[ + "*", + "account.application.authorized", + "account.application.deauthorized", + "account.external_account.created", + "account.external_account.deleted", + "account.external_account.updated", + "account.updated", + "account_notice.created", + "account_notice.updated", + "application_fee.created", + "application_fee.refund.updated", + "application_fee.refunded", + "balance.available", + "billing_portal.configuration.created", + "billing_portal.configuration.updated", + "billing_portal.session.created", + "capability.updated", + "capital.financing_offer.accepted", + "capital.financing_offer.canceled", + "capital.financing_offer.created", + "capital.financing_offer.expired", + "capital.financing_offer.fully_repaid", + "capital.financing_offer.paid_out", + "capital.financing_offer.rejected", + "capital.financing_offer.replacement_created", + "capital.financing_transaction.created", + "cash_balance.funds_available", + "charge.captured", + "charge.dispute.closed", + "charge.dispute.created", + "charge.dispute.funds_reinstated", + "charge.dispute.funds_withdrawn", + "charge.dispute.updated", + "charge.expired", + "charge.failed", + "charge.pending", + "charge.refund.updated", + "charge.refunded", + "charge.succeeded", + "charge.updated", + "checkout.session.async_payment_failed", + "checkout.session.async_payment_succeeded", + "checkout.session.completed", + "checkout.session.expired", + "climate.order.canceled", + "climate.order.created", + "climate.order.delayed", + "climate.order.delivered", + "climate.order.product_substituted", + "climate.product.created", + "climate.product.pricing_updated", + "coupon.created", + "coupon.deleted", + "coupon.updated", + "credit_note.created", + "credit_note.updated", + "credit_note.voided", + "customer.created", + "customer.deleted", + "customer.discount.created", + "customer.discount.deleted", + "customer.discount.updated", + "customer.source.created", + "customer.source.deleted", + "customer.source.expiring", + "customer.source.updated", + "customer.subscription.collection_paused", + "customer.subscription.collection_resumed", + "customer.subscription.created", + "customer.subscription.custom_event", + "customer.subscription.deleted", + "customer.subscription.paused", + "customer.subscription.pending_update_applied", + "customer.subscription.pending_update_expired", + "customer.subscription.resumed", + "customer.subscription.trial_will_end", + "customer.subscription.updated", + "customer.tax_id.created", + "customer.tax_id.deleted", + "customer.tax_id.updated", + "customer.updated", + "customer_cash_balance_transaction.created", + "entitlements.active_entitlement_summary.updated", + "file.created", + "financial_connections.account.created", + "financial_connections.account.deactivated", + "financial_connections.account.disconnected", + "financial_connections.account.reactivated", + "financial_connections.account.refreshed_balance", + "financial_connections.account.refreshed_inferred_balances", + "financial_connections.account.refreshed_ownership", + "financial_connections.account.refreshed_transactions", + "financial_connections.session.updated", + "identity.verification_session.canceled", + "identity.verification_session.created", + "identity.verification_session.processing", + "identity.verification_session.redacted", + "identity.verification_session.requires_input", + "identity.verification_session.verified", + "invoice.created", + "invoice.deleted", + "invoice.finalization_failed", + "invoice.finalized", + "invoice.marked_uncollectible", + "invoice.paid", + "invoice.payment.overpaid", + "invoice.payment_action_required", + "invoice.payment_failed", + "invoice.payment_succeeded", + "invoice.sent", + "invoice.upcoming", + "invoice.updated", + "invoice.voided", + "invoiceitem.created", + "invoiceitem.deleted", + "issuing_authorization.created", + "issuing_authorization.request", + "issuing_authorization.updated", + "issuing_card.created", + "issuing_card.updated", + "issuing_cardholder.created", + "issuing_cardholder.updated", + "issuing_dispute.closed", + "issuing_dispute.created", + "issuing_dispute.funds_reinstated", + "issuing_dispute.submitted", + "issuing_dispute.updated", + "issuing_personalization_design.activated", + "issuing_personalization_design.deactivated", + "issuing_personalization_design.rejected", + "issuing_personalization_design.updated", + "issuing_token.created", + "issuing_token.updated", + "issuing_transaction.created", + "issuing_transaction.updated", + "mandate.updated", + "payment_intent.amount_capturable_updated", + "payment_intent.canceled", + "payment_intent.created", + "payment_intent.partially_funded", + "payment_intent.payment_failed", + "payment_intent.processing", + "payment_intent.requires_action", + "payment_intent.succeeded", + "payment_link.created", + "payment_link.updated", + "payment_method.attached", + "payment_method.automatically_updated", + "payment_method.detached", + "payment_method.updated", + "payout.canceled", + "payout.created", + "payout.failed", + "payout.paid", + "payout.reconciliation_completed", + "payout.updated", + "person.created", + "person.deleted", + "person.updated", + "plan.created", + "plan.deleted", + "plan.updated", + "price.created", + "price.deleted", + "price.updated", + "product.created", + "product.deleted", + "product.updated", + "promotion_code.created", + "promotion_code.updated", + "quote.accept_failed", + "quote.accepted", + "quote.accepting", + "quote.canceled", + "quote.created", + "quote.draft", + "quote.finalized", + "quote.reestimate_failed", + "quote.reestimated", + "quote.stale", + "radar.early_fraud_warning.created", + "radar.early_fraud_warning.updated", + "refund.created", + "refund.updated", + "reporting.report_run.failed", + "reporting.report_run.succeeded", + "reporting.report_type.updated", + "review.closed", + "review.opened", + "setup_intent.canceled", + "setup_intent.created", + "setup_intent.requires_action", + "setup_intent.setup_failed", + "setup_intent.succeeded", + "sigma.scheduled_query_run.created", + "source.canceled", + "source.chargeable", + "source.failed", + "source.mandate_notification", + "source.refund_attributes_required", + "source.transaction.created", + "source.transaction.updated", + "subscription_schedule.aborted", + "subscription_schedule.canceled", + "subscription_schedule.completed", + "subscription_schedule.created", + "subscription_schedule.expiring", + "subscription_schedule.released", + "subscription_schedule.updated", + "tax.form.updated", + "tax.settings.updated", + "tax_rate.created", + "tax_rate.updated", + "terminal.reader.action_failed", + "terminal.reader.action_succeeded", + "terminal.reader.action_updated", + "test_helpers.test_clock.advancing", + "test_helpers.test_clock.created", + "test_helpers.test_clock.deleted", + "test_helpers.test_clock.internal_failure", + "test_helpers.test_clock.ready", + "topup.canceled", + "topup.created", + "topup.failed", + "topup.reversed", + "topup.succeeded", + "transfer.created", + "transfer.reversed", + "transfer.updated", + "treasury.credit_reversal.created", + "treasury.credit_reversal.posted", + "treasury.debit_reversal.completed", + "treasury.debit_reversal.created", + "treasury.debit_reversal.initial_credit_granted", + "treasury.financial_account.closed", + "treasury.financial_account.created", + "treasury.financial_account.features_status_updated", + "treasury.inbound_transfer.canceled", + "treasury.inbound_transfer.created", + "treasury.inbound_transfer.failed", + "treasury.inbound_transfer.succeeded", + "treasury.outbound_payment.canceled", + "treasury.outbound_payment.created", + "treasury.outbound_payment.expected_arrival_date_updated", + "treasury.outbound_payment.failed", + "treasury.outbound_payment.posted", + "treasury.outbound_payment.returned", + "treasury.outbound_transfer.canceled", + "treasury.outbound_transfer.created", + "treasury.outbound_transfer.expected_arrival_date_updated", + "treasury.outbound_transfer.failed", + "treasury.outbound_transfer.posted", + "treasury.outbound_transfer.returned", + "treasury.received_credit.created", + "treasury.received_credit.failed", + "treasury.received_credit.succeeded", + "treasury.received_debit.created", + "invoiceitem.updated", + "order.created", + "recipient.created", + "recipient.deleted", + "recipient.updated", + "sku.created", + "sku.deleted", + "sku.updated", + ] + ] ] """ The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -373,13 +742,13 @@ class ModifyParams(RequestOptions): """ 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`. """ - url: NotRequired["str"] + url: NotRequired[str] """ The URL of the webhook endpoint. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/_webhook_endpoint_service.py b/stripe/_webhook_endpoint_service.py index cea27fc6e..05cfebc61 100644 --- a/stripe/_webhook_endpoint_service.py +++ b/stripe/_webhook_endpoint_service.py @@ -12,12 +12,113 @@ class WebhookEndpointService(StripeService): class CreateParams(TypedDict): api_version: NotRequired[ - "Literal['2011-01-01', '2011-06-21', '2011-06-28', '2011-08-01', '2011-09-15', '2011-11-17', '2012-02-23', '2012-03-25', '2012-06-18', '2012-06-28', '2012-07-09', '2012-09-24', '2012-10-26', '2012-11-07', '2013-02-11', '2013-02-13', '2013-07-05', '2013-08-12', '2013-08-13', '2013-10-29', '2013-12-03', '2014-01-31', '2014-03-13', '2014-03-28', '2014-05-19', '2014-06-13', '2014-06-17', '2014-07-22', '2014-07-26', '2014-08-04', '2014-08-20', '2014-09-08', '2014-10-07', '2014-11-05', '2014-11-20', '2014-12-08', '2014-12-17', '2014-12-22', '2015-01-11', '2015-01-26', '2015-02-10', '2015-02-16', '2015-02-18', '2015-03-24', '2015-04-07', '2015-06-15', '2015-07-07', '2015-07-13', '2015-07-28', '2015-08-07', '2015-08-19', '2015-09-03', '2015-09-08', '2015-09-23', '2015-10-01', '2015-10-12', '2015-10-16', '2016-02-03', '2016-02-19', '2016-02-22', '2016-02-23', '2016-02-29', '2016-03-07', '2016-06-15', '2016-07-06', '2016-10-19', '2017-01-27', '2017-02-14', '2017-04-06', '2017-05-25', '2017-06-05', '2017-08-15', '2017-12-14', '2018-01-23', '2018-02-05', '2018-02-06', '2018-02-28', '2018-05-21', '2018-07-27', '2018-08-23', '2018-09-06', '2018-09-24', '2018-10-31', '2018-11-08', '2019-02-11', '2019-02-19', '2019-03-14', '2019-05-16', '2019-08-14', '2019-09-09', '2019-10-08', '2019-10-17', '2019-11-05', '2019-12-03', '2020-03-02', '2020-08-27', '2022-08-01', '2022-11-15', '2023-08-16', '2023-10-16']" + Literal[ + "2011-01-01", + "2011-06-21", + "2011-06-28", + "2011-08-01", + "2011-09-15", + "2011-11-17", + "2012-02-23", + "2012-03-25", + "2012-06-18", + "2012-06-28", + "2012-07-09", + "2012-09-24", + "2012-10-26", + "2012-11-07", + "2013-02-11", + "2013-02-13", + "2013-07-05", + "2013-08-12", + "2013-08-13", + "2013-10-29", + "2013-12-03", + "2014-01-31", + "2014-03-13", + "2014-03-28", + "2014-05-19", + "2014-06-13", + "2014-06-17", + "2014-07-22", + "2014-07-26", + "2014-08-04", + "2014-08-20", + "2014-09-08", + "2014-10-07", + "2014-11-05", + "2014-11-20", + "2014-12-08", + "2014-12-17", + "2014-12-22", + "2015-01-11", + "2015-01-26", + "2015-02-10", + "2015-02-16", + "2015-02-18", + "2015-03-24", + "2015-04-07", + "2015-06-15", + "2015-07-07", + "2015-07-13", + "2015-07-28", + "2015-08-07", + "2015-08-19", + "2015-09-03", + "2015-09-08", + "2015-09-23", + "2015-10-01", + "2015-10-12", + "2015-10-16", + "2016-02-03", + "2016-02-19", + "2016-02-22", + "2016-02-23", + "2016-02-29", + "2016-03-07", + "2016-06-15", + "2016-07-06", + "2016-10-19", + "2017-01-27", + "2017-02-14", + "2017-04-06", + "2017-05-25", + "2017-06-05", + "2017-08-15", + "2017-12-14", + "2018-01-23", + "2018-02-05", + "2018-02-06", + "2018-02-28", + "2018-05-21", + "2018-07-27", + "2018-08-23", + "2018-09-06", + "2018-09-24", + "2018-10-31", + "2018-11-08", + "2019-02-11", + "2019-02-19", + "2019-03-14", + "2019-05-16", + "2019-08-14", + "2019-09-09", + "2019-10-08", + "2019-10-17", + "2019-11-05", + "2019-12-03", + "2020-03-02", + "2020-08-27", + "2022-08-01", + "2022-11-15", + "2023-08-16", + "2023-10-16", + ] ] """ Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version. """ - connect: NotRequired["bool"] + connect: NotRequired[bool] """ Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`. """ @@ -297,7 +398,7 @@ class CreateParams(TypedDict): """ The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -314,25 +415,25 @@ class DeleteParams(TypedDict): pass class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -342,17 +443,285 @@ class UpdateParams(TypedDict): """ An optional description of what the webhook is used for. """ - disabled: NotRequired["bool"] + disabled: NotRequired[bool] """ Disable the webhook endpoint if set to true. """ enabled_events: NotRequired[ - "List[Literal['*', 'account.application.authorized', 'account.application.deauthorized', 'account.external_account.created', 'account.external_account.deleted', 'account.external_account.updated', 'account.updated', 'account_notice.created', 'account_notice.updated', 'application_fee.created', 'application_fee.refund.updated', 'application_fee.refunded', 'balance.available', 'billing_portal.configuration.created', 'billing_portal.configuration.updated', 'billing_portal.session.created', 'capability.updated', 'capital.financing_offer.accepted', 'capital.financing_offer.canceled', 'capital.financing_offer.created', 'capital.financing_offer.expired', 'capital.financing_offer.fully_repaid', 'capital.financing_offer.paid_out', 'capital.financing_offer.rejected', 'capital.financing_offer.replacement_created', 'capital.financing_transaction.created', 'cash_balance.funds_available', 'charge.captured', 'charge.dispute.closed', 'charge.dispute.created', 'charge.dispute.funds_reinstated', 'charge.dispute.funds_withdrawn', 'charge.dispute.updated', 'charge.expired', 'charge.failed', 'charge.pending', 'charge.refund.updated', 'charge.refunded', 'charge.succeeded', 'charge.updated', 'checkout.session.async_payment_failed', 'checkout.session.async_payment_succeeded', 'checkout.session.completed', 'checkout.session.expired', 'climate.order.canceled', 'climate.order.created', 'climate.order.delayed', 'climate.order.delivered', 'climate.order.product_substituted', 'climate.product.created', 'climate.product.pricing_updated', 'coupon.created', 'coupon.deleted', 'coupon.updated', 'credit_note.created', 'credit_note.updated', 'credit_note.voided', 'customer.created', 'customer.deleted', 'customer.discount.created', 'customer.discount.deleted', 'customer.discount.updated', 'customer.source.created', 'customer.source.deleted', 'customer.source.expiring', 'customer.source.updated', 'customer.subscription.collection_paused', 'customer.subscription.collection_resumed', 'customer.subscription.created', 'customer.subscription.custom_event', 'customer.subscription.deleted', 'customer.subscription.paused', 'customer.subscription.pending_update_applied', 'customer.subscription.pending_update_expired', 'customer.subscription.resumed', 'customer.subscription.trial_will_end', 'customer.subscription.updated', 'customer.tax_id.created', 'customer.tax_id.deleted', 'customer.tax_id.updated', 'customer.updated', 'customer_cash_balance_transaction.created', 'entitlements.active_entitlement_summary.updated', 'file.created', 'financial_connections.account.created', 'financial_connections.account.deactivated', 'financial_connections.account.disconnected', 'financial_connections.account.reactivated', 'financial_connections.account.refreshed_balance', 'financial_connections.account.refreshed_inferred_balances', 'financial_connections.account.refreshed_ownership', 'financial_connections.account.refreshed_transactions', 'financial_connections.session.updated', 'identity.verification_session.canceled', 'identity.verification_session.created', 'identity.verification_session.processing', 'identity.verification_session.redacted', 'identity.verification_session.requires_input', 'identity.verification_session.verified', 'invoice.created', 'invoice.deleted', 'invoice.finalization_failed', 'invoice.finalized', 'invoice.marked_uncollectible', 'invoice.paid', 'invoice.payment.overpaid', 'invoice.payment_action_required', 'invoice.payment_failed', 'invoice.payment_succeeded', 'invoice.sent', 'invoice.upcoming', 'invoice.updated', 'invoice.voided', 'invoiceitem.created', 'invoiceitem.deleted', 'issuing_authorization.created', 'issuing_authorization.request', 'issuing_authorization.updated', 'issuing_card.created', 'issuing_card.updated', 'issuing_cardholder.created', 'issuing_cardholder.updated', 'issuing_dispute.closed', 'issuing_dispute.created', 'issuing_dispute.funds_reinstated', 'issuing_dispute.submitted', 'issuing_dispute.updated', 'issuing_personalization_design.activated', 'issuing_personalization_design.deactivated', 'issuing_personalization_design.rejected', 'issuing_personalization_design.updated', 'issuing_token.created', 'issuing_token.updated', 'issuing_transaction.created', 'issuing_transaction.updated', 'mandate.updated', 'payment_intent.amount_capturable_updated', 'payment_intent.canceled', 'payment_intent.created', 'payment_intent.partially_funded', 'payment_intent.payment_failed', 'payment_intent.processing', 'payment_intent.requires_action', 'payment_intent.succeeded', 'payment_link.created', 'payment_link.updated', 'payment_method.attached', 'payment_method.automatically_updated', 'payment_method.detached', 'payment_method.updated', 'payout.canceled', 'payout.created', 'payout.failed', 'payout.paid', 'payout.reconciliation_completed', 'payout.updated', 'person.created', 'person.deleted', 'person.updated', 'plan.created', 'plan.deleted', 'plan.updated', 'price.created', 'price.deleted', 'price.updated', 'product.created', 'product.deleted', 'product.updated', 'promotion_code.created', 'promotion_code.updated', 'quote.accept_failed', 'quote.accepted', 'quote.accepting', 'quote.canceled', 'quote.created', 'quote.draft', 'quote.finalized', 'quote.reestimate_failed', 'quote.reestimated', 'quote.stale', 'radar.early_fraud_warning.created', 'radar.early_fraud_warning.updated', 'refund.created', 'refund.updated', 'reporting.report_run.failed', 'reporting.report_run.succeeded', 'reporting.report_type.updated', 'review.closed', 'review.opened', 'setup_intent.canceled', 'setup_intent.created', 'setup_intent.requires_action', 'setup_intent.setup_failed', 'setup_intent.succeeded', 'sigma.scheduled_query_run.created', 'source.canceled', 'source.chargeable', 'source.failed', 'source.mandate_notification', 'source.refund_attributes_required', 'source.transaction.created', 'source.transaction.updated', 'subscription_schedule.aborted', 'subscription_schedule.canceled', 'subscription_schedule.completed', 'subscription_schedule.created', 'subscription_schedule.expiring', 'subscription_schedule.released', 'subscription_schedule.updated', 'tax.form.updated', 'tax.settings.updated', 'tax_rate.created', 'tax_rate.updated', 'terminal.reader.action_failed', 'terminal.reader.action_succeeded', 'terminal.reader.action_updated', 'test_helpers.test_clock.advancing', 'test_helpers.test_clock.created', 'test_helpers.test_clock.deleted', 'test_helpers.test_clock.internal_failure', 'test_helpers.test_clock.ready', 'topup.canceled', 'topup.created', 'topup.failed', 'topup.reversed', 'topup.succeeded', 'transfer.created', 'transfer.reversed', 'transfer.updated', 'treasury.credit_reversal.created', 'treasury.credit_reversal.posted', 'treasury.debit_reversal.completed', 'treasury.debit_reversal.created', 'treasury.debit_reversal.initial_credit_granted', 'treasury.financial_account.closed', 'treasury.financial_account.created', 'treasury.financial_account.features_status_updated', 'treasury.inbound_transfer.canceled', 'treasury.inbound_transfer.created', 'treasury.inbound_transfer.failed', 'treasury.inbound_transfer.succeeded', 'treasury.outbound_payment.canceled', 'treasury.outbound_payment.created', 'treasury.outbound_payment.expected_arrival_date_updated', 'treasury.outbound_payment.failed', 'treasury.outbound_payment.posted', 'treasury.outbound_payment.returned', 'treasury.outbound_transfer.canceled', 'treasury.outbound_transfer.created', 'treasury.outbound_transfer.expected_arrival_date_updated', 'treasury.outbound_transfer.failed', 'treasury.outbound_transfer.posted', 'treasury.outbound_transfer.returned', 'treasury.received_credit.created', 'treasury.received_credit.failed', 'treasury.received_credit.succeeded', 'treasury.received_debit.created', 'invoiceitem.updated', 'order.created', 'recipient.created', 'recipient.deleted', 'recipient.updated', 'sku.created', 'sku.deleted', 'sku.updated']]" + List[ + Literal[ + "*", + "account.application.authorized", + "account.application.deauthorized", + "account.external_account.created", + "account.external_account.deleted", + "account.external_account.updated", + "account.updated", + "account_notice.created", + "account_notice.updated", + "application_fee.created", + "application_fee.refund.updated", + "application_fee.refunded", + "balance.available", + "billing_portal.configuration.created", + "billing_portal.configuration.updated", + "billing_portal.session.created", + "capability.updated", + "capital.financing_offer.accepted", + "capital.financing_offer.canceled", + "capital.financing_offer.created", + "capital.financing_offer.expired", + "capital.financing_offer.fully_repaid", + "capital.financing_offer.paid_out", + "capital.financing_offer.rejected", + "capital.financing_offer.replacement_created", + "capital.financing_transaction.created", + "cash_balance.funds_available", + "charge.captured", + "charge.dispute.closed", + "charge.dispute.created", + "charge.dispute.funds_reinstated", + "charge.dispute.funds_withdrawn", + "charge.dispute.updated", + "charge.expired", + "charge.failed", + "charge.pending", + "charge.refund.updated", + "charge.refunded", + "charge.succeeded", + "charge.updated", + "checkout.session.async_payment_failed", + "checkout.session.async_payment_succeeded", + "checkout.session.completed", + "checkout.session.expired", + "climate.order.canceled", + "climate.order.created", + "climate.order.delayed", + "climate.order.delivered", + "climate.order.product_substituted", + "climate.product.created", + "climate.product.pricing_updated", + "coupon.created", + "coupon.deleted", + "coupon.updated", + "credit_note.created", + "credit_note.updated", + "credit_note.voided", + "customer.created", + "customer.deleted", + "customer.discount.created", + "customer.discount.deleted", + "customer.discount.updated", + "customer.source.created", + "customer.source.deleted", + "customer.source.expiring", + "customer.source.updated", + "customer.subscription.collection_paused", + "customer.subscription.collection_resumed", + "customer.subscription.created", + "customer.subscription.custom_event", + "customer.subscription.deleted", + "customer.subscription.paused", + "customer.subscription.pending_update_applied", + "customer.subscription.pending_update_expired", + "customer.subscription.resumed", + "customer.subscription.trial_will_end", + "customer.subscription.updated", + "customer.tax_id.created", + "customer.tax_id.deleted", + "customer.tax_id.updated", + "customer.updated", + "customer_cash_balance_transaction.created", + "entitlements.active_entitlement_summary.updated", + "file.created", + "financial_connections.account.created", + "financial_connections.account.deactivated", + "financial_connections.account.disconnected", + "financial_connections.account.reactivated", + "financial_connections.account.refreshed_balance", + "financial_connections.account.refreshed_inferred_balances", + "financial_connections.account.refreshed_ownership", + "financial_connections.account.refreshed_transactions", + "financial_connections.session.updated", + "identity.verification_session.canceled", + "identity.verification_session.created", + "identity.verification_session.processing", + "identity.verification_session.redacted", + "identity.verification_session.requires_input", + "identity.verification_session.verified", + "invoice.created", + "invoice.deleted", + "invoice.finalization_failed", + "invoice.finalized", + "invoice.marked_uncollectible", + "invoice.paid", + "invoice.payment.overpaid", + "invoice.payment_action_required", + "invoice.payment_failed", + "invoice.payment_succeeded", + "invoice.sent", + "invoice.upcoming", + "invoice.updated", + "invoice.voided", + "invoiceitem.created", + "invoiceitem.deleted", + "issuing_authorization.created", + "issuing_authorization.request", + "issuing_authorization.updated", + "issuing_card.created", + "issuing_card.updated", + "issuing_cardholder.created", + "issuing_cardholder.updated", + "issuing_dispute.closed", + "issuing_dispute.created", + "issuing_dispute.funds_reinstated", + "issuing_dispute.submitted", + "issuing_dispute.updated", + "issuing_personalization_design.activated", + "issuing_personalization_design.deactivated", + "issuing_personalization_design.rejected", + "issuing_personalization_design.updated", + "issuing_token.created", + "issuing_token.updated", + "issuing_transaction.created", + "issuing_transaction.updated", + "mandate.updated", + "payment_intent.amount_capturable_updated", + "payment_intent.canceled", + "payment_intent.created", + "payment_intent.partially_funded", + "payment_intent.payment_failed", + "payment_intent.processing", + "payment_intent.requires_action", + "payment_intent.succeeded", + "payment_link.created", + "payment_link.updated", + "payment_method.attached", + "payment_method.automatically_updated", + "payment_method.detached", + "payment_method.updated", + "payout.canceled", + "payout.created", + "payout.failed", + "payout.paid", + "payout.reconciliation_completed", + "payout.updated", + "person.created", + "person.deleted", + "person.updated", + "plan.created", + "plan.deleted", + "plan.updated", + "price.created", + "price.deleted", + "price.updated", + "product.created", + "product.deleted", + "product.updated", + "promotion_code.created", + "promotion_code.updated", + "quote.accept_failed", + "quote.accepted", + "quote.accepting", + "quote.canceled", + "quote.created", + "quote.draft", + "quote.finalized", + "quote.reestimate_failed", + "quote.reestimated", + "quote.stale", + "radar.early_fraud_warning.created", + "radar.early_fraud_warning.updated", + "refund.created", + "refund.updated", + "reporting.report_run.failed", + "reporting.report_run.succeeded", + "reporting.report_type.updated", + "review.closed", + "review.opened", + "setup_intent.canceled", + "setup_intent.created", + "setup_intent.requires_action", + "setup_intent.setup_failed", + "setup_intent.succeeded", + "sigma.scheduled_query_run.created", + "source.canceled", + "source.chargeable", + "source.failed", + "source.mandate_notification", + "source.refund_attributes_required", + "source.transaction.created", + "source.transaction.updated", + "subscription_schedule.aborted", + "subscription_schedule.canceled", + "subscription_schedule.completed", + "subscription_schedule.created", + "subscription_schedule.expiring", + "subscription_schedule.released", + "subscription_schedule.updated", + "tax.form.updated", + "tax.settings.updated", + "tax_rate.created", + "tax_rate.updated", + "terminal.reader.action_failed", + "terminal.reader.action_succeeded", + "terminal.reader.action_updated", + "test_helpers.test_clock.advancing", + "test_helpers.test_clock.created", + "test_helpers.test_clock.deleted", + "test_helpers.test_clock.internal_failure", + "test_helpers.test_clock.ready", + "topup.canceled", + "topup.created", + "topup.failed", + "topup.reversed", + "topup.succeeded", + "transfer.created", + "transfer.reversed", + "transfer.updated", + "treasury.credit_reversal.created", + "treasury.credit_reversal.posted", + "treasury.debit_reversal.completed", + "treasury.debit_reversal.created", + "treasury.debit_reversal.initial_credit_granted", + "treasury.financial_account.closed", + "treasury.financial_account.created", + "treasury.financial_account.features_status_updated", + "treasury.inbound_transfer.canceled", + "treasury.inbound_transfer.created", + "treasury.inbound_transfer.failed", + "treasury.inbound_transfer.succeeded", + "treasury.outbound_payment.canceled", + "treasury.outbound_payment.created", + "treasury.outbound_payment.expected_arrival_date_updated", + "treasury.outbound_payment.failed", + "treasury.outbound_payment.posted", + "treasury.outbound_payment.returned", + "treasury.outbound_transfer.canceled", + "treasury.outbound_transfer.created", + "treasury.outbound_transfer.expected_arrival_date_updated", + "treasury.outbound_transfer.failed", + "treasury.outbound_transfer.posted", + "treasury.outbound_transfer.returned", + "treasury.received_credit.created", + "treasury.received_credit.failed", + "treasury.received_credit.succeeded", + "treasury.received_debit.created", + "invoiceitem.updated", + "order.created", + "recipient.created", + "recipient.deleted", + "recipient.updated", + "sku.created", + "sku.deleted", + "sku.updated", + ] + ] ] """ The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -360,7 +729,7 @@ class UpdateParams(TypedDict): """ 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`. """ - url: NotRequired["str"] + url: NotRequired[str] """ The URL of the webhook endpoint. """ diff --git a/stripe/apps/_secret.py b/stripe/apps/_secret.py index 6102cafc6..39f7ef8e2 100644 --- a/stripe/apps/_secret.py +++ b/stripe/apps/_secret.py @@ -35,11 +35,11 @@ class Scope(StripeObject): """ class CreateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ The Unix timestamp for the expiry time of the secret, after which the secret deletes. """ @@ -61,13 +61,13 @@ class CreateParamsScope(TypedDict): """ The secret scope type. """ - user: NotRequired["str"] + user: NotRequired[str] """ The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`. """ class DeleteWhereParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -85,13 +85,13 @@ class DeleteWhereParamsScope(TypedDict): """ The secret scope type. """ - user: NotRequired["str"] + user: NotRequired[str] """ The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`. """ class FindParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -109,21 +109,21 @@ class FindParamsScope(TypedDict): """ The secret scope type. """ - user: NotRequired["str"] + user: NotRequired[str] """ The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`. """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -131,7 +131,7 @@ class ListParams(RequestOptions): """ Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user. """ - starting_after: NotRequired["str"] + 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. """ @@ -141,7 +141,7 @@ class ListParamsScope(TypedDict): """ The secret scope type. """ - user: NotRequired["str"] + user: NotRequired[str] """ The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`. """ diff --git a/stripe/apps/_secret_service.py b/stripe/apps/_secret_service.py index 4ee181d9a..cdc3b0648 100644 --- a/stripe/apps/_secret_service.py +++ b/stripe/apps/_secret_service.py @@ -10,11 +10,11 @@ class SecretService(StripeService): class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ The Unix timestamp for the expiry time of the secret, after which the secret deletes. """ @@ -36,13 +36,13 @@ class CreateParamsScope(TypedDict): """ The secret scope type. """ - user: NotRequired["str"] + user: NotRequired[str] """ The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`. """ class DeleteWhereParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -60,13 +60,13 @@ class DeleteWhereParamsScope(TypedDict): """ The secret scope type. """ - user: NotRequired["str"] + user: NotRequired[str] """ The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`. """ class FindParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -84,21 +84,21 @@ class FindParamsScope(TypedDict): """ The secret scope type. """ - user: NotRequired["str"] + user: NotRequired[str] """ The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`. """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -106,7 +106,7 @@ class ListParams(TypedDict): """ Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user. """ - starting_after: NotRequired["str"] + 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. """ @@ -116,7 +116,7 @@ class ListParamsScope(TypedDict): """ The secret scope type. """ - user: NotRequired["str"] + user: NotRequired[str] """ The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`. """ diff --git a/stripe/billing/_meter.py b/stripe/billing/_meter.py index 52f199f4e..198797d8e 100644 --- a/stripe/billing/_meter.py +++ b/stripe/billing/_meter.py @@ -78,11 +78,11 @@ class CreateParams(RequestOptions): """ The name of the usage event to record usage for. Corresponds with the `event_name` field on usage events. """ - event_time_window: NotRequired["Literal['day', 'hour']"] + event_time_window: NotRequired[Literal["day", "hour"]] """ The time window to pre-aggregate usage events for, if any. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -114,7 +114,7 @@ class CreateParamsValueSettings(TypedDict): """ class DeactivateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -128,15 +128,15 @@ class ListEventSummariesParams(RequestOptions): """ The timestamp from when to stop aggregating usage events (exclusive). """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -144,55 +144,55 @@ class ListEventSummariesParams(RequestOptions): """ The timestamp from when to start aggregating usage events (inclusive). """ - starting_after: NotRequired["str"] + 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. """ - value_grouping_window: NotRequired["Literal['hour']"] + value_grouping_window: NotRequired[Literal["hour"]] """ Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - status: NotRequired["Literal['active', 'inactive']"] + status: NotRequired[Literal["active", "inactive"]] """ Filter results to only include meters with the given status. """ class ModifyParams(RequestOptions): - display_name: NotRequired["str"] + display_name: NotRequired[str] """ The meter's name. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ReactivateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/billing/_meter_event.py b/stripe/billing/_meter_event.py index 5d62c837a..cba844046 100644 --- a/stripe/billing/_meter_event.py +++ b/stripe/billing/_meter_event.py @@ -21,11 +21,11 @@ class CreateParams(RequestOptions): """ The name of the meter event. Corresponds with the `event_name` field on a meter. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - identifier: NotRequired["str"] + identifier: NotRequired[str] """ A unique identifier for the event. If not provided, one will be generated. """ diff --git a/stripe/billing/_meter_event_adjustment.py b/stripe/billing/_meter_event_adjustment.py index f33474f8e..b4c0d41e5 100644 --- a/stripe/billing/_meter_event_adjustment.py +++ b/stripe/billing/_meter_event_adjustment.py @@ -20,11 +20,11 @@ class CreateParams(RequestOptions): """ Specifies which event to cancel. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - type: NotRequired["Literal['cancel']"] + type: NotRequired[Literal["cancel"]] """ Specifies whether to cancel a single event or a range of events for a time period. """ diff --git a/stripe/billing/_meter_event_adjustment_service.py b/stripe/billing/_meter_event_adjustment_service.py index c4187d7ba..04eeea52e 100644 --- a/stripe/billing/_meter_event_adjustment_service.py +++ b/stripe/billing/_meter_event_adjustment_service.py @@ -13,11 +13,11 @@ class CreateParams(TypedDict): """ Specifies which event to cancel. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - type: NotRequired["Literal['cancel']"] + type: NotRequired[Literal["cancel"]] """ Specifies whether to cancel a single event or a range of events for a time period. """ diff --git a/stripe/billing/_meter_event_service.py b/stripe/billing/_meter_event_service.py index 809c8745a..ab1161a73 100644 --- a/stripe/billing/_meter_event_service.py +++ b/stripe/billing/_meter_event_service.py @@ -13,11 +13,11 @@ class CreateParams(TypedDict): """ The name of the meter event. Corresponds with the `event_name` field on a meter. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - identifier: NotRequired["str"] + identifier: NotRequired[str] """ A unique identifier for the event. If not provided, one will be generated. """ diff --git a/stripe/billing/_meter_event_summary_service.py b/stripe/billing/_meter_event_summary_service.py index 29c18f6b5..df51cd62f 100644 --- a/stripe/billing/_meter_event_summary_service.py +++ b/stripe/billing/_meter_event_summary_service.py @@ -19,15 +19,15 @@ class ListParams(TypedDict): """ The timestamp from when to stop aggregating usage events (exclusive). """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -35,11 +35,11 @@ class ListParams(TypedDict): """ The timestamp from when to start aggregating usage events (inclusive). """ - starting_after: NotRequired["str"] + 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. """ - value_grouping_window: NotRequired["Literal['hour']"] + value_grouping_window: NotRequired[Literal["hour"]] """ Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. """ diff --git a/stripe/billing/_meter_service.py b/stripe/billing/_meter_service.py index 9d90e78b6..ca27d84d6 100644 --- a/stripe/billing/_meter_service.py +++ b/stripe/billing/_meter_service.py @@ -36,11 +36,11 @@ class CreateParams(TypedDict): """ The name of the usage event to record usage for. Corresponds with the `event_name` field on usage events. """ - event_time_window: NotRequired["Literal['day', 'hour']"] + event_time_window: NotRequired[Literal["day", "hour"]] """ The time window to pre-aggregate usage events for, if any. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -72,51 +72,51 @@ class CreateParamsValueSettings(TypedDict): """ class DeactivateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - status: NotRequired["Literal['active', 'inactive']"] + status: NotRequired[Literal["active", "inactive"]] """ Filter results to only include meters with the given status. """ class ReactivateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - display_name: NotRequired["str"] + display_name: NotRequired[str] """ The meter's name. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/billing_portal/_configuration.py b/stripe/billing_portal/_configuration.py index 8da85854b..32f695c8c 100644 --- a/stripe/billing_portal/_configuration.py +++ b/stripe/billing_portal/_configuration.py @@ -189,7 +189,7 @@ class CreateParams(RequestOptions): """ The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -201,7 +201,7 @@ class CreateParams(RequestOptions): """ The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share). """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -211,11 +211,11 @@ class CreateParamsBusinessProfile(TypedDict): """ The messaging shown to customers in the portal. """ - privacy_policy_url: NotRequired["str"] + privacy_policy_url: NotRequired[str] """ A link to the business's publicly available privacy policy. """ - terms_of_service_url: NotRequired["str"] + terms_of_service_url: NotRequired[str] """ A link to the business's publicly available terms of service. """ @@ -293,12 +293,12 @@ class CreateParamsFeaturesSubscriptionCancel(TypedDict): """ Whether the feature is enabled. """ - mode: NotRequired["Literal['at_period_end', 'immediately']"] + mode: NotRequired[Literal["at_period_end", "immediately"]] """ Whether to cancel subscriptions immediately or at the end of the billing period. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. No prorations are generated when canceling a subscription at the end of its natural billing period. @@ -329,7 +329,7 @@ class CreateParamsFeaturesSubscriptionCancelCancellationReason(TypedDict): """ class CreateParamsFeaturesSubscriptionPause(TypedDict): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Whether the feature is enabled. """ @@ -355,7 +355,7 @@ class CreateParamsFeaturesSubscriptionUpdate(TypedDict): The list of up to 10 products that support subscription updates. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. @@ -378,33 +378,33 @@ class CreateParamsLoginPage(TypedDict): """ class ListParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations). """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - is_default: NotRequired["bool"] + is_default: NotRequired[bool] """ Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration). """ - limit: NotRequired["int"] + 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"] + 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): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the configuration is active and can be used to create portal sessions. """ @@ -418,7 +418,7 @@ class ModifyParams(RequestOptions): """ The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -494,7 +494,7 @@ class ModifyParamsFeaturesCustomerUpdate(TypedDict): """ The types of customer updates that are supported. When empty, customers are not updateable. """ - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Whether the feature is enabled. """ @@ -518,16 +518,16 @@ class ModifyParamsFeaturesSubscriptionCancel(TypedDict): """ Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer """ - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Whether the feature is enabled. """ - mode: NotRequired["Literal['at_period_end', 'immediately']"] + mode: NotRequired[Literal["at_period_end", "immediately"]] """ Whether to cancel subscriptions immediately or at the end of the billing period. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. No prorations are generated when canceling a subscription at the end of its natural billing period. @@ -546,7 +546,7 @@ class ModifyParamsFeaturesSubscriptionCancelCancellationReason(TypedDict): """ class ModifyParamsFeaturesSubscriptionPause(TypedDict): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Whether the feature is enabled. """ @@ -558,7 +558,7 @@ class ModifyParamsFeaturesSubscriptionUpdate(TypedDict): """ The types of subscription updates that are supported. When empty, subscriptions are not updateable. """ - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Whether the feature is enabled. """ @@ -569,7 +569,7 @@ class ModifyParamsFeaturesSubscriptionUpdate(TypedDict): The list of up to 10 products that support subscription updates. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. @@ -594,7 +594,7 @@ class ModifyParamsLoginPage(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/billing_portal/_configuration_service.py b/stripe/billing_portal/_configuration_service.py index 7188663a8..61ba49b22 100644 --- a/stripe/billing_portal/_configuration_service.py +++ b/stripe/billing_portal/_configuration_service.py @@ -19,7 +19,7 @@ class CreateParams(TypedDict): """ The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -31,7 +31,7 @@ class CreateParams(TypedDict): """ The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share). """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -41,11 +41,11 @@ class CreateParamsBusinessProfile(TypedDict): """ The messaging shown to customers in the portal. """ - privacy_policy_url: NotRequired["str"] + privacy_policy_url: NotRequired[str] """ A link to the business's publicly available privacy policy. """ - terms_of_service_url: NotRequired["str"] + terms_of_service_url: NotRequired[str] """ A link to the business's publicly available terms of service. """ @@ -123,12 +123,12 @@ class CreateParamsFeaturesSubscriptionCancel(TypedDict): """ Whether the feature is enabled. """ - mode: NotRequired["Literal['at_period_end', 'immediately']"] + mode: NotRequired[Literal["at_period_end", "immediately"]] """ Whether to cancel subscriptions immediately or at the end of the billing period. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. No prorations are generated when canceling a subscription at the end of its natural billing period. @@ -159,7 +159,7 @@ class CreateParamsFeaturesSubscriptionCancelCancellationReason(TypedDict): """ class CreateParamsFeaturesSubscriptionPause(TypedDict): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Whether the feature is enabled. """ @@ -185,7 +185,7 @@ class CreateParamsFeaturesSubscriptionUpdate(TypedDict): The list of up to 10 products that support subscription updates. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. @@ -208,39 +208,39 @@ class CreateParamsLoginPage(TypedDict): """ class ListParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations). """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - is_default: NotRequired["bool"] + is_default: NotRequired[bool] """ Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration). """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ Whether the configuration is active and can be used to create portal sessions. """ @@ -254,7 +254,7 @@ class UpdateParams(TypedDict): """ The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -330,7 +330,7 @@ class UpdateParamsFeaturesCustomerUpdate(TypedDict): """ The types of customer updates that are supported. When empty, customers are not updateable. """ - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Whether the feature is enabled. """ @@ -354,16 +354,16 @@ class UpdateParamsFeaturesSubscriptionCancel(TypedDict): """ Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer """ - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Whether the feature is enabled. """ - mode: NotRequired["Literal['at_period_end', 'immediately']"] + mode: NotRequired[Literal["at_period_end", "immediately"]] """ Whether to cancel subscriptions immediately or at the end of the billing period. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. No prorations are generated when canceling a subscription at the end of its natural billing period. @@ -382,7 +382,7 @@ class UpdateParamsFeaturesSubscriptionCancelCancellationReason(TypedDict): """ class UpdateParamsFeaturesSubscriptionPause(TypedDict): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Whether the feature is enabled. """ @@ -394,7 +394,7 @@ class UpdateParamsFeaturesSubscriptionUpdate(TypedDict): """ The types of subscription updates that are supported. When empty, subscriptions are not updateable. """ - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Whether the feature is enabled. """ @@ -405,7 +405,7 @@ class UpdateParamsFeaturesSubscriptionUpdate(TypedDict): The list of up to 10 products that support subscription updates. """ proration_behavior: NotRequired[ - "Literal['always_invoice', 'create_prorations', 'none']" + Literal["always_invoice", "create_prorations", "none"] ] """ Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. diff --git a/stripe/billing_portal/_session.py b/stripe/billing_portal/_session.py index 5c3d3cd97..201ac449c 100644 --- a/stripe/billing_portal/_session.py +++ b/stripe/billing_portal/_session.py @@ -173,7 +173,7 @@ class Item(StripeObject): } class CreateParams(RequestOptions): - configuration: NotRequired["str"] + configuration: NotRequired[str] """ The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. """ @@ -181,7 +181,7 @@ class CreateParams(RequestOptions): """ The ID of an existing customer. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -190,16 +190,64 @@ class CreateParams(RequestOptions): Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. """ locale: NotRequired[ - "Literal['auto', 'bg', 'cs', 'da', 'de', 'el', 'en', 'en-AU', 'en-CA', 'en-GB', 'en-IE', 'en-IN', 'en-NZ', 'en-SG', 'es', 'es-419', 'et', 'fi', 'fil', 'fr', 'fr-CA', 'hr', 'hu', 'id', 'it', 'ja', 'ko', 'lt', 'lv', 'ms', 'mt', 'nb', 'nl', 'pl', 'pt', 'pt-BR', 'ro', 'ru', 'sk', 'sl', 'sv', 'th', 'tr', 'vi', 'zh', 'zh-HK', 'zh-TW']" + Literal[ + "auto", + "bg", + "cs", + "da", + "de", + "el", + "en", + "en-AU", + "en-CA", + "en-GB", + "en-IE", + "en-IN", + "en-NZ", + "en-SG", + "es", + "es-419", + "et", + "fi", + "fil", + "fr", + "fr-CA", + "hr", + "hu", + "id", + "it", + "ja", + "ko", + "lt", + "lv", + "ms", + "mt", + "nb", + "nl", + "pl", + "pt", + "pt-BR", + "ro", + "ru", + "sk", + "sl", + "sv", + "th", + "tr", + "vi", + "zh", + "zh-HK", + "zh-TW", + ] ] """ The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer's `preferred_locales` or browser's locale is used. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The default URL to redirect customers to when they click on the portal's link to return to your website. """ @@ -258,7 +306,7 @@ class CreateParamsFlowDataAfterCompletion(TypedDict): """ class CreateParamsFlowDataAfterCompletionHostedConfirmation(TypedDict): - custom_message: NotRequired["str"] + custom_message: NotRequired[str] """ A custom message to display to the customer after the flow is completed. """ @@ -307,7 +355,9 @@ class CreateParamsFlowDataSubscriptionUpdate(TypedDict): class CreateParamsFlowDataSubscriptionUpdateConfirm(TypedDict): discounts: NotRequired[ - "List[Session.CreateParamsFlowDataSubscriptionUpdateConfirmDiscount]" + List[ + "Session.CreateParamsFlowDataSubscriptionUpdateConfirmDiscount" + ] ] """ The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified. @@ -324,11 +374,11 @@ class CreateParamsFlowDataSubscriptionUpdateConfirm(TypedDict): """ class CreateParamsFlowDataSubscriptionUpdateConfirmDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The ID of the coupon to apply to this subscription update. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to apply to this subscription update. """ @@ -338,11 +388,11 @@ class CreateParamsFlowDataSubscriptionUpdateConfirmItem(TypedDict): """ The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated. """ - price: NotRequired["str"] + price: NotRequired[str] """ The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow. """ diff --git a/stripe/billing_portal/_session_service.py b/stripe/billing_portal/_session_service.py index d1eb42fff..ef745d0a7 100644 --- a/stripe/billing_portal/_session_service.py +++ b/stripe/billing_portal/_session_service.py @@ -9,7 +9,7 @@ class SessionService(StripeService): class CreateParams(TypedDict): - configuration: NotRequired["str"] + configuration: NotRequired[str] """ The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. """ @@ -17,7 +17,7 @@ class CreateParams(TypedDict): """ The ID of an existing customer. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -26,16 +26,64 @@ class CreateParams(TypedDict): Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. """ locale: NotRequired[ - "Literal['auto', 'bg', 'cs', 'da', 'de', 'el', 'en', 'en-AU', 'en-CA', 'en-GB', 'en-IE', 'en-IN', 'en-NZ', 'en-SG', 'es', 'es-419', 'et', 'fi', 'fil', 'fr', 'fr-CA', 'hr', 'hu', 'id', 'it', 'ja', 'ko', 'lt', 'lv', 'ms', 'mt', 'nb', 'nl', 'pl', 'pt', 'pt-BR', 'ro', 'ru', 'sk', 'sl', 'sv', 'th', 'tr', 'vi', 'zh', 'zh-HK', 'zh-TW']" + Literal[ + "auto", + "bg", + "cs", + "da", + "de", + "el", + "en", + "en-AU", + "en-CA", + "en-GB", + "en-IE", + "en-IN", + "en-NZ", + "en-SG", + "es", + "es-419", + "et", + "fi", + "fil", + "fr", + "fr-CA", + "hr", + "hu", + "id", + "it", + "ja", + "ko", + "lt", + "lv", + "ms", + "mt", + "nb", + "nl", + "pl", + "pt", + "pt-BR", + "ro", + "ru", + "sk", + "sl", + "sv", + "th", + "tr", + "vi", + "zh", + "zh-HK", + "zh-TW", + ] ] """ The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer's `preferred_locales` or browser's locale is used. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The default URL to redirect customers to when they click on the portal's link to return to your website. """ @@ -94,7 +142,7 @@ class CreateParamsFlowDataAfterCompletion(TypedDict): """ class CreateParamsFlowDataAfterCompletionHostedConfirmation(TypedDict): - custom_message: NotRequired["str"] + custom_message: NotRequired[str] """ A custom message to display to the customer after the flow is completed. """ @@ -143,7 +191,9 @@ class CreateParamsFlowDataSubscriptionUpdate(TypedDict): class CreateParamsFlowDataSubscriptionUpdateConfirm(TypedDict): discounts: NotRequired[ - "List[SessionService.CreateParamsFlowDataSubscriptionUpdateConfirmDiscount]" + List[ + "SessionService.CreateParamsFlowDataSubscriptionUpdateConfirmDiscount" + ] ] """ The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified. @@ -160,11 +210,11 @@ class CreateParamsFlowDataSubscriptionUpdateConfirm(TypedDict): """ class CreateParamsFlowDataSubscriptionUpdateConfirmDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The ID of the coupon to apply to this subscription update. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to apply to this subscription update. """ @@ -174,11 +224,11 @@ class CreateParamsFlowDataSubscriptionUpdateConfirmItem(TypedDict): """ The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated. """ - price: NotRequired["str"] + price: NotRequired[str] """ The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow. """ diff --git a/stripe/capital/_financing_offer.py b/stripe/capital/_financing_offer.py index bf752a865..98deb5eaf 100644 --- a/stripe/capital/_financing_offer.py +++ b/stripe/capital/_financing_offer.py @@ -74,7 +74,7 @@ class OfferedTerms(StripeObject): """ class ListParams(RequestOptions): - connected_account: NotRequired["str"] + connected_account: NotRequired[str] """ limit list to offers belonging to given connected account """ @@ -82,55 +82,66 @@ class ListParams(RequestOptions): """ Only return offers that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['accepted', 'canceled', 'completed', 'delivered', 'expired', 'fully_repaid', 'paid_out', 'rejected', 'revoked', 'undelivered']" + Literal[ + "accepted", + "canceled", + "completed", + "delivered", + "expired", + "fully_repaid", + "paid_out", + "rejected", + "revoked", + "undelivered", + ] ] """ limit list to offers with given status """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class MarkDeliveredParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/capital/_financing_offer_service.py b/stripe/capital/_financing_offer_service.py index 43e61c6bb..0e18bb991 100644 --- a/stripe/capital/_financing_offer_service.py +++ b/stripe/capital/_financing_offer_service.py @@ -11,7 +11,7 @@ class FinancingOfferService(StripeService): class ListParams(TypedDict): - connected_account: NotRequired["str"] + connected_account: NotRequired[str] """ limit list to offers belonging to given connected account """ @@ -19,55 +19,66 @@ class ListParams(TypedDict): """ Only return offers that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['accepted', 'canceled', 'completed', 'delivered', 'expired', 'fully_repaid', 'paid_out', 'rejected', 'revoked', 'undelivered']" + Literal[ + "accepted", + "canceled", + "completed", + "delivered", + "expired", + "fully_repaid", + "paid_out", + "rejected", + "revoked", + "undelivered", + ] ] """ limit list to offers with given status """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class MarkDeliveredParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/capital/_financing_summary.py b/stripe/capital/_financing_summary.py index 07206ccb4..62fa9cf4c 100644 --- a/stripe/capital/_financing_summary.py +++ b/stripe/capital/_financing_summary.py @@ -74,7 +74,7 @@ class CurrentRepaymentInterval(StripeObject): } class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/capital/_financing_summary_service.py b/stripe/capital/_financing_summary_service.py index 644035b05..2f9a3193c 100644 --- a/stripe/capital/_financing_summary_service.py +++ b/stripe/capital/_financing_summary_service.py @@ -9,7 +9,7 @@ class FinancingSummaryService(StripeService): class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/capital/_financing_transaction.py b/stripe/capital/_financing_transaction.py index ebe7793fa..16b048807 100644 --- a/stripe/capital/_financing_transaction.py +++ b/stripe/capital/_financing_transaction.py @@ -75,41 +75,41 @@ class Transaction(StripeObject): _inner_class_types = {"transaction": Transaction} class ListParams(RequestOptions): - charge: NotRequired["str"] + charge: NotRequired[str] """ For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this charge. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - financing_offer: NotRequired["str"] + financing_offer: NotRequired[str] """ Returns transactions that were created that apply to this financing offer ID. """ - limit: NotRequired["int"] + 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. """ - reversed_transaction: NotRequired["str"] + reversed_transaction: NotRequired[str] """ Only returns transactions that are responsible for reversing this financing transaction ID. """ - starting_after: NotRequired["str"] + 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. """ - treasury_transaction: NotRequired["str"] + treasury_transaction: NotRequired[str] """ For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this Treasury Transaction. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/capital/_financing_transaction_service.py b/stripe/capital/_financing_transaction_service.py index 3dd04deae..4519becff 100644 --- a/stripe/capital/_financing_transaction_service.py +++ b/stripe/capital/_financing_transaction_service.py @@ -11,41 +11,41 @@ class FinancingTransactionService(StripeService): class ListParams(TypedDict): - charge: NotRequired["str"] + charge: NotRequired[str] """ For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this charge. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - financing_offer: NotRequired["str"] + financing_offer: NotRequired[str] """ Returns transactions that were created that apply to this financing offer ID. """ - limit: NotRequired["int"] + 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. """ - reversed_transaction: NotRequired["str"] + reversed_transaction: NotRequired[str] """ Only returns transactions that are responsible for reversing this financing transaction ID. """ - starting_after: NotRequired["str"] + 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. """ - treasury_transaction: NotRequired["str"] + treasury_transaction: NotRequired[str] """ For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this Treasury Transaction. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/checkout/_session.py b/stripe/checkout/_session.py index f3c458fe8..c1f10d1de 100644 --- a/stripe/checkout/_session.py +++ b/stripe/checkout/_session.py @@ -1494,7 +1494,7 @@ class CreateParams(RequestOptions): """ Configure actions after a Checkout Session has expired. """ - allow_promotion_codes: NotRequired["bool"] + allow_promotion_codes: NotRequired[bool] """ Enables user redeemable promotion codes. """ @@ -1502,15 +1502,15 @@ class CreateParams(RequestOptions): """ Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions. """ - billing_address_collection: NotRequired["Literal['auto', 'required']"] + billing_address_collection: NotRequired[Literal["auto", "required"]] """ Specify whether Checkout should collect the customer's billing address. Defaults to `auto`. """ - cancel_url: NotRequired["str"] + cancel_url: NotRequired[str] """ If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. """ - client_reference_id: NotRequired["str"] + client_reference_id: NotRequired[str] """ A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the @@ -1522,11 +1522,11 @@ class CreateParams(RequestOptions): """ Configure fields for the Checkout Session to gather active consent from customers. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set. """ - custom_fields: NotRequired["List[Session.CreateParamsCustomField]"] + custom_fields: NotRequired[List["Session.CreateParamsCustomField"]] """ Collect additional information from your customer using custom fields. Up to 3 fields are supported. """ @@ -1534,7 +1534,7 @@ class CreateParams(RequestOptions): """ Display additional text for your customers using custom text. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ ID of an existing Customer, if one exists. In `payment` mode, the customer's most recently saved card payment method will be used to prefill the email, name, card details, and billing address @@ -1548,7 +1548,7 @@ class CreateParams(RequestOptions): You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse. """ - customer_creation: NotRequired["Literal['always', 'if_required']"] + customer_creation: NotRequired[Literal["always", "if_required"]] """ Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation. @@ -1560,7 +1560,7 @@ class CreateParams(RequestOptions): Can only be set in `payment` and `setup` mode. """ - customer_email: NotRequired["str"] + customer_email: NotRequired[str] """ If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. @@ -1572,15 +1572,15 @@ class CreateParams(RequestOptions): """ Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided. """ - discounts: NotRequired["List[Session.CreateParamsDiscount]"] + discounts: NotRequired[List["Session.CreateParamsDiscount"]] """ The coupon or promotion code to apply to this Session. Currently, only up to one may be specified. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation. """ @@ -1588,7 +1588,7 @@ class CreateParams(RequestOptions): """ Generate a post-purchase Invoice for one-time payments. """ - line_items: NotRequired["List[Session.CreateParamsLineItem]"] + line_items: NotRequired[List["Session.CreateParamsLineItem"]] """ A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). @@ -1597,16 +1597,58 @@ class CreateParams(RequestOptions): For `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only. """ locale: NotRequired[ - "Literal['auto', 'bg', 'cs', 'da', 'de', 'el', 'en', 'en-GB', 'es', 'es-419', 'et', 'fi', 'fil', 'fr', 'fr-CA', 'hr', 'hu', 'id', 'it', 'ja', 'ko', 'lt', 'lv', 'ms', 'mt', 'nb', 'nl', 'pl', 'pt', 'pt-BR', 'ro', 'ru', 'sk', 'sl', 'sv', 'th', 'tr', 'vi', 'zh', 'zh-HK', 'zh-TW']" + Literal[ + "auto", + "bg", + "cs", + "da", + "de", + "el", + "en", + "en-GB", + "es", + "es-419", + "et", + "fi", + "fil", + "fr", + "fr-CA", + "hr", + "hu", + "id", + "it", + "ja", + "ko", + "lt", + "lv", + "ms", + "mt", + "nb", + "nl", + "pl", + "pt", + "pt-BR", + "ro", + "ru", + "sk", + "sl", + "sv", + "th", + "tr", + "vi", + "zh", + "zh-HK", + "zh-TW", + ] ] """ The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - mode: NotRequired["Literal['payment', 'setup', 'subscription']"] + mode: NotRequired[Literal["payment", "setup", "subscription"]] """ The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item. """ @@ -1617,7 +1659,7 @@ class CreateParams(RequestOptions): A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. """ payment_method_collection: NotRequired[ - "Literal['always', 'if_required']" + Literal["always", "if_required"] ] """ Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0. @@ -1627,7 +1669,7 @@ class CreateParams(RequestOptions): If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). """ - payment_method_configuration: NotRequired["str"] + payment_method_configuration: NotRequired[str] """ The ID of the payment method configuration to use with this Checkout session. """ @@ -1638,7 +1680,44 @@ class CreateParams(RequestOptions): Payment-method-specific configuration. """ payment_method_types: NotRequired[ - "List[Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'blik', 'boleto', 'card', 'cashapp', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'konbini', 'link', 'oxxo', 'p24', 'paynow', 'paypal', 'pix', 'promptpay', 'revolut_pay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" + List[ + Literal[ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "card", + "cashapp", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "konbini", + "link", + "oxxo", + "p24", + "paynow", + "paypal", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "us_bank_account", + "wechat_pay", + "zip", + ] + ] ] """ A list of the types of payment methods (e.g., `card`) this Checkout Session can accept. @@ -1663,12 +1742,12 @@ class CreateParams(RequestOptions): before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers). """ redirect_on_completion: NotRequired[ - "Literal['always', 'if_required', 'never']" + Literal["always", "if_required", "never"] ] """ This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. This parameter is required if ui_mode is `embedded` @@ -1685,12 +1764,12 @@ class CreateParams(RequestOptions): When set, provides configuration for Checkout to collect a shipping address from a customer. """ shipping_options: NotRequired[ - "List[Session.CreateParamsShippingOption]" + List["Session.CreateParamsShippingOption"] ] """ The shipping rate options to apply to this Session. Up to a maximum of 5. """ - submit_type: NotRequired["Literal['auto', 'book', 'donate', 'pay']"] + submit_type: NotRequired[Literal["auto", "book", "donate", "pay"]] """ Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. `submit_type` can only be @@ -1700,7 +1779,7 @@ class CreateParams(RequestOptions): """ A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode. """ - success_url: NotRequired["str"] + success_url: NotRequired[str] """ The URL to which Stripe should send customers when payment or setup is complete. @@ -1712,7 +1791,7 @@ class CreateParams(RequestOptions): """ Controls tax ID collection settings for the session. """ - ui_mode: NotRequired["Literal['embedded', 'hosted']"] + ui_mode: NotRequired[Literal["embedded", "hosted"]] """ The UI mode of the Session. Defaults to `hosted`. """ @@ -1724,7 +1803,7 @@ class CreateParamsAfterExpiration(TypedDict): """ class CreateParamsAfterExpirationRecovery(TypedDict): - allow_promotion_codes: NotRequired["bool"] + allow_promotion_codes: NotRequired[bool] """ Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false` """ @@ -1746,7 +1825,7 @@ class CreateParamsAutomaticTax(TypedDict): """ class CreateParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1762,13 +1841,13 @@ class CreateParamsConsentCollection(TypedDict): """ Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method. """ - promotions: NotRequired["Literal['auto', 'none']"] + promotions: NotRequired[Literal["auto", "none"]] """ If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer's locale. Only available to US merchants. """ - terms_of_service: NotRequired["Literal['none', 'required']"] + terms_of_service: NotRequired[Literal["none", "required"]] """ If set to `required`, it requires customers to check a terms of service checkbox before being able to pay. There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public). @@ -1798,7 +1877,7 @@ class CreateParamsCustomField(TypedDict): """ Configuration for `type=numeric` fields. """ - optional: NotRequired["bool"] + optional: NotRequired[bool] """ Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. """ @@ -1838,21 +1917,21 @@ class CreateParamsCustomFieldLabel(TypedDict): """ class CreateParamsCustomFieldNumeric(TypedDict): - maximum_length: NotRequired["int"] + maximum_length: NotRequired[int] """ The maximum character length constraint for the customer's input. """ - minimum_length: NotRequired["int"] + minimum_length: NotRequired[int] """ The minimum character length requirement for the customer's input. """ class CreateParamsCustomFieldText(TypedDict): - maximum_length: NotRequired["int"] + maximum_length: NotRequired[int] """ The maximum character length constraint for the customer's input. """ - minimum_length: NotRequired["int"] + minimum_length: NotRequired[int] """ The minimum character length requirement for the customer's input. """ @@ -1906,27 +1985,27 @@ class CreateParamsCustomTextTermsOfServiceAcceptance(TypedDict): """ class CreateParamsCustomerUpdate(TypedDict): - address: NotRequired["Literal['auto', 'never']"] + address: NotRequired[Literal["auto", "never"]] """ Describes whether Checkout saves the billing address onto `customer.address`. To always collect a full billing address, use `billing_address_collection`. Defaults to `never`. """ - name: NotRequired["Literal['auto', 'never']"] + name: NotRequired[Literal["auto", "never"]] """ Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`. """ - shipping: NotRequired["Literal['auto', 'never']"] + shipping: NotRequired[Literal["auto", "never"]] """ Describes whether Checkout saves shipping information onto `customer.shipping`. To collect shipping information, use `shipping_address_collection`. Defaults to `never`. """ class CreateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The ID of the coupon to apply to this Session. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to apply to this Session. """ @@ -1954,11 +2033,11 @@ class CreateParamsInvoiceCreationInvoiceData(TypedDict): """ Default custom fields to be displayed on invoices for this customer. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - footer: NotRequired["str"] + footer: NotRequired[str] """ Default footer to be displayed on invoices for this customer. """ @@ -1968,7 +2047,7 @@ class CreateParamsInvoiceCreationInvoiceData(TypedDict): """ The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -1990,7 +2069,7 @@ class CreateParamsInvoiceCreationInvoiceDataCustomField(TypedDict): """ class CreateParamsInvoiceCreationInvoiceDataIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -2014,11 +2093,11 @@ class CreateParamsLineItem(TypedDict): """ When set, provides configuration for this item's quantity to be adjusted by the customer during Checkout. """ - dynamic_tax_rates: NotRequired["List[str]"] + dynamic_tax_rates: NotRequired[List[str]] """ The [tax rates](https://stripe.com/docs/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required. """ @@ -2026,11 +2105,11 @@ class CreateParamsLineItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item. """ @@ -2040,11 +2119,11 @@ class CreateParamsLineItemAdjustableQuantity(TypedDict): """ Set to true if the quantity can be adjusted to any non-negative integer. By default customers will be able to remove the line item by setting the quantity to 0. """ - maximum: NotRequired["int"] + maximum: NotRequired[int] """ The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999. """ - minimum: NotRequired["int"] + minimum: NotRequired[int] """ The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0. """ @@ -2054,7 +2133,7 @@ class CreateParamsLineItemPriceData(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - product: NotRequired["str"] + product: NotRequired[str] """ The ID of the product that this price will belong to. One of `product` or `product_data` is required. """ @@ -2071,30 +2150,30 @@ class CreateParamsLineItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class CreateParamsLineItemPriceDataProductData(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. """ - images: NotRequired["List[str]"] + images: NotRequired[List[str]] """ A list of up to 8 URLs of images for this product, meant to be displayable to the customer. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -2102,7 +2181,7 @@ class CreateParamsLineItemPriceDataProductData(TypedDict): """ The product's name, meant to be displayable to the customer. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ @@ -2112,41 +2191,41 @@ class CreateParamsLineItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class CreateParamsPaymentIntentData(TypedDict): - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The Stripe account ID for which these funds are intended. For details, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ - receipt_email: NotRequired["str"] + receipt_email: NotRequired[str] """ Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). """ - setup_future_usage: NotRequired["Literal['off_session', 'on_session']"] + setup_future_usage: NotRequired[Literal["off_session", "on_session"]] """ Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session. @@ -2173,12 +2252,12 @@ class CreateParamsPaymentIntentData(TypedDict): """ Shipping information for this payment. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete @@ -2191,7 +2270,7 @@ class CreateParamsPaymentIntentData(TypedDict): The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. """ @@ -2201,7 +2280,7 @@ class CreateParamsPaymentIntentDataShipping(TypedDict): """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ @@ -2209,21 +2288,21 @@ class CreateParamsPaymentIntentDataShipping(TypedDict): """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class CreateParamsPaymentIntentDataShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ @@ -2231,21 +2310,21 @@ class CreateParamsPaymentIntentDataShippingAddress(TypedDict): """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsPaymentIntentDataTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when a charge succeeds. """ @@ -2400,7 +2479,7 @@ class CreateParamsPaymentMethodOptions(TypedDict): """ class CreateParamsPaymentMethodOptionsAcssDebit(TypedDict): - currency: NotRequired["Literal['cad', 'usd']"] + currency: NotRequired[Literal["cad", "usd"]] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). This is only accepted for Checkout Sessions in `setup` mode. """ @@ -2411,7 +2490,7 @@ class CreateParamsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2421,7 +2500,7 @@ class CreateParamsPaymentMethodOptionsAcssDebit(TypedDict): When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -2434,27 +2513,27 @@ class CreateParamsPaymentMethodOptionsAcssDebitMandateOptions(TypedDict): The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - default_for: NotRequired["List[Literal['invoice', 'subscription']]"] + default_for: NotRequired[List[Literal["invoice", "subscription"]]] """ List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ class CreateParamsPaymentMethodOptionsAffirm(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2464,7 +2543,7 @@ class CreateParamsPaymentMethodOptionsAffirm(TypedDict): """ class CreateParamsPaymentMethodOptionsAfterpayClearpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2474,7 +2553,7 @@ class CreateParamsPaymentMethodOptionsAfterpayClearpay(TypedDict): """ class CreateParamsPaymentMethodOptionsAlipay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2484,7 +2563,7 @@ class CreateParamsPaymentMethodOptionsAlipay(TypedDict): """ class CreateParamsPaymentMethodOptionsAuBecsDebit(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2495,7 +2574,7 @@ class CreateParamsPaymentMethodOptionsAuBecsDebit(TypedDict): class CreateParamsPaymentMethodOptionsBacsDebit(TypedDict): setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2506,7 +2585,7 @@ class CreateParamsPaymentMethodOptionsBacsDebit(TypedDict): """ class CreateParamsPaymentMethodOptionsBancontact(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2516,12 +2595,12 @@ class CreateParamsPaymentMethodOptionsBancontact(TypedDict): """ class CreateParamsPaymentMethodOptionsBoleto(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time. """ setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2539,12 +2618,12 @@ class CreateParamsPaymentMethodOptionsCard(TypedDict): Installment options for card payments """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ - setup_future_usage: NotRequired["Literal['off_session', 'on_session']"] + setup_future_usage: NotRequired[Literal["off_session", "on_session"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2552,17 +2631,17 @@ class CreateParamsPaymentMethodOptionsCard(TypedDict): When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). """ - statement_descriptor_suffix_kana: NotRequired["str"] + statement_descriptor_suffix_kana: NotRequired[str] """ Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters. """ - statement_descriptor_suffix_kanji: NotRequired["str"] + statement_descriptor_suffix_kanji: NotRequired[str] """ Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that's set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters. """ class CreateParamsPaymentMethodOptionsCardInstallments(TypedDict): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Setting to true enables installments for this Checkout Session. Setting to false will prevent any installment plan from applying to a payment. @@ -2570,7 +2649,7 @@ class CreateParamsPaymentMethodOptionsCardInstallments(TypedDict): class CreateParamsPaymentMethodOptionsCashapp(TypedDict): setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2587,11 +2666,11 @@ class CreateParamsPaymentMethodOptionsCustomerBalance(TypedDict): """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["Literal['bank_transfer']"] + funding_type: NotRequired[Literal["bank_transfer"]] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2610,7 +2689,17 @@ class CreateParamsPaymentMethodOptionsCustomerBalanceBankTransfer( Configuration for eu_bank_transfer funding type. """ requested_address_types: NotRequired[ - "List[Literal['aba', 'iban', 'sepa', 'sort_code', 'spei', 'swift', 'zengin']]" + List[ + Literal[ + "aba", + "iban", + "sepa", + "sort_code", + "spei", + "swift", + "zengin", + ] + ] ] """ List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. @@ -2637,7 +2726,7 @@ class CreateParamsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer( """ class CreateParamsPaymentMethodOptionsEps(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2647,7 +2736,7 @@ class CreateParamsPaymentMethodOptionsEps(TypedDict): """ class CreateParamsPaymentMethodOptionsFpx(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2657,7 +2746,7 @@ class CreateParamsPaymentMethodOptionsFpx(TypedDict): """ class CreateParamsPaymentMethodOptionsGiropay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2667,7 +2756,7 @@ class CreateParamsPaymentMethodOptionsGiropay(TypedDict): """ class CreateParamsPaymentMethodOptionsGrabpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2677,7 +2766,7 @@ class CreateParamsPaymentMethodOptionsGrabpay(TypedDict): """ class CreateParamsPaymentMethodOptionsIdeal(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2687,7 +2776,7 @@ class CreateParamsPaymentMethodOptionsIdeal(TypedDict): """ class CreateParamsPaymentMethodOptionsKlarna(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2697,11 +2786,11 @@ class CreateParamsPaymentMethodOptionsKlarna(TypedDict): """ class CreateParamsPaymentMethodOptionsKonbini(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2711,7 +2800,7 @@ class CreateParamsPaymentMethodOptionsKonbini(TypedDict): """ class CreateParamsPaymentMethodOptionsLink(TypedDict): - setup_future_usage: NotRequired["Literal['none', 'off_session']"] + setup_future_usage: NotRequired[Literal["none", "off_session"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2721,11 +2810,11 @@ class CreateParamsPaymentMethodOptionsLink(TypedDict): """ class CreateParamsPaymentMethodOptionsOxxo(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2735,7 +2824,7 @@ class CreateParamsPaymentMethodOptionsOxxo(TypedDict): """ class CreateParamsPaymentMethodOptionsP24(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2743,13 +2832,13 @@ class CreateParamsPaymentMethodOptionsP24(TypedDict): When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). """ - tos_shown_and_accepted: NotRequired["bool"] + tos_shown_and_accepted: NotRequired[bool] """ Confirm that the payer has accepted the P24 terms and conditions. """ class CreateParamsPaymentMethodOptionsPaynow(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2764,20 +2853,42 @@ class CreateParamsPaymentMethodOptionsPaypal(TypedDict): Controls when the funds will be captured from the customer's account. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-DE', 'de-LU', 'el-GR', 'en-GB', 'en-US', 'es-ES', 'fi-FI', 'fr-BE', 'fr-FR', 'fr-LU', 'hu-HU', 'it-IT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sk-SK', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-DE", + "de-LU", + "el-GR", + "en-GB", + "en-US", + "es-ES", + "fi-FI", + "fr-BE", + "fr-FR", + "fr-LU", + "hu-HU", + "it-IT", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sk-SK", + "sv-SE", + ] ] """ [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - reference_id: NotRequired["str"] + reference_id: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - risk_correlation_id: NotRequired["str"] + risk_correlation_id: NotRequired[str] """ The risk correlation ID for an on-session payment using a saved PayPal payment method. """ @@ -2793,19 +2904,19 @@ class CreateParamsPaymentMethodOptionsPaypal(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - subsellers: NotRequired["List[str]"] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ class CreateParamsPaymentMethodOptionsPix(TypedDict): - expires_after_seconds: NotRequired["int"] + expires_after_seconds: NotRequired[int] """ The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds. """ class CreateParamsPaymentMethodOptionsRevolutPay(TypedDict): - setup_future_usage: NotRequired["Literal['none', 'off_session']"] + setup_future_usage: NotRequired[Literal["none", "off_session"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2816,7 +2927,7 @@ class CreateParamsPaymentMethodOptionsRevolutPay(TypedDict): class CreateParamsPaymentMethodOptionsSepaDebit(TypedDict): setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2827,7 +2938,7 @@ class CreateParamsPaymentMethodOptionsSepaDebit(TypedDict): """ class CreateParamsPaymentMethodOptionsSofort(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2850,7 +2961,7 @@ class CreateParamsPaymentMethodOptionsUsBankAccount(TypedDict): Additional fields for Financial Connections Session creation """ setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2859,7 +2970,7 @@ class CreateParamsPaymentMethodOptionsUsBankAccount(TypedDict): When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). """ - verification_method: NotRequired["Literal['automatic', 'instant']"] + verification_method: NotRequired[Literal["automatic", "instant"]] """ Verification method for the intent """ @@ -2868,20 +2979,31 @@ class CreateParamsPaymentMethodOptionsUsBankAccountFinancialConnections( TypedDict, ): permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ class CreateParamsPaymentMethodOptionsWechatPay(TypedDict): - app_id: NotRequired["str"] + app_id: NotRequired[str] """ The app ID registered with WeChat Pay. Only required when client is ios or android. """ @@ -2889,7 +3011,7 @@ class CreateParamsPaymentMethodOptionsWechatPay(TypedDict): """ The client type that the end customer will pay from """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -2905,15 +3027,15 @@ class CreateParamsPhoneNumberCollection(TypedDict): """ class CreateParamsSetupIntentData(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The Stripe account for which the setup is intended. """ @@ -3166,7 +3288,7 @@ class CreateParamsShippingAddressCollection(TypedDict): """ class CreateParamsShippingOption(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the Shipping Rate to use for this shipping option. """ @@ -3194,21 +3316,21 @@ class CreateParamsShippingOptionShippingRateData(TypedDict): """ Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ - type: NotRequired["Literal['fixed_amount']"] + type: NotRequired[Literal["fixed_amount"]] """ The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. """ @@ -3263,7 +3385,10 @@ class CreateParamsShippingOptionShippingRateDataFixedAmount(TypedDict): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, Session.CreateParamsShippingOptionShippingRateDataFixedAmountCurrencyOptions]" + Dict[ + str, + "Session.CreateParamsShippingOptionShippingRateDataFixedAmountCurrencyOptions", + ] ] """ Shipping rates 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). @@ -3277,28 +3402,28 @@ class CreateParamsShippingOptionShippingRateDataFixedAmountCurrencyOptions( A non-negative integer in cents representing how much to charge. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ class CreateParamsSubscriptionData(TypedDict): - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ - billing_cycle_anchor: NotRequired["int"] + billing_cycle_anchor: NotRequired[int] """ A future timestamp to anchor the subscription's billing cycle for new subscriptions. """ - default_tax_rates: NotRequired["List[str]"] + default_tax_rates: NotRequired[List[str]] """ The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. """ - description: NotRequired["str"] + description: NotRequired[str] """ The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription @@ -3310,15 +3435,15 @@ class CreateParamsSubscriptionData(TypedDict): """ All invoices will be billed using the specified settings. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account on behalf of which to charge, for each of the subscription's invoices. """ - proration_behavior: NotRequired["Literal['create_prorations', 'none']"] + proration_behavior: NotRequired[Literal["create_prorations", "none"]] """ Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. """ @@ -3328,13 +3453,13 @@ class CreateParamsSubscriptionData(TypedDict): """ If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. """ - trial_end: NotRequired["int"] + trial_end: NotRequired[int] """ Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future. """ - trial_period_days: NotRequired["int"] + trial_period_days: NotRequired[int] """ Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1. @@ -3355,7 +3480,7 @@ class CreateParamsSubscriptionDataInvoiceSettings(TypedDict): """ class CreateParamsSubscriptionDataInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -3365,7 +3490,7 @@ class CreateParamsSubscriptionDataInvoiceSettingsIssuer(TypedDict): """ class CreateParamsSubscriptionDataTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -3393,25 +3518,25 @@ class CreateParamsTaxIdCollection(TypedDict): """ class ExpireParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListLineItemsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ @@ -3421,7 +3546,7 @@ class ListParams(RequestOptions): """ Only return Checkout Sessions that were created during the given date interval. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return the Checkout Sessions for the Customer specified. """ @@ -3429,53 +3554,53 @@ class ListParams(RequestOptions): """ Only return the Checkout Sessions for the Customer details specified. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - payment_intent: NotRequired["str"] + payment_intent: NotRequired[str] """ Only return the Checkout Session for the PaymentIntent specified. """ - payment_link: NotRequired["str"] + payment_link: NotRequired[str] """ Only return the Checkout Sessions for the Payment Link specified. """ - starting_after: NotRequired["str"] + 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. """ - status: NotRequired["Literal['complete', 'expired', 'open']"] + status: NotRequired[Literal["complete", "expired", "open"]] """ Only return the Checkout Sessions matching the given status. """ - subscription: NotRequired["str"] + subscription: NotRequired[str] """ Only return the Checkout Session for the subscription specified. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ @@ -3487,7 +3612,7 @@ class ListParamsCustomerDetails(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/checkout/_session_line_item_service.py b/stripe/checkout/_session_line_item_service.py index 73fed8040..dc7317d12 100644 --- a/stripe/checkout/_session_line_item_service.py +++ b/stripe/checkout/_session_line_item_service.py @@ -11,19 +11,19 @@ class SessionLineItemService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/checkout/_session_service.py b/stripe/checkout/_session_service.py index f40468c2b..afa185f14 100644 --- a/stripe/checkout/_session_service.py +++ b/stripe/checkout/_session_service.py @@ -22,7 +22,7 @@ class CreateParams(TypedDict): """ Configure actions after a Checkout Session has expired. """ - allow_promotion_codes: NotRequired["bool"] + allow_promotion_codes: NotRequired[bool] """ Enables user redeemable promotion codes. """ @@ -30,15 +30,15 @@ class CreateParams(TypedDict): """ Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions. """ - billing_address_collection: NotRequired["Literal['auto', 'required']"] + billing_address_collection: NotRequired[Literal["auto", "required"]] """ Specify whether Checkout should collect the customer's billing address. Defaults to `auto`. """ - cancel_url: NotRequired["str"] + cancel_url: NotRequired[str] """ If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. """ - client_reference_id: NotRequired["str"] + client_reference_id: NotRequired[str] """ A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the @@ -50,12 +50,12 @@ class CreateParams(TypedDict): """ Configure fields for the Checkout Session to gather active consent from customers. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set. """ custom_fields: NotRequired[ - "List[SessionService.CreateParamsCustomField]" + List["SessionService.CreateParamsCustomField"] ] """ Collect additional information from your customer using custom fields. Up to 3 fields are supported. @@ -64,7 +64,7 @@ class CreateParams(TypedDict): """ Display additional text for your customers using custom text. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ ID of an existing Customer, if one exists. In `payment` mode, the customer's most recently saved card payment method will be used to prefill the email, name, card details, and billing address @@ -78,7 +78,7 @@ class CreateParams(TypedDict): You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse. """ - customer_creation: NotRequired["Literal['always', 'if_required']"] + customer_creation: NotRequired[Literal["always", "if_required"]] """ Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation. @@ -90,7 +90,7 @@ class CreateParams(TypedDict): Can only be set in `payment` and `setup` mode. """ - customer_email: NotRequired["str"] + customer_email: NotRequired[str] """ If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. @@ -104,15 +104,15 @@ class CreateParams(TypedDict): """ Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided. """ - discounts: NotRequired["List[SessionService.CreateParamsDiscount]"] + discounts: NotRequired[List["SessionService.CreateParamsDiscount"]] """ The coupon or promotion code to apply to this Session. Currently, only up to one may be specified. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation. """ @@ -122,7 +122,7 @@ class CreateParams(TypedDict): """ Generate a post-purchase Invoice for one-time payments. """ - line_items: NotRequired["List[SessionService.CreateParamsLineItem]"] + line_items: NotRequired[List["SessionService.CreateParamsLineItem"]] """ A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). @@ -131,16 +131,58 @@ class CreateParams(TypedDict): For `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only. """ locale: NotRequired[ - "Literal['auto', 'bg', 'cs', 'da', 'de', 'el', 'en', 'en-GB', 'es', 'es-419', 'et', 'fi', 'fil', 'fr', 'fr-CA', 'hr', 'hu', 'id', 'it', 'ja', 'ko', 'lt', 'lv', 'ms', 'mt', 'nb', 'nl', 'pl', 'pt', 'pt-BR', 'ro', 'ru', 'sk', 'sl', 'sv', 'th', 'tr', 'vi', 'zh', 'zh-HK', 'zh-TW']" + Literal[ + "auto", + "bg", + "cs", + "da", + "de", + "el", + "en", + "en-GB", + "es", + "es-419", + "et", + "fi", + "fil", + "fr", + "fr-CA", + "hr", + "hu", + "id", + "it", + "ja", + "ko", + "lt", + "lv", + "ms", + "mt", + "nb", + "nl", + "pl", + "pt", + "pt-BR", + "ro", + "ru", + "sk", + "sl", + "sv", + "th", + "tr", + "vi", + "zh", + "zh-HK", + "zh-TW", + ] ] """ The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - mode: NotRequired["Literal['payment', 'setup', 'subscription']"] + mode: NotRequired[Literal["payment", "setup", "subscription"]] """ The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item. """ @@ -151,7 +193,7 @@ class CreateParams(TypedDict): A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. """ payment_method_collection: NotRequired[ - "Literal['always', 'if_required']" + Literal["always", "if_required"] ] """ Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0. @@ -161,7 +203,7 @@ class CreateParams(TypedDict): If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). """ - payment_method_configuration: NotRequired["str"] + payment_method_configuration: NotRequired[str] """ The ID of the payment method configuration to use with this Checkout session. """ @@ -172,7 +214,44 @@ class CreateParams(TypedDict): Payment-method-specific configuration. """ payment_method_types: NotRequired[ - "List[Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'blik', 'boleto', 'card', 'cashapp', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'konbini', 'link', 'oxxo', 'p24', 'paynow', 'paypal', 'pix', 'promptpay', 'revolut_pay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" + List[ + Literal[ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "card", + "cashapp", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "konbini", + "link", + "oxxo", + "p24", + "paynow", + "paypal", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "us_bank_account", + "wechat_pay", + "zip", + ] + ] ] """ A list of the types of payment methods (e.g., `card`) this Checkout Session can accept. @@ -197,12 +276,12 @@ class CreateParams(TypedDict): before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers). """ redirect_on_completion: NotRequired[ - "Literal['always', 'if_required', 'never']" + Literal["always", "if_required", "never"] ] """ This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. This parameter is required if ui_mode is `embedded` @@ -221,12 +300,12 @@ class CreateParams(TypedDict): When set, provides configuration for Checkout to collect a shipping address from a customer. """ shipping_options: NotRequired[ - "List[SessionService.CreateParamsShippingOption]" + List["SessionService.CreateParamsShippingOption"] ] """ The shipping rate options to apply to this Session. Up to a maximum of 5. """ - submit_type: NotRequired["Literal['auto', 'book', 'donate', 'pay']"] + submit_type: NotRequired[Literal["auto", "book", "donate", "pay"]] """ Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. `submit_type` can only be @@ -238,7 +317,7 @@ class CreateParams(TypedDict): """ A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode. """ - success_url: NotRequired["str"] + success_url: NotRequired[str] """ The URL to which Stripe should send customers when payment or setup is complete. @@ -252,7 +331,7 @@ class CreateParams(TypedDict): """ Controls tax ID collection settings for the session. """ - ui_mode: NotRequired["Literal['embedded', 'hosted']"] + ui_mode: NotRequired[Literal["embedded", "hosted"]] """ The UI mode of the Session. Defaults to `hosted`. """ @@ -266,7 +345,7 @@ class CreateParamsAfterExpiration(TypedDict): """ class CreateParamsAfterExpirationRecovery(TypedDict): - allow_promotion_codes: NotRequired["bool"] + allow_promotion_codes: NotRequired[bool] """ Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false` """ @@ -290,7 +369,7 @@ class CreateParamsAutomaticTax(TypedDict): """ class CreateParamsAutomaticTaxLiability(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -306,13 +385,13 @@ class CreateParamsConsentCollection(TypedDict): """ Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method. """ - promotions: NotRequired["Literal['auto', 'none']"] + promotions: NotRequired[Literal["auto", "none"]] """ If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer's locale. Only available to US merchants. """ - terms_of_service: NotRequired["Literal['none', 'required']"] + terms_of_service: NotRequired[Literal["none", "required"]] """ If set to `required`, it requires customers to check a terms of service checkbox before being able to pay. There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public). @@ -342,7 +421,7 @@ class CreateParamsCustomField(TypedDict): """ Configuration for `type=numeric` fields. """ - optional: NotRequired["bool"] + optional: NotRequired[bool] """ Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. """ @@ -382,21 +461,21 @@ class CreateParamsCustomFieldLabel(TypedDict): """ class CreateParamsCustomFieldNumeric(TypedDict): - maximum_length: NotRequired["int"] + maximum_length: NotRequired[int] """ The maximum character length constraint for the customer's input. """ - minimum_length: NotRequired["int"] + minimum_length: NotRequired[int] """ The minimum character length requirement for the customer's input. """ class CreateParamsCustomFieldText(TypedDict): - maximum_length: NotRequired["int"] + maximum_length: NotRequired[int] """ The maximum character length constraint for the customer's input. """ - minimum_length: NotRequired["int"] + minimum_length: NotRequired[int] """ The minimum character length requirement for the customer's input. """ @@ -452,27 +531,27 @@ class CreateParamsCustomTextTermsOfServiceAcceptance(TypedDict): """ class CreateParamsCustomerUpdate(TypedDict): - address: NotRequired["Literal['auto', 'never']"] + address: NotRequired[Literal["auto", "never"]] """ Describes whether Checkout saves the billing address onto `customer.address`. To always collect a full billing address, use `billing_address_collection`. Defaults to `never`. """ - name: NotRequired["Literal['auto', 'never']"] + name: NotRequired[Literal["auto", "never"]] """ Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`. """ - shipping: NotRequired["Literal['auto', 'never']"] + shipping: NotRequired[Literal["auto", "never"]] """ Describes whether Checkout saves shipping information onto `customer.shipping`. To collect shipping information, use `shipping_address_collection`. Defaults to `never`. """ class CreateParamsDiscount(TypedDict): - coupon: NotRequired["str"] + coupon: NotRequired[str] """ The ID of the coupon to apply to this Session. """ - promotion_code: NotRequired["str"] + promotion_code: NotRequired[str] """ The ID of a promotion code to apply to this Session. """ @@ -500,11 +579,11 @@ class CreateParamsInvoiceCreationInvoiceData(TypedDict): """ Default custom fields to be displayed on invoices for this customer. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - footer: NotRequired["str"] + footer: NotRequired[str] """ Default footer to be displayed on invoices for this customer. """ @@ -514,7 +593,7 @@ class CreateParamsInvoiceCreationInvoiceData(TypedDict): """ The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -536,7 +615,7 @@ class CreateParamsInvoiceCreationInvoiceDataCustomField(TypedDict): """ class CreateParamsInvoiceCreationInvoiceDataIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -560,11 +639,11 @@ class CreateParamsLineItem(TypedDict): """ When set, provides configuration for this item's quantity to be adjusted by the customer during Checkout. """ - dynamic_tax_rates: NotRequired["List[str]"] + dynamic_tax_rates: NotRequired[List[str]] """ The [tax rates](https://stripe.com/docs/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU. """ - price: NotRequired["str"] + price: NotRequired[str] """ The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required. """ @@ -572,11 +651,11 @@ class CreateParamsLineItem(TypedDict): """ Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`. """ - tax_rates: NotRequired["List[str]"] + tax_rates: NotRequired[List[str]] """ The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item. """ @@ -586,11 +665,11 @@ class CreateParamsLineItemAdjustableQuantity(TypedDict): """ Set to true if the quantity can be adjusted to any non-negative integer. By default customers will be able to remove the line item by setting the quantity to 0. """ - maximum: NotRequired["int"] + maximum: NotRequired[int] """ The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999. """ - minimum: NotRequired["int"] + minimum: NotRequired[int] """ The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0. """ @@ -600,7 +679,7 @@ class CreateParamsLineItemPriceData(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - product: NotRequired["str"] + product: NotRequired[str] """ The ID of the product that this price will belong to. One of `product` or `product_data` is required. """ @@ -617,30 +696,30 @@ class CreateParamsLineItemPriceData(TypedDict): The recurring components of a price such as `interval` and `interval_count`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. """ - unit_amount: NotRequired["int"] + unit_amount: NotRequired[int] """ A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required. """ - unit_amount_decimal: NotRequired["str"] + unit_amount_decimal: NotRequired[str] """ Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. """ class CreateParamsLineItemPriceDataProductData(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. """ - images: NotRequired["List[str]"] + images: NotRequired[List[str]] """ A list of up to 8 URLs of images for this product, meant to be displayable to the customer. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -648,7 +727,7 @@ class CreateParamsLineItemPriceDataProductData(TypedDict): """ The product's name, meant to be displayable to the customer. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ @@ -658,41 +737,41 @@ class CreateParamsLineItemPriceDataRecurring(TypedDict): """ Specifies billing frequency. Either `day`, `week`, `month` or `year`. """ - interval_count: NotRequired["int"] + interval_count: NotRequired[int] """ The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). """ class CreateParamsPaymentIntentData(TypedDict): - application_fee_amount: NotRequired["int"] + application_fee_amount: NotRequired[int] """ The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ capture_method: NotRequired[ - "Literal['automatic', 'automatic_async', 'manual']" + Literal["automatic", "automatic_async", "manual"] ] """ Controls when the funds will be captured from the customer's account. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The Stripe account ID for which these funds are intended. For details, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ - receipt_email: NotRequired["str"] + receipt_email: NotRequired[str] """ Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). """ - setup_future_usage: NotRequired["Literal['off_session', 'on_session']"] + setup_future_usage: NotRequired[Literal["off_session", "on_session"]] """ Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session. @@ -721,12 +800,12 @@ class CreateParamsPaymentIntentData(TypedDict): """ Shipping information for this payment. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge. """ - statement_descriptor_suffix: NotRequired["str"] + statement_descriptor_suffix: NotRequired[str] """ Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete @@ -739,7 +818,7 @@ class CreateParamsPaymentIntentData(TypedDict): The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. """ @@ -749,7 +828,7 @@ class CreateParamsPaymentIntentDataShipping(TypedDict): """ Shipping address. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. """ @@ -757,21 +836,21 @@ class CreateParamsPaymentIntentDataShipping(TypedDict): """ Recipient name. """ - phone: NotRequired["str"] + phone: NotRequired[str] """ Recipient phone (including extension). """ - tracking_number: NotRequired["str"] + tracking_number: NotRequired[str] """ The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. """ class CreateParamsPaymentIntentDataShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + country: NotRequired[str] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ @@ -779,21 +858,21 @@ class CreateParamsPaymentIntentDataShippingAddress(TypedDict): """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsPaymentIntentDataTransferData(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The amount that will be transferred automatically when a charge succeeds. """ @@ -980,7 +1059,7 @@ class CreateParamsPaymentMethodOptions(TypedDict): """ class CreateParamsPaymentMethodOptionsAcssDebit(TypedDict): - currency: NotRequired["Literal['cad', 'usd']"] + currency: NotRequired[Literal["cad", "usd"]] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). This is only accepted for Checkout Sessions in `setup` mode. """ @@ -991,7 +1070,7 @@ class CreateParamsPaymentMethodOptionsAcssDebit(TypedDict): Additional fields for Mandate creation """ setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1001,7 +1080,7 @@ class CreateParamsPaymentMethodOptionsAcssDebit(TypedDict): When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). """ verification_method: NotRequired[ - "Literal['automatic', 'instant', 'microdeposits']" + Literal["automatic", "instant", "microdeposits"] ] """ Verification method for the intent @@ -1014,27 +1093,27 @@ class CreateParamsPaymentMethodOptionsAcssDebitMandateOptions(TypedDict): The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ - default_for: NotRequired["List[Literal['invoice', 'subscription']]"] + default_for: NotRequired[List[Literal["invoice", "subscription"]]] """ List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode. """ - interval_description: NotRequired["str"] + interval_description: NotRequired[str] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ - "Literal['combined', 'interval', 'sporadic']" + Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ - transaction_type: NotRequired["Literal['business', 'personal']"] + transaction_type: NotRequired[Literal["business", "personal"]] """ Transaction type of the mandate. """ class CreateParamsPaymentMethodOptionsAffirm(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1044,7 +1123,7 @@ class CreateParamsPaymentMethodOptionsAffirm(TypedDict): """ class CreateParamsPaymentMethodOptionsAfterpayClearpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1054,7 +1133,7 @@ class CreateParamsPaymentMethodOptionsAfterpayClearpay(TypedDict): """ class CreateParamsPaymentMethodOptionsAlipay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1064,7 +1143,7 @@ class CreateParamsPaymentMethodOptionsAlipay(TypedDict): """ class CreateParamsPaymentMethodOptionsAuBecsDebit(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1075,7 +1154,7 @@ class CreateParamsPaymentMethodOptionsAuBecsDebit(TypedDict): class CreateParamsPaymentMethodOptionsBacsDebit(TypedDict): setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1086,7 +1165,7 @@ class CreateParamsPaymentMethodOptionsBacsDebit(TypedDict): """ class CreateParamsPaymentMethodOptionsBancontact(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1096,12 +1175,12 @@ class CreateParamsPaymentMethodOptionsBancontact(TypedDict): """ class CreateParamsPaymentMethodOptionsBoleto(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time. """ setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1119,12 +1198,12 @@ class CreateParamsPaymentMethodOptionsCard(TypedDict): Installment options for card payments """ request_three_d_secure: NotRequired[ - "Literal['any', 'automatic', 'challenge']" + Literal["any", "automatic", "challenge"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ - setup_future_usage: NotRequired["Literal['off_session', 'on_session']"] + setup_future_usage: NotRequired[Literal["off_session", "on_session"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1132,17 +1211,17 @@ class CreateParamsPaymentMethodOptionsCard(TypedDict): When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). """ - statement_descriptor_suffix_kana: NotRequired["str"] + statement_descriptor_suffix_kana: NotRequired[str] """ Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters. """ - statement_descriptor_suffix_kanji: NotRequired["str"] + statement_descriptor_suffix_kanji: NotRequired[str] """ Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that's set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters. """ class CreateParamsPaymentMethodOptionsCardInstallments(TypedDict): - enabled: NotRequired["bool"] + enabled: NotRequired[bool] """ Setting to true enables installments for this Checkout Session. Setting to false will prevent any installment plan from applying to a payment. @@ -1150,7 +1229,7 @@ class CreateParamsPaymentMethodOptionsCardInstallments(TypedDict): class CreateParamsPaymentMethodOptionsCashapp(TypedDict): setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1167,11 +1246,11 @@ class CreateParamsPaymentMethodOptionsCustomerBalance(TypedDict): """ Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`. """ - funding_type: NotRequired["Literal['bank_transfer']"] + funding_type: NotRequired[Literal["bank_transfer"]] """ The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1190,7 +1269,17 @@ class CreateParamsPaymentMethodOptionsCustomerBalanceBankTransfer( Configuration for eu_bank_transfer funding type. """ requested_address_types: NotRequired[ - "List[Literal['aba', 'iban', 'sepa', 'sort_code', 'spei', 'swift', 'zengin']]" + List[ + Literal[ + "aba", + "iban", + "sepa", + "sort_code", + "spei", + "swift", + "zengin", + ] + ] ] """ List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned. @@ -1217,7 +1306,7 @@ class CreateParamsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer( """ class CreateParamsPaymentMethodOptionsEps(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1227,7 +1316,7 @@ class CreateParamsPaymentMethodOptionsEps(TypedDict): """ class CreateParamsPaymentMethodOptionsFpx(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1237,7 +1326,7 @@ class CreateParamsPaymentMethodOptionsFpx(TypedDict): """ class CreateParamsPaymentMethodOptionsGiropay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1247,7 +1336,7 @@ class CreateParamsPaymentMethodOptionsGiropay(TypedDict): """ class CreateParamsPaymentMethodOptionsGrabpay(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1257,7 +1346,7 @@ class CreateParamsPaymentMethodOptionsGrabpay(TypedDict): """ class CreateParamsPaymentMethodOptionsIdeal(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1267,7 +1356,7 @@ class CreateParamsPaymentMethodOptionsIdeal(TypedDict): """ class CreateParamsPaymentMethodOptionsKlarna(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1277,11 +1366,11 @@ class CreateParamsPaymentMethodOptionsKlarna(TypedDict): """ class CreateParamsPaymentMethodOptionsKonbini(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1291,7 +1380,7 @@ class CreateParamsPaymentMethodOptionsKonbini(TypedDict): """ class CreateParamsPaymentMethodOptionsLink(TypedDict): - setup_future_usage: NotRequired["Literal['none', 'off_session']"] + setup_future_usage: NotRequired[Literal["none", "off_session"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1301,11 +1390,11 @@ class CreateParamsPaymentMethodOptionsLink(TypedDict): """ class CreateParamsPaymentMethodOptionsOxxo(TypedDict): - expires_after_days: NotRequired["int"] + expires_after_days: NotRequired[int] """ The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1315,7 +1404,7 @@ class CreateParamsPaymentMethodOptionsOxxo(TypedDict): """ class CreateParamsPaymentMethodOptionsP24(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1323,13 +1412,13 @@ class CreateParamsPaymentMethodOptionsP24(TypedDict): When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). """ - tos_shown_and_accepted: NotRequired["bool"] + tos_shown_and_accepted: NotRequired[bool] """ Confirm that the payer has accepted the P24 terms and conditions. """ class CreateParamsPaymentMethodOptionsPaynow(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1344,20 +1433,42 @@ class CreateParamsPaymentMethodOptionsPaypal(TypedDict): Controls when the funds will be captured from the customer's account. """ preferred_locale: NotRequired[ - "Literal['cs-CZ', 'da-DK', 'de-AT', 'de-DE', 'de-LU', 'el-GR', 'en-GB', 'en-US', 'es-ES', 'fi-FI', 'fr-BE', 'fr-FR', 'fr-LU', 'hu-HU', 'it-IT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'sk-SK', 'sv-SE']" + Literal[ + "cs-CZ", + "da-DK", + "de-AT", + "de-DE", + "de-LU", + "el-GR", + "en-GB", + "en-US", + "es-ES", + "fi-FI", + "fr-BE", + "fr-FR", + "fr-LU", + "hu-HU", + "it-IT", + "nl-BE", + "nl-NL", + "pl-PL", + "pt-PT", + "sk-SK", + "sv-SE", + ] ] """ [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - reference_id: NotRequired["str"] + reference_id: NotRequired[str] """ A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. """ - risk_correlation_id: NotRequired["str"] + risk_correlation_id: NotRequired[str] """ The risk correlation ID for an on-session payment using a saved PayPal payment method. """ @@ -1373,19 +1484,19 @@ class CreateParamsPaymentMethodOptionsPaypal(TypedDict): If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. """ - subsellers: NotRequired["List[str]"] + subsellers: NotRequired[List[str]] """ The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used. """ class CreateParamsPaymentMethodOptionsPix(TypedDict): - expires_after_seconds: NotRequired["int"] + expires_after_seconds: NotRequired[int] """ The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds. """ class CreateParamsPaymentMethodOptionsRevolutPay(TypedDict): - setup_future_usage: NotRequired["Literal['none', 'off_session']"] + setup_future_usage: NotRequired[Literal["none", "off_session"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1396,7 +1507,7 @@ class CreateParamsPaymentMethodOptionsRevolutPay(TypedDict): class CreateParamsPaymentMethodOptionsSepaDebit(TypedDict): setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1407,7 +1518,7 @@ class CreateParamsPaymentMethodOptionsSepaDebit(TypedDict): """ class CreateParamsPaymentMethodOptionsSofort(TypedDict): - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1430,7 +1541,7 @@ class CreateParamsPaymentMethodOptionsUsBankAccount(TypedDict): Additional fields for Financial Connections Session creation """ setup_future_usage: NotRequired[ - "Literal['none', 'off_session', 'on_session']" + Literal["none", "off_session", "on_session"] ] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1439,7 +1550,7 @@ class CreateParamsPaymentMethodOptionsUsBankAccount(TypedDict): When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). """ - verification_method: NotRequired["Literal['automatic', 'instant']"] + verification_method: NotRequired[Literal["automatic", "instant"]] """ Verification method for the intent """ @@ -1448,20 +1559,31 @@ class CreateParamsPaymentMethodOptionsUsBankAccountFinancialConnections( TypedDict, ): permissions: NotRequired[ - "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" + List[ + Literal[ + "balances", "ownership", "payment_method", "transactions" + ] + ] ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ class CreateParamsPaymentMethodOptionsWechatPay(TypedDict): - app_id: NotRequired["str"] + app_id: NotRequired[str] """ The app ID registered with WeChat Pay. Only required when client is ios or android. """ @@ -1469,7 +1591,7 @@ class CreateParamsPaymentMethodOptionsWechatPay(TypedDict): """ The client type that the end customer will pay from """ - setup_future_usage: NotRequired["Literal['none']"] + setup_future_usage: NotRequired[Literal["none"]] """ Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1485,15 +1607,15 @@ class CreateParamsPhoneNumberCollection(TypedDict): """ class CreateParamsSetupIntentData(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The Stripe account for which the setup is intended. """ @@ -1746,7 +1868,7 @@ class CreateParamsShippingAddressCollection(TypedDict): """ class CreateParamsShippingOption(TypedDict): - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ The ID of the Shipping Rate to use for this shipping option. """ @@ -1774,21 +1896,21 @@ class CreateParamsShippingOptionShippingRateData(TypedDict): """ Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ - type: NotRequired["Literal['fixed_amount']"] + type: NotRequired[Literal["fixed_amount"]] """ The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. """ @@ -1843,7 +1965,10 @@ class CreateParamsShippingOptionShippingRateDataFixedAmount(TypedDict): Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ currency_options: NotRequired[ - "Dict[str, SessionService.CreateParamsShippingOptionShippingRateDataFixedAmountCurrencyOptions]" + Dict[ + str, + "SessionService.CreateParamsShippingOptionShippingRateDataFixedAmountCurrencyOptions", + ] ] """ Shipping rates 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). @@ -1857,28 +1982,28 @@ class CreateParamsShippingOptionShippingRateDataFixedAmountCurrencyOptions( A non-negative integer in cents representing how much to charge. """ tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'unspecified']" + Literal["exclusive", "inclusive", "unspecified"] ] """ Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. """ class CreateParamsSubscriptionData(TypedDict): - application_fee_percent: NotRequired["float"] + application_fee_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). """ - billing_cycle_anchor: NotRequired["int"] + billing_cycle_anchor: NotRequired[int] """ A future timestamp to anchor the subscription's billing cycle for new subscriptions. """ - default_tax_rates: NotRequired["List[str]"] + default_tax_rates: NotRequired[List[str]] """ The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. """ - description: NotRequired["str"] + description: NotRequired[str] """ The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription @@ -1890,15 +2015,15 @@ class CreateParamsSubscriptionData(TypedDict): """ All invoices will be billed using the specified settings. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - on_behalf_of: NotRequired["str"] + on_behalf_of: NotRequired[str] """ The account on behalf of which to charge, for each of the subscription's invoices. """ - proration_behavior: NotRequired["Literal['create_prorations', 'none']"] + proration_behavior: NotRequired[Literal["create_prorations", "none"]] """ Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. """ @@ -1908,13 +2033,13 @@ class CreateParamsSubscriptionData(TypedDict): """ If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. """ - trial_end: NotRequired["int"] + trial_end: NotRequired[int] """ Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future. """ - trial_period_days: NotRequired["int"] + trial_period_days: NotRequired[int] """ Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1. @@ -1935,7 +2060,7 @@ class CreateParamsSubscriptionDataInvoiceSettings(TypedDict): """ class CreateParamsSubscriptionDataInvoiceSettingsIssuer(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The connected account being referenced when `type` is `account`. """ @@ -1945,7 +2070,7 @@ class CreateParamsSubscriptionDataInvoiceSettingsIssuer(TypedDict): """ class CreateParamsSubscriptionDataTransferData(TypedDict): - amount_percent: NotRequired["float"] + amount_percent: NotRequired[float] """ A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. """ @@ -1973,7 +2098,7 @@ class CreateParamsTaxIdCollection(TypedDict): """ class ExpireParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1983,7 +2108,7 @@ class ListParams(TypedDict): """ Only return Checkout Sessions that were created during the given date interval. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return the Checkout Sessions for the Customer specified. """ @@ -1993,53 +2118,53 @@ class ListParams(TypedDict): """ Only return the Checkout Sessions for the Customer details specified. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - payment_intent: NotRequired["str"] + payment_intent: NotRequired[str] """ Only return the Checkout Session for the PaymentIntent specified. """ - payment_link: NotRequired["str"] + payment_link: NotRequired[str] """ Only return the Checkout Sessions for the Payment Link specified. """ - starting_after: NotRequired["str"] + 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. """ - status: NotRequired["Literal['complete', 'expired', 'open']"] + status: NotRequired[Literal["complete", "expired", "open"]] """ Only return the Checkout Sessions matching the given status. """ - subscription: NotRequired["str"] + subscription: NotRequired[str] """ Only return the Checkout Session for the subscription specified. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ @@ -2051,7 +2176,7 @@ class ListParamsCustomerDetails(TypedDict): """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/climate/_order.py b/stripe/climate/_order.py index f227c2332..1fdf62de0 100644 --- a/stripe/climate/_order.py +++ b/stripe/climate/_order.py @@ -86,13 +86,13 @@ class Location(StripeObject): _inner_class_types = {"location": Location} class CancelParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CreateParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ Requested amount of carbon removal units. Either this or `metric_tons` must be specified. """ @@ -100,19 +100,19 @@ class CreateParams(RequestOptions): """ Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - metric_tons: NotRequired["str"] + metric_tons: NotRequired[str] """ Requested number of tons for the order. Either this or `amount` must be specified. """ @@ -128,19 +128,19 @@ class CreateParamsBeneficiary(TypedDict): """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ @@ -150,11 +150,11 @@ class ModifyParams(RequestOptions): """ Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -166,7 +166,7 @@ class ModifyParamsBeneficiary(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/climate/_order_service.py b/stripe/climate/_order_service.py index 5ea56fae4..6ee55084a 100644 --- a/stripe/climate/_order_service.py +++ b/stripe/climate/_order_service.py @@ -11,13 +11,13 @@ class OrderService(StripeService): class CancelParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CreateParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ Requested amount of carbon removal units. Either this or `metric_tons` must be specified. """ @@ -25,19 +25,19 @@ class CreateParams(TypedDict): """ Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - metric_tons: NotRequired["str"] + metric_tons: NotRequired[str] """ Requested number of tons for the order. Either this or `amount` must be specified. """ @@ -53,25 +53,25 @@ class CreateParamsBeneficiary(TypedDict): """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -83,11 +83,11 @@ class UpdateParams(TypedDict): """ Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ diff --git a/stripe/climate/_product.py b/stripe/climate/_product.py index 07823436b..8117c7aa5 100644 --- a/stripe/climate/_product.py +++ b/stripe/climate/_product.py @@ -34,25 +34,25 @@ class CurrentPricesPerMetricTon(StripeObject): """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/climate/_product_service.py b/stripe/climate/_product_service.py index 4a4fd6381..b0c4d230d 100644 --- a/stripe/climate/_product_service.py +++ b/stripe/climate/_product_service.py @@ -11,25 +11,25 @@ class ProductService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/climate/_supplier.py b/stripe/climate/_supplier.py index eeacc535a..74927e9ce 100644 --- a/stripe/climate/_supplier.py +++ b/stripe/climate/_supplier.py @@ -38,25 +38,25 @@ class Location(StripeObject): """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/climate/_supplier_service.py b/stripe/climate/_supplier_service.py index efd0c2ba9..6f4bf0b17 100644 --- a/stripe/climate/_supplier_service.py +++ b/stripe/climate/_supplier_service.py @@ -11,25 +11,25 @@ class SupplierService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/entitlements/_active_entitlement.py b/stripe/entitlements/_active_entitlement.py index 77569618c..fb96b420e 100644 --- a/stripe/entitlements/_active_entitlement.py +++ b/stripe/entitlements/_active_entitlement.py @@ -21,19 +21,19 @@ class ListParams(RequestOptions): """ The ID of the customer. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/entitlements/_active_entitlement_service.py b/stripe/entitlements/_active_entitlement_service.py index d036b9eba..a038d9b4d 100644 --- a/stripe/entitlements/_active_entitlement_service.py +++ b/stripe/entitlements/_active_entitlement_service.py @@ -14,19 +14,19 @@ class ListParams(TypedDict): """ The ID of the customer. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/entitlements/_feature.py b/stripe/entitlements/_feature.py index b8f9f2f05..13e636ed5 100644 --- a/stripe/entitlements/_feature.py +++ b/stripe/entitlements/_feature.py @@ -21,7 +21,7 @@ class Feature( ] = "entitlements.feature" class CreateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -29,7 +29,7 @@ class CreateParams(RequestOptions): """ A unique key you provide as your own system identifier. This may be up to 80 characters. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ @@ -39,19 +39,19 @@ class CreateParams(RequestOptions): """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/entitlements/_feature_service.py b/stripe/entitlements/_feature_service.py index 6312765a5..d83c06d33 100644 --- a/stripe/entitlements/_feature_service.py +++ b/stripe/entitlements/_feature_service.py @@ -10,7 +10,7 @@ class FeatureService(StripeService): class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -18,7 +18,7 @@ class CreateParams(TypedDict): """ A unique key you provide as your own system identifier. This may be up to 80 characters. """ - metadata: NotRequired["Dict[str, str]"] + metadata: NotRequired[Dict[str, str]] """ Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ @@ -28,19 +28,19 @@ class CreateParams(TypedDict): """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/financial_connections/_account.py b/stripe/financial_connections/_account.py index 4ddf2a4ad..32470e2b4 100644 --- a/stripe/financial_connections/_account.py +++ b/stripe/financial_connections/_account.py @@ -154,39 +154,39 @@ class TransactionRefresh(StripeObject): """ class DisconnectParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListInferredBalancesParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 ListOwnersParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -194,7 +194,7 @@ class ListOwnersParams(RequestOptions): """ The ID of the ownership object to fetch owners from. """ - starting_after: NotRequired["str"] + 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. """ @@ -204,39 +204,39 @@ class ListParams(RequestOptions): """ If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - session: NotRequired["str"] + session: NotRequired[str] """ If present, only return accounts that were collected as part of the given session. """ - starting_after: NotRequired["str"] + 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 ListParamsAccountHolder(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The ID of the Stripe account whose accounts will be retrieved. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of the Stripe customer whose accounts will be retrieved. """ class RefreshAccountParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -250,13 +250,13 @@ class RefreshAccountParams(RequestOptions): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SubscribeParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -266,7 +266,7 @@ class SubscribeParams(RequestOptions): """ class UnsubscribeParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/financial_connections/_account_inferred_balance_service.py b/stripe/financial_connections/_account_inferred_balance_service.py index 29a6995a0..d590bde48 100644 --- a/stripe/financial_connections/_account_inferred_balance_service.py +++ b/stripe/financial_connections/_account_inferred_balance_service.py @@ -13,19 +13,19 @@ class AccountInferredBalanceService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/financial_connections/_account_owner_service.py b/stripe/financial_connections/_account_owner_service.py index 52a6eae06..43422e8c8 100644 --- a/stripe/financial_connections/_account_owner_service.py +++ b/stripe/financial_connections/_account_owner_service.py @@ -11,15 +11,15 @@ class AccountOwnerService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -27,7 +27,7 @@ class ListParams(TypedDict): """ The ID of the ownership object to fetch owners from. """ - starting_after: NotRequired["str"] + 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. """ diff --git a/stripe/financial_connections/_account_service.py b/stripe/financial_connections/_account_service.py index a46dd135e..addb2bdd3 100644 --- a/stripe/financial_connections/_account_service.py +++ b/stripe/financial_connections/_account_service.py @@ -22,7 +22,7 @@ def __init__(self, requestor): self.owners = AccountOwnerService(self._requestor) class DisconnectParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -32,39 +32,39 @@ class ListParams(TypedDict): """ If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - session: NotRequired["str"] + session: NotRequired[str] """ If present, only return accounts that were collected as part of the given session. """ - starting_after: NotRequired["str"] + 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 ListParamsAccountHolder(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The ID of the Stripe account whose accounts will be retrieved. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of the Stripe customer whose accounts will be retrieved. """ class RefreshParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -78,13 +78,13 @@ class RefreshParams(TypedDict): """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SubscribeParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -94,7 +94,7 @@ class SubscribeParams(TypedDict): """ class UnsubscribeParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/financial_connections/_session.py b/stripe/financial_connections/_session.py index 8711c6da5..7c64c79c9 100644 --- a/stripe/financial_connections/_session.py +++ b/stripe/financial_connections/_session.py @@ -75,7 +75,7 @@ class CreateParams(RequestOptions): """ The account holder to link accounts for. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -100,22 +100,29 @@ class CreateParams(RequestOptions): Possible values are `balances`, `transactions`, `ownership`, and `payment_method`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ class CreateParamsAccountHolder(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The ID of the Stripe account whose accounts will be retrieved. Should only be present if `type` is `account`. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of the Stripe customer whose accounts will be retrieved. Should only be present if `type` is `customer`. """ @@ -137,13 +144,13 @@ class CreateParamsLimits(TypedDict): """ class CreateParamsManualEntry(TypedDict): - mode: NotRequired["Literal['automatic', 'custom']"] + mode: NotRequired[Literal["automatic", "custom"]] """ Whether manual entry will be handled by Stripe during the Session. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/financial_connections/_session_service.py b/stripe/financial_connections/_session_service.py index c947c8c86..f4b2a1816 100644 --- a/stripe/financial_connections/_session_service.py +++ b/stripe/financial_connections/_session_service.py @@ -14,7 +14,7 @@ class CreateParams(TypedDict): """ The account holder to link accounts for. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -39,22 +39,29 @@ class CreateParams(TypedDict): Possible values are `balances`, `transactions`, `ownership`, and `payment_method`. """ prefetch: NotRequired[ - "List[Literal['balances', 'inferred_balances', 'ownership', 'transactions']]" + List[ + Literal[ + "balances", + "inferred_balances", + "ownership", + "transactions", + ] + ] ] """ List of data features that you would like to retrieve upon account creation. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ class CreateParamsAccountHolder(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The ID of the Stripe account whose accounts will be retrieved. Should only be present if `type` is `account`. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of the Stripe customer whose accounts will be retrieved. Should only be present if `type` is `customer`. """ @@ -76,13 +83,13 @@ class CreateParamsLimits(TypedDict): """ class CreateParamsManualEntry(TypedDict): - mode: NotRequired["Literal['automatic', 'custom']"] + mode: NotRequired[Literal["automatic", "custom"]] """ Whether manual entry will be handled by Stripe during the Session. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/financial_connections/_transaction.py b/stripe/financial_connections/_transaction.py index 191383592..70b6ce9bb 100644 --- a/stripe/financial_connections/_transaction.py +++ b/stripe/financial_connections/_transaction.py @@ -32,19 +32,19 @@ class ListParams(RequestOptions): """ The ID of the Stripe account whose transactions will be retrieved. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ @@ -60,19 +60,19 @@ class ListParams(RequestOptions): """ class ListParamsTransactedAt(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ @@ -84,7 +84,7 @@ class ListParamsTransactionRefresh(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/financial_connections/_transaction_service.py b/stripe/financial_connections/_transaction_service.py index b82617656..362ea579a 100644 --- a/stripe/financial_connections/_transaction_service.py +++ b/stripe/financial_connections/_transaction_service.py @@ -15,19 +15,19 @@ class ListParams(TypedDict): """ The ID of the Stripe account whose transactions will be retrieved. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ @@ -45,19 +45,19 @@ class ListParams(TypedDict): """ class ListParamsTransactedAt(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ @@ -69,7 +69,7 @@ class ListParamsTransactionRefresh(TypedDict): """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/forwarding/_request.py b/stripe/forwarding/_request.py index 59264b0c5..f3744cc11 100644 --- a/stripe/forwarding/_request.py +++ b/stripe/forwarding/_request.py @@ -96,7 +96,7 @@ class CreateParams(RequestOptions): """ The Forwarding Config used when making the forwarded request. The config specifes the HTTP method, merchant credentials, connection settings, and supported destination URLs. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -122,11 +122,11 @@ class CreateParams(RequestOptions): """ class CreateParamsRequest(TypedDict): - body: NotRequired["str"] + body: NotRequired[str] """ The body payload to send to the destination endpoint. """ - headers: NotRequired["List[Request.CreateParamsRequestHeader]"] + headers: NotRequired[List["Request.CreateParamsRequestHeader"]] """ The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included. """ @@ -146,43 +146,43 @@ class ListParams(RequestOptions): """ Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values. """ - ending_before: NotRequired["str"] + ending_before: NotRequired[str] """ A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + starting_after: NotRequired[str] """ A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Return results where the `created` field is greater than this value. """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Return results where the `created` field is greater than or equal to this value. """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Return results where the `created` field is less than this value. """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Return results where the `created` field is less than or equal to this value. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/forwarding/_request_service.py b/stripe/forwarding/_request_service.py index 53741c233..d3e37ff6e 100644 --- a/stripe/forwarding/_request_service.py +++ b/stripe/forwarding/_request_service.py @@ -15,7 +15,7 @@ class CreateParams(TypedDict): """ The Forwarding Config used when making the forwarded request. The config specifes the HTTP method, merchant credentials, connection settings, and supported destination URLs. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -41,11 +41,11 @@ class CreateParams(TypedDict): """ class CreateParamsRequest(TypedDict): - body: NotRequired["str"] + body: NotRequired[str] """ The body payload to send to the destination endpoint. """ - headers: NotRequired["List[RequestService.CreateParamsRequestHeader]"] + headers: NotRequired[List["RequestService.CreateParamsRequestHeader"]] """ The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included. """ @@ -65,43 +65,43 @@ class ListParams(TypedDict): """ Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values. """ - ending_before: NotRequired["str"] + ending_before: NotRequired[str] """ A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + starting_after: NotRequired[str] """ A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Return results where the `created` field is greater than this value. """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Return results where the `created` field is greater than or equal to this value. """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Return results where the `created` field is less than this value. """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Return results where the `created` field is less than or equal to this value. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/gift_cards/_card.py b/stripe/gift_cards/_card.py index 17b9208a5..6525b0355 100644 --- a/stripe/gift_cards/_card.py +++ b/stripe/gift_cards/_card.py @@ -73,7 +73,7 @@ class Payment(StripeObject): } class CreateParams(RequestOptions): - active: NotRequired["bool"] + active: NotRequired[bool] """ The active state for the new gift card, defaults to false. The active state can be updated after creation. """ @@ -85,15 +85,15 @@ class CreateParams(RequestOptions): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - initial_amount: NotRequired["int"] + initial_amount: NotRequired[int] """ The initial amount to load onto the new gift card, defaults to 0. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -115,29 +115,29 @@ class CreateParamsCreatedByPayment(TypedDict): """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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): - active: NotRequired["bool"] + active: NotRequired[bool] """ The new active state for the gift card. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -147,7 +147,7 @@ class ModifyParams(RequestOptions): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -157,11 +157,11 @@ class ValidateParams(RequestOptions): """ The gift card code to be validated. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - giftcard_pin: NotRequired["str"] + giftcard_pin: NotRequired[str] """ The pin associated with the gift card. Not all gift cards have pins. """ diff --git a/stripe/gift_cards/_card_service.py b/stripe/gift_cards/_card_service.py index 5c0967abb..ee424faa0 100644 --- a/stripe/gift_cards/_card_service.py +++ b/stripe/gift_cards/_card_service.py @@ -11,7 +11,7 @@ class CardService(StripeService): class CreateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ The active state for the new gift card, defaults to false. The active state can be updated after creation. """ @@ -23,15 +23,15 @@ class CreateParams(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - initial_amount: NotRequired["int"] + initial_amount: NotRequired[int] """ The initial amount to load onto the new gift card, defaults to 0. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -53,35 +53,35 @@ class CreateParamsCreatedByPayment(TypedDict): """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - active: NotRequired["bool"] + active: NotRequired[bool] """ The new active state for the gift card. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -95,11 +95,11 @@ class ValidateParams(TypedDict): """ The gift card code to be validated. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - giftcard_pin: NotRequired["str"] + giftcard_pin: NotRequired[str] """ The pin associated with the gift card. Not all gift cards have pins. """ diff --git a/stripe/gift_cards/_transaction.py b/stripe/gift_cards/_transaction.py index 9b889f614..14986cde7 100644 --- a/stripe/gift_cards/_transaction.py +++ b/stripe/gift_cards/_transaction.py @@ -70,13 +70,13 @@ class Payment(StripeObject): } class CancelParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ConfirmParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -86,7 +86,7 @@ class CreateParams(RequestOptions): """ The amount of the transaction. A negative amount deducts funds, and a positive amount adds funds. """ - confirm: NotRequired["bool"] + confirm: NotRequired[bool] """ Whether this is a confirmed transaction. A confirmed transaction immediately deducts from/adds to the `amount_available` on the gift card. Otherwise, it creates a held transaction that increments the `amount_held` on the gift card. """ @@ -98,11 +98,11 @@ class CreateParams(RequestOptions): """ The currency of the transaction. This must match the currency of the gift card. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -110,11 +110,11 @@ class CreateParams(RequestOptions): """ The gift card to create a new transaction on. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. """ @@ -136,37 +136,37 @@ class CreateParamsCreatedByPayment(TypedDict): """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - gift_card: NotRequired["str"] + gift_card: NotRequired[str] """ The gift card to list transactions for. """ - limit: NotRequired["int"] + 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"] + 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. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. """ class ModifyParams(RequestOptions): - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -176,7 +176,7 @@ class ModifyParams(RequestOptions): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/gift_cards/_transaction_service.py b/stripe/gift_cards/_transaction_service.py index 462cf6cc3..2316132c8 100644 --- a/stripe/gift_cards/_transaction_service.py +++ b/stripe/gift_cards/_transaction_service.py @@ -11,13 +11,13 @@ class TransactionService(StripeService): class CancelParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ConfirmParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -27,7 +27,7 @@ class CreateParams(TypedDict): """ The amount of the transaction. A negative amount deducts funds, and a positive amount adds funds. """ - confirm: NotRequired["bool"] + confirm: NotRequired[bool] """ Whether this is a confirmed transaction. A confirmed transaction immediately deducts from/adds to the `amount_available` on the gift card. Otherwise, it creates a held transaction that increments the `amount_held` on the gift card. """ @@ -39,11 +39,11 @@ class CreateParams(TypedDict): """ The currency of the transaction. This must match the currency of the gift card. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -51,11 +51,11 @@ class CreateParams(TypedDict): """ The gift card to create a new transaction on. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. """ @@ -77,43 +77,43 @@ class CreateParamsCreatedByPayment(TypedDict): """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - gift_card: NotRequired["str"] + gift_card: NotRequired[str] """ The gift card to list transactions for. """ - limit: NotRequired["int"] + 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"] + 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. """ - transfer_group: NotRequired["str"] + transfer_group: NotRequired[str] """ A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/identity/_verification_report.py b/stripe/identity/_verification_report.py index 75c53e629..acec47b98 100644 --- a/stripe/identity/_verification_report.py +++ b/stripe/identity/_verification_report.py @@ -294,7 +294,7 @@ class Error(StripeObject): _inner_class_types = {"error": Error} class ListParams(RequestOptions): - client_reference_id: NotRequired["str"] + client_reference_id: NotRequired[str] """ A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. """ @@ -302,51 +302,51 @@ class ListParams(RequestOptions): """ Only return VerificationReports that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - type: NotRequired["Literal['document', 'id_number']"] + type: NotRequired[Literal["document", "id_number"]] """ Only return VerificationReports of this type """ - verification_session: NotRequired["str"] + verification_session: NotRequired[str] """ Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/identity/_verification_report_service.py b/stripe/identity/_verification_report_service.py index 6ad5915ff..7554c54e0 100644 --- a/stripe/identity/_verification_report_service.py +++ b/stripe/identity/_verification_report_service.py @@ -11,7 +11,7 @@ class VerificationReportService(StripeService): class ListParams(TypedDict): - client_reference_id: NotRequired["str"] + client_reference_id: NotRequired[str] """ A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. """ @@ -19,51 +19,51 @@ class ListParams(TypedDict): """ Only return VerificationReports that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - type: NotRequired["Literal['document', 'id_number']"] + type: NotRequired[Literal["document", "id_number"]] """ Only return VerificationReports of this type """ - verification_session: NotRequired["str"] + verification_session: NotRequired[str] """ Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/identity/_verification_session.py b/stripe/identity/_verification_session.py index e818ab242..03d409ac1 100644 --- a/stripe/identity/_verification_session.py +++ b/stripe/identity/_verification_session.py @@ -174,21 +174,21 @@ class Dob(StripeObject): _inner_class_types = {"address": Address, "dob": Dob} class CancelParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CreateParams(RequestOptions): - client_reference_id: NotRequired["str"] + client_reference_id: NotRequired[str] """ A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -196,7 +196,7 @@ class CreateParams(RequestOptions): """ A set of options for the session's verification checks. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL that the user will be redirected to upon completing the verification flow. """ @@ -215,26 +215,26 @@ class CreateParamsOptions(TypedDict): class CreateParamsOptionsDocument(TypedDict): allowed_types: NotRequired[ - "List[Literal['driving_license', 'id_card', 'passport']]" + List[Literal["driving_license", "id_card", "passport"]] ] """ Array of strings of allowed identity document types. If the provided identity document isn't one of the allowed types, the verification check will fail with a document_type_not_allowed error code. """ - require_id_number: NotRequired["bool"] + require_id_number: NotRequired[bool] """ Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document's extracted name and date of birth. """ - require_live_capture: NotRequired["bool"] + require_live_capture: NotRequired[bool] """ Disable image uploads, identity document images have to be captured using the device's camera. """ - require_matching_selfie: NotRequired["bool"] + require_matching_selfie: NotRequired[bool] """ Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://stripe.com/docs/identity/selfie). """ class ListParams(RequestOptions): - client_reference_id: NotRequired["str"] + client_reference_id: NotRequired[str] """ A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. """ @@ -242,53 +242,53 @@ class ListParams(RequestOptions): """ Only return VerificationSessions that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['canceled', 'processing', 'requires_input', 'verified']" + Literal["canceled", "processing", "requires_input", "verified"] ] """ Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -296,7 +296,7 @@ class ModifyParams(RequestOptions): """ A set of options for the session's verification checks. """ - type: NotRequired["Literal['document', 'id_number']"] + type: NotRequired[Literal["document", "id_number"]] """ The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. """ @@ -311,32 +311,32 @@ class ModifyParamsOptions(TypedDict): class ModifyParamsOptionsDocument(TypedDict): allowed_types: NotRequired[ - "List[Literal['driving_license', 'id_card', 'passport']]" + List[Literal["driving_license", "id_card", "passport"]] ] """ Array of strings of allowed identity document types. If the provided identity document isn't one of the allowed types, the verification check will fail with a document_type_not_allowed error code. """ - require_id_number: NotRequired["bool"] + require_id_number: NotRequired[bool] """ Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document's extracted name and date of birth. """ - require_live_capture: NotRequired["bool"] + require_live_capture: NotRequired[bool] """ Disable image uploads, identity document images have to be captured using the device's camera. """ - require_matching_selfie: NotRequired["bool"] + require_matching_selfie: NotRequired[bool] """ Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://stripe.com/docs/identity/selfie). """ class RedactParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/identity/_verification_session_service.py b/stripe/identity/_verification_session_service.py index ad3768f06..052d38343 100644 --- a/stripe/identity/_verification_session_service.py +++ b/stripe/identity/_verification_session_service.py @@ -11,21 +11,21 @@ class VerificationSessionService(StripeService): class CancelParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CreateParams(TypedDict): - client_reference_id: NotRequired["str"] + client_reference_id: NotRequired[str] """ A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -33,7 +33,7 @@ class CreateParams(TypedDict): """ A set of options for the session's verification checks. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ The URL that the user will be redirected to upon completing the verification flow. """ @@ -52,26 +52,26 @@ class CreateParamsOptions(TypedDict): class CreateParamsOptionsDocument(TypedDict): allowed_types: NotRequired[ - "List[Literal['driving_license', 'id_card', 'passport']]" + List[Literal["driving_license", "id_card", "passport"]] ] """ Array of strings of allowed identity document types. If the provided identity document isn't one of the allowed types, the verification check will fail with a document_type_not_allowed error code. """ - require_id_number: NotRequired["bool"] + require_id_number: NotRequired[bool] """ Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document's extracted name and date of birth. """ - require_live_capture: NotRequired["bool"] + require_live_capture: NotRequired[bool] """ Disable image uploads, identity document images have to be captured using the device's camera. """ - require_matching_selfie: NotRequired["bool"] + require_matching_selfie: NotRequired[bool] """ Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://stripe.com/docs/identity/selfie). """ class ListParams(TypedDict): - client_reference_id: NotRequired["str"] + client_reference_id: NotRequired[str] """ A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. """ @@ -81,65 +81,65 @@ class ListParams(TypedDict): """ Only return VerificationSessions that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['canceled', 'processing', 'requires_input', 'verified']" + Literal["canceled", "processing", "requires_input", "verified"] ] """ Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RedactParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -147,7 +147,7 @@ class UpdateParams(TypedDict): """ A set of options for the session's verification checks. """ - type: NotRequired["Literal['document', 'id_number']"] + type: NotRequired[Literal["document", "id_number"]] """ The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. """ @@ -162,20 +162,20 @@ class UpdateParamsOptions(TypedDict): class UpdateParamsOptionsDocument(TypedDict): allowed_types: NotRequired[ - "List[Literal['driving_license', 'id_card', 'passport']]" + List[Literal["driving_license", "id_card", "passport"]] ] """ Array of strings of allowed identity document types. If the provided identity document isn't one of the allowed types, the verification check will fail with a document_type_not_allowed error code. """ - require_id_number: NotRequired["bool"] + require_id_number: NotRequired[bool] """ Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document's extracted name and date of birth. """ - require_live_capture: NotRequired["bool"] + require_live_capture: NotRequired[bool] """ Disable image uploads, identity document images have to be captured using the device's camera. """ - require_matching_selfie: NotRequired["bool"] + require_matching_selfie: NotRequired[bool] """ Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://stripe.com/docs/identity/selfie). """ diff --git a/stripe/issuing/_authorization.py b/stripe/issuing/_authorization.py index 492889583..491baa895 100644 --- a/stripe/issuing/_authorization.py +++ b/stripe/issuing/_authorization.py @@ -294,11 +294,11 @@ class ThreeDSecure(StripeObject): } class ApproveParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -308,15 +308,15 @@ class ApproveParams(RequestOptions): """ class CaptureParams(RequestOptions): - capture_amount: NotRequired["int"] + capture_amount: NotRequired[int] """ The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ - close_authorization: NotRequired["bool"] + close_authorization: NotRequired[bool] """ Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -343,101 +343,107 @@ class CaptureParamsPurchaseDetails(TypedDict): Information about lodging that was purchased with this transaction. """ receipt: NotRequired[ - "List[Authorization.CaptureParamsPurchaseDetailsReceipt]" + List["Authorization.CaptureParamsPurchaseDetailsReceipt"] ] """ The line items in the purchase. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A merchant-specific order number. """ class CaptureParamsPurchaseDetailsFlight(TypedDict): - departure_at: NotRequired["int"] + departure_at: NotRequired[int] """ The time that the flight departed. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the passenger. """ - refundable: NotRequired["bool"] + refundable: NotRequired[bool] """ Whether the ticket is refundable. """ segments: NotRequired[ - "List[Authorization.CaptureParamsPurchaseDetailsFlightSegment]" + List["Authorization.CaptureParamsPurchaseDetailsFlightSegment"] ] """ The legs of the trip. """ - travel_agency: NotRequired["str"] + travel_agency: NotRequired[str] """ The travel agency that issued the ticket. """ class CaptureParamsPurchaseDetailsFlightSegment(TypedDict): - arrival_airport_code: NotRequired["str"] + arrival_airport_code: NotRequired[str] """ The three-letter IATA airport code of the flight's destination. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The airline carrier code. """ - departure_airport_code: NotRequired["str"] + departure_airport_code: NotRequired[str] """ The three-letter IATA airport code that the flight departed from. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number. """ - service_class: NotRequired["str"] + service_class: NotRequired[str] """ The flight's service class. """ - stopover_allowed: NotRequired["bool"] + stopover_allowed: NotRequired[bool] """ Whether a stopover is allowed on this flight. """ class CaptureParamsPurchaseDetailsFuel(TypedDict): type: NotRequired[ - "Literal['diesel', 'other', 'unleaded_plus', 'unleaded_regular', 'unleaded_super']" + Literal[ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super", + ] ] """ The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. """ - unit: NotRequired["Literal['liter', 'us_gallon']"] + unit: NotRequired[Literal["liter", "us_gallon"]] """ The units for `volume_decimal`. One of `us_gallon` or `liter`. """ - unit_cost_decimal: NotRequired["str"] + unit_cost_decimal: NotRequired[str] """ The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. """ - volume_decimal: NotRequired["str"] + volume_decimal: NotRequired[str] """ The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. """ class CaptureParamsPurchaseDetailsLodging(TypedDict): - check_in_at: NotRequired["int"] + check_in_at: NotRequired[int] """ The time of checking into the lodging. """ - nights: NotRequired["int"] + nights: NotRequired[int] """ The number of nights stayed at the lodging. """ class CaptureParamsPurchaseDetailsReceipt(TypedDict): - description: NotRequired["str"] - quantity: NotRequired["str"] - total: NotRequired["int"] - unit_cost: NotRequired["int"] + description: NotRequired[str] + quantity: NotRequired[str] + total: NotRequired[int] + unit_cost: NotRequired[int] class CreateParams(RequestOptions): amount: int @@ -449,7 +455,7 @@ class CreateParams(RequestOptions): Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ authorization_method: NotRequired[ - "Literal['chip', 'contactless', 'keyed_in', 'online', 'swipe']" + Literal["chip", "contactless", "keyed_in", "online", "swipe"] ] """ How the card details were provided. Defaults to online. @@ -458,15 +464,15 @@ class CreateParams(RequestOptions): """ Card associated with this authorization. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - is_amount_controllable: NotRequired["bool"] + is_amount_controllable: NotRequired[bool] """ If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. """ @@ -484,78 +490,371 @@ class CreateParams(RequestOptions): """ Verifications that Stripe performed on information that the cardholder provided to the merchant. """ - wallet: NotRequired[ - "Literal['apple_pay', 'google_pay', 'samsung_pay']" - ] + wallet: NotRequired[Literal["apple_pay", "google_pay", "samsung_pay"]] """ The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. """ class CreateParamsAmountDetails(TypedDict): - atm_fee: NotRequired["int"] + atm_fee: NotRequired[int] """ The ATM withdrawal fee. """ - cashback_amount: NotRequired["int"] + cashback_amount: NotRequired[int] """ The amount of cash requested by the cardholder. """ class CreateParamsMerchantData(TypedDict): category: NotRequired[ - "Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']" + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] ] """ A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. """ - city: NotRequired["str"] + city: NotRequired[str] """ City where the seller is located """ - country: NotRequired["str"] + country: NotRequired[str] """ Country where the seller is located """ - name: NotRequired["str"] + name: NotRequired[str] """ Name of the seller """ - network_id: NotRequired["str"] + network_id: NotRequired[str] """ Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code where the seller is located """ - state: NotRequired["str"] + state: NotRequired[str] """ State where the seller is located """ - terminal_id: NotRequired["str"] + terminal_id: NotRequired[str] """ An ID assigned by the seller to the location of the sale. """ - url: NotRequired["str"] + url: NotRequired[str] """ URL provided by the merchant on a 3DS request """ class CreateParamsNetworkData(TypedDict): - acquiring_institution_id: NotRequired["str"] + acquiring_institution_id: NotRequired[str] """ Identifier assigned to the acquirer by the card network. """ class CreateParamsVerificationData(TypedDict): address_line1_check: NotRequired[ - "Literal['match', 'mismatch', 'not_provided']" + Literal["match", "mismatch", "not_provided"] ] """ Whether the cardholder provided an address first line and if it matched the cardholder's `billing.address.line1`. """ address_postal_code_check: NotRequired[ - "Literal['match', 'mismatch', 'not_provided']" + Literal["match", "mismatch", "not_provided"] ] """ Whether the cardholder provided a postal code and if it matched the cardholder's `billing.address.postal_code`. @@ -566,13 +865,11 @@ class CreateParamsVerificationData(TypedDict): """ The exemption applied to this authorization. """ - cvc_check: NotRequired["Literal['match', 'mismatch', 'not_provided']"] + cvc_check: NotRequired[Literal["match", "mismatch", "not_provided"]] """ Whether the cardholder provided a CVC and if it matched Stripe's record. """ - expiry_check: NotRequired[ - "Literal['match', 'mismatch', 'not_provided']" - ] + expiry_check: NotRequired[Literal["match", "mismatch", "not_provided"]] """ Whether the cardholder provided an expiry date and if it matched Stripe's record. """ @@ -604,7 +901,7 @@ class CreateParamsVerificationDataThreeDSecure(TypedDict): """ class DeclineParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -614,13 +911,13 @@ class DeclineParams(RequestOptions): """ class ExpireParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class IncrementParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -628,17 +925,17 @@ class IncrementParams(RequestOptions): """ The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ - is_amount_controllable: NotRequired["bool"] + is_amount_controllable: NotRequired[bool] """ If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. """ class ListParams(RequestOptions): - card: NotRequired["str"] + card: NotRequired[str] """ Only return authorizations that belong to the given card. """ - cardholder: NotRequired["str"] + cardholder: NotRequired[str] """ Only return authorizations that belong to the given cardholder. """ @@ -646,47 +943,47 @@ class ListParams(RequestOptions): """ Only return authorizations that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - status: NotRequired["Literal['closed', 'pending', 'reversed']"] + status: NotRequired[Literal["closed", "pending", "reversed"]] """ Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -696,17 +993,17 @@ class ModifyParams(RequestOptions): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ReverseParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - reverse_amount: NotRequired["int"] + reverse_amount: NotRequired[int] """ The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ diff --git a/stripe/issuing/_authorization_service.py b/stripe/issuing/_authorization_service.py index ed4c1b87d..20118487b 100644 --- a/stripe/issuing/_authorization_service.py +++ b/stripe/issuing/_authorization_service.py @@ -11,11 +11,11 @@ class AuthorizationService(StripeService): class ApproveParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -25,7 +25,7 @@ class ApproveParams(TypedDict): """ class DeclineParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -35,11 +35,11 @@ class DeclineParams(TypedDict): """ class ListParams(TypedDict): - card: NotRequired["str"] + card: NotRequired[str] """ Only return authorizations that belong to the given card. """ - cardholder: NotRequired["str"] + cardholder: NotRequired[str] """ Only return authorizations that belong to the given cardholder. """ @@ -47,53 +47,53 @@ class ListParams(TypedDict): """ Only return authorizations that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - status: NotRequired["Literal['closed', 'pending', 'reversed']"] + status: NotRequired[Literal["closed", "pending", "reversed"]] """ Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/issuing/_card.py b/stripe/issuing/_card.py index 2c430185b..c4fdd91e2 100644 --- a/stripe/issuing/_card.py +++ b/stripe/issuing/_card.py @@ -1165,7 +1165,7 @@ class GooglePay(StripeObject): _inner_class_types = {"apple_pay": ApplePay, "google_pay": GooglePay} class CreateParams(RequestOptions): - cardholder: NotRequired["str"] + cardholder: NotRequired[str] """ The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated. """ @@ -1173,16 +1173,16 @@ class CreateParams(RequestOptions): """ The currency for the card. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - financial_account: NotRequired["str"] - metadata: NotRequired["Dict[str, str]"] + financial_account: NotRequired[str] + 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`. """ - personalization_design: NotRequired["str"] + personalization_design: NotRequired[str] """ The personalization design object belonging to this card. """ @@ -1190,12 +1190,12 @@ class CreateParams(RequestOptions): """ The desired PIN for this card. """ - replacement_for: NotRequired["str"] + replacement_for: NotRequired[str] """ The card this is meant to be a replacement for (if any). """ replacement_reason: NotRequired[ - "Literal['damaged', 'expired', 'lost', 'stolen']" + Literal["damaged", "expired", "lost", "stolen"] ] """ If `replacement_for` is specified, this should indicate why that card is being replaced. @@ -1208,7 +1208,7 @@ class CreateParams(RequestOptions): """ Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. """ - status: NotRequired["Literal['active', 'inactive']"] + status: NotRequired[Literal["active", "inactive"]] """ Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. """ @@ -1218,7 +1218,7 @@ class CreateParams(RequestOptions): """ class CreateParamsPin(TypedDict): - encrypted_number: NotRequired["str"] + encrypted_number: NotRequired[str] """ The card's desired new PIN, encrypted under Stripe's public key. """ @@ -1242,19 +1242,19 @@ class CreateParamsShipping(TypedDict): """ The name printed on the shipping label when shipping the card. """ - phone_number: NotRequired["str"] + phone_number: NotRequired[str] """ Phone number of the recipient of the shipment. """ - require_signature: NotRequired["bool"] + require_signature: NotRequired[bool] """ Whether a signature is required for card delivery. """ - service: NotRequired["Literal['express', 'priority', 'standard']"] + service: NotRequired[Literal["express", "priority", "standard"]] """ Shipment service. """ - type: NotRequired["Literal['bulk', 'individual']"] + type: NotRequired[Literal["bulk", "individual"]] """ Packaging options. """ @@ -1272,7 +1272,7 @@ class CreateParamsShippingAddress(TypedDict): """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ @@ -1280,7 +1280,7 @@ class CreateParamsShippingAddress(TypedDict): """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1294,26 +1294,622 @@ class CreateParamsShippingAddressValidation(TypedDict): """ class CreateParamsShippingCustoms(TypedDict): - eori_number: NotRequired["str"] + eori_number: NotRequired[str] """ The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe. """ class CreateParamsSpendingControls(TypedDict): allowed_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ blocked_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ spending_limits: NotRequired[ - "List[Card.CreateParamsSpendingControlsSpendingLimit]" + List["Card.CreateParamsSpendingControlsSpendingLimit"] ] """ Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). @@ -1325,7 +1921,305 @@ class CreateParamsSpendingControlsSpendingLimit(TypedDict): Maximum amount allowed to spend per interval. """ categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. @@ -1343,19 +2237,19 @@ class CreateParamsSpendingControlsSpendingLimit(TypedDict): """ class DeliverCardParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class FailCardParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListParams(RequestOptions): - cardholder: NotRequired["str"] + cardholder: NotRequired[str] """ Only return cards belonging to the Cardholder with the provided ID. """ @@ -1363,68 +2257,68 @@ class ListParams(RequestOptions): """ Only return cards that were issued during the given date interval. """ - ending_before: NotRequired["str"] + 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. """ - exp_month: NotRequired["int"] + exp_month: NotRequired[int] """ Only return cards that have the given expiration month. """ - exp_year: NotRequired["int"] + exp_year: NotRequired[int] """ Only return cards that have the given expiration year. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - last4: NotRequired["str"] + last4: NotRequired[str] """ Only return cards that have the given last four digits. """ - limit: NotRequired["int"] + 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. """ - personalization_design: NotRequired["str"] - starting_after: NotRequired["str"] + personalization_design: NotRequired[str] + 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. """ - status: NotRequired["Literal['active', 'canceled', 'inactive']"] + status: NotRequired[Literal["active", "canceled", "inactive"]] """ Only return cards that have the given status. One of `active`, `inactive`, or `canceled`. """ - type: NotRequired["Literal['physical', 'virtual']"] + type: NotRequired[Literal["physical", "virtual"]] """ Only return cards that have the given type. One of `virtual` or `physical`. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - cancellation_reason: NotRequired["Literal['lost', 'stolen']"] + cancellation_reason: NotRequired[Literal["lost", "stolen"]] """ Reason why the `status` of this card is `canceled`. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1432,7 +2326,7 @@ class ModifyParams(RequestOptions): """ 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`. """ - personalization_design: NotRequired["str"] + personalization_design: NotRequired[str] pin: NotRequired["Card.ModifyParamsPin"] """ The desired new PIN for this card. @@ -1445,13 +2339,13 @@ class ModifyParams(RequestOptions): """ Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. """ - status: NotRequired["Literal['active', 'canceled', 'inactive']"] + status: NotRequired[Literal["active", "canceled", "inactive"]] """ Dictates whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`. """ class ModifyParamsPin(TypedDict): - encrypted_number: NotRequired["str"] + encrypted_number: NotRequired[str] """ The card's desired new PIN, encrypted under Stripe's public key. """ @@ -1475,19 +2369,19 @@ class ModifyParamsShipping(TypedDict): """ The name printed on the shipping label when shipping the card. """ - phone_number: NotRequired["str"] + phone_number: NotRequired[str] """ Phone number of the recipient of the shipment. """ - require_signature: NotRequired["bool"] + require_signature: NotRequired[bool] """ Whether a signature is required for card delivery. """ - service: NotRequired["Literal['express', 'priority', 'standard']"] + service: NotRequired[Literal["express", "priority", "standard"]] """ Shipment service. """ - type: NotRequired["Literal['bulk', 'individual']"] + type: NotRequired[Literal["bulk", "individual"]] """ Packaging options. """ @@ -1505,7 +2399,7 @@ class ModifyParamsShippingAddress(TypedDict): """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ @@ -1513,7 +2407,7 @@ class ModifyParamsShippingAddress(TypedDict): """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -1527,26 +2421,622 @@ class ModifyParamsShippingAddressValidation(TypedDict): """ class ModifyParamsShippingCustoms(TypedDict): - eori_number: NotRequired["str"] + eori_number: NotRequired[str] """ The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe. """ class ModifyParamsSpendingControls(TypedDict): allowed_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ blocked_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ spending_limits: NotRequired[ - "List[Card.ModifyParamsSpendingControlsSpendingLimit]" + List["Card.ModifyParamsSpendingControlsSpendingLimit"] ] """ Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). @@ -1558,7 +3048,305 @@ class ModifyParamsSpendingControlsSpendingLimit(TypedDict): Maximum amount allowed to spend per interval. """ categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. @@ -1576,19 +3364,19 @@ class ModifyParamsSpendingControlsSpendingLimit(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ReturnCardParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ShipCardParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/issuing/_card_service.py b/stripe/issuing/_card_service.py index 78a68c35b..1f3f62e53 100644 --- a/stripe/issuing/_card_service.py +++ b/stripe/issuing/_card_service.py @@ -11,7 +11,7 @@ class CardService(StripeService): class CreateParams(TypedDict): - cardholder: NotRequired["str"] + cardholder: NotRequired[str] """ The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated. """ @@ -19,16 +19,16 @@ class CreateParams(TypedDict): """ The currency for the card. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - financial_account: NotRequired["str"] - metadata: NotRequired["Dict[str, str]"] + financial_account: NotRequired[str] + 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`. """ - personalization_design: NotRequired["str"] + personalization_design: NotRequired[str] """ The personalization design object belonging to this card. """ @@ -36,12 +36,12 @@ class CreateParams(TypedDict): """ The desired PIN for this card. """ - replacement_for: NotRequired["str"] + replacement_for: NotRequired[str] """ The card this is meant to be a replacement for (if any). """ replacement_reason: NotRequired[ - "Literal['damaged', 'expired', 'lost', 'stolen']" + Literal["damaged", "expired", "lost", "stolen"] ] """ If `replacement_for` is specified, this should indicate why that card is being replaced. @@ -56,7 +56,7 @@ class CreateParams(TypedDict): """ Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. """ - status: NotRequired["Literal['active', 'inactive']"] + status: NotRequired[Literal["active", "inactive"]] """ Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. """ @@ -66,7 +66,7 @@ class CreateParams(TypedDict): """ class CreateParamsPin(TypedDict): - encrypted_number: NotRequired["str"] + encrypted_number: NotRequired[str] """ The card's desired new PIN, encrypted under Stripe's public key. """ @@ -90,19 +90,19 @@ class CreateParamsShipping(TypedDict): """ The name printed on the shipping label when shipping the card. """ - phone_number: NotRequired["str"] + phone_number: NotRequired[str] """ Phone number of the recipient of the shipment. """ - require_signature: NotRequired["bool"] + require_signature: NotRequired[bool] """ Whether a signature is required for card delivery. """ - service: NotRequired["Literal['express', 'priority', 'standard']"] + service: NotRequired[Literal["express", "priority", "standard"]] """ Shipment service. """ - type: NotRequired["Literal['bulk', 'individual']"] + type: NotRequired[Literal["bulk", "individual"]] """ Packaging options. """ @@ -120,7 +120,7 @@ class CreateParamsShippingAddress(TypedDict): """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ @@ -128,7 +128,7 @@ class CreateParamsShippingAddress(TypedDict): """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -142,26 +142,622 @@ class CreateParamsShippingAddressValidation(TypedDict): """ class CreateParamsShippingCustoms(TypedDict): - eori_number: NotRequired["str"] + eori_number: NotRequired[str] """ The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe. """ class CreateParamsSpendingControls(TypedDict): allowed_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ blocked_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ spending_limits: NotRequired[ - "List[CardService.CreateParamsSpendingControlsSpendingLimit]" + List["CardService.CreateParamsSpendingControlsSpendingLimit"] ] """ Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). @@ -173,7 +769,305 @@ class CreateParamsSpendingControlsSpendingLimit(TypedDict): Maximum amount allowed to spend per interval. """ categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. @@ -191,7 +1085,7 @@ class CreateParamsSpendingControlsSpendingLimit(TypedDict): """ class ListParams(TypedDict): - cardholder: NotRequired["str"] + cardholder: NotRequired[str] """ Only return cards belonging to the Cardholder with the provided ID. """ @@ -199,74 +1093,74 @@ class ListParams(TypedDict): """ Only return cards that were issued during the given date interval. """ - ending_before: NotRequired["str"] + 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. """ - exp_month: NotRequired["int"] + exp_month: NotRequired[int] """ Only return cards that have the given expiration month. """ - exp_year: NotRequired["int"] + exp_year: NotRequired[int] """ Only return cards that have the given expiration year. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - last4: NotRequired["str"] + last4: NotRequired[str] """ Only return cards that have the given last four digits. """ - limit: NotRequired["int"] + 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. """ - personalization_design: NotRequired["str"] - starting_after: NotRequired["str"] + personalization_design: NotRequired[str] + 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. """ - status: NotRequired["Literal['active', 'canceled', 'inactive']"] + status: NotRequired[Literal["active", "canceled", "inactive"]] """ Only return cards that have the given status. One of `active`, `inactive`, or `canceled`. """ - type: NotRequired["Literal['physical', 'virtual']"] + type: NotRequired[Literal["physical", "virtual"]] """ Only return cards that have the given type. One of `virtual` or `physical`. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - cancellation_reason: NotRequired["Literal['lost', 'stolen']"] + cancellation_reason: NotRequired[Literal["lost", "stolen"]] """ Reason why the `status` of this card is `canceled`. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -274,7 +1168,7 @@ class UpdateParams(TypedDict): """ 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`. """ - personalization_design: NotRequired["str"] + personalization_design: NotRequired[str] pin: NotRequired["CardService.UpdateParamsPin"] """ The desired new PIN for this card. @@ -289,13 +1183,13 @@ class UpdateParams(TypedDict): """ Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. """ - status: NotRequired["Literal['active', 'canceled', 'inactive']"] + status: NotRequired[Literal["active", "canceled", "inactive"]] """ Dictates whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`. """ class UpdateParamsPin(TypedDict): - encrypted_number: NotRequired["str"] + encrypted_number: NotRequired[str] """ The card's desired new PIN, encrypted under Stripe's public key. """ @@ -319,19 +1213,19 @@ class UpdateParamsShipping(TypedDict): """ The name printed on the shipping label when shipping the card. """ - phone_number: NotRequired["str"] + phone_number: NotRequired[str] """ Phone number of the recipient of the shipment. """ - require_signature: NotRequired["bool"] + require_signature: NotRequired[bool] """ Whether a signature is required for card delivery. """ - service: NotRequired["Literal['express', 'priority', 'standard']"] + service: NotRequired[Literal["express", "priority", "standard"]] """ Shipment service. """ - type: NotRequired["Literal['bulk', 'individual']"] + type: NotRequired[Literal["bulk", "individual"]] """ Packaging options. """ @@ -349,7 +1243,7 @@ class UpdateParamsShippingAddress(TypedDict): """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ @@ -357,7 +1251,7 @@ class UpdateParamsShippingAddress(TypedDict): """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -371,26 +1265,622 @@ class UpdateParamsShippingAddressValidation(TypedDict): """ class UpdateParamsShippingCustoms(TypedDict): - eori_number: NotRequired["str"] + eori_number: NotRequired[str] """ The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe. """ class UpdateParamsSpendingControls(TypedDict): allowed_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ blocked_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ spending_limits: NotRequired[ - "List[CardService.UpdateParamsSpendingControlsSpendingLimit]" + List["CardService.UpdateParamsSpendingControlsSpendingLimit"] ] """ Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). @@ -402,7 +1892,305 @@ class UpdateParamsSpendingControlsSpendingLimit(TypedDict): Maximum amount allowed to spend per interval. """ categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. diff --git a/stripe/issuing/_cardholder.py b/stripe/issuing/_cardholder.py index db235f9ea..4338b6b4a 100644 --- a/stripe/issuing/_cardholder.py +++ b/stripe/issuing/_cardholder.py @@ -1129,11 +1129,11 @@ class CreateParams(RequestOptions): """ Additional information about a `company` cardholder. """ - email: NotRequired["str"] + email: NotRequired[str] """ The cardholder's email address. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1141,7 +1141,7 @@ class CreateParams(RequestOptions): """ Additional information about an `individual` cardholder. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -1149,13 +1149,13 @@ class CreateParams(RequestOptions): """ The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers. """ - phone_number: NotRequired["str"] + phone_number: NotRequired[str] """ The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. While phone number is optional if the cardholder will not be creating EU cards, note that this cardholder will not be eligible for 3DS without a phone number. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details. """ preferred_locales: NotRequired[ - "List[Literal['de', 'en', 'es', 'fr', 'it']]" + List[Literal["de", "en", "es", "fr", "it"]] ] """ The cardholder's preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. @@ -1167,11 +1167,11 @@ class CreateParams(RequestOptions): """ Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. """ - status: NotRequired["Literal['active', 'inactive']"] + status: NotRequired[Literal["active", "inactive"]] """ Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`. """ - type: NotRequired["Literal['company', 'individual']"] + type: NotRequired[Literal["company", "individual"]] """ One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details. """ @@ -1195,7 +1195,7 @@ class CreateParamsBillingAddress(TypedDict): """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ @@ -1203,13 +1203,13 @@ class CreateParamsBillingAddress(TypedDict): """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsCompany(TypedDict): - tax_id: NotRequired["str"] + tax_id: NotRequired[str] """ The entity's business ID number. """ @@ -1225,11 +1225,11 @@ class CreateParamsIndividual(TypedDict): """ The date of birth of this cardholder. Cardholders must be older than 13 years old. """ - first_name: NotRequired["str"] + first_name: NotRequired[str] """ The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. """ - last_name: NotRequired["str"] + last_name: NotRequired[str] """ The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. """ @@ -1249,11 +1249,11 @@ class CreateParamsIndividualCardIssuing(TypedDict): """ class CreateParamsIndividualCardIssuingUserTermsAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. """ @@ -1285,35 +1285,631 @@ class CreateParamsIndividualVerification(TypedDict): """ class CreateParamsIndividualVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. """ class CreateParamsSpendingControls(TypedDict): allowed_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ blocked_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ spending_limits: NotRequired[ - "List[Cardholder.CreateParamsSpendingControlsSpendingLimit]" + List["Cardholder.CreateParamsSpendingControlsSpendingLimit"] ] """ Limit spending with amount-based rules that apply across this cardholder's cards. """ - spending_limits_currency: NotRequired["str"] + spending_limits_currency: NotRequired[str] """ Currency of amounts within `spending_limits`. Defaults to your merchant country's currency. """ @@ -1324,7 +1920,305 @@ class CreateParamsSpendingControlsSpendingLimit(TypedDict): Maximum amount allowed to spend per interval. """ categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. @@ -1346,53 +2240,53 @@ class ListParams(RequestOptions): """ Only return cardholders that were created during the given date interval. """ - email: NotRequired["str"] + email: NotRequired[str] """ Only return cardholders that have the given email address. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - phone_number: NotRequired["str"] + phone_number: NotRequired[str] """ Only return cardholders that have the given phone number. """ - starting_after: NotRequired["str"] + 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. """ - status: NotRequired["Literal['active', 'blocked', 'inactive']"] + status: NotRequired[Literal["active", "blocked", "inactive"]] """ Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`. """ - type: NotRequired["Literal['company', 'individual']"] + type: NotRequired[Literal["company", "individual"]] """ Only return cardholders that have the given type. One of `individual` or `company`. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ @@ -1406,11 +2300,11 @@ class ModifyParams(RequestOptions): """ Additional information about a `company` cardholder. """ - email: NotRequired["str"] + email: NotRequired[str] """ The cardholder's email address. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1418,16 +2312,16 @@ class ModifyParams(RequestOptions): """ Additional information about an `individual` cardholder. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - phone_number: NotRequired["str"] + phone_number: NotRequired[str] """ The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure) for more details. """ preferred_locales: NotRequired[ - "List[Literal['de', 'en', 'es', 'fr', 'it']]" + List[Literal["de", "en", "es", "fr", "it"]] ] """ The cardholder's preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. @@ -1439,7 +2333,7 @@ class ModifyParams(RequestOptions): """ Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. """ - status: NotRequired["Literal['active', 'inactive']"] + status: NotRequired[Literal["active", "inactive"]] """ Specifies whether to permit authorizations on this cardholder's cards. """ @@ -1463,7 +2357,7 @@ class ModifyParamsBillingAddress(TypedDict): """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ @@ -1471,13 +2365,13 @@ class ModifyParamsBillingAddress(TypedDict): """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class ModifyParamsCompany(TypedDict): - tax_id: NotRequired["str"] + tax_id: NotRequired[str] """ The entity's business ID number. """ @@ -1493,11 +2387,11 @@ class ModifyParamsIndividual(TypedDict): """ The date of birth of this cardholder. Cardholders must be older than 13 years old. """ - first_name: NotRequired["str"] + first_name: NotRequired[str] """ The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. """ - last_name: NotRequired["str"] + last_name: NotRequired[str] """ The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. """ @@ -1517,11 +2411,11 @@ class ModifyParamsIndividualCardIssuing(TypedDict): """ class ModifyParamsIndividualCardIssuingUserTermsAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. """ @@ -1553,35 +2447,631 @@ class ModifyParamsIndividualVerification(TypedDict): """ class ModifyParamsIndividualVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. """ class ModifyParamsSpendingControls(TypedDict): allowed_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ blocked_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ spending_limits: NotRequired[ - "List[Cardholder.ModifyParamsSpendingControlsSpendingLimit]" + List["Cardholder.ModifyParamsSpendingControlsSpendingLimit"] ] """ Limit spending with amount-based rules that apply across this cardholder's cards. """ - spending_limits_currency: NotRequired["str"] + spending_limits_currency: NotRequired[str] """ Currency of amounts within `spending_limits`. Defaults to your merchant country's currency. """ @@ -1592,7 +3082,305 @@ class ModifyParamsSpendingControlsSpendingLimit(TypedDict): Maximum amount allowed to spend per interval. """ categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. @@ -1610,7 +3398,7 @@ class ModifyParamsSpendingControlsSpendingLimit(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/issuing/_cardholder_service.py b/stripe/issuing/_cardholder_service.py index adbf054c0..016940660 100644 --- a/stripe/issuing/_cardholder_service.py +++ b/stripe/issuing/_cardholder_service.py @@ -19,11 +19,11 @@ class CreateParams(TypedDict): """ Additional information about a `company` cardholder. """ - email: NotRequired["str"] + email: NotRequired[str] """ The cardholder's email address. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -31,7 +31,7 @@ class CreateParams(TypedDict): """ Additional information about an `individual` cardholder. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -39,13 +39,13 @@ class CreateParams(TypedDict): """ The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers. """ - phone_number: NotRequired["str"] + phone_number: NotRequired[str] """ The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. While phone number is optional if the cardholder will not be creating EU cards, note that this cardholder will not be eligible for 3DS without a phone number. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details. """ preferred_locales: NotRequired[ - "List[Literal['de', 'en', 'es', 'fr', 'it']]" + List[Literal["de", "en", "es", "fr", "it"]] ] """ The cardholder's preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. @@ -57,11 +57,11 @@ class CreateParams(TypedDict): """ Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. """ - status: NotRequired["Literal['active', 'inactive']"] + status: NotRequired[Literal["active", "inactive"]] """ Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`. """ - type: NotRequired["Literal['company', 'individual']"] + type: NotRequired[Literal["company", "individual"]] """ One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details. """ @@ -85,7 +85,7 @@ class CreateParamsBillingAddress(TypedDict): """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ @@ -93,13 +93,13 @@ class CreateParamsBillingAddress(TypedDict): """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsCompany(TypedDict): - tax_id: NotRequired["str"] + tax_id: NotRequired[str] """ The entity's business ID number. """ @@ -115,11 +115,11 @@ class CreateParamsIndividual(TypedDict): """ The date of birth of this cardholder. Cardholders must be older than 13 years old. """ - first_name: NotRequired["str"] + first_name: NotRequired[str] """ The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. """ - last_name: NotRequired["str"] + last_name: NotRequired[str] """ The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. """ @@ -139,11 +139,11 @@ class CreateParamsIndividualCardIssuing(TypedDict): """ class CreateParamsIndividualCardIssuingUserTermsAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. """ @@ -175,35 +175,631 @@ class CreateParamsIndividualVerification(TypedDict): """ class CreateParamsIndividualVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. """ class CreateParamsSpendingControls(TypedDict): allowed_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ blocked_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ spending_limits: NotRequired[ - "List[CardholderService.CreateParamsSpendingControlsSpendingLimit]" + List["CardholderService.CreateParamsSpendingControlsSpendingLimit"] ] """ Limit spending with amount-based rules that apply across this cardholder's cards. """ - spending_limits_currency: NotRequired["str"] + spending_limits_currency: NotRequired[str] """ Currency of amounts within `spending_limits`. Defaults to your merchant country's currency. """ @@ -214,7 +810,305 @@ class CreateParamsSpendingControlsSpendingLimit(TypedDict): Maximum amount allowed to spend per interval. """ categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. @@ -236,59 +1130,59 @@ class ListParams(TypedDict): """ Only return cardholders that were created during the given date interval. """ - email: NotRequired["str"] + email: NotRequired[str] """ Only return cardholders that have the given email address. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - phone_number: NotRequired["str"] + phone_number: NotRequired[str] """ Only return cardholders that have the given phone number. """ - starting_after: NotRequired["str"] + 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. """ - status: NotRequired["Literal['active', 'blocked', 'inactive']"] + status: NotRequired[Literal["active", "blocked", "inactive"]] """ Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`. """ - type: NotRequired["Literal['company', 'individual']"] + type: NotRequired[Literal["company", "individual"]] """ Only return cardholders that have the given type. One of `individual` or `company`. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -302,11 +1196,11 @@ class UpdateParams(TypedDict): """ Additional information about a `company` cardholder. """ - email: NotRequired["str"] + email: NotRequired[str] """ The cardholder's email address. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -314,16 +1208,16 @@ class UpdateParams(TypedDict): """ Additional information about an `individual` cardholder. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - phone_number: NotRequired["str"] + phone_number: NotRequired[str] """ The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure) for more details. """ preferred_locales: NotRequired[ - "List[Literal['de', 'en', 'es', 'fr', 'it']]" + List[Literal["de", "en", "es", "fr", "it"]] ] """ The cardholder's preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. @@ -335,7 +1229,7 @@ class UpdateParams(TypedDict): """ Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. """ - status: NotRequired["Literal['active', 'inactive']"] + status: NotRequired[Literal["active", "inactive"]] """ Specifies whether to permit authorizations on this cardholder's cards. """ @@ -359,7 +1253,7 @@ class UpdateParamsBillingAddress(TypedDict): """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ @@ -367,13 +1261,13 @@ class UpdateParamsBillingAddress(TypedDict): """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class UpdateParamsCompany(TypedDict): - tax_id: NotRequired["str"] + tax_id: NotRequired[str] """ The entity's business ID number. """ @@ -389,11 +1283,11 @@ class UpdateParamsIndividual(TypedDict): """ The date of birth of this cardholder. Cardholders must be older than 13 years old. """ - first_name: NotRequired["str"] + first_name: NotRequired[str] """ The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. """ - last_name: NotRequired["str"] + last_name: NotRequired[str] """ The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. """ @@ -413,11 +1307,11 @@ class UpdateParamsIndividualCardIssuing(TypedDict): """ class UpdateParamsIndividualCardIssuingUserTermsAcceptance(TypedDict): - date: NotRequired["int"] + date: NotRequired[int] """ The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. """ - ip: NotRequired["str"] + ip: NotRequired[str] """ The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. """ @@ -449,35 +1343,631 @@ class UpdateParamsIndividualVerification(TypedDict): """ class UpdateParamsIndividualVerificationDocument(TypedDict): - back: NotRequired["str"] + back: NotRequired[str] """ The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. """ - front: NotRequired["str"] + front: NotRequired[str] """ The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. """ class UpdateParamsSpendingControls(TypedDict): allowed_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ blocked_categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ spending_limits: NotRequired[ - "List[CardholderService.UpdateParamsSpendingControlsSpendingLimit]" + List["CardholderService.UpdateParamsSpendingControlsSpendingLimit"] ] """ Limit spending with amount-based rules that apply across this cardholder's cards. """ - spending_limits_currency: NotRequired["str"] + spending_limits_currency: NotRequired[str] """ Currency of amounts within `spending_limits`. Defaults to your merchant country's currency. """ @@ -488,7 +1978,305 @@ class UpdateParamsSpendingControlsSpendingLimit(TypedDict): Maximum amount allowed to spend per interval. """ categories: NotRequired[ - "List[Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']]" + List[ + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] + ] ] """ Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. diff --git a/stripe/issuing/_credit_underwriting_record.py b/stripe/issuing/_credit_underwriting_record.py index 238439d8f..51987a218 100644 --- a/stripe/issuing/_credit_underwriting_record.py +++ b/stripe/issuing/_credit_underwriting_record.py @@ -375,7 +375,7 @@ class CorrectParams(RequestOptions): """ Information about the company or person applying or holding the account. """ - decided_at: NotRequired["int"] + decided_at: NotRequired[int] """ Date when a decision was made. """ @@ -383,11 +383,11 @@ class CorrectParams(RequestOptions): """ Details about the decision. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -400,7 +400,7 @@ class CorrectParams(RequestOptions): class CorrectParamsApplication(TypedDict): application_method: NotRequired[ - "Literal['in_person', 'mail', 'online', 'phone']" + Literal["in_person", "mail", "online", "phone"] ] """ The channel through which the applicant has submitted their application. Defaults to `online`. @@ -463,7 +463,7 @@ class CorrectParamsDecision(TypedDict): """ class CorrectParamsDecisionApplicationRejected(TypedDict): - reason_other_explanation: NotRequired["str"] + reason_other_explanation: NotRequired[str] """ Details about the `reasons.other` when present. """ @@ -543,7 +543,7 @@ class CorrectParamsDecisionCreditLimitApproved(TypedDict): """ The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the credit approved, will default to the Account's Issuing currency. """ @@ -553,11 +553,11 @@ class CorrectParamsDecisionCreditLimitDecreased(TypedDict): """ The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the credit approved, will default to the Account's Issuing currency. """ - reason_other_explanation: NotRequired["str"] + reason_other_explanation: NotRequired[str] """ Details about the `reasons.other` when present. """ @@ -641,7 +641,7 @@ class CorrectParamsDecisionCreditLimitDecreased(TypedDict): """ class CorrectParamsDecisionCreditLineClosed(TypedDict): - reason_other_explanation: NotRequired["str"] + reason_other_explanation: NotRequired[str] """ Details about the `reasons.other` when present. """ @@ -751,18 +751,18 @@ class CreateFromApplicationParams(RequestOptions): """ Information about the company or person applying or holding the account. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ class CreateFromApplicationParamsApplication(TypedDict): application_method: NotRequired[ - "Literal['in_person', 'mail', 'online', 'phone']" + Literal["in_person", "mail", "online", "phone"] ] """ The channel through which the applicant has submitted their application. Defaults to `online`. @@ -799,11 +799,11 @@ class CreateFromProactiveReviewParams(RequestOptions): """ Details about the decision. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -860,7 +860,7 @@ class CreateFromProactiveReviewParamsDecisionCreditLimitApproved( """ The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the credit approved, will default to the Account's Issuing currency. """ @@ -872,11 +872,11 @@ class CreateFromProactiveReviewParamsDecisionCreditLimitDecreased( """ The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the credit approved, will default to the Account's Issuing currency. """ - reason_other_explanation: NotRequired["str"] + reason_other_explanation: NotRequired[str] """ Details about the `reasons.other` when present. """ @@ -960,7 +960,7 @@ class CreateFromProactiveReviewParamsDecisionCreditLimitDecreased( """ class CreateFromProactiveReviewParamsDecisionCreditLineClosed(TypedDict): - reason_other_explanation: NotRequired["str"] + reason_other_explanation: NotRequired[str] """ Details about the `reasons.other` when present. """ @@ -1062,19 +1062,19 @@ class CreateFromProactiveReviewParamsUnderwritingException(TypedDict): """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ @@ -1088,11 +1088,11 @@ class ReportDecisionParams(RequestOptions): """ Details about the decision. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -1127,7 +1127,7 @@ class ReportDecisionParamsDecision(TypedDict): """ class ReportDecisionParamsDecisionApplicationRejected(TypedDict): - reason_other_explanation: NotRequired["str"] + reason_other_explanation: NotRequired[str] """ Details about the `reasons.other` when present. """ @@ -1207,7 +1207,7 @@ class ReportDecisionParamsDecisionCreditLimitApproved(TypedDict): """ The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the credit approved, will default to the Account's Issuing currency. """ @@ -1231,7 +1231,7 @@ class ReportDecisionParamsUnderwritingException(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/issuing/_credit_underwriting_record_service.py b/stripe/issuing/_credit_underwriting_record_service.py index 72d318fe3..aff6f97f1 100644 --- a/stripe/issuing/_credit_underwriting_record_service.py +++ b/stripe/issuing/_credit_underwriting_record_service.py @@ -23,7 +23,7 @@ class CorrectParams(TypedDict): """ Information about the company or person applying or holding the account. """ - decided_at: NotRequired["int"] + decided_at: NotRequired[int] """ Date when a decision was made. """ @@ -33,11 +33,11 @@ class CorrectParams(TypedDict): """ Details about the decision. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -50,7 +50,7 @@ class CorrectParams(TypedDict): class CorrectParamsApplication(TypedDict): application_method: NotRequired[ - "Literal['in_person', 'mail', 'online', 'phone']" + Literal["in_person", "mail", "online", "phone"] ] """ The channel through which the applicant has submitted their application. Defaults to `online`. @@ -113,7 +113,7 @@ class CorrectParamsDecision(TypedDict): """ class CorrectParamsDecisionApplicationRejected(TypedDict): - reason_other_explanation: NotRequired["str"] + reason_other_explanation: NotRequired[str] """ Details about the `reasons.other` when present. """ @@ -193,7 +193,7 @@ class CorrectParamsDecisionCreditLimitApproved(TypedDict): """ The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the credit approved, will default to the Account's Issuing currency. """ @@ -203,11 +203,11 @@ class CorrectParamsDecisionCreditLimitDecreased(TypedDict): """ The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the credit approved, will default to the Account's Issuing currency. """ - reason_other_explanation: NotRequired["str"] + reason_other_explanation: NotRequired[str] """ Details about the `reasons.other` when present. """ @@ -291,7 +291,7 @@ class CorrectParamsDecisionCreditLimitDecreased(TypedDict): """ class CorrectParamsDecisionCreditLineClosed(TypedDict): - reason_other_explanation: NotRequired["str"] + reason_other_explanation: NotRequired[str] """ Details about the `reasons.other` when present. """ @@ -401,18 +401,18 @@ class CreateFromApplicationParams(TypedDict): """ Information about the company or person applying or holding the account. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ class CreateFromApplicationParamsApplication(TypedDict): application_method: NotRequired[ - "Literal['in_person', 'mail', 'online', 'phone']" + Literal["in_person", "mail", "online", "phone"] ] """ The channel through which the applicant has submitted their application. Defaults to `online`. @@ -449,11 +449,11 @@ class CreateFromProactiveReviewParams(TypedDict): """ Details about the decision. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -510,7 +510,7 @@ class CreateFromProactiveReviewParamsDecisionCreditLimitApproved( """ The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the credit approved, will default to the Account's Issuing currency. """ @@ -522,11 +522,11 @@ class CreateFromProactiveReviewParamsDecisionCreditLimitDecreased( """ The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the credit approved, will default to the Account's Issuing currency. """ - reason_other_explanation: NotRequired["str"] + reason_other_explanation: NotRequired[str] """ Details about the `reasons.other` when present. """ @@ -610,7 +610,7 @@ class CreateFromProactiveReviewParamsDecisionCreditLimitDecreased( """ class CreateFromProactiveReviewParamsDecisionCreditLineClosed(TypedDict): - reason_other_explanation: NotRequired["str"] + reason_other_explanation: NotRequired[str] """ Details about the `reasons.other` when present. """ @@ -712,19 +712,19 @@ class CreateFromProactiveReviewParamsUnderwritingException(TypedDict): """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ @@ -738,11 +738,11 @@ class ReportDecisionParams(TypedDict): """ Details about the decision. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -777,7 +777,7 @@ class ReportDecisionParamsDecision(TypedDict): """ class ReportDecisionParamsDecisionApplicationRejected(TypedDict): - reason_other_explanation: NotRequired["str"] + reason_other_explanation: NotRequired[str] """ Details about the `reasons.other` when present. """ @@ -857,7 +857,7 @@ class ReportDecisionParamsDecisionCreditLimitApproved(TypedDict): """ The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the credit approved, will default to the Account's Issuing currency. """ @@ -881,7 +881,7 @@ class ReportDecisionParamsUnderwritingException(TypedDict): """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/issuing/_dispute.py b/stripe/issuing/_dispute.py index e50744e8d..32c735376 100644 --- a/stripe/issuing/_dispute.py +++ b/stripe/issuing/_dispute.py @@ -243,7 +243,7 @@ class Treasury(StripeObject): """ class CreateParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If not set, defaults to the full transaction amount. """ @@ -251,15 +251,15 @@ class CreateParams(RequestOptions): """ Evidence provided for the dispute. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - transaction: NotRequired["str"] + transaction: NotRequired[str] """ The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`. """ @@ -304,7 +304,15 @@ class CreateParamsEvidence(TypedDict): Evidence provided when `reason` is 'other'. """ reason: NotRequired[ - "Literal['canceled', 'duplicate', 'fraudulent', 'merchandise_not_as_described', 'not_received', 'other', 'service_not_as_described']" + Literal[ + "canceled", + "duplicate", + "fraudulent", + "merchandise_not_as_described", + "not_received", + "other", + "service_not_as_described", + ] ] """ The reason for filing the dispute. The evidence should be submitted in the field of the same name. @@ -383,7 +391,7 @@ class CreateParamsEvidenceDuplicate(TypedDict): """ Explanation of why the cardholder is disputing this transaction. """ - original_transaction: NotRequired["str"] + original_transaction: NotRequired[str] """ Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one. """ @@ -503,53 +511,53 @@ class ListParams(RequestOptions): """ Only return Issuing disputes that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['expired', 'lost', 'submitted', 'unsubmitted', 'won']" + Literal["expired", "lost", "submitted", "unsubmitted", "won"] ] """ Select Issuing disputes with the given status. """ - transaction: NotRequired["str"] + transaction: NotRequired[str] """ Select the Issuing dispute for the given transaction. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ @@ -557,7 +565,7 @@ class ModifyParams(RequestOptions): """ Evidence provided for the dispute. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -602,7 +610,15 @@ class ModifyParamsEvidence(TypedDict): Evidence provided when `reason` is 'other'. """ reason: NotRequired[ - "Literal['canceled', 'duplicate', 'fraudulent', 'merchandise_not_as_described', 'not_received', 'other', 'service_not_as_described']" + Literal[ + "canceled", + "duplicate", + "fraudulent", + "merchandise_not_as_described", + "not_received", + "other", + "service_not_as_described", + ] ] """ The reason for filing the dispute. The evidence should be submitted in the field of the same name. @@ -681,7 +697,7 @@ class ModifyParamsEvidenceDuplicate(TypedDict): """ Explanation of why the cardholder is disputing this transaction. """ - original_transaction: NotRequired["str"] + original_transaction: NotRequired[str] """ Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one. """ @@ -791,13 +807,13 @@ class ModifyParamsEvidenceServiceNotAsDescribed(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SubmitParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/issuing/_dispute_service.py b/stripe/issuing/_dispute_service.py index ea7f4d4e3..4b567e3ce 100644 --- a/stripe/issuing/_dispute_service.py +++ b/stripe/issuing/_dispute_service.py @@ -11,7 +11,7 @@ class DisputeService(StripeService): class CreateParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If not set, defaults to the full transaction amount. """ @@ -19,15 +19,15 @@ class CreateParams(TypedDict): """ Evidence provided for the dispute. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - transaction: NotRequired["str"] + transaction: NotRequired[str] """ The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`. """ @@ -74,7 +74,15 @@ class CreateParamsEvidence(TypedDict): Evidence provided when `reason` is 'other'. """ reason: NotRequired[ - "Literal['canceled', 'duplicate', 'fraudulent', 'merchandise_not_as_described', 'not_received', 'other', 'service_not_as_described']" + Literal[ + "canceled", + "duplicate", + "fraudulent", + "merchandise_not_as_described", + "not_received", + "other", + "service_not_as_described", + ] ] """ The reason for filing the dispute. The evidence should be submitted in the field of the same name. @@ -153,7 +161,7 @@ class CreateParamsEvidenceDuplicate(TypedDict): """ Explanation of why the cardholder is disputing this transaction. """ - original_transaction: NotRequired["str"] + original_transaction: NotRequired[str] """ Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one. """ @@ -273,59 +281,59 @@ class ListParams(TypedDict): """ Only return Issuing disputes that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['expired', 'lost', 'submitted', 'unsubmitted', 'won']" + Literal["expired", "lost", "submitted", "unsubmitted", "won"] ] """ Select Issuing disputes with the given status. """ - transaction: NotRequired["str"] + transaction: NotRequired[str] """ Select the Issuing dispute for the given transaction. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SubmitParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -335,7 +343,7 @@ class SubmitParams(TypedDict): """ class UpdateParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ @@ -343,7 +351,7 @@ class UpdateParams(TypedDict): """ Evidence provided for the dispute. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -390,7 +398,15 @@ class UpdateParamsEvidence(TypedDict): Evidence provided when `reason` is 'other'. """ reason: NotRequired[ - "Literal['canceled', 'duplicate', 'fraudulent', 'merchandise_not_as_described', 'not_received', 'other', 'service_not_as_described']" + Literal[ + "canceled", + "duplicate", + "fraudulent", + "merchandise_not_as_described", + "not_received", + "other", + "service_not_as_described", + ] ] """ The reason for filing the dispute. The evidence should be submitted in the field of the same name. @@ -469,7 +485,7 @@ class UpdateParamsEvidenceDuplicate(TypedDict): """ Explanation of why the cardholder is disputing this transaction. """ - original_transaction: NotRequired["str"] + original_transaction: NotRequired[str] """ Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one. """ diff --git a/stripe/issuing/_personalization_design.py b/stripe/issuing/_personalization_design.py index 6f74c90f9..16b2aaa9d 100644 --- a/stripe/issuing/_personalization_design.py +++ b/stripe/issuing/_personalization_design.py @@ -101,13 +101,13 @@ class RejectionReasons(StripeObject): """ class ActivateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CreateParams(RequestOptions): - card_logo: NotRequired["str"] + card_logo: NotRequired[str] """ The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. """ @@ -117,19 +117,19 @@ class CreateParams(RequestOptions): """ Hash containing carrier text, for use with physical bundles that support carrier text. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - lookup_key: NotRequired["str"] + lookup_key: NotRequired[str] """ A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - name: NotRequired["str"] + name: NotRequired[str] """ Friendly display name. """ @@ -143,7 +143,7 @@ class CreateParams(RequestOptions): """ Information on whether this personalization design is used to create cards when one is not specified. """ - transfer_lookup_key: NotRequired["bool"] + transfer_lookup_key: NotRequired[bool] """ If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design. """ @@ -173,25 +173,25 @@ class CreateParamsPreferences(TypedDict): """ class DeactivateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - lookup_keys: NotRequired["List[str]"] + lookup_keys: NotRequired[List[str]] """ Only return personalization designs with the given lookup keys. """ @@ -199,23 +199,23 @@ class ListParams(RequestOptions): """ Only return personalization designs with the given preferences. """ - starting_after: NotRequired["str"] + 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. """ status: NotRequired[ - "Literal['active', 'inactive', 'rejected', 'review']" + Literal["active", "inactive", "rejected", "review"] ] """ Only return personalization designs with the given status. """ class ListParamsPreferences(TypedDict): - is_default: NotRequired["bool"] + is_default: NotRequired[bool] """ Only return the personalization design that's set as the default. A connected account uses the Connect platform's default design if no personalization design is set as the default. """ - is_platform_default: NotRequired["bool"] + is_platform_default: NotRequired[bool] """ Only return the personalization design that is set as the Connect platform's default. This parameter is only applicable to connected accounts. """ @@ -231,7 +231,7 @@ class ModifyParams(RequestOptions): """ Hash containing carrier text, for use with physical bundles that support carrier text. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -239,7 +239,7 @@ class ModifyParams(RequestOptions): """ A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -247,7 +247,7 @@ class ModifyParams(RequestOptions): """ Friendly display name. Providing an empty string will set the field to null. """ - physical_bundle: NotRequired["str"] + physical_bundle: NotRequired[str] """ The physical bundle object belonging to this personalization design. """ @@ -257,7 +257,7 @@ class ModifyParams(RequestOptions): """ Information on whether this personalization design is used to create cards when one is not specified. """ - transfer_lookup_key: NotRequired["bool"] + transfer_lookup_key: NotRequired[bool] """ If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design. """ @@ -287,7 +287,7 @@ class ModifyParamsPreferences(TypedDict): """ class RejectParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -298,20 +298,41 @@ class RejectParams(RequestOptions): class RejectParamsRejectionReasons(TypedDict): card_logo: NotRequired[ - "List[Literal['geographic_location', 'inappropriate', 'network_name', 'non_binary_image', 'non_fiat_currency', 'other', 'other_entity', 'promotional_material']]" + List[ + Literal[ + "geographic_location", + "inappropriate", + "network_name", + "non_binary_image", + "non_fiat_currency", + "other", + "other_entity", + "promotional_material", + ] + ] ] """ The reason(s) the card logo was rejected. """ carrier_text: NotRequired[ - "List[Literal['geographic_location', 'inappropriate', 'network_name', 'non_fiat_currency', 'other', 'other_entity', 'promotional_material']]" + List[ + Literal[ + "geographic_location", + "inappropriate", + "network_name", + "non_fiat_currency", + "other", + "other_entity", + "promotional_material", + ] + ] ] """ The reason(s) the carrier text was rejected. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/issuing/_personalization_design_service.py b/stripe/issuing/_personalization_design_service.py index a1e06854b..259746c88 100644 --- a/stripe/issuing/_personalization_design_service.py +++ b/stripe/issuing/_personalization_design_service.py @@ -11,7 +11,7 @@ class PersonalizationDesignService(StripeService): class CreateParams(TypedDict): - card_logo: NotRequired["str"] + card_logo: NotRequired[str] """ The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. """ @@ -21,19 +21,19 @@ class CreateParams(TypedDict): """ Hash containing carrier text, for use with physical bundles that support carrier text. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - lookup_key: NotRequired["str"] + lookup_key: NotRequired[str] """ A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - name: NotRequired["str"] + name: NotRequired[str] """ Friendly display name. """ @@ -47,7 +47,7 @@ class CreateParams(TypedDict): """ Information on whether this personalization design is used to create cards when one is not specified. """ - transfer_lookup_key: NotRequired["bool"] + transfer_lookup_key: NotRequired[bool] """ If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design. """ @@ -77,19 +77,19 @@ class CreateParamsPreferences(TypedDict): """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - lookup_keys: NotRequired["List[str]"] + lookup_keys: NotRequired[List[str]] """ Only return personalization designs with the given lookup keys. """ @@ -99,29 +99,29 @@ class ListParams(TypedDict): """ Only return personalization designs with the given preferences. """ - starting_after: NotRequired["str"] + 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. """ status: NotRequired[ - "Literal['active', 'inactive', 'rejected', 'review']" + Literal["active", "inactive", "rejected", "review"] ] """ Only return personalization designs with the given status. """ class ListParamsPreferences(TypedDict): - is_default: NotRequired["bool"] + is_default: NotRequired[bool] """ Only return the personalization design that's set as the default. A connected account uses the Connect platform's default design if no personalization design is set as the default. """ - is_platform_default: NotRequired["bool"] + is_platform_default: NotRequired[bool] """ Only return the personalization design that is set as the Connect platform's default. This parameter is only applicable to connected accounts. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -137,7 +137,7 @@ class UpdateParams(TypedDict): """ Hash containing carrier text, for use with physical bundles that support carrier text. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -145,7 +145,7 @@ class UpdateParams(TypedDict): """ A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -153,7 +153,7 @@ class UpdateParams(TypedDict): """ Friendly display name. Providing an empty string will set the field to null. """ - physical_bundle: NotRequired["str"] + physical_bundle: NotRequired[str] """ The physical bundle object belonging to this personalization design. """ @@ -163,7 +163,7 @@ class UpdateParams(TypedDict): """ Information on whether this personalization design is used to create cards when one is not specified. """ - transfer_lookup_key: NotRequired["bool"] + transfer_lookup_key: NotRequired[bool] """ If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design. """ diff --git a/stripe/issuing/_physical_bundle.py b/stripe/issuing/_physical_bundle.py index 23cd3d06e..c5c5d0c82 100644 --- a/stripe/issuing/_physical_bundle.py +++ b/stripe/issuing/_physical_bundle.py @@ -32,33 +32,33 @@ class Features(StripeObject): """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - status: NotRequired["Literal['active', 'inactive', 'review']"] + status: NotRequired[Literal["active", "inactive", "review"]] """ Only return physical bundles with the given status. """ - type: NotRequired["Literal['custom', 'standard']"] + type: NotRequired[Literal["custom", "standard"]] """ Only return physical bundles with the given type. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/issuing/_physical_bundle_service.py b/stripe/issuing/_physical_bundle_service.py index 29b5317db..39722924d 100644 --- a/stripe/issuing/_physical_bundle_service.py +++ b/stripe/issuing/_physical_bundle_service.py @@ -11,33 +11,33 @@ class PhysicalBundleService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - status: NotRequired["Literal['active', 'inactive', 'review']"] + status: NotRequired[Literal["active", "inactive", "review"]] """ Only return physical bundles with the given status. """ - type: NotRequired["Literal['custom', 'standard']"] + type: NotRequired[Literal["custom", "standard"]] """ Only return physical bundles with the given type. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/issuing/_token.py b/stripe/issuing/_token.py index 1af66bf65..f05427ae3 100644 --- a/stripe/issuing/_token.py +++ b/stripe/issuing/_token.py @@ -201,49 +201,49 @@ class ListParams(RequestOptions): """ Only return Issuing tokens that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['active', 'deleted', 'requested', 'suspended']" + Literal["active", "deleted", "requested", "suspended"] ] """ Select Issuing tokens with the given status. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -253,7 +253,7 @@ class ModifyParams(RequestOptions): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/issuing/_token_service.py b/stripe/issuing/_token_service.py index a3728f6ed..6a6b99d20 100644 --- a/stripe/issuing/_token_service.py +++ b/stripe/issuing/_token_service.py @@ -19,55 +19,55 @@ class ListParams(TypedDict): """ Only return Issuing tokens that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['active', 'deleted', 'requested', 'suspended']" + Literal["active", "deleted", "requested", "suspended"] ] """ Select Issuing tokens with the given status. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/issuing/_transaction.py b/stripe/issuing/_transaction.py index c67dc9674..7746593dc 100644 --- a/stripe/issuing/_transaction.py +++ b/stripe/issuing/_transaction.py @@ -251,11 +251,11 @@ class CreateForceCaptureParams(RequestOptions): """ Card associated with this transaction. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the capture. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -274,40 +274,335 @@ class CreateForceCaptureParams(RequestOptions): class CreateForceCaptureParamsMerchantData(TypedDict): category: NotRequired[ - "Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']" + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] ] """ A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. """ - city: NotRequired["str"] + city: NotRequired[str] """ City where the seller is located """ - country: NotRequired["str"] + country: NotRequired[str] """ Country where the seller is located """ - name: NotRequired["str"] + name: NotRequired[str] """ Name of the seller """ - network_id: NotRequired["str"] + network_id: NotRequired[str] """ Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code where the seller is located """ - state: NotRequired["str"] + state: NotRequired[str] """ State where the seller is located """ - terminal_id: NotRequired["str"] + terminal_id: NotRequired[str] """ An ID assigned by the seller to the location of the sale. """ - url: NotRequired["str"] + url: NotRequired[str] """ URL provided by the merchant on a 3DS request """ @@ -332,101 +627,109 @@ class CreateForceCaptureParamsPurchaseDetails(TypedDict): Information about lodging that was purchased with this transaction. """ receipt: NotRequired[ - "List[Transaction.CreateForceCaptureParamsPurchaseDetailsReceipt]" + List["Transaction.CreateForceCaptureParamsPurchaseDetailsReceipt"] ] """ The line items in the purchase. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A merchant-specific order number. """ class CreateForceCaptureParamsPurchaseDetailsFlight(TypedDict): - departure_at: NotRequired["int"] + departure_at: NotRequired[int] """ The time that the flight departed. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the passenger. """ - refundable: NotRequired["bool"] + refundable: NotRequired[bool] """ Whether the ticket is refundable. """ segments: NotRequired[ - "List[Transaction.CreateForceCaptureParamsPurchaseDetailsFlightSegment]" + List[ + "Transaction.CreateForceCaptureParamsPurchaseDetailsFlightSegment" + ] ] """ The legs of the trip. """ - travel_agency: NotRequired["str"] + travel_agency: NotRequired[str] """ The travel agency that issued the ticket. """ class CreateForceCaptureParamsPurchaseDetailsFlightSegment(TypedDict): - arrival_airport_code: NotRequired["str"] + arrival_airport_code: NotRequired[str] """ The three-letter IATA airport code of the flight's destination. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The airline carrier code. """ - departure_airport_code: NotRequired["str"] + departure_airport_code: NotRequired[str] """ The three-letter IATA airport code that the flight departed from. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number. """ - service_class: NotRequired["str"] + service_class: NotRequired[str] """ The flight's service class. """ - stopover_allowed: NotRequired["bool"] + stopover_allowed: NotRequired[bool] """ Whether a stopover is allowed on this flight. """ class CreateForceCaptureParamsPurchaseDetailsFuel(TypedDict): type: NotRequired[ - "Literal['diesel', 'other', 'unleaded_plus', 'unleaded_regular', 'unleaded_super']" + Literal[ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super", + ] ] """ The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. """ - unit: NotRequired["Literal['liter', 'us_gallon']"] + unit: NotRequired[Literal["liter", "us_gallon"]] """ The units for `volume_decimal`. One of `us_gallon` or `liter`. """ - unit_cost_decimal: NotRequired["str"] + unit_cost_decimal: NotRequired[str] """ The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. """ - volume_decimal: NotRequired["str"] + volume_decimal: NotRequired[str] """ The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. """ class CreateForceCaptureParamsPurchaseDetailsLodging(TypedDict): - check_in_at: NotRequired["int"] + check_in_at: NotRequired[int] """ The time of checking into the lodging. """ - nights: NotRequired["int"] + nights: NotRequired[int] """ The number of nights stayed at the lodging. """ class CreateForceCaptureParamsPurchaseDetailsReceipt(TypedDict): - description: NotRequired["str"] - quantity: NotRequired["str"] - total: NotRequired["int"] - unit_cost: NotRequired["int"] + description: NotRequired[str] + quantity: NotRequired[str] + total: NotRequired[int] + unit_cost: NotRequired[int] class CreateUnlinkedRefundParams(RequestOptions): amount: int @@ -437,11 +740,11 @@ class CreateUnlinkedRefundParams(RequestOptions): """ Card associated with this unlinked refund transaction. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -460,40 +763,335 @@ class CreateUnlinkedRefundParams(RequestOptions): class CreateUnlinkedRefundParamsMerchantData(TypedDict): category: NotRequired[ - "Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']" + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] ] """ A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. """ - city: NotRequired["str"] + city: NotRequired[str] """ City where the seller is located """ - country: NotRequired["str"] + country: NotRequired[str] """ Country where the seller is located """ - name: NotRequired["str"] + name: NotRequired[str] """ Name of the seller """ - network_id: NotRequired["str"] + network_id: NotRequired[str] """ Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code where the seller is located """ - state: NotRequired["str"] + state: NotRequired[str] """ State where the seller is located """ - terminal_id: NotRequired["str"] + terminal_id: NotRequired[str] """ An ID assigned by the seller to the location of the sale. """ - url: NotRequired["str"] + url: NotRequired[str] """ URL provided by the merchant on a 3DS request """ @@ -518,108 +1116,118 @@ class CreateUnlinkedRefundParamsPurchaseDetails(TypedDict): Information about lodging that was purchased with this transaction. """ receipt: NotRequired[ - "List[Transaction.CreateUnlinkedRefundParamsPurchaseDetailsReceipt]" + List[ + "Transaction.CreateUnlinkedRefundParamsPurchaseDetailsReceipt" + ] ] """ The line items in the purchase. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A merchant-specific order number. """ class CreateUnlinkedRefundParamsPurchaseDetailsFlight(TypedDict): - departure_at: NotRequired["int"] + departure_at: NotRequired[int] """ The time that the flight departed. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the passenger. """ - refundable: NotRequired["bool"] + refundable: NotRequired[bool] """ Whether the ticket is refundable. """ segments: NotRequired[ - "List[Transaction.CreateUnlinkedRefundParamsPurchaseDetailsFlightSegment]" + List[ + "Transaction.CreateUnlinkedRefundParamsPurchaseDetailsFlightSegment" + ] ] """ The legs of the trip. """ - travel_agency: NotRequired["str"] + travel_agency: NotRequired[str] """ The travel agency that issued the ticket. """ class CreateUnlinkedRefundParamsPurchaseDetailsFlightSegment(TypedDict): - arrival_airport_code: NotRequired["str"] + arrival_airport_code: NotRequired[str] """ The three-letter IATA airport code of the flight's destination. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The airline carrier code. """ - departure_airport_code: NotRequired["str"] + departure_airport_code: NotRequired[str] """ The three-letter IATA airport code that the flight departed from. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number. """ - service_class: NotRequired["str"] + service_class: NotRequired[str] """ The flight's service class. """ - stopover_allowed: NotRequired["bool"] + stopover_allowed: NotRequired[bool] """ Whether a stopover is allowed on this flight. """ class CreateUnlinkedRefundParamsPurchaseDetailsFuel(TypedDict): type: NotRequired[ - "Literal['diesel', 'other', 'unleaded_plus', 'unleaded_regular', 'unleaded_super']" + Literal[ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super", + ] ] """ The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. """ - unit: NotRequired["Literal['liter', 'us_gallon']"] + unit: NotRequired[Literal["liter", "us_gallon"]] """ The units for `volume_decimal`. One of `us_gallon` or `liter`. """ - unit_cost_decimal: NotRequired["str"] + unit_cost_decimal: NotRequired[str] """ The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. """ - volume_decimal: NotRequired["str"] + volume_decimal: NotRequired[str] """ The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. """ class CreateUnlinkedRefundParamsPurchaseDetailsLodging(TypedDict): - check_in_at: NotRequired["int"] + check_in_at: NotRequired[int] """ The time of checking into the lodging. """ - nights: NotRequired["int"] + nights: NotRequired[int] """ The number of nights stayed at the lodging. """ class CreateUnlinkedRefundParamsPurchaseDetailsReceipt(TypedDict): - description: NotRequired["str"] - quantity: NotRequired["str"] - total: NotRequired["int"] - unit_cost: NotRequired["int"] + description: NotRequired[str] + quantity: NotRequired[str] + total: NotRequired[int] + unit_cost: NotRequired[int] class ListParams(RequestOptions): - card: NotRequired["str"] + card: NotRequired[str] """ Only return transactions that belong to the given card. """ - cardholder: NotRequired["str"] + cardholder: NotRequired[str] """ Only return transactions that belong to the given cardholder. """ @@ -627,47 +1235,47 @@ class ListParams(RequestOptions): """ Only return transactions that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - type: NotRequired["Literal['capture', 'refund']"] + type: NotRequired[Literal["capture", "refund"]] """ Only return transactions that have the given type. One of `capture` or `refund`. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -677,17 +1285,17 @@ class ModifyParams(RequestOptions): """ class RefundParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - refund_amount: NotRequired["int"] + refund_amount: NotRequired[int] """ The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/issuing/_transaction_service.py b/stripe/issuing/_transaction_service.py index 596479ded..178c73832 100644 --- a/stripe/issuing/_transaction_service.py +++ b/stripe/issuing/_transaction_service.py @@ -11,11 +11,11 @@ class TransactionService(StripeService): class ListParams(TypedDict): - card: NotRequired["str"] + card: NotRequired[str] """ Only return transactions that belong to the given card. """ - cardholder: NotRequired["str"] + cardholder: NotRequired[str] """ Only return transactions that belong to the given cardholder. """ @@ -23,53 +23,53 @@ class ListParams(TypedDict): """ Only return transactions that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - type: NotRequired["Literal['capture', 'refund']"] + type: NotRequired[Literal["capture", "refund"]] """ Only return transactions that have the given type. One of `capture` or `refund`. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/radar/_early_fraud_warning.py b/stripe/radar/_early_fraud_warning.py index 4b4b0d51b..5a6c54658 100644 --- a/stripe/radar/_early_fraud_warning.py +++ b/stripe/radar/_early_fraud_warning.py @@ -31,7 +31,7 @@ class EarlyFraudWarning(ListableAPIResource["EarlyFraudWarning"]): ] = "radar.early_fraud_warning" class ListParams(RequestOptions): - charge: NotRequired["str"] + charge: NotRequired[str] """ Only return early fraud warnings for the charge specified by this charge ID. """ @@ -39,47 +39,47 @@ class ListParams(RequestOptions): """ Only return early fraud warnings that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - payment_intent: NotRequired["str"] + payment_intent: NotRequired[str] """ Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/radar/_early_fraud_warning_service.py b/stripe/radar/_early_fraud_warning_service.py index 05bd4f75e..2118f15cb 100644 --- a/stripe/radar/_early_fraud_warning_service.py +++ b/stripe/radar/_early_fraud_warning_service.py @@ -11,7 +11,7 @@ class EarlyFraudWarningService(StripeService): class ListParams(TypedDict): - charge: NotRequired["str"] + charge: NotRequired[str] """ Only return early fraud warnings for the charge specified by this charge ID. """ @@ -19,47 +19,47 @@ class ListParams(TypedDict): """ Only return early fraud warnings that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - payment_intent: NotRequired["str"] + payment_intent: NotRequired[str] """ Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID. """ - starting_after: NotRequired["str"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/radar/_value_list.py b/stripe/radar/_value_list.py index 8c46bc85e..158494dac 100644 --- a/stripe/radar/_value_list.py +++ b/stripe/radar/_value_list.py @@ -39,17 +39,28 @@ class CreateParams(RequestOptions): """ The name of the value list for use in rules. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ item_type: NotRequired[ - "Literal['card_bin', 'card_fingerprint', 'case_sensitive_string', 'country', 'customer_id', 'email', 'ip_address', 'sepa_debit_fingerprint', 'string', 'us_bank_account_fingerprint']" + Literal[ + "card_bin", + "card_fingerprint", + "case_sensitive_string", + "country", + "customer_id", + "email", + "ip_address", + "sepa_debit_fingerprint", + "string", + "us_bank_account_fingerprint", + ] ] """ Type of the items in the value list. One of `card_fingerprint`, `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. Use `string` if the item type is unknown or mixed. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -62,11 +73,11 @@ class DeleteParams(RequestOptions): pass class ListParams(RequestOptions): - alias: NotRequired["str"] + alias: NotRequired[str] """ The alias used to reference the value list when writing rules. """ - contains: NotRequired["str"] + contains: NotRequired[str] """ A value contained within a value list - returns all value lists containing this value. """ @@ -74,61 +85,61 @@ class ListParams(RequestOptions): """ Only return value lists that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - alias: NotRequired["str"] + alias: NotRequired[str] """ The name of the value list for use in rules. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - name: NotRequired["str"] + name: NotRequired[str] """ The human-readable name of the value list. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/radar/_value_list_item.py b/stripe/radar/_value_list_item.py index 6112b59a6..b48d9d542 100644 --- a/stripe/radar/_value_list_item.py +++ b/stripe/radar/_value_list_item.py @@ -26,7 +26,7 @@ class ValueListItem( ] = "radar.value_list_item" class CreateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -47,23 +47,23 @@ class ListParams(RequestOptions): """ Only return items that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - value: NotRequired["str"] + value: NotRequired[str] """ Return items belonging to the parent list whose value matches the specified value (using an "is like" match). """ @@ -73,25 +73,25 @@ class ListParams(RequestOptions): """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/radar/_value_list_item_service.py b/stripe/radar/_value_list_item_service.py index 99ca13ada..60c54fec2 100644 --- a/stripe/radar/_value_list_item_service.py +++ b/stripe/radar/_value_list_item_service.py @@ -11,7 +11,7 @@ class ValueListItemService(StripeService): class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -32,23 +32,23 @@ class ListParams(TypedDict): """ Only return items that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - value: NotRequired["str"] + value: NotRequired[str] """ Return items belonging to the parent list whose value matches the specified value (using an "is like" match). """ @@ -58,25 +58,25 @@ class ListParams(TypedDict): """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/radar/_value_list_service.py b/stripe/radar/_value_list_service.py index 18e43e1dc..f0e9e330d 100644 --- a/stripe/radar/_value_list_service.py +++ b/stripe/radar/_value_list_service.py @@ -15,17 +15,28 @@ class CreateParams(TypedDict): """ The name of the value list for use in rules. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ item_type: NotRequired[ - "Literal['card_bin', 'card_fingerprint', 'case_sensitive_string', 'country', 'customer_id', 'email', 'ip_address', 'sepa_debit_fingerprint', 'string', 'us_bank_account_fingerprint']" + Literal[ + "card_bin", + "card_fingerprint", + "case_sensitive_string", + "country", + "customer_id", + "email", + "ip_address", + "sepa_debit_fingerprint", + "string", + "us_bank_account_fingerprint", + ] ] """ Type of the items in the value list. One of `card_fingerprint`, `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. Use `string` if the item type is unknown or mixed. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -38,11 +49,11 @@ class DeleteParams(TypedDict): pass class ListParams(TypedDict): - alias: NotRequired["str"] + alias: NotRequired[str] """ The alias used to reference the value list when writing rules. """ - contains: NotRequired["str"] + contains: NotRequired[str] """ A value contained within a value list - returns all value lists containing this value. """ @@ -50,61 +61,61 @@ class ListParams(TypedDict): """ Only return value lists that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - alias: NotRequired["str"] + alias: NotRequired[str] """ The name of the value list for use in rules. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - name: NotRequired["str"] + name: NotRequired[str] """ The human-readable name of the value list. """ diff --git a/stripe/reporting/_report_run.py b/stripe/reporting/_report_run.py index c7e9f962d..9cdbb1754 100644 --- a/stripe/reporting/_report_run.py +++ b/stripe/reporting/_report_run.py @@ -72,7 +72,7 @@ class Parameters(StripeObject): """ class CreateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -86,38 +86,676 @@ class CreateParams(RequestOptions): """ class CreateParamsParameters(TypedDict): - columns: NotRequired["List[str]"] + columns: NotRequired[List[str]] """ The set of report columns to include in the report output. If omitted, the Report Type is run with its default column set. """ - connected_account: NotRequired["str"] + connected_account: NotRequired[str] """ Connected account ID to filter for in the report run. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Currency of objects to be included in the report run. """ - interval_end: NotRequired["int"] + interval_end: NotRequired[int] """ Ending timestamp of data to be included in the report run (exclusive). """ - interval_start: NotRequired["int"] + interval_start: NotRequired[int] """ Starting timestamp of data to be included in the report run. """ - payout: NotRequired["str"] + payout: NotRequired[str] """ Payout ID by which to filter the report run. """ reporting_category: NotRequired[ - "Literal['advance', 'advance_funding', 'anticipation_repayment', 'charge', 'charge_failure', 'climate_order_purchase', 'climate_order_refund', 'connect_collection_transfer', 'connect_reserved_funds', 'contribution', 'dispute', 'dispute_reversal', 'fee', 'financing_paydown', 'financing_paydown_reversal', 'financing_payout', 'financing_payout_reversal', 'issuing_authorization_hold', 'issuing_authorization_release', 'issuing_dispute', 'issuing_transaction', 'network_cost', 'other_adjustment', 'partial_capture_reversal', 'payout', 'payout_reversal', 'platform_earning', 'platform_earning_refund', 'refund', 'refund_failure', 'risk_reserved_funds', 'tax', 'topup', 'topup_reversal', 'transfer', 'transfer_reversal', 'unreconciled_customer_funds', 'obligation']" + Literal[ + "advance", + "advance_funding", + "anticipation_repayment", + "charge", + "charge_failure", + "climate_order_purchase", + "climate_order_refund", + "connect_collection_transfer", + "connect_reserved_funds", + "contribution", + "dispute", + "dispute_reversal", + "fee", + "financing_paydown", + "financing_paydown_reversal", + "financing_payout", + "financing_payout_reversal", + "issuing_authorization_hold", + "issuing_authorization_release", + "issuing_dispute", + "issuing_transaction", + "network_cost", + "other_adjustment", + "partial_capture_reversal", + "payout", + "payout_reversal", + "platform_earning", + "platform_earning_refund", + "refund", + "refund_failure", + "risk_reserved_funds", + "tax", + "topup", + "topup_reversal", + "transfer", + "transfer_reversal", + "unreconciled_customer_funds", + "obligation", + ] ] """ Category of balance transactions to be included in the report run. """ timezone: NotRequired[ - "Literal['Africa/Abidjan', 'Africa/Accra', 'Africa/Addis_Ababa', 'Africa/Algiers', 'Africa/Asmara', 'Africa/Asmera', 'Africa/Bamako', 'Africa/Bangui', 'Africa/Banjul', 'Africa/Bissau', 'Africa/Blantyre', 'Africa/Brazzaville', 'Africa/Bujumbura', 'Africa/Cairo', 'Africa/Casablanca', 'Africa/Ceuta', 'Africa/Conakry', 'Africa/Dakar', 'Africa/Dar_es_Salaam', 'Africa/Djibouti', 'Africa/Douala', 'Africa/El_Aaiun', 'Africa/Freetown', 'Africa/Gaborone', 'Africa/Harare', 'Africa/Johannesburg', 'Africa/Juba', 'Africa/Kampala', 'Africa/Khartoum', 'Africa/Kigali', 'Africa/Kinshasa', 'Africa/Lagos', 'Africa/Libreville', 'Africa/Lome', 'Africa/Luanda', 'Africa/Lubumbashi', 'Africa/Lusaka', 'Africa/Malabo', 'Africa/Maputo', 'Africa/Maseru', 'Africa/Mbabane', 'Africa/Mogadishu', 'Africa/Monrovia', 'Africa/Nairobi', 'Africa/Ndjamena', 'Africa/Niamey', 'Africa/Nouakchott', 'Africa/Ouagadougou', 'Africa/Porto-Novo', 'Africa/Sao_Tome', 'Africa/Timbuktu', 'Africa/Tripoli', 'Africa/Tunis', 'Africa/Windhoek', 'America/Adak', 'America/Anchorage', 'America/Anguilla', 'America/Antigua', 'America/Araguaina', 'America/Argentina/Buenos_Aires', 'America/Argentina/Catamarca', 'America/Argentina/ComodRivadavia', 'America/Argentina/Cordoba', 'America/Argentina/Jujuy', 'America/Argentina/La_Rioja', 'America/Argentina/Mendoza', 'America/Argentina/Rio_Gallegos', 'America/Argentina/Salta', 'America/Argentina/San_Juan', 'America/Argentina/San_Luis', 'America/Argentina/Tucuman', 'America/Argentina/Ushuaia', 'America/Aruba', 'America/Asuncion', 'America/Atikokan', 'America/Atka', 'America/Bahia', 'America/Bahia_Banderas', 'America/Barbados', 'America/Belem', 'America/Belize', 'America/Blanc-Sablon', 'America/Boa_Vista', 'America/Bogota', 'America/Boise', 'America/Buenos_Aires', 'America/Cambridge_Bay', 'America/Campo_Grande', 'America/Cancun', 'America/Caracas', 'America/Catamarca', 'America/Cayenne', 'America/Cayman', 'America/Chicago', 'America/Chihuahua', 'America/Ciudad_Juarez', 'America/Coral_Harbour', 'America/Cordoba', 'America/Costa_Rica', 'America/Creston', 'America/Cuiaba', 'America/Curacao', 'America/Danmarkshavn', 'America/Dawson', 'America/Dawson_Creek', 'America/Denver', 'America/Detroit', 'America/Dominica', 'America/Edmonton', 'America/Eirunepe', 'America/El_Salvador', 'America/Ensenada', 'America/Fort_Nelson', 'America/Fort_Wayne', 'America/Fortaleza', 'America/Glace_Bay', 'America/Godthab', 'America/Goose_Bay', 'America/Grand_Turk', 'America/Grenada', 'America/Guadeloupe', 'America/Guatemala', 'America/Guayaquil', 'America/Guyana', 'America/Halifax', 'America/Havana', 'America/Hermosillo', 'America/Indiana/Indianapolis', 'America/Indiana/Knox', 'America/Indiana/Marengo', 'America/Indiana/Petersburg', 'America/Indiana/Tell_City', 'America/Indiana/Vevay', 'America/Indiana/Vincennes', 'America/Indiana/Winamac', 'America/Indianapolis', 'America/Inuvik', 'America/Iqaluit', 'America/Jamaica', 'America/Jujuy', 'America/Juneau', 'America/Kentucky/Louisville', 'America/Kentucky/Monticello', 'America/Knox_IN', 'America/Kralendijk', 'America/La_Paz', 'America/Lima', 'America/Los_Angeles', 'America/Louisville', 'America/Lower_Princes', 'America/Maceio', 'America/Managua', 'America/Manaus', 'America/Marigot', 'America/Martinique', 'America/Matamoros', 'America/Mazatlan', 'America/Mendoza', 'America/Menominee', 'America/Merida', 'America/Metlakatla', 'America/Mexico_City', 'America/Miquelon', 'America/Moncton', 'America/Monterrey', 'America/Montevideo', 'America/Montreal', 'America/Montserrat', 'America/Nassau', 'America/New_York', 'America/Nipigon', 'America/Nome', 'America/Noronha', 'America/North_Dakota/Beulah', 'America/North_Dakota/Center', 'America/North_Dakota/New_Salem', 'America/Nuuk', 'America/Ojinaga', 'America/Panama', 'America/Pangnirtung', 'America/Paramaribo', 'America/Phoenix', 'America/Port-au-Prince', 'America/Port_of_Spain', 'America/Porto_Acre', 'America/Porto_Velho', 'America/Puerto_Rico', 'America/Punta_Arenas', 'America/Rainy_River', 'America/Rankin_Inlet', 'America/Recife', 'America/Regina', 'America/Resolute', 'America/Rio_Branco', 'America/Rosario', 'America/Santa_Isabel', 'America/Santarem', 'America/Santiago', 'America/Santo_Domingo', 'America/Sao_Paulo', 'America/Scoresbysund', 'America/Shiprock', 'America/Sitka', 'America/St_Barthelemy', 'America/St_Johns', 'America/St_Kitts', 'America/St_Lucia', 'America/St_Thomas', 'America/St_Vincent', 'America/Swift_Current', 'America/Tegucigalpa', 'America/Thule', 'America/Thunder_Bay', 'America/Tijuana', 'America/Toronto', 'America/Tortola', 'America/Vancouver', 'America/Virgin', 'America/Whitehorse', 'America/Winnipeg', 'America/Yakutat', 'America/Yellowknife', 'Antarctica/Casey', 'Antarctica/Davis', 'Antarctica/DumontDUrville', 'Antarctica/Macquarie', 'Antarctica/Mawson', 'Antarctica/McMurdo', 'Antarctica/Palmer', 'Antarctica/Rothera', 'Antarctica/South_Pole', 'Antarctica/Syowa', 'Antarctica/Troll', 'Antarctica/Vostok', 'Arctic/Longyearbyen', 'Asia/Aden', 'Asia/Almaty', 'Asia/Amman', 'Asia/Anadyr', 'Asia/Aqtau', 'Asia/Aqtobe', 'Asia/Ashgabat', 'Asia/Ashkhabad', 'Asia/Atyrau', 'Asia/Baghdad', 'Asia/Bahrain', 'Asia/Baku', 'Asia/Bangkok', 'Asia/Barnaul', 'Asia/Beirut', 'Asia/Bishkek', 'Asia/Brunei', 'Asia/Calcutta', 'Asia/Chita', 'Asia/Choibalsan', 'Asia/Chongqing', 'Asia/Chungking', 'Asia/Colombo', 'Asia/Dacca', 'Asia/Damascus', 'Asia/Dhaka', 'Asia/Dili', 'Asia/Dubai', 'Asia/Dushanbe', 'Asia/Famagusta', 'Asia/Gaza', 'Asia/Harbin', 'Asia/Hebron', 'Asia/Ho_Chi_Minh', 'Asia/Hong_Kong', 'Asia/Hovd', 'Asia/Irkutsk', 'Asia/Istanbul', 'Asia/Jakarta', 'Asia/Jayapura', 'Asia/Jerusalem', 'Asia/Kabul', 'Asia/Kamchatka', 'Asia/Karachi', 'Asia/Kashgar', 'Asia/Kathmandu', 'Asia/Katmandu', 'Asia/Khandyga', 'Asia/Kolkata', 'Asia/Krasnoyarsk', 'Asia/Kuala_Lumpur', 'Asia/Kuching', 'Asia/Kuwait', 'Asia/Macao', 'Asia/Macau', 'Asia/Magadan', 'Asia/Makassar', 'Asia/Manila', 'Asia/Muscat', 'Asia/Nicosia', 'Asia/Novokuznetsk', 'Asia/Novosibirsk', 'Asia/Omsk', 'Asia/Oral', 'Asia/Phnom_Penh', 'Asia/Pontianak', 'Asia/Pyongyang', 'Asia/Qatar', 'Asia/Qostanay', 'Asia/Qyzylorda', 'Asia/Rangoon', 'Asia/Riyadh', 'Asia/Saigon', 'Asia/Sakhalin', 'Asia/Samarkand', 'Asia/Seoul', 'Asia/Shanghai', 'Asia/Singapore', 'Asia/Srednekolymsk', 'Asia/Taipei', 'Asia/Tashkent', 'Asia/Tbilisi', 'Asia/Tehran', 'Asia/Tel_Aviv', 'Asia/Thimbu', 'Asia/Thimphu', 'Asia/Tokyo', 'Asia/Tomsk', 'Asia/Ujung_Pandang', 'Asia/Ulaanbaatar', 'Asia/Ulan_Bator', 'Asia/Urumqi', 'Asia/Ust-Nera', 'Asia/Vientiane', 'Asia/Vladivostok', 'Asia/Yakutsk', 'Asia/Yangon', 'Asia/Yekaterinburg', 'Asia/Yerevan', 'Atlantic/Azores', 'Atlantic/Bermuda', 'Atlantic/Canary', 'Atlantic/Cape_Verde', 'Atlantic/Faeroe', 'Atlantic/Faroe', 'Atlantic/Jan_Mayen', 'Atlantic/Madeira', 'Atlantic/Reykjavik', 'Atlantic/South_Georgia', 'Atlantic/St_Helena', 'Atlantic/Stanley', 'Australia/ACT', 'Australia/Adelaide', 'Australia/Brisbane', 'Australia/Broken_Hill', 'Australia/Canberra', 'Australia/Currie', 'Australia/Darwin', 'Australia/Eucla', 'Australia/Hobart', 'Australia/LHI', 'Australia/Lindeman', 'Australia/Lord_Howe', 'Australia/Melbourne', 'Australia/NSW', 'Australia/North', 'Australia/Perth', 'Australia/Queensland', 'Australia/South', 'Australia/Sydney', 'Australia/Tasmania', 'Australia/Victoria', 'Australia/West', 'Australia/Yancowinna', 'Brazil/Acre', 'Brazil/DeNoronha', 'Brazil/East', 'Brazil/West', 'CET', 'CST6CDT', 'Canada/Atlantic', 'Canada/Central', 'Canada/Eastern', 'Canada/Mountain', 'Canada/Newfoundland', 'Canada/Pacific', 'Canada/Saskatchewan', 'Canada/Yukon', 'Chile/Continental', 'Chile/EasterIsland', 'Cuba', 'EET', 'EST', 'EST5EDT', 'Egypt', 'Eire', 'Etc/GMT', 'Etc/GMT+0', 'Etc/GMT+1', 'Etc/GMT+10', 'Etc/GMT+11', 'Etc/GMT+12', 'Etc/GMT+2', 'Etc/GMT+3', 'Etc/GMT+4', 'Etc/GMT+5', 'Etc/GMT+6', 'Etc/GMT+7', 'Etc/GMT+8', 'Etc/GMT+9', 'Etc/GMT-0', 'Etc/GMT-1', 'Etc/GMT-10', 'Etc/GMT-11', 'Etc/GMT-12', 'Etc/GMT-13', 'Etc/GMT-14', 'Etc/GMT-2', 'Etc/GMT-3', 'Etc/GMT-4', 'Etc/GMT-5', 'Etc/GMT-6', 'Etc/GMT-7', 'Etc/GMT-8', 'Etc/GMT-9', 'Etc/GMT0', 'Etc/Greenwich', 'Etc/UCT', 'Etc/UTC', 'Etc/Universal', 'Etc/Zulu', 'Europe/Amsterdam', 'Europe/Andorra', 'Europe/Astrakhan', 'Europe/Athens', 'Europe/Belfast', 'Europe/Belgrade', 'Europe/Berlin', 'Europe/Bratislava', 'Europe/Brussels', 'Europe/Bucharest', 'Europe/Budapest', 'Europe/Busingen', 'Europe/Chisinau', 'Europe/Copenhagen', 'Europe/Dublin', 'Europe/Gibraltar', 'Europe/Guernsey', 'Europe/Helsinki', 'Europe/Isle_of_Man', 'Europe/Istanbul', 'Europe/Jersey', 'Europe/Kaliningrad', 'Europe/Kiev', 'Europe/Kirov', 'Europe/Kyiv', 'Europe/Lisbon', 'Europe/Ljubljana', 'Europe/London', 'Europe/Luxembourg', 'Europe/Madrid', 'Europe/Malta', 'Europe/Mariehamn', 'Europe/Minsk', 'Europe/Monaco', 'Europe/Moscow', 'Europe/Nicosia', 'Europe/Oslo', 'Europe/Paris', 'Europe/Podgorica', 'Europe/Prague', 'Europe/Riga', 'Europe/Rome', 'Europe/Samara', 'Europe/San_Marino', 'Europe/Sarajevo', 'Europe/Saratov', 'Europe/Simferopol', 'Europe/Skopje', 'Europe/Sofia', 'Europe/Stockholm', 'Europe/Tallinn', 'Europe/Tirane', 'Europe/Tiraspol', 'Europe/Ulyanovsk', 'Europe/Uzhgorod', 'Europe/Vaduz', 'Europe/Vatican', 'Europe/Vienna', 'Europe/Vilnius', 'Europe/Volgograd', 'Europe/Warsaw', 'Europe/Zagreb', 'Europe/Zaporozhye', 'Europe/Zurich', 'Factory', 'GB', 'GB-Eire', 'GMT', 'GMT+0', 'GMT-0', 'GMT0', 'Greenwich', 'HST', 'Hongkong', 'Iceland', 'Indian/Antananarivo', 'Indian/Chagos', 'Indian/Christmas', 'Indian/Cocos', 'Indian/Comoro', 'Indian/Kerguelen', 'Indian/Mahe', 'Indian/Maldives', 'Indian/Mauritius', 'Indian/Mayotte', 'Indian/Reunion', 'Iran', 'Israel', 'Jamaica', 'Japan', 'Kwajalein', 'Libya', 'MET', 'MST', 'MST7MDT', 'Mexico/BajaNorte', 'Mexico/BajaSur', 'Mexico/General', 'NZ', 'NZ-CHAT', 'Navajo', 'PRC', 'PST8PDT', 'Pacific/Apia', 'Pacific/Auckland', 'Pacific/Bougainville', 'Pacific/Chatham', 'Pacific/Chuuk', 'Pacific/Easter', 'Pacific/Efate', 'Pacific/Enderbury', 'Pacific/Fakaofo', 'Pacific/Fiji', 'Pacific/Funafuti', 'Pacific/Galapagos', 'Pacific/Gambier', 'Pacific/Guadalcanal', 'Pacific/Guam', 'Pacific/Honolulu', 'Pacific/Johnston', 'Pacific/Kanton', 'Pacific/Kiritimati', 'Pacific/Kosrae', 'Pacific/Kwajalein', 'Pacific/Majuro', 'Pacific/Marquesas', 'Pacific/Midway', 'Pacific/Nauru', 'Pacific/Niue', 'Pacific/Norfolk', 'Pacific/Noumea', 'Pacific/Pago_Pago', 'Pacific/Palau', 'Pacific/Pitcairn', 'Pacific/Pohnpei', 'Pacific/Ponape', 'Pacific/Port_Moresby', 'Pacific/Rarotonga', 'Pacific/Saipan', 'Pacific/Samoa', 'Pacific/Tahiti', 'Pacific/Tarawa', 'Pacific/Tongatapu', 'Pacific/Truk', 'Pacific/Wake', 'Pacific/Wallis', 'Pacific/Yap', 'Poland', 'Portugal', 'ROC', 'ROK', 'Singapore', 'Turkey', 'UCT', 'US/Alaska', 'US/Aleutian', 'US/Arizona', 'US/Central', 'US/East-Indiana', 'US/Eastern', 'US/Hawaii', 'US/Indiana-Starke', 'US/Michigan', 'US/Mountain', 'US/Pacific', 'US/Pacific-New', 'US/Samoa', 'UTC', 'Universal', 'W-SU', 'WET', 'Zulu']" + Literal[ + "Africa/Abidjan", + "Africa/Accra", + "Africa/Addis_Ababa", + "Africa/Algiers", + "Africa/Asmara", + "Africa/Asmera", + "Africa/Bamako", + "Africa/Bangui", + "Africa/Banjul", + "Africa/Bissau", + "Africa/Blantyre", + "Africa/Brazzaville", + "Africa/Bujumbura", + "Africa/Cairo", + "Africa/Casablanca", + "Africa/Ceuta", + "Africa/Conakry", + "Africa/Dakar", + "Africa/Dar_es_Salaam", + "Africa/Djibouti", + "Africa/Douala", + "Africa/El_Aaiun", + "Africa/Freetown", + "Africa/Gaborone", + "Africa/Harare", + "Africa/Johannesburg", + "Africa/Juba", + "Africa/Kampala", + "Africa/Khartoum", + "Africa/Kigali", + "Africa/Kinshasa", + "Africa/Lagos", + "Africa/Libreville", + "Africa/Lome", + "Africa/Luanda", + "Africa/Lubumbashi", + "Africa/Lusaka", + "Africa/Malabo", + "Africa/Maputo", + "Africa/Maseru", + "Africa/Mbabane", + "Africa/Mogadishu", + "Africa/Monrovia", + "Africa/Nairobi", + "Africa/Ndjamena", + "Africa/Niamey", + "Africa/Nouakchott", + "Africa/Ouagadougou", + "Africa/Porto-Novo", + "Africa/Sao_Tome", + "Africa/Timbuktu", + "Africa/Tripoli", + "Africa/Tunis", + "Africa/Windhoek", + "America/Adak", + "America/Anchorage", + "America/Anguilla", + "America/Antigua", + "America/Araguaina", + "America/Argentina/Buenos_Aires", + "America/Argentina/Catamarca", + "America/Argentina/ComodRivadavia", + "America/Argentina/Cordoba", + "America/Argentina/Jujuy", + "America/Argentina/La_Rioja", + "America/Argentina/Mendoza", + "America/Argentina/Rio_Gallegos", + "America/Argentina/Salta", + "America/Argentina/San_Juan", + "America/Argentina/San_Luis", + "America/Argentina/Tucuman", + "America/Argentina/Ushuaia", + "America/Aruba", + "America/Asuncion", + "America/Atikokan", + "America/Atka", + "America/Bahia", + "America/Bahia_Banderas", + "America/Barbados", + "America/Belem", + "America/Belize", + "America/Blanc-Sablon", + "America/Boa_Vista", + "America/Bogota", + "America/Boise", + "America/Buenos_Aires", + "America/Cambridge_Bay", + "America/Campo_Grande", + "America/Cancun", + "America/Caracas", + "America/Catamarca", + "America/Cayenne", + "America/Cayman", + "America/Chicago", + "America/Chihuahua", + "America/Ciudad_Juarez", + "America/Coral_Harbour", + "America/Cordoba", + "America/Costa_Rica", + "America/Creston", + "America/Cuiaba", + "America/Curacao", + "America/Danmarkshavn", + "America/Dawson", + "America/Dawson_Creek", + "America/Denver", + "America/Detroit", + "America/Dominica", + "America/Edmonton", + "America/Eirunepe", + "America/El_Salvador", + "America/Ensenada", + "America/Fort_Nelson", + "America/Fort_Wayne", + "America/Fortaleza", + "America/Glace_Bay", + "America/Godthab", + "America/Goose_Bay", + "America/Grand_Turk", + "America/Grenada", + "America/Guadeloupe", + "America/Guatemala", + "America/Guayaquil", + "America/Guyana", + "America/Halifax", + "America/Havana", + "America/Hermosillo", + "America/Indiana/Indianapolis", + "America/Indiana/Knox", + "America/Indiana/Marengo", + "America/Indiana/Petersburg", + "America/Indiana/Tell_City", + "America/Indiana/Vevay", + "America/Indiana/Vincennes", + "America/Indiana/Winamac", + "America/Indianapolis", + "America/Inuvik", + "America/Iqaluit", + "America/Jamaica", + "America/Jujuy", + "America/Juneau", + "America/Kentucky/Louisville", + "America/Kentucky/Monticello", + "America/Knox_IN", + "America/Kralendijk", + "America/La_Paz", + "America/Lima", + "America/Los_Angeles", + "America/Louisville", + "America/Lower_Princes", + "America/Maceio", + "America/Managua", + "America/Manaus", + "America/Marigot", + "America/Martinique", + "America/Matamoros", + "America/Mazatlan", + "America/Mendoza", + "America/Menominee", + "America/Merida", + "America/Metlakatla", + "America/Mexico_City", + "America/Miquelon", + "America/Moncton", + "America/Monterrey", + "America/Montevideo", + "America/Montreal", + "America/Montserrat", + "America/Nassau", + "America/New_York", + "America/Nipigon", + "America/Nome", + "America/Noronha", + "America/North_Dakota/Beulah", + "America/North_Dakota/Center", + "America/North_Dakota/New_Salem", + "America/Nuuk", + "America/Ojinaga", + "America/Panama", + "America/Pangnirtung", + "America/Paramaribo", + "America/Phoenix", + "America/Port-au-Prince", + "America/Port_of_Spain", + "America/Porto_Acre", + "America/Porto_Velho", + "America/Puerto_Rico", + "America/Punta_Arenas", + "America/Rainy_River", + "America/Rankin_Inlet", + "America/Recife", + "America/Regina", + "America/Resolute", + "America/Rio_Branco", + "America/Rosario", + "America/Santa_Isabel", + "America/Santarem", + "America/Santiago", + "America/Santo_Domingo", + "America/Sao_Paulo", + "America/Scoresbysund", + "America/Shiprock", + "America/Sitka", + "America/St_Barthelemy", + "America/St_Johns", + "America/St_Kitts", + "America/St_Lucia", + "America/St_Thomas", + "America/St_Vincent", + "America/Swift_Current", + "America/Tegucigalpa", + "America/Thule", + "America/Thunder_Bay", + "America/Tijuana", + "America/Toronto", + "America/Tortola", + "America/Vancouver", + "America/Virgin", + "America/Whitehorse", + "America/Winnipeg", + "America/Yakutat", + "America/Yellowknife", + "Antarctica/Casey", + "Antarctica/Davis", + "Antarctica/DumontDUrville", + "Antarctica/Macquarie", + "Antarctica/Mawson", + "Antarctica/McMurdo", + "Antarctica/Palmer", + "Antarctica/Rothera", + "Antarctica/South_Pole", + "Antarctica/Syowa", + "Antarctica/Troll", + "Antarctica/Vostok", + "Arctic/Longyearbyen", + "Asia/Aden", + "Asia/Almaty", + "Asia/Amman", + "Asia/Anadyr", + "Asia/Aqtau", + "Asia/Aqtobe", + "Asia/Ashgabat", + "Asia/Ashkhabad", + "Asia/Atyrau", + "Asia/Baghdad", + "Asia/Bahrain", + "Asia/Baku", + "Asia/Bangkok", + "Asia/Barnaul", + "Asia/Beirut", + "Asia/Bishkek", + "Asia/Brunei", + "Asia/Calcutta", + "Asia/Chita", + "Asia/Choibalsan", + "Asia/Chongqing", + "Asia/Chungking", + "Asia/Colombo", + "Asia/Dacca", + "Asia/Damascus", + "Asia/Dhaka", + "Asia/Dili", + "Asia/Dubai", + "Asia/Dushanbe", + "Asia/Famagusta", + "Asia/Gaza", + "Asia/Harbin", + "Asia/Hebron", + "Asia/Ho_Chi_Minh", + "Asia/Hong_Kong", + "Asia/Hovd", + "Asia/Irkutsk", + "Asia/Istanbul", + "Asia/Jakarta", + "Asia/Jayapura", + "Asia/Jerusalem", + "Asia/Kabul", + "Asia/Kamchatka", + "Asia/Karachi", + "Asia/Kashgar", + "Asia/Kathmandu", + "Asia/Katmandu", + "Asia/Khandyga", + "Asia/Kolkata", + "Asia/Krasnoyarsk", + "Asia/Kuala_Lumpur", + "Asia/Kuching", + "Asia/Kuwait", + "Asia/Macao", + "Asia/Macau", + "Asia/Magadan", + "Asia/Makassar", + "Asia/Manila", + "Asia/Muscat", + "Asia/Nicosia", + "Asia/Novokuznetsk", + "Asia/Novosibirsk", + "Asia/Omsk", + "Asia/Oral", + "Asia/Phnom_Penh", + "Asia/Pontianak", + "Asia/Pyongyang", + "Asia/Qatar", + "Asia/Qostanay", + "Asia/Qyzylorda", + "Asia/Rangoon", + "Asia/Riyadh", + "Asia/Saigon", + "Asia/Sakhalin", + "Asia/Samarkand", + "Asia/Seoul", + "Asia/Shanghai", + "Asia/Singapore", + "Asia/Srednekolymsk", + "Asia/Taipei", + "Asia/Tashkent", + "Asia/Tbilisi", + "Asia/Tehran", + "Asia/Tel_Aviv", + "Asia/Thimbu", + "Asia/Thimphu", + "Asia/Tokyo", + "Asia/Tomsk", + "Asia/Ujung_Pandang", + "Asia/Ulaanbaatar", + "Asia/Ulan_Bator", + "Asia/Urumqi", + "Asia/Ust-Nera", + "Asia/Vientiane", + "Asia/Vladivostok", + "Asia/Yakutsk", + "Asia/Yangon", + "Asia/Yekaterinburg", + "Asia/Yerevan", + "Atlantic/Azores", + "Atlantic/Bermuda", + "Atlantic/Canary", + "Atlantic/Cape_Verde", + "Atlantic/Faeroe", + "Atlantic/Faroe", + "Atlantic/Jan_Mayen", + "Atlantic/Madeira", + "Atlantic/Reykjavik", + "Atlantic/South_Georgia", + "Atlantic/St_Helena", + "Atlantic/Stanley", + "Australia/ACT", + "Australia/Adelaide", + "Australia/Brisbane", + "Australia/Broken_Hill", + "Australia/Canberra", + "Australia/Currie", + "Australia/Darwin", + "Australia/Eucla", + "Australia/Hobart", + "Australia/LHI", + "Australia/Lindeman", + "Australia/Lord_Howe", + "Australia/Melbourne", + "Australia/NSW", + "Australia/North", + "Australia/Perth", + "Australia/Queensland", + "Australia/South", + "Australia/Sydney", + "Australia/Tasmania", + "Australia/Victoria", + "Australia/West", + "Australia/Yancowinna", + "Brazil/Acre", + "Brazil/DeNoronha", + "Brazil/East", + "Brazil/West", + "CET", + "CST6CDT", + "Canada/Atlantic", + "Canada/Central", + "Canada/Eastern", + "Canada/Mountain", + "Canada/Newfoundland", + "Canada/Pacific", + "Canada/Saskatchewan", + "Canada/Yukon", + "Chile/Continental", + "Chile/EasterIsland", + "Cuba", + "EET", + "EST", + "EST5EDT", + "Egypt", + "Eire", + "Etc/GMT", + "Etc/GMT+0", + "Etc/GMT+1", + "Etc/GMT+10", + "Etc/GMT+11", + "Etc/GMT+12", + "Etc/GMT+2", + "Etc/GMT+3", + "Etc/GMT+4", + "Etc/GMT+5", + "Etc/GMT+6", + "Etc/GMT+7", + "Etc/GMT+8", + "Etc/GMT+9", + "Etc/GMT-0", + "Etc/GMT-1", + "Etc/GMT-10", + "Etc/GMT-11", + "Etc/GMT-12", + "Etc/GMT-13", + "Etc/GMT-14", + "Etc/GMT-2", + "Etc/GMT-3", + "Etc/GMT-4", + "Etc/GMT-5", + "Etc/GMT-6", + "Etc/GMT-7", + "Etc/GMT-8", + "Etc/GMT-9", + "Etc/GMT0", + "Etc/Greenwich", + "Etc/UCT", + "Etc/UTC", + "Etc/Universal", + "Etc/Zulu", + "Europe/Amsterdam", + "Europe/Andorra", + "Europe/Astrakhan", + "Europe/Athens", + "Europe/Belfast", + "Europe/Belgrade", + "Europe/Berlin", + "Europe/Bratislava", + "Europe/Brussels", + "Europe/Bucharest", + "Europe/Budapest", + "Europe/Busingen", + "Europe/Chisinau", + "Europe/Copenhagen", + "Europe/Dublin", + "Europe/Gibraltar", + "Europe/Guernsey", + "Europe/Helsinki", + "Europe/Isle_of_Man", + "Europe/Istanbul", + "Europe/Jersey", + "Europe/Kaliningrad", + "Europe/Kiev", + "Europe/Kirov", + "Europe/Kyiv", + "Europe/Lisbon", + "Europe/Ljubljana", + "Europe/London", + "Europe/Luxembourg", + "Europe/Madrid", + "Europe/Malta", + "Europe/Mariehamn", + "Europe/Minsk", + "Europe/Monaco", + "Europe/Moscow", + "Europe/Nicosia", + "Europe/Oslo", + "Europe/Paris", + "Europe/Podgorica", + "Europe/Prague", + "Europe/Riga", + "Europe/Rome", + "Europe/Samara", + "Europe/San_Marino", + "Europe/Sarajevo", + "Europe/Saratov", + "Europe/Simferopol", + "Europe/Skopje", + "Europe/Sofia", + "Europe/Stockholm", + "Europe/Tallinn", + "Europe/Tirane", + "Europe/Tiraspol", + "Europe/Ulyanovsk", + "Europe/Uzhgorod", + "Europe/Vaduz", + "Europe/Vatican", + "Europe/Vienna", + "Europe/Vilnius", + "Europe/Volgograd", + "Europe/Warsaw", + "Europe/Zagreb", + "Europe/Zaporozhye", + "Europe/Zurich", + "Factory", + "GB", + "GB-Eire", + "GMT", + "GMT+0", + "GMT-0", + "GMT0", + "Greenwich", + "HST", + "Hongkong", + "Iceland", + "Indian/Antananarivo", + "Indian/Chagos", + "Indian/Christmas", + "Indian/Cocos", + "Indian/Comoro", + "Indian/Kerguelen", + "Indian/Mahe", + "Indian/Maldives", + "Indian/Mauritius", + "Indian/Mayotte", + "Indian/Reunion", + "Iran", + "Israel", + "Jamaica", + "Japan", + "Kwajalein", + "Libya", + "MET", + "MST", + "MST7MDT", + "Mexico/BajaNorte", + "Mexico/BajaSur", + "Mexico/General", + "NZ", + "NZ-CHAT", + "Navajo", + "PRC", + "PST8PDT", + "Pacific/Apia", + "Pacific/Auckland", + "Pacific/Bougainville", + "Pacific/Chatham", + "Pacific/Chuuk", + "Pacific/Easter", + "Pacific/Efate", + "Pacific/Enderbury", + "Pacific/Fakaofo", + "Pacific/Fiji", + "Pacific/Funafuti", + "Pacific/Galapagos", + "Pacific/Gambier", + "Pacific/Guadalcanal", + "Pacific/Guam", + "Pacific/Honolulu", + "Pacific/Johnston", + "Pacific/Kanton", + "Pacific/Kiritimati", + "Pacific/Kosrae", + "Pacific/Kwajalein", + "Pacific/Majuro", + "Pacific/Marquesas", + "Pacific/Midway", + "Pacific/Nauru", + "Pacific/Niue", + "Pacific/Norfolk", + "Pacific/Noumea", + "Pacific/Pago_Pago", + "Pacific/Palau", + "Pacific/Pitcairn", + "Pacific/Pohnpei", + "Pacific/Ponape", + "Pacific/Port_Moresby", + "Pacific/Rarotonga", + "Pacific/Saipan", + "Pacific/Samoa", + "Pacific/Tahiti", + "Pacific/Tarawa", + "Pacific/Tongatapu", + "Pacific/Truk", + "Pacific/Wake", + "Pacific/Wallis", + "Pacific/Yap", + "Poland", + "Portugal", + "ROC", + "ROK", + "Singapore", + "Turkey", + "UCT", + "US/Alaska", + "US/Aleutian", + "US/Arizona", + "US/Central", + "US/East-Indiana", + "US/Eastern", + "US/Hawaii", + "US/Indiana-Starke", + "US/Michigan", + "US/Mountain", + "US/Pacific", + "US/Pacific-New", + "US/Samoa", + "UTC", + "Universal", + "W-SU", + "WET", + "Zulu", + ] ] """ Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`. @@ -128,43 +766,43 @@ class ListParams(RequestOptions): """ Only return Report Runs that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/reporting/_report_run_service.py b/stripe/reporting/_report_run_service.py index a8a89da27..dfdc1a0c7 100644 --- a/stripe/reporting/_report_run_service.py +++ b/stripe/reporting/_report_run_service.py @@ -11,7 +11,7 @@ class ReportRunService(StripeService): class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -25,38 +25,676 @@ class CreateParams(TypedDict): """ class CreateParamsParameters(TypedDict): - columns: NotRequired["List[str]"] + columns: NotRequired[List[str]] """ The set of report columns to include in the report output. If omitted, the Report Type is run with its default column set. """ - connected_account: NotRequired["str"] + connected_account: NotRequired[str] """ Connected account ID to filter for in the report run. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ Currency of objects to be included in the report run. """ - interval_end: NotRequired["int"] + interval_end: NotRequired[int] """ Ending timestamp of data to be included in the report run (exclusive). """ - interval_start: NotRequired["int"] + interval_start: NotRequired[int] """ Starting timestamp of data to be included in the report run. """ - payout: NotRequired["str"] + payout: NotRequired[str] """ Payout ID by which to filter the report run. """ reporting_category: NotRequired[ - "Literal['advance', 'advance_funding', 'anticipation_repayment', 'charge', 'charge_failure', 'climate_order_purchase', 'climate_order_refund', 'connect_collection_transfer', 'connect_reserved_funds', 'contribution', 'dispute', 'dispute_reversal', 'fee', 'financing_paydown', 'financing_paydown_reversal', 'financing_payout', 'financing_payout_reversal', 'issuing_authorization_hold', 'issuing_authorization_release', 'issuing_dispute', 'issuing_transaction', 'network_cost', 'other_adjustment', 'partial_capture_reversal', 'payout', 'payout_reversal', 'platform_earning', 'platform_earning_refund', 'refund', 'refund_failure', 'risk_reserved_funds', 'tax', 'topup', 'topup_reversal', 'transfer', 'transfer_reversal', 'unreconciled_customer_funds', 'obligation']" + Literal[ + "advance", + "advance_funding", + "anticipation_repayment", + "charge", + "charge_failure", + "climate_order_purchase", + "climate_order_refund", + "connect_collection_transfer", + "connect_reserved_funds", + "contribution", + "dispute", + "dispute_reversal", + "fee", + "financing_paydown", + "financing_paydown_reversal", + "financing_payout", + "financing_payout_reversal", + "issuing_authorization_hold", + "issuing_authorization_release", + "issuing_dispute", + "issuing_transaction", + "network_cost", + "other_adjustment", + "partial_capture_reversal", + "payout", + "payout_reversal", + "platform_earning", + "platform_earning_refund", + "refund", + "refund_failure", + "risk_reserved_funds", + "tax", + "topup", + "topup_reversal", + "transfer", + "transfer_reversal", + "unreconciled_customer_funds", + "obligation", + ] ] """ Category of balance transactions to be included in the report run. """ timezone: NotRequired[ - "Literal['Africa/Abidjan', 'Africa/Accra', 'Africa/Addis_Ababa', 'Africa/Algiers', 'Africa/Asmara', 'Africa/Asmera', 'Africa/Bamako', 'Africa/Bangui', 'Africa/Banjul', 'Africa/Bissau', 'Africa/Blantyre', 'Africa/Brazzaville', 'Africa/Bujumbura', 'Africa/Cairo', 'Africa/Casablanca', 'Africa/Ceuta', 'Africa/Conakry', 'Africa/Dakar', 'Africa/Dar_es_Salaam', 'Africa/Djibouti', 'Africa/Douala', 'Africa/El_Aaiun', 'Africa/Freetown', 'Africa/Gaborone', 'Africa/Harare', 'Africa/Johannesburg', 'Africa/Juba', 'Africa/Kampala', 'Africa/Khartoum', 'Africa/Kigali', 'Africa/Kinshasa', 'Africa/Lagos', 'Africa/Libreville', 'Africa/Lome', 'Africa/Luanda', 'Africa/Lubumbashi', 'Africa/Lusaka', 'Africa/Malabo', 'Africa/Maputo', 'Africa/Maseru', 'Africa/Mbabane', 'Africa/Mogadishu', 'Africa/Monrovia', 'Africa/Nairobi', 'Africa/Ndjamena', 'Africa/Niamey', 'Africa/Nouakchott', 'Africa/Ouagadougou', 'Africa/Porto-Novo', 'Africa/Sao_Tome', 'Africa/Timbuktu', 'Africa/Tripoli', 'Africa/Tunis', 'Africa/Windhoek', 'America/Adak', 'America/Anchorage', 'America/Anguilla', 'America/Antigua', 'America/Araguaina', 'America/Argentina/Buenos_Aires', 'America/Argentina/Catamarca', 'America/Argentina/ComodRivadavia', 'America/Argentina/Cordoba', 'America/Argentina/Jujuy', 'America/Argentina/La_Rioja', 'America/Argentina/Mendoza', 'America/Argentina/Rio_Gallegos', 'America/Argentina/Salta', 'America/Argentina/San_Juan', 'America/Argentina/San_Luis', 'America/Argentina/Tucuman', 'America/Argentina/Ushuaia', 'America/Aruba', 'America/Asuncion', 'America/Atikokan', 'America/Atka', 'America/Bahia', 'America/Bahia_Banderas', 'America/Barbados', 'America/Belem', 'America/Belize', 'America/Blanc-Sablon', 'America/Boa_Vista', 'America/Bogota', 'America/Boise', 'America/Buenos_Aires', 'America/Cambridge_Bay', 'America/Campo_Grande', 'America/Cancun', 'America/Caracas', 'America/Catamarca', 'America/Cayenne', 'America/Cayman', 'America/Chicago', 'America/Chihuahua', 'America/Ciudad_Juarez', 'America/Coral_Harbour', 'America/Cordoba', 'America/Costa_Rica', 'America/Creston', 'America/Cuiaba', 'America/Curacao', 'America/Danmarkshavn', 'America/Dawson', 'America/Dawson_Creek', 'America/Denver', 'America/Detroit', 'America/Dominica', 'America/Edmonton', 'America/Eirunepe', 'America/El_Salvador', 'America/Ensenada', 'America/Fort_Nelson', 'America/Fort_Wayne', 'America/Fortaleza', 'America/Glace_Bay', 'America/Godthab', 'America/Goose_Bay', 'America/Grand_Turk', 'America/Grenada', 'America/Guadeloupe', 'America/Guatemala', 'America/Guayaquil', 'America/Guyana', 'America/Halifax', 'America/Havana', 'America/Hermosillo', 'America/Indiana/Indianapolis', 'America/Indiana/Knox', 'America/Indiana/Marengo', 'America/Indiana/Petersburg', 'America/Indiana/Tell_City', 'America/Indiana/Vevay', 'America/Indiana/Vincennes', 'America/Indiana/Winamac', 'America/Indianapolis', 'America/Inuvik', 'America/Iqaluit', 'America/Jamaica', 'America/Jujuy', 'America/Juneau', 'America/Kentucky/Louisville', 'America/Kentucky/Monticello', 'America/Knox_IN', 'America/Kralendijk', 'America/La_Paz', 'America/Lima', 'America/Los_Angeles', 'America/Louisville', 'America/Lower_Princes', 'America/Maceio', 'America/Managua', 'America/Manaus', 'America/Marigot', 'America/Martinique', 'America/Matamoros', 'America/Mazatlan', 'America/Mendoza', 'America/Menominee', 'America/Merida', 'America/Metlakatla', 'America/Mexico_City', 'America/Miquelon', 'America/Moncton', 'America/Monterrey', 'America/Montevideo', 'America/Montreal', 'America/Montserrat', 'America/Nassau', 'America/New_York', 'America/Nipigon', 'America/Nome', 'America/Noronha', 'America/North_Dakota/Beulah', 'America/North_Dakota/Center', 'America/North_Dakota/New_Salem', 'America/Nuuk', 'America/Ojinaga', 'America/Panama', 'America/Pangnirtung', 'America/Paramaribo', 'America/Phoenix', 'America/Port-au-Prince', 'America/Port_of_Spain', 'America/Porto_Acre', 'America/Porto_Velho', 'America/Puerto_Rico', 'America/Punta_Arenas', 'America/Rainy_River', 'America/Rankin_Inlet', 'America/Recife', 'America/Regina', 'America/Resolute', 'America/Rio_Branco', 'America/Rosario', 'America/Santa_Isabel', 'America/Santarem', 'America/Santiago', 'America/Santo_Domingo', 'America/Sao_Paulo', 'America/Scoresbysund', 'America/Shiprock', 'America/Sitka', 'America/St_Barthelemy', 'America/St_Johns', 'America/St_Kitts', 'America/St_Lucia', 'America/St_Thomas', 'America/St_Vincent', 'America/Swift_Current', 'America/Tegucigalpa', 'America/Thule', 'America/Thunder_Bay', 'America/Tijuana', 'America/Toronto', 'America/Tortola', 'America/Vancouver', 'America/Virgin', 'America/Whitehorse', 'America/Winnipeg', 'America/Yakutat', 'America/Yellowknife', 'Antarctica/Casey', 'Antarctica/Davis', 'Antarctica/DumontDUrville', 'Antarctica/Macquarie', 'Antarctica/Mawson', 'Antarctica/McMurdo', 'Antarctica/Palmer', 'Antarctica/Rothera', 'Antarctica/South_Pole', 'Antarctica/Syowa', 'Antarctica/Troll', 'Antarctica/Vostok', 'Arctic/Longyearbyen', 'Asia/Aden', 'Asia/Almaty', 'Asia/Amman', 'Asia/Anadyr', 'Asia/Aqtau', 'Asia/Aqtobe', 'Asia/Ashgabat', 'Asia/Ashkhabad', 'Asia/Atyrau', 'Asia/Baghdad', 'Asia/Bahrain', 'Asia/Baku', 'Asia/Bangkok', 'Asia/Barnaul', 'Asia/Beirut', 'Asia/Bishkek', 'Asia/Brunei', 'Asia/Calcutta', 'Asia/Chita', 'Asia/Choibalsan', 'Asia/Chongqing', 'Asia/Chungking', 'Asia/Colombo', 'Asia/Dacca', 'Asia/Damascus', 'Asia/Dhaka', 'Asia/Dili', 'Asia/Dubai', 'Asia/Dushanbe', 'Asia/Famagusta', 'Asia/Gaza', 'Asia/Harbin', 'Asia/Hebron', 'Asia/Ho_Chi_Minh', 'Asia/Hong_Kong', 'Asia/Hovd', 'Asia/Irkutsk', 'Asia/Istanbul', 'Asia/Jakarta', 'Asia/Jayapura', 'Asia/Jerusalem', 'Asia/Kabul', 'Asia/Kamchatka', 'Asia/Karachi', 'Asia/Kashgar', 'Asia/Kathmandu', 'Asia/Katmandu', 'Asia/Khandyga', 'Asia/Kolkata', 'Asia/Krasnoyarsk', 'Asia/Kuala_Lumpur', 'Asia/Kuching', 'Asia/Kuwait', 'Asia/Macao', 'Asia/Macau', 'Asia/Magadan', 'Asia/Makassar', 'Asia/Manila', 'Asia/Muscat', 'Asia/Nicosia', 'Asia/Novokuznetsk', 'Asia/Novosibirsk', 'Asia/Omsk', 'Asia/Oral', 'Asia/Phnom_Penh', 'Asia/Pontianak', 'Asia/Pyongyang', 'Asia/Qatar', 'Asia/Qostanay', 'Asia/Qyzylorda', 'Asia/Rangoon', 'Asia/Riyadh', 'Asia/Saigon', 'Asia/Sakhalin', 'Asia/Samarkand', 'Asia/Seoul', 'Asia/Shanghai', 'Asia/Singapore', 'Asia/Srednekolymsk', 'Asia/Taipei', 'Asia/Tashkent', 'Asia/Tbilisi', 'Asia/Tehran', 'Asia/Tel_Aviv', 'Asia/Thimbu', 'Asia/Thimphu', 'Asia/Tokyo', 'Asia/Tomsk', 'Asia/Ujung_Pandang', 'Asia/Ulaanbaatar', 'Asia/Ulan_Bator', 'Asia/Urumqi', 'Asia/Ust-Nera', 'Asia/Vientiane', 'Asia/Vladivostok', 'Asia/Yakutsk', 'Asia/Yangon', 'Asia/Yekaterinburg', 'Asia/Yerevan', 'Atlantic/Azores', 'Atlantic/Bermuda', 'Atlantic/Canary', 'Atlantic/Cape_Verde', 'Atlantic/Faeroe', 'Atlantic/Faroe', 'Atlantic/Jan_Mayen', 'Atlantic/Madeira', 'Atlantic/Reykjavik', 'Atlantic/South_Georgia', 'Atlantic/St_Helena', 'Atlantic/Stanley', 'Australia/ACT', 'Australia/Adelaide', 'Australia/Brisbane', 'Australia/Broken_Hill', 'Australia/Canberra', 'Australia/Currie', 'Australia/Darwin', 'Australia/Eucla', 'Australia/Hobart', 'Australia/LHI', 'Australia/Lindeman', 'Australia/Lord_Howe', 'Australia/Melbourne', 'Australia/NSW', 'Australia/North', 'Australia/Perth', 'Australia/Queensland', 'Australia/South', 'Australia/Sydney', 'Australia/Tasmania', 'Australia/Victoria', 'Australia/West', 'Australia/Yancowinna', 'Brazil/Acre', 'Brazil/DeNoronha', 'Brazil/East', 'Brazil/West', 'CET', 'CST6CDT', 'Canada/Atlantic', 'Canada/Central', 'Canada/Eastern', 'Canada/Mountain', 'Canada/Newfoundland', 'Canada/Pacific', 'Canada/Saskatchewan', 'Canada/Yukon', 'Chile/Continental', 'Chile/EasterIsland', 'Cuba', 'EET', 'EST', 'EST5EDT', 'Egypt', 'Eire', 'Etc/GMT', 'Etc/GMT+0', 'Etc/GMT+1', 'Etc/GMT+10', 'Etc/GMT+11', 'Etc/GMT+12', 'Etc/GMT+2', 'Etc/GMT+3', 'Etc/GMT+4', 'Etc/GMT+5', 'Etc/GMT+6', 'Etc/GMT+7', 'Etc/GMT+8', 'Etc/GMT+9', 'Etc/GMT-0', 'Etc/GMT-1', 'Etc/GMT-10', 'Etc/GMT-11', 'Etc/GMT-12', 'Etc/GMT-13', 'Etc/GMT-14', 'Etc/GMT-2', 'Etc/GMT-3', 'Etc/GMT-4', 'Etc/GMT-5', 'Etc/GMT-6', 'Etc/GMT-7', 'Etc/GMT-8', 'Etc/GMT-9', 'Etc/GMT0', 'Etc/Greenwich', 'Etc/UCT', 'Etc/UTC', 'Etc/Universal', 'Etc/Zulu', 'Europe/Amsterdam', 'Europe/Andorra', 'Europe/Astrakhan', 'Europe/Athens', 'Europe/Belfast', 'Europe/Belgrade', 'Europe/Berlin', 'Europe/Bratislava', 'Europe/Brussels', 'Europe/Bucharest', 'Europe/Budapest', 'Europe/Busingen', 'Europe/Chisinau', 'Europe/Copenhagen', 'Europe/Dublin', 'Europe/Gibraltar', 'Europe/Guernsey', 'Europe/Helsinki', 'Europe/Isle_of_Man', 'Europe/Istanbul', 'Europe/Jersey', 'Europe/Kaliningrad', 'Europe/Kiev', 'Europe/Kirov', 'Europe/Kyiv', 'Europe/Lisbon', 'Europe/Ljubljana', 'Europe/London', 'Europe/Luxembourg', 'Europe/Madrid', 'Europe/Malta', 'Europe/Mariehamn', 'Europe/Minsk', 'Europe/Monaco', 'Europe/Moscow', 'Europe/Nicosia', 'Europe/Oslo', 'Europe/Paris', 'Europe/Podgorica', 'Europe/Prague', 'Europe/Riga', 'Europe/Rome', 'Europe/Samara', 'Europe/San_Marino', 'Europe/Sarajevo', 'Europe/Saratov', 'Europe/Simferopol', 'Europe/Skopje', 'Europe/Sofia', 'Europe/Stockholm', 'Europe/Tallinn', 'Europe/Tirane', 'Europe/Tiraspol', 'Europe/Ulyanovsk', 'Europe/Uzhgorod', 'Europe/Vaduz', 'Europe/Vatican', 'Europe/Vienna', 'Europe/Vilnius', 'Europe/Volgograd', 'Europe/Warsaw', 'Europe/Zagreb', 'Europe/Zaporozhye', 'Europe/Zurich', 'Factory', 'GB', 'GB-Eire', 'GMT', 'GMT+0', 'GMT-0', 'GMT0', 'Greenwich', 'HST', 'Hongkong', 'Iceland', 'Indian/Antananarivo', 'Indian/Chagos', 'Indian/Christmas', 'Indian/Cocos', 'Indian/Comoro', 'Indian/Kerguelen', 'Indian/Mahe', 'Indian/Maldives', 'Indian/Mauritius', 'Indian/Mayotte', 'Indian/Reunion', 'Iran', 'Israel', 'Jamaica', 'Japan', 'Kwajalein', 'Libya', 'MET', 'MST', 'MST7MDT', 'Mexico/BajaNorte', 'Mexico/BajaSur', 'Mexico/General', 'NZ', 'NZ-CHAT', 'Navajo', 'PRC', 'PST8PDT', 'Pacific/Apia', 'Pacific/Auckland', 'Pacific/Bougainville', 'Pacific/Chatham', 'Pacific/Chuuk', 'Pacific/Easter', 'Pacific/Efate', 'Pacific/Enderbury', 'Pacific/Fakaofo', 'Pacific/Fiji', 'Pacific/Funafuti', 'Pacific/Galapagos', 'Pacific/Gambier', 'Pacific/Guadalcanal', 'Pacific/Guam', 'Pacific/Honolulu', 'Pacific/Johnston', 'Pacific/Kanton', 'Pacific/Kiritimati', 'Pacific/Kosrae', 'Pacific/Kwajalein', 'Pacific/Majuro', 'Pacific/Marquesas', 'Pacific/Midway', 'Pacific/Nauru', 'Pacific/Niue', 'Pacific/Norfolk', 'Pacific/Noumea', 'Pacific/Pago_Pago', 'Pacific/Palau', 'Pacific/Pitcairn', 'Pacific/Pohnpei', 'Pacific/Ponape', 'Pacific/Port_Moresby', 'Pacific/Rarotonga', 'Pacific/Saipan', 'Pacific/Samoa', 'Pacific/Tahiti', 'Pacific/Tarawa', 'Pacific/Tongatapu', 'Pacific/Truk', 'Pacific/Wake', 'Pacific/Wallis', 'Pacific/Yap', 'Poland', 'Portugal', 'ROC', 'ROK', 'Singapore', 'Turkey', 'UCT', 'US/Alaska', 'US/Aleutian', 'US/Arizona', 'US/Central', 'US/East-Indiana', 'US/Eastern', 'US/Hawaii', 'US/Indiana-Starke', 'US/Michigan', 'US/Mountain', 'US/Pacific', 'US/Pacific-New', 'US/Samoa', 'UTC', 'Universal', 'W-SU', 'WET', 'Zulu']" + Literal[ + "Africa/Abidjan", + "Africa/Accra", + "Africa/Addis_Ababa", + "Africa/Algiers", + "Africa/Asmara", + "Africa/Asmera", + "Africa/Bamako", + "Africa/Bangui", + "Africa/Banjul", + "Africa/Bissau", + "Africa/Blantyre", + "Africa/Brazzaville", + "Africa/Bujumbura", + "Africa/Cairo", + "Africa/Casablanca", + "Africa/Ceuta", + "Africa/Conakry", + "Africa/Dakar", + "Africa/Dar_es_Salaam", + "Africa/Djibouti", + "Africa/Douala", + "Africa/El_Aaiun", + "Africa/Freetown", + "Africa/Gaborone", + "Africa/Harare", + "Africa/Johannesburg", + "Africa/Juba", + "Africa/Kampala", + "Africa/Khartoum", + "Africa/Kigali", + "Africa/Kinshasa", + "Africa/Lagos", + "Africa/Libreville", + "Africa/Lome", + "Africa/Luanda", + "Africa/Lubumbashi", + "Africa/Lusaka", + "Africa/Malabo", + "Africa/Maputo", + "Africa/Maseru", + "Africa/Mbabane", + "Africa/Mogadishu", + "Africa/Monrovia", + "Africa/Nairobi", + "Africa/Ndjamena", + "Africa/Niamey", + "Africa/Nouakchott", + "Africa/Ouagadougou", + "Africa/Porto-Novo", + "Africa/Sao_Tome", + "Africa/Timbuktu", + "Africa/Tripoli", + "Africa/Tunis", + "Africa/Windhoek", + "America/Adak", + "America/Anchorage", + "America/Anguilla", + "America/Antigua", + "America/Araguaina", + "America/Argentina/Buenos_Aires", + "America/Argentina/Catamarca", + "America/Argentina/ComodRivadavia", + "America/Argentina/Cordoba", + "America/Argentina/Jujuy", + "America/Argentina/La_Rioja", + "America/Argentina/Mendoza", + "America/Argentina/Rio_Gallegos", + "America/Argentina/Salta", + "America/Argentina/San_Juan", + "America/Argentina/San_Luis", + "America/Argentina/Tucuman", + "America/Argentina/Ushuaia", + "America/Aruba", + "America/Asuncion", + "America/Atikokan", + "America/Atka", + "America/Bahia", + "America/Bahia_Banderas", + "America/Barbados", + "America/Belem", + "America/Belize", + "America/Blanc-Sablon", + "America/Boa_Vista", + "America/Bogota", + "America/Boise", + "America/Buenos_Aires", + "America/Cambridge_Bay", + "America/Campo_Grande", + "America/Cancun", + "America/Caracas", + "America/Catamarca", + "America/Cayenne", + "America/Cayman", + "America/Chicago", + "America/Chihuahua", + "America/Ciudad_Juarez", + "America/Coral_Harbour", + "America/Cordoba", + "America/Costa_Rica", + "America/Creston", + "America/Cuiaba", + "America/Curacao", + "America/Danmarkshavn", + "America/Dawson", + "America/Dawson_Creek", + "America/Denver", + "America/Detroit", + "America/Dominica", + "America/Edmonton", + "America/Eirunepe", + "America/El_Salvador", + "America/Ensenada", + "America/Fort_Nelson", + "America/Fort_Wayne", + "America/Fortaleza", + "America/Glace_Bay", + "America/Godthab", + "America/Goose_Bay", + "America/Grand_Turk", + "America/Grenada", + "America/Guadeloupe", + "America/Guatemala", + "America/Guayaquil", + "America/Guyana", + "America/Halifax", + "America/Havana", + "America/Hermosillo", + "America/Indiana/Indianapolis", + "America/Indiana/Knox", + "America/Indiana/Marengo", + "America/Indiana/Petersburg", + "America/Indiana/Tell_City", + "America/Indiana/Vevay", + "America/Indiana/Vincennes", + "America/Indiana/Winamac", + "America/Indianapolis", + "America/Inuvik", + "America/Iqaluit", + "America/Jamaica", + "America/Jujuy", + "America/Juneau", + "America/Kentucky/Louisville", + "America/Kentucky/Monticello", + "America/Knox_IN", + "America/Kralendijk", + "America/La_Paz", + "America/Lima", + "America/Los_Angeles", + "America/Louisville", + "America/Lower_Princes", + "America/Maceio", + "America/Managua", + "America/Manaus", + "America/Marigot", + "America/Martinique", + "America/Matamoros", + "America/Mazatlan", + "America/Mendoza", + "America/Menominee", + "America/Merida", + "America/Metlakatla", + "America/Mexico_City", + "America/Miquelon", + "America/Moncton", + "America/Monterrey", + "America/Montevideo", + "America/Montreal", + "America/Montserrat", + "America/Nassau", + "America/New_York", + "America/Nipigon", + "America/Nome", + "America/Noronha", + "America/North_Dakota/Beulah", + "America/North_Dakota/Center", + "America/North_Dakota/New_Salem", + "America/Nuuk", + "America/Ojinaga", + "America/Panama", + "America/Pangnirtung", + "America/Paramaribo", + "America/Phoenix", + "America/Port-au-Prince", + "America/Port_of_Spain", + "America/Porto_Acre", + "America/Porto_Velho", + "America/Puerto_Rico", + "America/Punta_Arenas", + "America/Rainy_River", + "America/Rankin_Inlet", + "America/Recife", + "America/Regina", + "America/Resolute", + "America/Rio_Branco", + "America/Rosario", + "America/Santa_Isabel", + "America/Santarem", + "America/Santiago", + "America/Santo_Domingo", + "America/Sao_Paulo", + "America/Scoresbysund", + "America/Shiprock", + "America/Sitka", + "America/St_Barthelemy", + "America/St_Johns", + "America/St_Kitts", + "America/St_Lucia", + "America/St_Thomas", + "America/St_Vincent", + "America/Swift_Current", + "America/Tegucigalpa", + "America/Thule", + "America/Thunder_Bay", + "America/Tijuana", + "America/Toronto", + "America/Tortola", + "America/Vancouver", + "America/Virgin", + "America/Whitehorse", + "America/Winnipeg", + "America/Yakutat", + "America/Yellowknife", + "Antarctica/Casey", + "Antarctica/Davis", + "Antarctica/DumontDUrville", + "Antarctica/Macquarie", + "Antarctica/Mawson", + "Antarctica/McMurdo", + "Antarctica/Palmer", + "Antarctica/Rothera", + "Antarctica/South_Pole", + "Antarctica/Syowa", + "Antarctica/Troll", + "Antarctica/Vostok", + "Arctic/Longyearbyen", + "Asia/Aden", + "Asia/Almaty", + "Asia/Amman", + "Asia/Anadyr", + "Asia/Aqtau", + "Asia/Aqtobe", + "Asia/Ashgabat", + "Asia/Ashkhabad", + "Asia/Atyrau", + "Asia/Baghdad", + "Asia/Bahrain", + "Asia/Baku", + "Asia/Bangkok", + "Asia/Barnaul", + "Asia/Beirut", + "Asia/Bishkek", + "Asia/Brunei", + "Asia/Calcutta", + "Asia/Chita", + "Asia/Choibalsan", + "Asia/Chongqing", + "Asia/Chungking", + "Asia/Colombo", + "Asia/Dacca", + "Asia/Damascus", + "Asia/Dhaka", + "Asia/Dili", + "Asia/Dubai", + "Asia/Dushanbe", + "Asia/Famagusta", + "Asia/Gaza", + "Asia/Harbin", + "Asia/Hebron", + "Asia/Ho_Chi_Minh", + "Asia/Hong_Kong", + "Asia/Hovd", + "Asia/Irkutsk", + "Asia/Istanbul", + "Asia/Jakarta", + "Asia/Jayapura", + "Asia/Jerusalem", + "Asia/Kabul", + "Asia/Kamchatka", + "Asia/Karachi", + "Asia/Kashgar", + "Asia/Kathmandu", + "Asia/Katmandu", + "Asia/Khandyga", + "Asia/Kolkata", + "Asia/Krasnoyarsk", + "Asia/Kuala_Lumpur", + "Asia/Kuching", + "Asia/Kuwait", + "Asia/Macao", + "Asia/Macau", + "Asia/Magadan", + "Asia/Makassar", + "Asia/Manila", + "Asia/Muscat", + "Asia/Nicosia", + "Asia/Novokuznetsk", + "Asia/Novosibirsk", + "Asia/Omsk", + "Asia/Oral", + "Asia/Phnom_Penh", + "Asia/Pontianak", + "Asia/Pyongyang", + "Asia/Qatar", + "Asia/Qostanay", + "Asia/Qyzylorda", + "Asia/Rangoon", + "Asia/Riyadh", + "Asia/Saigon", + "Asia/Sakhalin", + "Asia/Samarkand", + "Asia/Seoul", + "Asia/Shanghai", + "Asia/Singapore", + "Asia/Srednekolymsk", + "Asia/Taipei", + "Asia/Tashkent", + "Asia/Tbilisi", + "Asia/Tehran", + "Asia/Tel_Aviv", + "Asia/Thimbu", + "Asia/Thimphu", + "Asia/Tokyo", + "Asia/Tomsk", + "Asia/Ujung_Pandang", + "Asia/Ulaanbaatar", + "Asia/Ulan_Bator", + "Asia/Urumqi", + "Asia/Ust-Nera", + "Asia/Vientiane", + "Asia/Vladivostok", + "Asia/Yakutsk", + "Asia/Yangon", + "Asia/Yekaterinburg", + "Asia/Yerevan", + "Atlantic/Azores", + "Atlantic/Bermuda", + "Atlantic/Canary", + "Atlantic/Cape_Verde", + "Atlantic/Faeroe", + "Atlantic/Faroe", + "Atlantic/Jan_Mayen", + "Atlantic/Madeira", + "Atlantic/Reykjavik", + "Atlantic/South_Georgia", + "Atlantic/St_Helena", + "Atlantic/Stanley", + "Australia/ACT", + "Australia/Adelaide", + "Australia/Brisbane", + "Australia/Broken_Hill", + "Australia/Canberra", + "Australia/Currie", + "Australia/Darwin", + "Australia/Eucla", + "Australia/Hobart", + "Australia/LHI", + "Australia/Lindeman", + "Australia/Lord_Howe", + "Australia/Melbourne", + "Australia/NSW", + "Australia/North", + "Australia/Perth", + "Australia/Queensland", + "Australia/South", + "Australia/Sydney", + "Australia/Tasmania", + "Australia/Victoria", + "Australia/West", + "Australia/Yancowinna", + "Brazil/Acre", + "Brazil/DeNoronha", + "Brazil/East", + "Brazil/West", + "CET", + "CST6CDT", + "Canada/Atlantic", + "Canada/Central", + "Canada/Eastern", + "Canada/Mountain", + "Canada/Newfoundland", + "Canada/Pacific", + "Canada/Saskatchewan", + "Canada/Yukon", + "Chile/Continental", + "Chile/EasterIsland", + "Cuba", + "EET", + "EST", + "EST5EDT", + "Egypt", + "Eire", + "Etc/GMT", + "Etc/GMT+0", + "Etc/GMT+1", + "Etc/GMT+10", + "Etc/GMT+11", + "Etc/GMT+12", + "Etc/GMT+2", + "Etc/GMT+3", + "Etc/GMT+4", + "Etc/GMT+5", + "Etc/GMT+6", + "Etc/GMT+7", + "Etc/GMT+8", + "Etc/GMT+9", + "Etc/GMT-0", + "Etc/GMT-1", + "Etc/GMT-10", + "Etc/GMT-11", + "Etc/GMT-12", + "Etc/GMT-13", + "Etc/GMT-14", + "Etc/GMT-2", + "Etc/GMT-3", + "Etc/GMT-4", + "Etc/GMT-5", + "Etc/GMT-6", + "Etc/GMT-7", + "Etc/GMT-8", + "Etc/GMT-9", + "Etc/GMT0", + "Etc/Greenwich", + "Etc/UCT", + "Etc/UTC", + "Etc/Universal", + "Etc/Zulu", + "Europe/Amsterdam", + "Europe/Andorra", + "Europe/Astrakhan", + "Europe/Athens", + "Europe/Belfast", + "Europe/Belgrade", + "Europe/Berlin", + "Europe/Bratislava", + "Europe/Brussels", + "Europe/Bucharest", + "Europe/Budapest", + "Europe/Busingen", + "Europe/Chisinau", + "Europe/Copenhagen", + "Europe/Dublin", + "Europe/Gibraltar", + "Europe/Guernsey", + "Europe/Helsinki", + "Europe/Isle_of_Man", + "Europe/Istanbul", + "Europe/Jersey", + "Europe/Kaliningrad", + "Europe/Kiev", + "Europe/Kirov", + "Europe/Kyiv", + "Europe/Lisbon", + "Europe/Ljubljana", + "Europe/London", + "Europe/Luxembourg", + "Europe/Madrid", + "Europe/Malta", + "Europe/Mariehamn", + "Europe/Minsk", + "Europe/Monaco", + "Europe/Moscow", + "Europe/Nicosia", + "Europe/Oslo", + "Europe/Paris", + "Europe/Podgorica", + "Europe/Prague", + "Europe/Riga", + "Europe/Rome", + "Europe/Samara", + "Europe/San_Marino", + "Europe/Sarajevo", + "Europe/Saratov", + "Europe/Simferopol", + "Europe/Skopje", + "Europe/Sofia", + "Europe/Stockholm", + "Europe/Tallinn", + "Europe/Tirane", + "Europe/Tiraspol", + "Europe/Ulyanovsk", + "Europe/Uzhgorod", + "Europe/Vaduz", + "Europe/Vatican", + "Europe/Vienna", + "Europe/Vilnius", + "Europe/Volgograd", + "Europe/Warsaw", + "Europe/Zagreb", + "Europe/Zaporozhye", + "Europe/Zurich", + "Factory", + "GB", + "GB-Eire", + "GMT", + "GMT+0", + "GMT-0", + "GMT0", + "Greenwich", + "HST", + "Hongkong", + "Iceland", + "Indian/Antananarivo", + "Indian/Chagos", + "Indian/Christmas", + "Indian/Cocos", + "Indian/Comoro", + "Indian/Kerguelen", + "Indian/Mahe", + "Indian/Maldives", + "Indian/Mauritius", + "Indian/Mayotte", + "Indian/Reunion", + "Iran", + "Israel", + "Jamaica", + "Japan", + "Kwajalein", + "Libya", + "MET", + "MST", + "MST7MDT", + "Mexico/BajaNorte", + "Mexico/BajaSur", + "Mexico/General", + "NZ", + "NZ-CHAT", + "Navajo", + "PRC", + "PST8PDT", + "Pacific/Apia", + "Pacific/Auckland", + "Pacific/Bougainville", + "Pacific/Chatham", + "Pacific/Chuuk", + "Pacific/Easter", + "Pacific/Efate", + "Pacific/Enderbury", + "Pacific/Fakaofo", + "Pacific/Fiji", + "Pacific/Funafuti", + "Pacific/Galapagos", + "Pacific/Gambier", + "Pacific/Guadalcanal", + "Pacific/Guam", + "Pacific/Honolulu", + "Pacific/Johnston", + "Pacific/Kanton", + "Pacific/Kiritimati", + "Pacific/Kosrae", + "Pacific/Kwajalein", + "Pacific/Majuro", + "Pacific/Marquesas", + "Pacific/Midway", + "Pacific/Nauru", + "Pacific/Niue", + "Pacific/Norfolk", + "Pacific/Noumea", + "Pacific/Pago_Pago", + "Pacific/Palau", + "Pacific/Pitcairn", + "Pacific/Pohnpei", + "Pacific/Ponape", + "Pacific/Port_Moresby", + "Pacific/Rarotonga", + "Pacific/Saipan", + "Pacific/Samoa", + "Pacific/Tahiti", + "Pacific/Tarawa", + "Pacific/Tongatapu", + "Pacific/Truk", + "Pacific/Wake", + "Pacific/Wallis", + "Pacific/Yap", + "Poland", + "Portugal", + "ROC", + "ROK", + "Singapore", + "Turkey", + "UCT", + "US/Alaska", + "US/Aleutian", + "US/Arizona", + "US/Central", + "US/East-Indiana", + "US/Eastern", + "US/Hawaii", + "US/Indiana-Starke", + "US/Michigan", + "US/Mountain", + "US/Pacific", + "US/Pacific-New", + "US/Samoa", + "UTC", + "Universal", + "W-SU", + "WET", + "Zulu", + ] ] """ Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`. @@ -67,43 +705,43 @@ class ListParams(TypedDict): """ Only return Report Runs that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/reporting/_report_type.py b/stripe/reporting/_report_type.py index 72794c353..b6e476595 100644 --- a/stripe/reporting/_report_type.py +++ b/stripe/reporting/_report_type.py @@ -24,13 +24,13 @@ class ReportType(ListableAPIResource["ReportType"]): ] = "reporting.report_type" class ListParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/reporting/_report_type_service.py b/stripe/reporting/_report_type_service.py index f3c50c14c..e50f78037 100644 --- a/stripe/reporting/_report_type_service.py +++ b/stripe/reporting/_report_type_service.py @@ -11,13 +11,13 @@ class ReportTypeService(StripeService): class ListParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/sigma/_scheduled_query_run.py b/stripe/sigma/_scheduled_query_run.py index 1d46bfef3..aef65a5d0 100644 --- a/stripe/sigma/_scheduled_query_run.py +++ b/stripe/sigma/_scheduled_query_run.py @@ -30,25 +30,25 @@ class Error(StripeObject): """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/sigma/_scheduled_query_run_service.py b/stripe/sigma/_scheduled_query_run_service.py index 9f2b84252..55bec997f 100644 --- a/stripe/sigma/_scheduled_query_run_service.py +++ b/stripe/sigma/_scheduled_query_run_service.py @@ -11,25 +11,25 @@ class ScheduledQueryRunService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/tax/_calculation.py b/stripe/tax/_calculation.py index bd8205e32..a2037110f 100644 --- a/stripe/tax/_calculation.py +++ b/stripe/tax/_calculation.py @@ -378,7 +378,7 @@ class CreateParams(RequestOptions): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to `customer_details`. """ @@ -388,7 +388,7 @@ class CreateParams(RequestOptions): """ Details about the customer, including address and tax IDs. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -406,7 +406,7 @@ class CreateParams(RequestOptions): """ Shipping cost details to be used for the calculation. """ - tax_date: NotRequired["int"] + tax_date: NotRequired[int] """ Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future. """ @@ -416,22 +416,22 @@ class CreateParamsCustomerDetails(TypedDict): """ The customer's postal address (for example, home or business location). """ - address_source: NotRequired["Literal['billing', 'shipping']"] + address_source: NotRequired[Literal["billing", "shipping"]] """ The type of customer address provided. """ - ip_address: NotRequired["str"] + ip_address: NotRequired[str] """ The customer's IP address (IPv4 or IPv6). """ tax_ids: NotRequired[ - "List[Calculation.CreateParamsCustomerDetailsTaxId]" + List["Calculation.CreateParamsCustomerDetailsTaxId"] ] """ The customer's tax IDs. Stripe Tax might consider a transaction with applicable tax IDs to be B2B, which might affect the tax calculation result. Stripe Tax doesn't validate tax IDs for correctness. """ taxability_override: NotRequired[ - "Literal['customer_exempt', 'none', 'reverse_charge']" + Literal["customer_exempt", "none", "reverse_charge"] ] """ Overrides the tax calculation result to allow you to not collect tax from your customer. Use this if you've manually checked your customer's tax exemptions. Prefer providing the customer's `tax_ids` where possible, which automatically determines whether `reverse_charge` applies. @@ -546,23 +546,23 @@ class CreateParamsLineItem(TypedDict): """ A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing the line item's total price. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount. """ - product: NotRequired["str"] + product: NotRequired[str] """ If provided, the product's `tax_code` will be used as the line item's `tax_code`. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The number of units of the item being purchased. Used to calculate the per-unit price from the total `amount` for the line. For example, if `amount=100` and `quantity=4`, the calculated unit price is 25. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A custom identifier for this line item, which must be unique across the line items in the calculation. The reference helps identify each line item in exported [tax reports](https://stripe.com/docs/tax/reports). """ - tax_behavior: NotRequired["Literal['exclusive', 'inclusive']"] + tax_behavior: NotRequired[Literal["exclusive", "inclusive"]] """ Specifies whether the `amount` includes taxes. Defaults to `exclusive`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID to use for this line item. If not provided, we will use the tax code from the provided `product` param. If neither `tax_code` nor `product` is provided, we will use the default tax code from your Tax Settings. """ @@ -600,37 +600,37 @@ class CreateParamsShipFromDetailsAddress(TypedDict): """ class CreateParamsShippingCost(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing the shipping charge. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount. """ - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ If provided, the [shipping rate](https://stripe.com/docs/api/shipping_rates/object)'s `amount`, `tax_code` and `tax_behavior` are used. If you provide a shipping rate, then you cannot pass the `amount`, `tax_code`, or `tax_behavior` parameters. """ - tax_behavior: NotRequired["Literal['exclusive', 'inclusive']"] + tax_behavior: NotRequired[Literal["exclusive", "inclusive"]] """ Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. Defaults to `exclusive`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ The [tax code](https://stripe.com/docs/tax/tax-categories) used to calculate tax on shipping. If not provided, the default shipping tax code from your [Tax Settings](https://stripe.com/settings/tax) is used. """ class ListLineItemsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/tax/_calculation_line_item_service.py b/stripe/tax/_calculation_line_item_service.py index 021fca9a0..1061d0ed2 100644 --- a/stripe/tax/_calculation_line_item_service.py +++ b/stripe/tax/_calculation_line_item_service.py @@ -11,19 +11,19 @@ class CalculationLineItemService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/tax/_calculation_service.py b/stripe/tax/_calculation_service.py index 1f38ad349..3753c4d04 100644 --- a/stripe/tax/_calculation_service.py +++ b/stripe/tax/_calculation_service.py @@ -20,7 +20,7 @@ class CreateParams(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to `customer_details`. """ @@ -30,7 +30,7 @@ class CreateParams(TypedDict): """ Details about the customer, including address and tax IDs. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -50,7 +50,7 @@ class CreateParams(TypedDict): """ Shipping cost details to be used for the calculation. """ - tax_date: NotRequired["int"] + tax_date: NotRequired[int] """ Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future. """ @@ -62,22 +62,22 @@ class CreateParamsCustomerDetails(TypedDict): """ The customer's postal address (for example, home or business location). """ - address_source: NotRequired["Literal['billing', 'shipping']"] + address_source: NotRequired[Literal["billing", "shipping"]] """ The type of customer address provided. """ - ip_address: NotRequired["str"] + ip_address: NotRequired[str] """ The customer's IP address (IPv4 or IPv6). """ tax_ids: NotRequired[ - "List[CalculationService.CreateParamsCustomerDetailsTaxId]" + List["CalculationService.CreateParamsCustomerDetailsTaxId"] ] """ The customer's tax IDs. Stripe Tax might consider a transaction with applicable tax IDs to be B2B, which might affect the tax calculation result. Stripe Tax doesn't validate tax IDs for correctness. """ taxability_override: NotRequired[ - "Literal['customer_exempt', 'none', 'reverse_charge']" + Literal["customer_exempt", "none", "reverse_charge"] ] """ Overrides the tax calculation result to allow you to not collect tax from your customer. Use this if you've manually checked your customer's tax exemptions. Prefer providing the customer's `tax_ids` where possible, which automatically determines whether `reverse_charge` applies. @@ -192,23 +192,23 @@ class CreateParamsLineItem(TypedDict): """ A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing the line item's total price. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount. """ - product: NotRequired["str"] + product: NotRequired[str] """ If provided, the product's `tax_code` will be used as the line item's `tax_code`. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The number of units of the item being purchased. Used to calculate the per-unit price from the total `amount` for the line. For example, if `amount=100` and `quantity=4`, the calculated unit price is 25. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A custom identifier for this line item, which must be unique across the line items in the calculation. The reference helps identify each line item in exported [tax reports](https://stripe.com/docs/tax/reports). """ - tax_behavior: NotRequired["Literal['exclusive', 'inclusive']"] + tax_behavior: NotRequired[Literal["exclusive", "inclusive"]] """ Specifies whether the `amount` includes taxes. Defaults to `exclusive`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID to use for this line item. If not provided, we will use the tax code from the provided `product` param. If neither `tax_code` nor `product` is provided, we will use the default tax code from your Tax Settings. """ @@ -246,19 +246,19 @@ class CreateParamsShipFromDetailsAddress(TypedDict): """ class CreateParamsShippingCost(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing the shipping charge. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount. """ - shipping_rate: NotRequired["str"] + shipping_rate: NotRequired[str] """ If provided, the [shipping rate](https://stripe.com/docs/api/shipping_rates/object)'s `amount`, `tax_code` and `tax_behavior` are used. If you provide a shipping rate, then you cannot pass the `amount`, `tax_code`, or `tax_behavior` parameters. """ - tax_behavior: NotRequired["Literal['exclusive', 'inclusive']"] + tax_behavior: NotRequired[Literal["exclusive", "inclusive"]] """ Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. Defaults to `exclusive`. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ The [tax code](https://stripe.com/docs/tax/tax-categories) used to calculate tax on shipping. If not provided, the default shipping tax code from your [Tax Settings](https://stripe.com/settings/tax) is used. """ diff --git a/stripe/tax/_form.py b/stripe/tax/_form.py index d110882d1..6d25c10f1 100644 --- a/stripe/tax/_form.py +++ b/stripe/tax/_form.py @@ -83,15 +83,15 @@ class Us1099Nec(StripeObject): """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -99,35 +99,33 @@ class ListParams(RequestOptions): """ The payee whose volume is represented on the tax form. """ - starting_after: NotRequired["str"] + 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. """ - type: NotRequired[ - "Literal['us_1099_k', 'us_1099_misc', 'us_1099_nec']" - ] + type: NotRequired[Literal["us_1099_k", "us_1099_misc", "us_1099_nec"]] """ An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future tax form types. If your integration expects only one type of tax form in the response, make sure to provide a type value in the request. """ class ListParamsPayee(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The ID of the Stripe account whose forms will be retrieved. """ - type: NotRequired["Literal['account']"] + type: NotRequired[Literal["account"]] """ Specifies the payee type. Always `account`. """ class PdfParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/tax/_form_service.py b/stripe/tax/_form_service.py index e3fce546b..d65c0343d 100644 --- a/stripe/tax/_form_service.py +++ b/stripe/tax/_form_service.py @@ -11,15 +11,15 @@ class FormService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ @@ -27,35 +27,33 @@ class ListParams(TypedDict): """ The payee whose volume is represented on the tax form. """ - starting_after: NotRequired["str"] + 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. """ - type: NotRequired[ - "Literal['us_1099_k', 'us_1099_misc', 'us_1099_nec']" - ] + type: NotRequired[Literal["us_1099_k", "us_1099_misc", "us_1099_nec"]] """ An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future tax form types. If your integration expects only one type of tax form in the response, make sure to provide a type value in the request. """ class ListParamsPayee(TypedDict): - account: NotRequired["str"] + account: NotRequired[str] """ The ID of the Stripe account whose forms will be retrieved. """ - type: NotRequired["Literal['account']"] + type: NotRequired[Literal["account"]] """ Specifies the payee type. Always `account`. """ class PdfParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/tax/_registration.py b/stripe/tax/_registration.py index 1d8350e69..b6c707f05 100644 --- a/stripe/tax/_registration.py +++ b/stripe/tax/_registration.py @@ -687,11 +687,11 @@ class CreateParams(RequestOptions): """ Specific options for a registration in the specified `country`. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch. """ @@ -1559,23 +1559,23 @@ class CreateParamsCountryOptionsZa(TypedDict): """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - status: NotRequired["Literal['active', 'all', 'expired', 'scheduled']"] + status: NotRequired[Literal["active", "all", "expired", "scheduled"]] """ The status of the Tax Registration. """ @@ -1585,7 +1585,7 @@ class ModifyParams(RequestOptions): """ Time at which the registration becomes active. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -1595,7 +1595,7 @@ class ModifyParams(RequestOptions): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/tax/_registration_service.py b/stripe/tax/_registration_service.py index 4e1c08acf..f9429be5f 100644 --- a/stripe/tax/_registration_service.py +++ b/stripe/tax/_registration_service.py @@ -23,11 +23,11 @@ class CreateParams(TypedDict): """ Specific options for a registration in the specified `country`. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - expires_at: NotRequired["int"] + expires_at: NotRequired[int] """ If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch. """ @@ -899,29 +899,29 @@ class CreateParamsCountryOptionsZa(TypedDict): """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ - status: NotRequired["Literal['active', 'all', 'expired', 'scheduled']"] + status: NotRequired[Literal["active", "all", "expired", "scheduled"]] """ The status of the Tax Registration. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -931,7 +931,7 @@ class UpdateParams(TypedDict): """ Time at which the registration becomes active. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/tax/_settings.py b/stripe/tax/_settings.py index b4bd1728a..c8454342a 100644 --- a/stripe/tax/_settings.py +++ b/stripe/tax/_settings.py @@ -81,7 +81,7 @@ class ModifyParams(RequestOptions): """ Default configuration to be used on Stripe Tax calculations. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -92,12 +92,12 @@ class ModifyParams(RequestOptions): class ModifyParamsDefaults(TypedDict): tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'inferred_by_currency']" + Literal["exclusive", "inclusive", "inferred_by_currency"] ] """ Specifies the default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) to be used when the item's price has unspecified tax behavior. One of inclusive, exclusive, or inferred_by_currency. Once specified, it cannot be changed back to null. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ @@ -109,33 +109,33 @@ class ModifyParamsHeadOffice(TypedDict): """ class ModifyParamsHeadOfficeAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/tax/_settings_service.py b/stripe/tax/_settings_service.py index e0c27024e..63903ccff 100644 --- a/stripe/tax/_settings_service.py +++ b/stripe/tax/_settings_service.py @@ -9,7 +9,7 @@ class SettingsService(StripeService): class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -19,7 +19,7 @@ class UpdateParams(TypedDict): """ Default configuration to be used on Stripe Tax calculations. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -30,12 +30,12 @@ class UpdateParams(TypedDict): class UpdateParamsDefaults(TypedDict): tax_behavior: NotRequired[ - "Literal['exclusive', 'inclusive', 'inferred_by_currency']" + Literal["exclusive", "inclusive", "inferred_by_currency"] ] """ Specifies the default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) to be used when the item's price has unspecified tax behavior. One of inclusive, exclusive, or inferred_by_currency. Once specified, it cannot be changed back to null. """ - tax_code: NotRequired["str"] + tax_code: NotRequired[str] """ A [tax code](https://stripe.com/docs/tax/tax-categories) ID. """ @@ -47,27 +47,27 @@ class UpdateParamsHeadOffice(TypedDict): """ class UpdateParamsHeadOfficeAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". """ diff --git a/stripe/tax/_transaction.py b/stripe/tax/_transaction.py index 6adbc498f..ea4b7f164 100644 --- a/stripe/tax/_transaction.py +++ b/stripe/tax/_transaction.py @@ -315,11 +315,11 @@ class CreateFromCalculationParams(RequestOptions): """ Tax Calculation ID to be used as input when creating the transaction. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -329,21 +329,21 @@ class CreateFromCalculationParams(RequestOptions): """ class CreateReversalParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - flat_amount: NotRequired["int"] + flat_amount: NotRequired[int] """ A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes. """ line_items: NotRequired[ - "List[Transaction.CreateReversalParamsLineItem]" + List["Transaction.CreateReversalParamsLineItem"] ] """ The line item amounts to reverse. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -375,7 +375,7 @@ class CreateReversalParamsLineItem(TypedDict): """ The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. """ - metadata: NotRequired["Dict[str, str]"] + 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. """ @@ -383,7 +383,7 @@ class CreateReversalParamsLineItem(TypedDict): """ The `id` of the line item to reverse in the original transaction. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity reversed. Appears in [tax exports](https://stripe.com/docs/tax/reports), but does not affect the amount of tax reversed. """ @@ -403,25 +403,25 @@ class CreateReversalParamsShippingCost(TypedDict): """ class ListLineItemsParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/tax/_transaction_line_item_service.py b/stripe/tax/_transaction_line_item_service.py index 75c8e5622..2a50b2fd5 100644 --- a/stripe/tax/_transaction_line_item_service.py +++ b/stripe/tax/_transaction_line_item_service.py @@ -11,19 +11,19 @@ class TransactionLineItemService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ diff --git a/stripe/tax/_transaction_service.py b/stripe/tax/_transaction_service.py index 918732dc5..d4d488996 100644 --- a/stripe/tax/_transaction_service.py +++ b/stripe/tax/_transaction_service.py @@ -21,11 +21,11 @@ class CreateFromCalculationParams(TypedDict): """ Tax Calculation ID to be used as input when creating the transaction. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -35,21 +35,21 @@ class CreateFromCalculationParams(TypedDict): """ class CreateReversalParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - flat_amount: NotRequired["int"] + flat_amount: NotRequired[int] """ A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes. """ line_items: NotRequired[ - "List[TransactionService.CreateReversalParamsLineItem]" + List["TransactionService.CreateReversalParamsLineItem"] ] """ The line item amounts to reverse. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -81,7 +81,7 @@ class CreateReversalParamsLineItem(TypedDict): """ The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. """ - metadata: NotRequired["Dict[str, str]"] + 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. """ @@ -89,7 +89,7 @@ class CreateReversalParamsLineItem(TypedDict): """ The `id` of the line item to reverse in the original transaction. """ - quantity: NotRequired["int"] + quantity: NotRequired[int] """ The quantity reversed. Appears in [tax exports](https://stripe.com/docs/tax/reports), but does not affect the amount of tax reversed. """ @@ -109,7 +109,7 @@ class CreateReversalParamsShippingCost(TypedDict): """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/terminal/_configuration.py b/stripe/terminal/_configuration.py index f0f26c53c..786a5f0ba 100644 --- a/stripe/terminal/_configuration.py +++ b/stripe/terminal/_configuration.py @@ -287,11 +287,11 @@ class CreateParams(RequestOptions): """ An object containing device type specific settings for BBPOS WisePOS E readers """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - name: NotRequired["str"] + name: NotRequired[str] """ Name of the configuration """ @@ -379,197 +379,197 @@ class CreateParamsTipping(TypedDict): """ class CreateParamsTippingAud(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingCad(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingChf(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingCzk(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingDkk(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingEur(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingGbp(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingHkd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingMyr(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingNok(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingNzd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingSek(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingSgd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingUsd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ @@ -584,23 +584,23 @@ class DeleteParams(RequestOptions): pass class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - is_account_default: NotRequired["bool"] + is_account_default: NotRequired[bool] """ if present, only return the account default or non-default configurations. """ - limit: NotRequired["int"] + 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"] + 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. """ @@ -612,11 +612,11 @@ class ModifyParams(RequestOptions): """ An object containing device type specific settings for BBPOS WisePOS E readers """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - name: NotRequired["str"] + name: NotRequired[str] """ Name of the configuration """ @@ -706,197 +706,197 @@ class ModifyParamsTipping(TypedDict): """ class ModifyParamsTippingAud(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class ModifyParamsTippingCad(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class ModifyParamsTippingChf(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class ModifyParamsTippingCzk(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class ModifyParamsTippingDkk(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class ModifyParamsTippingEur(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class ModifyParamsTippingGbp(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class ModifyParamsTippingHkd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class ModifyParamsTippingMyr(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class ModifyParamsTippingNok(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class ModifyParamsTippingNzd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class ModifyParamsTippingSek(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class ModifyParamsTippingSgd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class ModifyParamsTippingUsd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ @@ -908,7 +908,7 @@ class ModifyParamsVerifoneP400(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/terminal/_configuration_service.py b/stripe/terminal/_configuration_service.py index 511581177..76740d703 100644 --- a/stripe/terminal/_configuration_service.py +++ b/stripe/terminal/_configuration_service.py @@ -17,11 +17,11 @@ class CreateParams(TypedDict): """ An object containing device type specific settings for BBPOS WisePOS E readers """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - name: NotRequired["str"] + name: NotRequired[str] """ Name of the configuration """ @@ -115,197 +115,197 @@ class CreateParamsTipping(TypedDict): """ class CreateParamsTippingAud(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingCad(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingChf(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingCzk(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingDkk(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingEur(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingGbp(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingHkd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingMyr(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingNok(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingNzd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingSek(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingSgd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class CreateParamsTippingUsd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ @@ -320,29 +320,29 @@ class DeleteParams(TypedDict): pass class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - is_account_default: NotRequired["bool"] + is_account_default: NotRequired[bool] """ if present, only return the account default or non-default configurations. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -354,11 +354,11 @@ class UpdateParams(TypedDict): """ An object containing device type specific settings for BBPOS WisePOS E readers """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - name: NotRequired["str"] + name: NotRequired[str] """ Name of the configuration """ @@ -452,197 +452,197 @@ class UpdateParamsTipping(TypedDict): """ class UpdateParamsTippingAud(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class UpdateParamsTippingCad(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class UpdateParamsTippingChf(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class UpdateParamsTippingCzk(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class UpdateParamsTippingDkk(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class UpdateParamsTippingEur(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class UpdateParamsTippingGbp(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class UpdateParamsTippingHkd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class UpdateParamsTippingMyr(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class UpdateParamsTippingNok(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class UpdateParamsTippingNzd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class UpdateParamsTippingSek(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class UpdateParamsTippingSgd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ class UpdateParamsTippingUsd(TypedDict): - fixed_amounts: NotRequired["List[int]"] + fixed_amounts: NotRequired[List[int]] """ Fixed amounts displayed when collecting a tip """ - percentages: NotRequired["List[int]"] + percentages: NotRequired[List[int]] """ Percentages displayed when collecting a tip """ - smart_tip_threshold: NotRequired["int"] + smart_tip_threshold: NotRequired[int] """ Below this amount, fixed amounts will be displayed; above it, percentages will be displayed """ diff --git a/stripe/terminal/_connection_token.py b/stripe/terminal/_connection_token.py index 84f1fdc79..294eb02b7 100644 --- a/stripe/terminal/_connection_token.py +++ b/stripe/terminal/_connection_token.py @@ -18,11 +18,11 @@ class ConnectionToken(CreateableAPIResource["ConnectionToken"]): ] = "terminal.connection_token" class CreateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - location: NotRequired["str"] + location: NotRequired[str] """ The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/fleet/locations#connection-tokens). """ diff --git a/stripe/terminal/_connection_token_service.py b/stripe/terminal/_connection_token_service.py index aa8e64c16..12861c259 100644 --- a/stripe/terminal/_connection_token_service.py +++ b/stripe/terminal/_connection_token_service.py @@ -9,11 +9,11 @@ class ConnectionTokenService(StripeService): class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - location: NotRequired["str"] + location: NotRequired[str] """ The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/fleet/locations#connection-tokens). """ diff --git a/stripe/terminal/_location.py b/stripe/terminal/_location.py index e2e129486..fe38a4c11 100644 --- a/stripe/terminal/_location.py +++ b/stripe/terminal/_location.py @@ -57,7 +57,7 @@ class CreateParams(RequestOptions): """ The full address of the location. """ - configuration_overrides: NotRequired["str"] + configuration_overrides: NotRequired[str] """ The ID of a configuration that will be used to customize all readers in this location. """ @@ -65,7 +65,7 @@ class CreateParams(RequestOptions): """ A name for the location. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -75,7 +75,7 @@ class CreateParams(RequestOptions): """ class CreateParamsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ @@ -83,19 +83,19 @@ class CreateParamsAddress(TypedDict): """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ - line1: NotRequired["str"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -104,19 +104,19 @@ class DeleteParams(RequestOptions): pass class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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. """ @@ -130,11 +130,11 @@ class ModifyParams(RequestOptions): """ The ID of a configuration that will be used to customize all readers in this location. """ - display_name: NotRequired["str"] + display_name: NotRequired[str] """ A name for the location. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -144,33 +144,33 @@ class ModifyParams(RequestOptions): """ class ModifyParamsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/terminal/_location_service.py b/stripe/terminal/_location_service.py index 4ad66cc76..18a8458cb 100644 --- a/stripe/terminal/_location_service.py +++ b/stripe/terminal/_location_service.py @@ -15,7 +15,7 @@ class CreateParams(TypedDict): """ The full address of the location. """ - configuration_overrides: NotRequired["str"] + configuration_overrides: NotRequired[str] """ The ID of a configuration that will be used to customize all readers in this location. """ @@ -23,7 +23,7 @@ class CreateParams(TypedDict): """ A name for the location. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -33,7 +33,7 @@ class CreateParams(TypedDict): """ class CreateParamsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ @@ -41,19 +41,19 @@ class CreateParamsAddress(TypedDict): """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ - line1: NotRequired["str"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -62,25 +62,25 @@ class DeleteParams(TypedDict): pass class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -94,11 +94,11 @@ class UpdateParams(TypedDict): """ The ID of a configuration that will be used to customize all readers in this location. """ - display_name: NotRequired["str"] + display_name: NotRequired[str] """ A name for the location. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -108,27 +108,27 @@ class UpdateParams(TypedDict): """ class UpdateParamsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ diff --git a/stripe/terminal/_reader.py b/stripe/terminal/_reader.py index 10e511cfc..6b4627f92 100644 --- a/stripe/terminal/_reader.py +++ b/stripe/terminal/_reader.py @@ -395,13 +395,13 @@ class LineItem(StripeObject): } class CancelActionParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CollectInputsParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -409,7 +409,7 @@ class CollectInputsParams(RequestOptions): """ List of inputs to be collected using the Reader """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -419,7 +419,7 @@ class CollectInputsParamsInput(TypedDict): """ Customize the text which will be displayed while collecting this input """ - required: NotRequired["bool"] + required: NotRequired[bool] """ Indicate that this input is required, disabling the skip button """ @@ -433,15 +433,15 @@ class CollectInputsParamsInput(TypedDict): """ class CollectInputsParamsInputCustomText(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The description which will be displayed when collecting this input """ - skip_button: NotRequired["str"] + skip_button: NotRequired[str] """ The skip button text """ - submit_button: NotRequired["str"] + submit_button: NotRequired[str] """ The submit button text """ @@ -457,7 +457,7 @@ class CollectInputsParamsInputSelection(TypedDict): """ class CollectInputsParamsInputSelectionChoice(TypedDict): - style: NotRequired["Literal['primary', 'secondary']"] + style: NotRequired[Literal["primary", "secondary"]] """ The style of the button which will be shown for this choice """ @@ -473,7 +473,7 @@ class CollectPaymentMethodParams(RequestOptions): """ Configuration overrides """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -483,11 +483,11 @@ class CollectPaymentMethodParams(RequestOptions): """ class CollectPaymentMethodParamsCollectConfig(TypedDict): - enable_customer_cancellation: NotRequired["bool"] + enable_customer_cancellation: NotRequired[bool] """ Enables cancel button on transaction screens. """ - skip_tipping: NotRequired["bool"] + skip_tipping: NotRequired[bool] """ Override showing a tipping selection screen on this transaction. """ @@ -499,13 +499,13 @@ class CollectPaymentMethodParamsCollectConfig(TypedDict): """ class CollectPaymentMethodParamsCollectConfigTipping(TypedDict): - amount_eligible: NotRequired["int"] + amount_eligible: NotRequired[int] """ Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency). """ class ConfirmPaymentIntentParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -515,15 +515,15 @@ class ConfirmPaymentIntentParams(RequestOptions): """ class CreateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - label: NotRequired["str"] + label: NotRequired[str] """ Custom label given to the reader for easier identification. If no label is specified, the registration code will be used. """ - location: NotRequired["str"] + location: NotRequired[str] """ The location to assign the reader to. """ @@ -541,42 +541,49 @@ class DeleteParams(RequestOptions): class ListParams(RequestOptions): device_type: NotRequired[ - "Literal['bbpos_chipper2x', 'bbpos_wisepad3', 'bbpos_wisepos_e', 'simulated_wisepos_e', 'stripe_m2', 'verifone_P400']" + Literal[ + "bbpos_chipper2x", + "bbpos_wisepad3", + "bbpos_wisepos_e", + "simulated_wisepos_e", + "stripe_m2", + "verifone_P400", + ] ] """ Filters readers by device type """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - location: NotRequired["str"] + location: NotRequired[str] """ A location ID to filter the response list to only readers at the specific location """ - serial_number: NotRequired["str"] + serial_number: NotRequired[str] """ Filters readers by serial number """ - starting_after: NotRequired["str"] + 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. """ - status: NotRequired["Literal['offline', 'online']"] + status: NotRequired[Literal["offline", "online"]] """ A status filter to filter readers to only offline or online readers """ class ModifyParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -590,7 +597,7 @@ class ModifyParams(RequestOptions): """ class PresentPaymentMethodParams(RequestOptions): - amount_tip: NotRequired["int"] + amount_tip: NotRequired[int] """ Simulated on-reader tip amount. """ @@ -600,7 +607,7 @@ class PresentPaymentMethodParams(RequestOptions): """ Simulated data for the card_present payment method. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -610,25 +617,25 @@ class PresentPaymentMethodParams(RequestOptions): """ Simulated data for the interac_present payment method. """ - type: NotRequired["Literal['card_present', 'interac_present']"] + type: NotRequired[Literal["card_present", "interac_present"]] """ Simulated payment type. """ class PresentPaymentMethodParamsCardPresent(TypedDict): - number: NotRequired["str"] + number: NotRequired[str] """ The card number, as a string without any separators. """ class PresentPaymentMethodParamsInteracPresent(TypedDict): - number: NotRequired["str"] + number: NotRequired[str] """ Card Number """ class ProcessPaymentIntentParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -644,11 +651,11 @@ class ProcessPaymentIntentParams(RequestOptions): """ class ProcessPaymentIntentParamsProcessConfig(TypedDict): - enable_customer_cancellation: NotRequired["bool"] + enable_customer_cancellation: NotRequired[bool] """ Enables cancel button on transaction screens. """ - skip_tipping: NotRequired["bool"] + skip_tipping: NotRequired[bool] """ Override showing a tipping selection screen on this transaction. """ @@ -660,7 +667,7 @@ class ProcessPaymentIntentParamsProcessConfig(TypedDict): """ class ProcessPaymentIntentParamsProcessConfigTipping(TypedDict): - amount_eligible: NotRequired["int"] + amount_eligible: NotRequired[int] """ Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency). """ @@ -670,7 +677,7 @@ class ProcessSetupIntentParams(RequestOptions): """ Customer Consent Collected """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -686,33 +693,33 @@ class ProcessSetupIntentParams(RequestOptions): """ class ProcessSetupIntentParamsProcessConfig(TypedDict): - enable_customer_cancellation: NotRequired["bool"] + enable_customer_cancellation: NotRequired[bool] """ Enables cancel button on transaction screens. """ class RefundPaymentParams(RequestOptions): - amount: NotRequired["int"] + amount: NotRequired[int] """ A positive integer in __cents__ representing how much of this charge to refund. """ - charge: NotRequired["str"] + charge: NotRequired[str] """ ID of the Charge to refund. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - payment_intent: NotRequired["str"] + payment_intent: NotRequired[str] """ ID of the PaymentIntent to refund. """ - refund_application_fee: NotRequired["bool"] + refund_application_fee: NotRequired[bool] """ Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. """ @@ -722,19 +729,19 @@ class RefundPaymentParams(RequestOptions): """ Configuration overrides """ - reverse_transfer: NotRequired["bool"] + reverse_transfer: NotRequired[bool] """ Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge. """ class RefundPaymentParamsRefundPaymentConfig(TypedDict): - enable_customer_cancellation: NotRequired["bool"] + enable_customer_cancellation: NotRequired[bool] """ Enables cancel button on transaction screens. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -744,7 +751,7 @@ class SetReaderDisplayParams(RequestOptions): """ Cart """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -762,7 +769,7 @@ class SetReaderDisplayParamsCart(TypedDict): """ Array of line items that were purchased. """ - tax: NotRequired["int"] + tax: NotRequired[int] """ The amount of tax in cents. """ diff --git a/stripe/terminal/_reader_service.py b/stripe/terminal/_reader_service.py index 819365616..a8c3462b1 100644 --- a/stripe/terminal/_reader_service.py +++ b/stripe/terminal/_reader_service.py @@ -11,13 +11,13 @@ class ReaderService(StripeService): class CancelActionParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class CollectInputsParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -25,7 +25,7 @@ class CollectInputsParams(TypedDict): """ List of inputs to be collected using the Reader """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -35,7 +35,7 @@ class CollectInputsParamsInput(TypedDict): """ Customize the text which will be displayed while collecting this input """ - required: NotRequired["bool"] + required: NotRequired[bool] """ Indicate that this input is required, disabling the skip button """ @@ -51,15 +51,15 @@ class CollectInputsParamsInput(TypedDict): """ class CollectInputsParamsInputCustomText(TypedDict): - description: NotRequired["str"] + description: NotRequired[str] """ The description which will be displayed when collecting this input """ - skip_button: NotRequired["str"] + skip_button: NotRequired[str] """ The skip button text """ - submit_button: NotRequired["str"] + submit_button: NotRequired[str] """ The submit button text """ @@ -75,7 +75,7 @@ class CollectInputsParamsInputSelection(TypedDict): """ class CollectInputsParamsInputSelectionChoice(TypedDict): - style: NotRequired["Literal['primary', 'secondary']"] + style: NotRequired[Literal["primary", "secondary"]] """ The style of the button which will be shown for this choice """ @@ -91,7 +91,7 @@ class CollectPaymentMethodParams(TypedDict): """ Configuration overrides """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -101,11 +101,11 @@ class CollectPaymentMethodParams(TypedDict): """ class CollectPaymentMethodParamsCollectConfig(TypedDict): - enable_customer_cancellation: NotRequired["bool"] + enable_customer_cancellation: NotRequired[bool] """ Enables cancel button on transaction screens. """ - skip_tipping: NotRequired["bool"] + skip_tipping: NotRequired[bool] """ Override showing a tipping selection screen on this transaction. """ @@ -117,13 +117,13 @@ class CollectPaymentMethodParamsCollectConfig(TypedDict): """ class CollectPaymentMethodParamsCollectConfigTipping(TypedDict): - amount_eligible: NotRequired["int"] + amount_eligible: NotRequired[int] """ Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency). """ class ConfirmPaymentIntentParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -133,15 +133,15 @@ class ConfirmPaymentIntentParams(TypedDict): """ class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - label: NotRequired["str"] + label: NotRequired[str] """ Custom label given to the reader for easier identification. If no label is specified, the registration code will be used. """ - location: NotRequired["str"] + location: NotRequired[str] """ The location to assign the reader to. """ @@ -159,42 +159,49 @@ class DeleteParams(TypedDict): class ListParams(TypedDict): device_type: NotRequired[ - "Literal['bbpos_chipper2x', 'bbpos_wisepad3', 'bbpos_wisepos_e', 'simulated_wisepos_e', 'stripe_m2', 'verifone_P400']" + Literal[ + "bbpos_chipper2x", + "bbpos_wisepad3", + "bbpos_wisepos_e", + "simulated_wisepos_e", + "stripe_m2", + "verifone_P400", + ] ] """ Filters readers by device type """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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. """ - location: NotRequired["str"] + location: NotRequired[str] """ A location ID to filter the response list to only readers at the specific location """ - serial_number: NotRequired["str"] + serial_number: NotRequired[str] """ Filters readers by serial number """ - starting_after: NotRequired["str"] + 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. """ - status: NotRequired["Literal['offline', 'online']"] + status: NotRequired[Literal["offline", "online"]] """ A status filter to filter readers to only offline or online readers """ class ProcessPaymentIntentParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -210,11 +217,11 @@ class ProcessPaymentIntentParams(TypedDict): """ class ProcessPaymentIntentParamsProcessConfig(TypedDict): - enable_customer_cancellation: NotRequired["bool"] + enable_customer_cancellation: NotRequired[bool] """ Enables cancel button on transaction screens. """ - skip_tipping: NotRequired["bool"] + skip_tipping: NotRequired[bool] """ Override showing a tipping selection screen on this transaction. """ @@ -226,7 +233,7 @@ class ProcessPaymentIntentParamsProcessConfig(TypedDict): """ class ProcessPaymentIntentParamsProcessConfigTipping(TypedDict): - amount_eligible: NotRequired["int"] + amount_eligible: NotRequired[int] """ Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency). """ @@ -236,7 +243,7 @@ class ProcessSetupIntentParams(TypedDict): """ Customer Consent Collected """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -252,33 +259,33 @@ class ProcessSetupIntentParams(TypedDict): """ class ProcessSetupIntentParamsProcessConfig(TypedDict): - enable_customer_cancellation: NotRequired["bool"] + enable_customer_cancellation: NotRequired[bool] """ Enables cancel button on transaction screens. """ class RefundPaymentParams(TypedDict): - amount: NotRequired["int"] + amount: NotRequired[int] """ A positive integer in __cents__ representing how much of this charge to refund. """ - charge: NotRequired["str"] + charge: NotRequired[str] """ ID of the Charge to refund. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - payment_intent: NotRequired["str"] + payment_intent: NotRequired[str] """ ID of the PaymentIntent to refund. """ - refund_application_fee: NotRequired["bool"] + refund_application_fee: NotRequired[bool] """ Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. """ @@ -288,19 +295,19 @@ class RefundPaymentParams(TypedDict): """ Configuration overrides """ - reverse_transfer: NotRequired["bool"] + reverse_transfer: NotRequired[bool] """ Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge. """ class RefundPaymentParamsRefundPaymentConfig(TypedDict): - enable_customer_cancellation: NotRequired["bool"] + enable_customer_cancellation: NotRequired[bool] """ Enables cancel button on transaction screens. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -310,7 +317,7 @@ class SetReaderDisplayParams(TypedDict): """ Cart """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -328,7 +335,7 @@ class SetReaderDisplayParamsCart(TypedDict): """ Array of line items that were purchased. """ - tax: NotRequired["int"] + tax: NotRequired[int] """ The amount of tax in cents. """ @@ -352,7 +359,7 @@ class SetReaderDisplayParamsCartLineItem(TypedDict): """ class UpdateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/test_helpers/_confirmation_token_service.py b/stripe/test_helpers/_confirmation_token_service.py index 8cd1a687a..23dd29bbc 100644 --- a/stripe/test_helpers/_confirmation_token_service.py +++ b/stripe/test_helpers/_confirmation_token_service.py @@ -9,11 +9,11 @@ class ConfirmationTokenService(StripeService): class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - payment_method: NotRequired["str"] + payment_method: NotRequired[str] """ ID of an existing PaymentMethod. """ @@ -23,11 +23,11 @@ class CreateParams(TypedDict): """ If provided, this hash will be used to create a PaymentMethod. """ - return_url: NotRequired["str"] + return_url: NotRequired[str] """ Return URL used to confirm the Intent. """ - setup_future_usage: NotRequired["Literal['off_session', 'on_session']"] + setup_future_usage: NotRequired[Literal["off_session", "on_session"]] """ Indicates that you intend to make future payments with this ConfirmationToken's payment method. @@ -165,7 +165,7 @@ class CreateParamsPaymentMethodData(TypedDict): """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -353,11 +353,11 @@ class CreateParamsPaymentMethodDataAuBecsDebit(TypedDict): """ class CreateParamsPaymentMethodDataBacsDebit(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account that the funds will be debited from. """ - sort_code: NotRequired["str"] + sort_code: NotRequired[str] """ Sort code of the bank account. (e.g., `10-20-30`) """ @@ -386,27 +386,27 @@ class CreateParamsPaymentMethodDataBillingDetails(TypedDict): """ class CreateParamsPaymentMethodDataBillingDetailsAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ @@ -428,14 +428,43 @@ class CreateParamsPaymentMethodDataCustomerBalance(TypedDict): class CreateParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ - "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" + Literal[ + "arzte_und_apotheker_bank", + "austrian_anadi_bank_ag", + "bank_austria", + "bankhaus_carl_spangler", + "bankhaus_schelhammer_und_schattera_ag", + "bawag_psk_ag", + "bks_bank_ag", + "brull_kallmus_bank_ag", + "btv_vier_lander_bank", + "capital_bank_grawe_gruppe_ag", + "deutsche_bank_ag", + "dolomitenbank", + "easybank_ag", + "erste_bank_und_sparkassen", + "hypo_alpeadriabank_international_ag", + "hypo_bank_burgenland_aktiengesellschaft", + "hypo_noe_lb_fur_niederosterreich_u_wien", + "hypo_oberosterreich_salzburg_steiermark", + "hypo_tirol_bank_ag", + "hypo_vorarlberg_bank_ag", + "marchfelder_bank", + "oberbank_ag", + "raiffeisen_bankengruppe_osterreich", + "schoellerbank_ag", + "sparda_bank_wien", + "volksbank_gruppe", + "volkskreditbank_ag", + "vr_bank_braunau", + ] ] """ The customer's bank. """ class CreateParamsPaymentMethodDataFpx(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type for FPX transaction """ @@ -475,7 +504,24 @@ class CreateParamsPaymentMethodDataGrabpay(TypedDict): class CreateParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ - "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" + Literal[ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe", + ] ] """ The customer's bank. @@ -523,7 +569,34 @@ class CreateParamsPaymentMethodDataOxxo(TypedDict): class CreateParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ - "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'velobank', 'volkswagen_bank']" + Literal[ + "alior_bank", + "bank_millennium", + "bank_nowy_bfg_sa", + "bank_pekao_sa", + "banki_spbdzielcze", + "blik", + "bnp_paribas", + "boz", + "citi_handlowy", + "credit_agricole", + "envelobank", + "etransfer_pocztowy24", + "getin_bank", + "ideabank", + "ing", + "inteligo", + "mbank_mtransfer", + "nest_przelew", + "noble_pay", + "pbac_z_ipko", + "plus_bank", + "santander_przelew24", + "tmobile_usbugi_bankowe", + "toyota_bank", + "velobank", + "volkswagen_bank", + ] ] """ The customer's bank. @@ -536,15 +609,15 @@ class CreateParamsPaymentMethodDataPaypal(TypedDict): pass class CreateParamsPaymentMethodDataPayto(TypedDict): - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The account number for the bank account. """ - bsb_number: NotRequired["str"] + bsb_number: NotRequired[str] """ Bank-State-Branch number of the bank account. """ - pay_id: NotRequired["str"] + pay_id: NotRequired[str] """ The PayID alias for the bank account. """ @@ -556,7 +629,7 @@ class CreateParamsPaymentMethodDataPromptpay(TypedDict): pass class CreateParamsPaymentMethodDataRadarOptions(TypedDict): - session: NotRequired["str"] + session: NotRequired[str] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -583,23 +656,23 @@ class CreateParamsPaymentMethodDataTwint(TypedDict): pass class CreateParamsPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -625,27 +698,27 @@ class CreateParamsShipping(TypedDict): """ class CreateParamsShippingAddress(TypedDict): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ diff --git a/stripe/test_helpers/_customer_service.py b/stripe/test_helpers/_customer_service.py index 8ce3e1248..f9870538b 100644 --- a/stripe/test_helpers/_customer_service.py +++ b/stripe/test_helpers/_customer_service.py @@ -20,11 +20,11 @@ class FundCashBalanceParams(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation algorithm](https://stripe.com/docs/payments/customer-balance/reconciliation) applies to different user inputs. """ diff --git a/stripe/test_helpers/_refund_service.py b/stripe/test_helpers/_refund_service.py index d251679f6..27d0a885f 100644 --- a/stripe/test_helpers/_refund_service.py +++ b/stripe/test_helpers/_refund_service.py @@ -10,7 +10,7 @@ class RefundService(StripeService): class ExpireParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/test_helpers/_test_clock.py b/stripe/test_helpers/_test_clock.py index 79cdd52c0..97996fe29 100644 --- a/stripe/test_helpers/_test_clock.py +++ b/stripe/test_helpers/_test_clock.py @@ -26,7 +26,7 @@ class TestClock( ] = "test_helpers.test_clock" class AdvanceParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -36,7 +36,7 @@ class AdvanceParams(RequestOptions): """ class CreateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -44,7 +44,7 @@ class CreateParams(RequestOptions): """ The initial frozen time for this test clock. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name for this test clock. """ @@ -53,25 +53,25 @@ class DeleteParams(RequestOptions): pass class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/test_helpers/_test_clock_service.py b/stripe/test_helpers/_test_clock_service.py index d4393beb6..72e98b2dd 100644 --- a/stripe/test_helpers/_test_clock_service.py +++ b/stripe/test_helpers/_test_clock_service.py @@ -11,7 +11,7 @@ class TestClockService(StripeService): class AdvanceParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -21,7 +21,7 @@ class AdvanceParams(TypedDict): """ class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -29,7 +29,7 @@ class CreateParams(TypedDict): """ The initial frozen time for this test clock. """ - name: NotRequired["str"] + name: NotRequired[str] """ The name for this test clock. """ @@ -38,25 +38,25 @@ class DeleteParams(TypedDict): pass class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + 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"] + 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 RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/test_helpers/issuing/_authorization_service.py b/stripe/test_helpers/issuing/_authorization_service.py index c5df7ba89..438942ee4 100644 --- a/stripe/test_helpers/issuing/_authorization_service.py +++ b/stripe/test_helpers/issuing/_authorization_service.py @@ -10,15 +10,15 @@ class AuthorizationService(StripeService): class CaptureParams(TypedDict): - capture_amount: NotRequired["int"] + capture_amount: NotRequired[int] """ The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ - close_authorization: NotRequired["bool"] + close_authorization: NotRequired[bool] """ Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -49,101 +49,109 @@ class CaptureParamsPurchaseDetails(TypedDict): Information about lodging that was purchased with this transaction. """ receipt: NotRequired[ - "List[AuthorizationService.CaptureParamsPurchaseDetailsReceipt]" + List["AuthorizationService.CaptureParamsPurchaseDetailsReceipt"] ] """ The line items in the purchase. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A merchant-specific order number. """ class CaptureParamsPurchaseDetailsFlight(TypedDict): - departure_at: NotRequired["int"] + departure_at: NotRequired[int] """ The time that the flight departed. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the passenger. """ - refundable: NotRequired["bool"] + refundable: NotRequired[bool] """ Whether the ticket is refundable. """ segments: NotRequired[ - "List[AuthorizationService.CaptureParamsPurchaseDetailsFlightSegment]" + List[ + "AuthorizationService.CaptureParamsPurchaseDetailsFlightSegment" + ] ] """ The legs of the trip. """ - travel_agency: NotRequired["str"] + travel_agency: NotRequired[str] """ The travel agency that issued the ticket. """ class CaptureParamsPurchaseDetailsFlightSegment(TypedDict): - arrival_airport_code: NotRequired["str"] + arrival_airport_code: NotRequired[str] """ The three-letter IATA airport code of the flight's destination. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The airline carrier code. """ - departure_airport_code: NotRequired["str"] + departure_airport_code: NotRequired[str] """ The three-letter IATA airport code that the flight departed from. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number. """ - service_class: NotRequired["str"] + service_class: NotRequired[str] """ The flight's service class. """ - stopover_allowed: NotRequired["bool"] + stopover_allowed: NotRequired[bool] """ Whether a stopover is allowed on this flight. """ class CaptureParamsPurchaseDetailsFuel(TypedDict): type: NotRequired[ - "Literal['diesel', 'other', 'unleaded_plus', 'unleaded_regular', 'unleaded_super']" + Literal[ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super", + ] ] """ The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. """ - unit: NotRequired["Literal['liter', 'us_gallon']"] + unit: NotRequired[Literal["liter", "us_gallon"]] """ The units for `volume_decimal`. One of `us_gallon` or `liter`. """ - unit_cost_decimal: NotRequired["str"] + unit_cost_decimal: NotRequired[str] """ The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. """ - volume_decimal: NotRequired["str"] + volume_decimal: NotRequired[str] """ The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. """ class CaptureParamsPurchaseDetailsLodging(TypedDict): - check_in_at: NotRequired["int"] + check_in_at: NotRequired[int] """ The time of checking into the lodging. """ - nights: NotRequired["int"] + nights: NotRequired[int] """ The number of nights stayed at the lodging. """ class CaptureParamsPurchaseDetailsReceipt(TypedDict): - description: NotRequired["str"] - quantity: NotRequired["str"] - total: NotRequired["int"] - unit_cost: NotRequired["int"] + description: NotRequired[str] + quantity: NotRequired[str] + total: NotRequired[int] + unit_cost: NotRequired[int] class CreateParams(TypedDict): amount: int @@ -157,7 +165,7 @@ class CreateParams(TypedDict): Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ authorization_method: NotRequired[ - "Literal['chip', 'contactless', 'keyed_in', 'online', 'swipe']" + Literal["chip", "contactless", "keyed_in", "online", "swipe"] ] """ How the card details were provided. Defaults to online. @@ -166,15 +174,15 @@ class CreateParams(TypedDict): """ Card associated with this authorization. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - is_amount_controllable: NotRequired["bool"] + is_amount_controllable: NotRequired[bool] """ If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. """ @@ -196,78 +204,371 @@ class CreateParams(TypedDict): """ Verifications that Stripe performed on information that the cardholder provided to the merchant. """ - wallet: NotRequired[ - "Literal['apple_pay', 'google_pay', 'samsung_pay']" - ] + wallet: NotRequired[Literal["apple_pay", "google_pay", "samsung_pay"]] """ The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. """ class CreateParamsAmountDetails(TypedDict): - atm_fee: NotRequired["int"] + atm_fee: NotRequired[int] """ The ATM withdrawal fee. """ - cashback_amount: NotRequired["int"] + cashback_amount: NotRequired[int] """ The amount of cash requested by the cardholder. """ class CreateParamsMerchantData(TypedDict): category: NotRequired[ - "Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']" + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] ] """ A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. """ - city: NotRequired["str"] + city: NotRequired[str] """ City where the seller is located """ - country: NotRequired["str"] + country: NotRequired[str] """ Country where the seller is located """ - name: NotRequired["str"] + name: NotRequired[str] """ Name of the seller """ - network_id: NotRequired["str"] + network_id: NotRequired[str] """ Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code where the seller is located """ - state: NotRequired["str"] + state: NotRequired[str] """ State where the seller is located """ - terminal_id: NotRequired["str"] + terminal_id: NotRequired[str] """ An ID assigned by the seller to the location of the sale. """ - url: NotRequired["str"] + url: NotRequired[str] """ URL provided by the merchant on a 3DS request """ class CreateParamsNetworkData(TypedDict): - acquiring_institution_id: NotRequired["str"] + acquiring_institution_id: NotRequired[str] """ Identifier assigned to the acquirer by the card network. """ class CreateParamsVerificationData(TypedDict): address_line1_check: NotRequired[ - "Literal['match', 'mismatch', 'not_provided']" + Literal["match", "mismatch", "not_provided"] ] """ Whether the cardholder provided an address first line and if it matched the cardholder's `billing.address.line1`. """ address_postal_code_check: NotRequired[ - "Literal['match', 'mismatch', 'not_provided']" + Literal["match", "mismatch", "not_provided"] ] """ Whether the cardholder provided a postal code and if it matched the cardholder's `billing.address.postal_code`. @@ -278,13 +579,11 @@ class CreateParamsVerificationData(TypedDict): """ The exemption applied to this authorization. """ - cvc_check: NotRequired["Literal['match', 'mismatch', 'not_provided']"] + cvc_check: NotRequired[Literal["match", "mismatch", "not_provided"]] """ Whether the cardholder provided a CVC and if it matched Stripe's record. """ - expiry_check: NotRequired[ - "Literal['match', 'mismatch', 'not_provided']" - ] + expiry_check: NotRequired[Literal["match", "mismatch", "not_provided"]] """ Whether the cardholder provided an expiry date and if it matched Stripe's record. """ @@ -316,13 +615,13 @@ class CreateParamsVerificationDataThreeDSecure(TypedDict): """ class ExpireParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class IncrementParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -330,17 +629,17 @@ class IncrementParams(TypedDict): """ The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ - is_amount_controllable: NotRequired["bool"] + is_amount_controllable: NotRequired[bool] """ If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. """ class ReverseParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - reverse_amount: NotRequired["int"] + reverse_amount: NotRequired[int] """ The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ diff --git a/stripe/test_helpers/issuing/_card_service.py b/stripe/test_helpers/issuing/_card_service.py index edc4437d2..51b742f65 100644 --- a/stripe/test_helpers/issuing/_card_service.py +++ b/stripe/test_helpers/issuing/_card_service.py @@ -10,25 +10,25 @@ class CardService(StripeService): class DeliverCardParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class FailCardParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ReturnCardParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ShipCardParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/test_helpers/issuing/_personalization_design_service.py b/stripe/test_helpers/issuing/_personalization_design_service.py index 8d3aa8a80..18823b094 100644 --- a/stripe/test_helpers/issuing/_personalization_design_service.py +++ b/stripe/test_helpers/issuing/_personalization_design_service.py @@ -10,19 +10,19 @@ class PersonalizationDesignService(StripeService): class ActivateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class DeactivateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RejectParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -33,13 +33,34 @@ class RejectParams(TypedDict): class RejectParamsRejectionReasons(TypedDict): card_logo: NotRequired[ - "List[Literal['geographic_location', 'inappropriate', 'network_name', 'non_binary_image', 'non_fiat_currency', 'other', 'other_entity', 'promotional_material']]" + List[ + Literal[ + "geographic_location", + "inappropriate", + "network_name", + "non_binary_image", + "non_fiat_currency", + "other", + "other_entity", + "promotional_material", + ] + ] ] """ The reason(s) the card logo was rejected. """ carrier_text: NotRequired[ - "List[Literal['geographic_location', 'inappropriate', 'network_name', 'non_fiat_currency', 'other', 'other_entity', 'promotional_material']]" + List[ + Literal[ + "geographic_location", + "inappropriate", + "network_name", + "non_fiat_currency", + "other", + "other_entity", + "promotional_material", + ] + ] ] """ The reason(s) the carrier text was rejected. diff --git a/stripe/test_helpers/issuing/_transaction_service.py b/stripe/test_helpers/issuing/_transaction_service.py index 99f2cddb3..218470270 100644 --- a/stripe/test_helpers/issuing/_transaction_service.py +++ b/stripe/test_helpers/issuing/_transaction_service.py @@ -18,11 +18,11 @@ class CreateForceCaptureParams(TypedDict): """ Card associated with this transaction. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the capture. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -41,40 +41,335 @@ class CreateForceCaptureParams(TypedDict): class CreateForceCaptureParamsMerchantData(TypedDict): category: NotRequired[ - "Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']" + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] ] """ A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. """ - city: NotRequired["str"] + city: NotRequired[str] """ City where the seller is located """ - country: NotRequired["str"] + country: NotRequired[str] """ Country where the seller is located """ - name: NotRequired["str"] + name: NotRequired[str] """ Name of the seller """ - network_id: NotRequired["str"] + network_id: NotRequired[str] """ Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code where the seller is located """ - state: NotRequired["str"] + state: NotRequired[str] """ State where the seller is located """ - terminal_id: NotRequired["str"] + terminal_id: NotRequired[str] """ An ID assigned by the seller to the location of the sale. """ - url: NotRequired["str"] + url: NotRequired[str] """ URL provided by the merchant on a 3DS request """ @@ -99,101 +394,111 @@ class CreateForceCaptureParamsPurchaseDetails(TypedDict): Information about lodging that was purchased with this transaction. """ receipt: NotRequired[ - "List[TransactionService.CreateForceCaptureParamsPurchaseDetailsReceipt]" + List[ + "TransactionService.CreateForceCaptureParamsPurchaseDetailsReceipt" + ] ] """ The line items in the purchase. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A merchant-specific order number. """ class CreateForceCaptureParamsPurchaseDetailsFlight(TypedDict): - departure_at: NotRequired["int"] + departure_at: NotRequired[int] """ The time that the flight departed. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the passenger. """ - refundable: NotRequired["bool"] + refundable: NotRequired[bool] """ Whether the ticket is refundable. """ segments: NotRequired[ - "List[TransactionService.CreateForceCaptureParamsPurchaseDetailsFlightSegment]" + List[ + "TransactionService.CreateForceCaptureParamsPurchaseDetailsFlightSegment" + ] ] """ The legs of the trip. """ - travel_agency: NotRequired["str"] + travel_agency: NotRequired[str] """ The travel agency that issued the ticket. """ class CreateForceCaptureParamsPurchaseDetailsFlightSegment(TypedDict): - arrival_airport_code: NotRequired["str"] + arrival_airport_code: NotRequired[str] """ The three-letter IATA airport code of the flight's destination. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The airline carrier code. """ - departure_airport_code: NotRequired["str"] + departure_airport_code: NotRequired[str] """ The three-letter IATA airport code that the flight departed from. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number. """ - service_class: NotRequired["str"] + service_class: NotRequired[str] """ The flight's service class. """ - stopover_allowed: NotRequired["bool"] + stopover_allowed: NotRequired[bool] """ Whether a stopover is allowed on this flight. """ class CreateForceCaptureParamsPurchaseDetailsFuel(TypedDict): type: NotRequired[ - "Literal['diesel', 'other', 'unleaded_plus', 'unleaded_regular', 'unleaded_super']" + Literal[ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super", + ] ] """ The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. """ - unit: NotRequired["Literal['liter', 'us_gallon']"] + unit: NotRequired[Literal["liter", "us_gallon"]] """ The units for `volume_decimal`. One of `us_gallon` or `liter`. """ - unit_cost_decimal: NotRequired["str"] + unit_cost_decimal: NotRequired[str] """ The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. """ - volume_decimal: NotRequired["str"] + volume_decimal: NotRequired[str] """ The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. """ class CreateForceCaptureParamsPurchaseDetailsLodging(TypedDict): - check_in_at: NotRequired["int"] + check_in_at: NotRequired[int] """ The time of checking into the lodging. """ - nights: NotRequired["int"] + nights: NotRequired[int] """ The number of nights stayed at the lodging. """ class CreateForceCaptureParamsPurchaseDetailsReceipt(TypedDict): - description: NotRequired["str"] - quantity: NotRequired["str"] - total: NotRequired["int"] - unit_cost: NotRequired["int"] + description: NotRequired[str] + quantity: NotRequired[str] + total: NotRequired[int] + unit_cost: NotRequired[int] class CreateUnlinkedRefundParams(TypedDict): amount: int @@ -204,11 +509,11 @@ class CreateUnlinkedRefundParams(TypedDict): """ Card associated with this unlinked refund transaction. """ - currency: NotRequired["str"] + currency: NotRequired[str] """ The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -227,40 +532,335 @@ class CreateUnlinkedRefundParams(TypedDict): class CreateUnlinkedRefundParamsMerchantData(TypedDict): category: NotRequired[ - "Literal['ac_refrigeration_repair', 'accounting_bookkeeping_services', 'advertising_services', 'agricultural_cooperative', 'airlines_air_carriers', 'airports_flying_fields', 'ambulance_services', 'amusement_parks_carnivals', 'antique_reproductions', 'antique_shops', 'aquariums', 'architectural_surveying_services', 'art_dealers_and_galleries', 'artists_supply_and_craft_shops', 'auto_and_home_supply_stores', 'auto_body_repair_shops', 'auto_paint_shops', 'auto_service_shops', 'automated_cash_disburse', 'automated_fuel_dispensers', 'automobile_associations', 'automotive_parts_and_accessories_stores', 'automotive_tire_stores', 'bail_and_bond_payments', 'bakeries', 'bands_orchestras', 'barber_and_beauty_shops', 'betting_casino_gambling', 'bicycle_shops', 'billiard_pool_establishments', 'boat_dealers', 'boat_rentals_and_leases', 'book_stores', 'books_periodicals_and_newspapers', 'bowling_alleys', 'bus_lines', 'business_secretarial_schools', 'buying_shopping_services', 'cable_satellite_and_other_pay_television_and_radio', 'camera_and_photographic_supply_stores', 'candy_nut_and_confectionery_stores', 'car_and_truck_dealers_new_used', 'car_and_truck_dealers_used_only', 'car_rental_agencies', 'car_washes', 'carpentry_services', 'carpet_upholstery_cleaning', 'caterers', 'charitable_and_social_service_organizations_fundraising', 'chemicals_and_allied_products', 'child_care_services', 'childrens_and_infants_wear_stores', 'chiropodists_podiatrists', 'chiropractors', 'cigar_stores_and_stands', 'civic_social_fraternal_associations', 'cleaning_and_maintenance', 'clothing_rental', 'colleges_universities', 'commercial_equipment', 'commercial_footwear', 'commercial_photography_art_and_graphics', 'commuter_transport_and_ferries', 'computer_network_services', 'computer_programming', 'computer_repair', 'computer_software_stores', 'computers_peripherals_and_software', 'concrete_work_services', 'construction_materials', 'consulting_public_relations', 'correspondence_schools', 'cosmetic_stores', 'counseling_services', 'country_clubs', 'courier_services', 'court_costs', 'credit_reporting_agencies', 'cruise_lines', 'dairy_products_stores', 'dance_hall_studios_schools', 'dating_escort_services', 'dentists_orthodontists', 'department_stores', 'detective_agencies', 'digital_goods_applications', 'digital_goods_games', 'digital_goods_large_volume', 'digital_goods_media', 'direct_marketing_catalog_merchant', 'direct_marketing_combination_catalog_and_retail_merchant', 'direct_marketing_inbound_telemarketing', 'direct_marketing_insurance_services', 'direct_marketing_other', 'direct_marketing_outbound_telemarketing', 'direct_marketing_subscription', 'direct_marketing_travel', 'discount_stores', 'doctors', 'door_to_door_sales', 'drapery_window_covering_and_upholstery_stores', 'drinking_places', 'drug_stores_and_pharmacies', 'drugs_drug_proprietaries_and_druggist_sundries', 'dry_cleaners', 'durable_goods', 'duty_free_stores', 'eating_places_restaurants', 'educational_services', 'electric_razor_stores', 'electric_vehicle_charging', 'electrical_parts_and_equipment', 'electrical_services', 'electronics_repair_shops', 'electronics_stores', 'elementary_secondary_schools', 'emergency_services_gcas_visa_use_only', 'employment_temp_agencies', 'equipment_rental', 'exterminating_services', 'family_clothing_stores', 'fast_food_restaurants', 'financial_institutions', 'fines_government_administrative_entities', 'fireplace_fireplace_screens_and_accessories_stores', 'floor_covering_stores', 'florists', 'florists_supplies_nursery_stock_and_flowers', 'freezer_and_locker_meat_provisioners', 'fuel_dealers_non_automotive', 'funeral_services_crematories', 'furniture_home_furnishings_and_equipment_stores_except_appliances', 'furniture_repair_refinishing', 'furriers_and_fur_shops', 'general_services', 'gift_card_novelty_and_souvenir_shops', 'glass_paint_and_wallpaper_stores', 'glassware_crystal_stores', 'golf_courses_public', 'government_licensed_horse_dog_racing_us_region_only', 'government_licensed_online_casions_online_gambling_us_region_only', 'government_owned_lotteries_non_us_region', 'government_owned_lotteries_us_region_only', 'government_services', 'grocery_stores_supermarkets', 'hardware_equipment_and_supplies', 'hardware_stores', 'health_and_beauty_spas', 'hearing_aids_sales_and_supplies', 'heating_plumbing_a_c', 'hobby_toy_and_game_shops', 'home_supply_warehouse_stores', 'hospitals', 'hotels_motels_and_resorts', 'household_appliance_stores', 'industrial_supplies', 'information_retrieval_services', 'insurance_default', 'insurance_underwriting_premiums', 'intra_company_purchases', 'jewelry_stores_watches_clocks_and_silverware_stores', 'landscaping_services', 'laundries', 'laundry_cleaning_services', 'legal_services_attorneys', 'luggage_and_leather_goods_stores', 'lumber_building_materials_stores', 'manual_cash_disburse', 'marinas_service_and_supplies', 'marketplaces', 'masonry_stonework_and_plaster', 'massage_parlors', 'medical_and_dental_labs', 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies', 'medical_services', 'membership_organizations', 'mens_and_boys_clothing_and_accessories_stores', 'mens_womens_clothing_stores', 'metal_service_centers', 'miscellaneous_apparel_and_accessory_shops', 'miscellaneous_auto_dealers', 'miscellaneous_business_services', 'miscellaneous_food_stores', 'miscellaneous_general_merchandise', 'miscellaneous_general_services', 'miscellaneous_home_furnishing_specialty_stores', 'miscellaneous_publishing_and_printing', 'miscellaneous_recreation_services', 'miscellaneous_repair_shops', 'miscellaneous_specialty_retail', 'mobile_home_dealers', 'motion_picture_theaters', 'motor_freight_carriers_and_trucking', 'motor_homes_dealers', 'motor_vehicle_supplies_and_new_parts', 'motorcycle_shops_and_dealers', 'motorcycle_shops_dealers', 'music_stores_musical_instruments_pianos_and_sheet_music', 'news_dealers_and_newsstands', 'non_fi_money_orders', 'non_fi_stored_value_card_purchase_load', 'nondurable_goods', 'nurseries_lawn_and_garden_supply_stores', 'nursing_personal_care', 'office_and_commercial_furniture', 'opticians_eyeglasses', 'optometrists_ophthalmologist', 'orthopedic_goods_prosthetic_devices', 'osteopaths', 'package_stores_beer_wine_and_liquor', 'paints_varnishes_and_supplies', 'parking_lots_garages', 'passenger_railways', 'pawn_shops', 'pet_shops_pet_food_and_supplies', 'petroleum_and_petroleum_products', 'photo_developing', 'photographic_photocopy_microfilm_equipment_and_supplies', 'photographic_studios', 'picture_video_production', 'piece_goods_notions_and_other_dry_goods', 'plumbing_heating_equipment_and_supplies', 'political_organizations', 'postal_services_government_only', 'precious_stones_and_metals_watches_and_jewelry', 'professional_services', 'public_warehousing_and_storage', 'quick_copy_repro_and_blueprint', 'railroads', 'real_estate_agents_and_managers_rentals', 'record_stores', 'recreational_vehicle_rentals', 'religious_goods_stores', 'religious_organizations', 'roofing_siding_sheet_metal', 'secretarial_support_services', 'security_brokers_dealers', 'service_stations', 'sewing_needlework_fabric_and_piece_goods_stores', 'shoe_repair_hat_cleaning', 'shoe_stores', 'small_appliance_repair', 'snowmobile_dealers', 'special_trade_services', 'specialty_cleaning', 'sporting_goods_stores', 'sporting_recreation_camps', 'sports_and_riding_apparel_stores', 'sports_clubs_fields', 'stamp_and_coin_stores', 'stationary_office_supplies_printing_and_writing_paper', 'stationery_stores_office_and_school_supply_stores', 'swimming_pools_sales', 't_ui_travel_germany', 'tailors_alterations', 'tax_payments_government_agencies', 'tax_preparation_services', 'taxicabs_limousines', 'telecommunication_equipment_and_telephone_sales', 'telecommunication_services', 'telegraph_services', 'tent_and_awning_shops', 'testing_laboratories', 'theatrical_ticket_agencies', 'timeshares', 'tire_retreading_and_repair', 'tolls_bridge_fees', 'tourist_attractions_and_exhibits', 'towing_services', 'trailer_parks_campgrounds', 'transportation_services', 'travel_agencies_tour_operators', 'truck_stop_iteration', 'truck_utility_trailer_rentals', 'typesetting_plate_making_and_related_services', 'typewriter_stores', 'u_s_federal_government_agencies_or_departments', 'uniforms_commercial_clothing', 'used_merchandise_and_secondhand_stores', 'utilities', 'variety_stores', 'veterinary_services', 'video_amusement_game_supplies', 'video_game_arcades', 'video_tape_rental_stores', 'vocational_trade_schools', 'watch_jewelry_repair', 'welding_repair', 'wholesale_clubs', 'wig_and_toupee_stores', 'wires_money_orders', 'womens_accessory_and_specialty_shops', 'womens_ready_to_wear_stores', 'wrecking_and_salvage_yards']" + Literal[ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards", + ] ] """ A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. """ - city: NotRequired["str"] + city: NotRequired[str] """ City where the seller is located """ - country: NotRequired["str"] + country: NotRequired[str] """ Country where the seller is located """ - name: NotRequired["str"] + name: NotRequired[str] """ Name of the seller """ - network_id: NotRequired["str"] + network_id: NotRequired[str] """ Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ Postal code where the seller is located """ - state: NotRequired["str"] + state: NotRequired[str] """ State where the seller is located """ - terminal_id: NotRequired["str"] + terminal_id: NotRequired[str] """ An ID assigned by the seller to the location of the sale. """ - url: NotRequired["str"] + url: NotRequired[str] """ URL provided by the merchant on a 3DS request """ @@ -285,108 +885,118 @@ class CreateUnlinkedRefundParamsPurchaseDetails(TypedDict): Information about lodging that was purchased with this transaction. """ receipt: NotRequired[ - "List[TransactionService.CreateUnlinkedRefundParamsPurchaseDetailsReceipt]" + List[ + "TransactionService.CreateUnlinkedRefundParamsPurchaseDetailsReceipt" + ] ] """ The line items in the purchase. """ - reference: NotRequired["str"] + reference: NotRequired[str] """ A merchant-specific order number. """ class CreateUnlinkedRefundParamsPurchaseDetailsFlight(TypedDict): - departure_at: NotRequired["int"] + departure_at: NotRequired[int] """ The time that the flight departed. """ - passenger_name: NotRequired["str"] + passenger_name: NotRequired[str] """ The name of the passenger. """ - refundable: NotRequired["bool"] + refundable: NotRequired[bool] """ Whether the ticket is refundable. """ segments: NotRequired[ - "List[TransactionService.CreateUnlinkedRefundParamsPurchaseDetailsFlightSegment]" + List[ + "TransactionService.CreateUnlinkedRefundParamsPurchaseDetailsFlightSegment" + ] ] """ The legs of the trip. """ - travel_agency: NotRequired["str"] + travel_agency: NotRequired[str] """ The travel agency that issued the ticket. """ class CreateUnlinkedRefundParamsPurchaseDetailsFlightSegment(TypedDict): - arrival_airport_code: NotRequired["str"] + arrival_airport_code: NotRequired[str] """ The three-letter IATA airport code of the flight's destination. """ - carrier: NotRequired["str"] + carrier: NotRequired[str] """ The airline carrier code. """ - departure_airport_code: NotRequired["str"] + departure_airport_code: NotRequired[str] """ The three-letter IATA airport code that the flight departed from. """ - flight_number: NotRequired["str"] + flight_number: NotRequired[str] """ The flight number. """ - service_class: NotRequired["str"] + service_class: NotRequired[str] """ The flight's service class. """ - stopover_allowed: NotRequired["bool"] + stopover_allowed: NotRequired[bool] """ Whether a stopover is allowed on this flight. """ class CreateUnlinkedRefundParamsPurchaseDetailsFuel(TypedDict): type: NotRequired[ - "Literal['diesel', 'other', 'unleaded_plus', 'unleaded_regular', 'unleaded_super']" + Literal[ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super", + ] ] """ The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. """ - unit: NotRequired["Literal['liter', 'us_gallon']"] + unit: NotRequired[Literal["liter", "us_gallon"]] """ The units for `volume_decimal`. One of `us_gallon` or `liter`. """ - unit_cost_decimal: NotRequired["str"] + unit_cost_decimal: NotRequired[str] """ The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. """ - volume_decimal: NotRequired["str"] + volume_decimal: NotRequired[str] """ The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. """ class CreateUnlinkedRefundParamsPurchaseDetailsLodging(TypedDict): - check_in_at: NotRequired["int"] + check_in_at: NotRequired[int] """ The time of checking into the lodging. """ - nights: NotRequired["int"] + nights: NotRequired[int] """ The number of nights stayed at the lodging. """ class CreateUnlinkedRefundParamsPurchaseDetailsReceipt(TypedDict): - description: NotRequired["str"] - quantity: NotRequired["str"] - total: NotRequired["int"] - unit_cost: NotRequired["int"] + description: NotRequired[str] + quantity: NotRequired[str] + total: NotRequired[int] + unit_cost: NotRequired[int] class RefundParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - refund_amount: NotRequired["int"] + refund_amount: NotRequired[int] """ The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ diff --git a/stripe/test_helpers/terminal/_reader_service.py b/stripe/test_helpers/terminal/_reader_service.py index 286e94b91..04c64468a 100644 --- a/stripe/test_helpers/terminal/_reader_service.py +++ b/stripe/test_helpers/terminal/_reader_service.py @@ -10,7 +10,7 @@ class ReaderService(StripeService): class PresentPaymentMethodParams(TypedDict): - amount_tip: NotRequired["int"] + amount_tip: NotRequired[int] """ Simulated on-reader tip amount. """ @@ -20,7 +20,7 @@ class PresentPaymentMethodParams(TypedDict): """ Simulated data for the card_present payment method. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -30,19 +30,19 @@ class PresentPaymentMethodParams(TypedDict): """ Simulated data for the interac_present payment method. """ - type: NotRequired["Literal['card_present', 'interac_present']"] + type: NotRequired[Literal["card_present", "interac_present"]] """ Simulated payment type. """ class PresentPaymentMethodParamsCardPresent(TypedDict): - number: NotRequired["str"] + number: NotRequired[str] """ The card number, as a string without any separators. """ class PresentPaymentMethodParamsInteracPresent(TypedDict): - number: NotRequired["str"] + number: NotRequired[str] """ Card Number """ diff --git a/stripe/test_helpers/treasury/_inbound_transfer_service.py b/stripe/test_helpers/treasury/_inbound_transfer_service.py index f8f4f6b5d..16b16359d 100644 --- a/stripe/test_helpers/treasury/_inbound_transfer_service.py +++ b/stripe/test_helpers/treasury/_inbound_transfer_service.py @@ -10,7 +10,7 @@ class InboundTransferService(StripeService): class FailParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -23,20 +23,34 @@ class FailParams(TypedDict): class FailParamsFailureDetails(TypedDict): code: NotRequired[ - "Literal['account_closed', 'account_frozen', 'bank_account_restricted', 'bank_ownership_changed', 'debit_not_authorized', 'incorrect_account_holder_address', 'incorrect_account_holder_name', 'incorrect_account_holder_tax_id', 'insufficient_funds', 'invalid_account_number', 'invalid_currency', 'no_account', 'other']" + Literal[ + "account_closed", + "account_frozen", + "bank_account_restricted", + "bank_ownership_changed", + "debit_not_authorized", + "incorrect_account_holder_address", + "incorrect_account_holder_name", + "incorrect_account_holder_tax_id", + "insufficient_funds", + "invalid_account_number", + "invalid_currency", + "no_account", + "other", + ] ] """ Reason for the failure. """ class ReturnInboundTransferParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SucceedParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/test_helpers/treasury/_outbound_payment_service.py b/stripe/test_helpers/treasury/_outbound_payment_service.py index d148082fe..2506837af 100644 --- a/stripe/test_helpers/treasury/_outbound_payment_service.py +++ b/stripe/test_helpers/treasury/_outbound_payment_service.py @@ -10,19 +10,19 @@ class OutboundPaymentService(StripeService): class FailParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class PostParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ReturnOutboundPaymentParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -35,7 +35,18 @@ class ReturnOutboundPaymentParams(TypedDict): class ReturnOutboundPaymentParamsReturnedDetails(TypedDict): code: NotRequired[ - "Literal['account_closed', 'account_frozen', 'bank_account_restricted', 'bank_ownership_changed', 'declined', 'incorrect_account_holder_name', 'invalid_account_number', 'invalid_currency', 'no_account', 'other']" + Literal[ + "account_closed", + "account_frozen", + "bank_account_restricted", + "bank_ownership_changed", + "declined", + "incorrect_account_holder_name", + "invalid_account_number", + "invalid_currency", + "no_account", + "other", + ] ] """ The return code to be set on the OutboundPayment object. diff --git a/stripe/test_helpers/treasury/_outbound_transfer_service.py b/stripe/test_helpers/treasury/_outbound_transfer_service.py index 0e3cb7617..a16ae3792 100644 --- a/stripe/test_helpers/treasury/_outbound_transfer_service.py +++ b/stripe/test_helpers/treasury/_outbound_transfer_service.py @@ -10,19 +10,19 @@ class OutboundTransferService(StripeService): class FailParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class PostParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ReturnOutboundTransferParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -35,7 +35,18 @@ class ReturnOutboundTransferParams(TypedDict): class ReturnOutboundTransferParamsReturnedDetails(TypedDict): code: NotRequired[ - "Literal['account_closed', 'account_frozen', 'bank_account_restricted', 'bank_ownership_changed', 'declined', 'incorrect_account_holder_name', 'invalid_account_number', 'invalid_currency', 'no_account', 'other']" + Literal[ + "account_closed", + "account_frozen", + "bank_account_restricted", + "bank_ownership_changed", + "declined", + "incorrect_account_holder_name", + "invalid_account_number", + "invalid_currency", + "no_account", + "other", + ] ] """ Reason for the return. diff --git a/stripe/test_helpers/treasury/_received_credit_service.py b/stripe/test_helpers/treasury/_received_credit_service.py index 96e247453..e55e48e9b 100644 --- a/stripe/test_helpers/treasury/_received_credit_service.py +++ b/stripe/test_helpers/treasury/_received_credit_service.py @@ -17,11 +17,11 @@ class CreateParams(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -59,15 +59,15 @@ class CreateParamsInitiatingPaymentMethodDetails(TypedDict): """ class CreateParamsInitiatingPaymentMethodDetailsUsBankAccount(TypedDict): - account_holder_name: NotRequired["str"] + account_holder_name: NotRequired[str] """ The bank account holder's name. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The bank account number. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ The bank account's routing number. """ @@ -83,7 +83,7 @@ class CreateParamsNetworkDetails(TypedDict): """ class CreateParamsNetworkDetailsAch(TypedDict): - addenda: NotRequired["str"] + addenda: NotRequired[str] """ ACH Addenda record """ diff --git a/stripe/test_helpers/treasury/_received_debit_service.py b/stripe/test_helpers/treasury/_received_debit_service.py index eb714dffd..dff1db468 100644 --- a/stripe/test_helpers/treasury/_received_debit_service.py +++ b/stripe/test_helpers/treasury/_received_debit_service.py @@ -17,11 +17,11 @@ class CreateParams(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -59,15 +59,15 @@ class CreateParamsInitiatingPaymentMethodDetails(TypedDict): """ class CreateParamsInitiatingPaymentMethodDetailsUsBankAccount(TypedDict): - account_holder_name: NotRequired["str"] + account_holder_name: NotRequired[str] """ The bank account holder's name. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The bank account number. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ The bank account's routing number. """ @@ -83,7 +83,7 @@ class CreateParamsNetworkDetails(TypedDict): """ class CreateParamsNetworkDetailsAch(TypedDict): - addenda: NotRequired["str"] + addenda: NotRequired[str] """ Addenda record data associated with this ReceivedDebit. """ diff --git a/stripe/treasury/_credit_reversal.py b/stripe/treasury/_credit_reversal.py index 025ff7948..1318c3d53 100644 --- a/stripe/treasury/_credit_reversal.py +++ b/stripe/treasury/_credit_reversal.py @@ -32,11 +32,11 @@ class StatusTransitions(StripeObject): """ class CreateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -46,11 +46,11 @@ class CreateParams(RequestOptions): """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -58,25 +58,25 @@ class ListParams(RequestOptions): """ Returns objects associated with this FinancialAccount. """ - limit: NotRequired["int"] + 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. """ - received_credit: NotRequired["str"] + received_credit: NotRequired[str] """ Only return CreditReversals for the ReceivedCredit ID. """ - starting_after: NotRequired["str"] + 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. """ - status: NotRequired["Literal['canceled', 'posted', 'processing']"] + status: NotRequired[Literal["canceled", "posted", "processing"]] """ Only return CreditReversals for a given status. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_credit_reversal_service.py b/stripe/treasury/_credit_reversal_service.py index 2f59302a9..3ae920b0f 100644 --- a/stripe/treasury/_credit_reversal_service.py +++ b/stripe/treasury/_credit_reversal_service.py @@ -11,11 +11,11 @@ class CreditReversalService(StripeService): class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -25,11 +25,11 @@ class CreateParams(TypedDict): """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -37,25 +37,25 @@ class ListParams(TypedDict): """ Returns objects associated with this FinancialAccount. """ - limit: NotRequired["int"] + 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. """ - received_credit: NotRequired["str"] + received_credit: NotRequired[str] """ Only return CreditReversals for the ReceivedCredit ID. """ - starting_after: NotRequired["str"] + 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. """ - status: NotRequired["Literal['canceled', 'posted', 'processing']"] + status: NotRequired[Literal["canceled", "posted", "processing"]] """ Only return CreditReversals for a given status. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_debit_reversal.py b/stripe/treasury/_debit_reversal.py index 627c7eec9..6c1ec1c0c 100644 --- a/stripe/treasury/_debit_reversal.py +++ b/stripe/treasury/_debit_reversal.py @@ -38,11 +38,11 @@ class StatusTransitions(StripeObject): """ class CreateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -52,11 +52,11 @@ class CreateParams(RequestOptions): """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -64,29 +64,29 @@ class ListParams(RequestOptions): """ Returns objects associated with this FinancialAccount. """ - limit: NotRequired["int"] + 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. """ - received_debit: NotRequired["str"] + received_debit: NotRequired[str] """ Only return DebitReversals for the ReceivedDebit ID. """ - resolution: NotRequired["Literal['lost', 'won']"] + resolution: NotRequired[Literal["lost", "won"]] """ Only return DebitReversals for a given resolution. """ - starting_after: NotRequired["str"] + 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. """ - status: NotRequired["Literal['canceled', 'completed', 'processing']"] + status: NotRequired[Literal["canceled", "completed", "processing"]] """ Only return DebitReversals for a given status. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_debit_reversal_service.py b/stripe/treasury/_debit_reversal_service.py index 2d1c6db52..b8f54471b 100644 --- a/stripe/treasury/_debit_reversal_service.py +++ b/stripe/treasury/_debit_reversal_service.py @@ -11,11 +11,11 @@ class DebitReversalService(StripeService): class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -25,11 +25,11 @@ class CreateParams(TypedDict): """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -37,29 +37,29 @@ class ListParams(TypedDict): """ Returns objects associated with this FinancialAccount. """ - limit: NotRequired["int"] + 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. """ - received_debit: NotRequired["str"] + received_debit: NotRequired[str] """ Only return DebitReversals for the ReceivedDebit ID. """ - resolution: NotRequired["Literal['lost', 'won']"] + resolution: NotRequired[Literal["lost", "won"]] """ Only return DebitReversals for a given resolution. """ - starting_after: NotRequired["str"] + 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. """ - status: NotRequired["Literal['canceled', 'completed', 'processing']"] + status: NotRequired[Literal["canceled", "completed", "processing"]] """ Only return DebitReversals for a given status. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_financial_account.py b/stripe/treasury/_financial_account.py index 13ae6a330..3cbd88346 100644 --- a/stripe/treasury/_financial_account.py +++ b/stripe/treasury/_financial_account.py @@ -113,7 +113,7 @@ class Closed(StripeObject): _inner_class_types = {"closed": Closed} class CreateParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -121,7 +121,7 @@ class CreateParams(RequestOptions): """ Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -279,11 +279,11 @@ class CreateParamsFeaturesOutboundTransfersUsDomesticWire(TypedDict): """ class CreateParamsPlatformRestrictions(TypedDict): - inbound_flows: NotRequired["Literal['restricted', 'unrestricted']"] + inbound_flows: NotRequired[Literal["restricted", "unrestricted"]] """ Restricts all inbound money movement. """ - outbound_flows: NotRequired["Literal['restricted', 'unrestricted']"] + outbound_flows: NotRequired[Literal["restricted", "unrestricted"]] """ Restricts all outbound money movement. """ @@ -293,43 +293,43 @@ class ListParams(RequestOptions): """ Only return FinancialAccounts that were created during the given date interval. """ - ending_before: NotRequired["str"] + ending_before: NotRequired[str] """ An object ID cursor for use in pagination. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + limit: NotRequired[int] """ A limit ranging from 1 to 100 (defaults to 10). """ - starting_after: NotRequired["str"] + starting_after: NotRequired[str] """ An object ID cursor for use in pagination. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -337,7 +337,7 @@ class ModifyParams(RequestOptions): """ Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated `status_details`. Stripe or the platform may control features via the requested field. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -491,23 +491,23 @@ class ModifyParamsFeaturesOutboundTransfersUsDomesticWire(TypedDict): """ class ModifyParamsPlatformRestrictions(TypedDict): - inbound_flows: NotRequired["Literal['restricted', 'unrestricted']"] + inbound_flows: NotRequired[Literal["restricted", "unrestricted"]] """ Restricts all inbound money movement. """ - outbound_flows: NotRequired["Literal['restricted', 'unrestricted']"] + outbound_flows: NotRequired[Literal["restricted", "unrestricted"]] """ Restricts all outbound money movement. """ class RetrieveFeaturesParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -525,7 +525,7 @@ class UpdateFeaturesParams(RequestOptions): """ Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_financial_account_features_service.py b/stripe/treasury/_financial_account_features_service.py index cd216d8c4..85f555ac3 100644 --- a/stripe/treasury/_financial_account_features_service.py +++ b/stripe/treasury/_financial_account_features_service.py @@ -24,7 +24,7 @@ class CreateParams(TypedDict): """ Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -158,13 +158,13 @@ class CreateParamsOutboundTransfersUsDomesticWire(TypedDict): """ class ListParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -182,7 +182,7 @@ class UpdateParams(TypedDict): """ Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_financial_account_service.py b/stripe/treasury/_financial_account_service.py index b8802137d..c61f2e46e 100644 --- a/stripe/treasury/_financial_account_service.py +++ b/stripe/treasury/_financial_account_service.py @@ -18,7 +18,7 @@ def __init__(self, requestor): self.features = FinancialAccountFeaturesService(self._requestor) class CreateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -26,7 +26,7 @@ class CreateParams(TypedDict): """ Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -184,11 +184,11 @@ class CreateParamsFeaturesOutboundTransfersUsDomesticWire(TypedDict): """ class CreateParamsPlatformRestrictions(TypedDict): - inbound_flows: NotRequired["Literal['restricted', 'unrestricted']"] + inbound_flows: NotRequired[Literal["restricted", "unrestricted"]] """ Restricts all inbound money movement. """ - outbound_flows: NotRequired["Literal['restricted', 'unrestricted']"] + outbound_flows: NotRequired[Literal["restricted", "unrestricted"]] """ Restricts all outbound money movement. """ @@ -198,49 +198,49 @@ class ListParams(TypedDict): """ Only return FinancialAccounts that were created during the given date interval. """ - ending_before: NotRequired["str"] + ending_before: NotRequired[str] """ An object ID cursor for use in pagination. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ - limit: NotRequired["int"] + limit: NotRequired[int] """ A limit ranging from 1 to 100 (defaults to 10). """ - starting_after: NotRequired["str"] + starting_after: NotRequired[str] """ An object ID cursor for use in pagination. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class UpdateParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -248,7 +248,7 @@ class UpdateParams(TypedDict): """ Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated `status_details`. Stripe or the platform may control features via the requested field. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -402,11 +402,11 @@ class UpdateParamsFeaturesOutboundTransfersUsDomesticWire(TypedDict): """ class UpdateParamsPlatformRestrictions(TypedDict): - inbound_flows: NotRequired["Literal['restricted', 'unrestricted']"] + inbound_flows: NotRequired[Literal["restricted", "unrestricted"]] """ Restricts all inbound money movement. """ - outbound_flows: NotRequired["Literal['restricted', 'unrestricted']"] + outbound_flows: NotRequired[Literal["restricted", "unrestricted"]] """ Restricts all outbound money movement. """ diff --git a/stripe/treasury/_inbound_transfer.py b/stripe/treasury/_inbound_transfer.py index c549fc651..ec921ddac 100644 --- a/stripe/treasury/_inbound_transfer.py +++ b/stripe/treasury/_inbound_transfer.py @@ -19,6 +19,7 @@ ) if TYPE_CHECKING: + from stripe._mandate import Mandate from stripe.treasury._transaction import Transaction @@ -120,6 +121,10 @@ class UsBankAccount(StripeObject): """ Last four digits of the bank account number. """ + mandate: Optional[ExpandableField["Mandate"]] + """ + ID of the mandate used to make this payment. + """ network: Literal["ach"] """ The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. @@ -155,7 +160,7 @@ class StatusTransitions(StripeObject): """ class CancelParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -169,11 +174,11 @@ class CreateParams(RequestOptions): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -181,7 +186,7 @@ class CreateParams(RequestOptions): """ The FinancialAccount to send funds to. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -189,13 +194,13 @@ class CreateParams(RequestOptions): """ The origin payment method to be debited for the InboundTransfer. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ The complete description that appears on your customers' statements. Maximum 10 characters. """ class FailParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -208,18 +213,32 @@ class FailParams(RequestOptions): class FailParamsFailureDetails(TypedDict): code: NotRequired[ - "Literal['account_closed', 'account_frozen', 'bank_account_restricted', 'bank_ownership_changed', 'debit_not_authorized', 'incorrect_account_holder_address', 'incorrect_account_holder_name', 'incorrect_account_holder_tax_id', 'insufficient_funds', 'invalid_account_number', 'invalid_currency', 'no_account', 'other']" + Literal[ + "account_closed", + "account_frozen", + "bank_account_restricted", + "bank_ownership_changed", + "debit_not_authorized", + "incorrect_account_holder_address", + "incorrect_account_holder_name", + "incorrect_account_holder_tax_id", + "insufficient_funds", + "invalid_account_number", + "invalid_currency", + "no_account", + "other", + ] ] """ Reason for the failure. """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -227,35 +246,35 @@ class ListParams(RequestOptions): """ Returns objects associated with this FinancialAccount. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['canceled', 'failed', 'processing', 'succeeded']" + Literal["canceled", "failed", "processing", "succeeded"] ] """ Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ReturnInboundTransferParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class SucceedParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_inbound_transfer_service.py b/stripe/treasury/_inbound_transfer_service.py index e6f961a16..40c7114b3 100644 --- a/stripe/treasury/_inbound_transfer_service.py +++ b/stripe/treasury/_inbound_transfer_service.py @@ -11,7 +11,7 @@ class InboundTransferService(StripeService): class CancelParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -25,11 +25,11 @@ class CreateParams(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -37,7 +37,7 @@ class CreateParams(TypedDict): """ The FinancialAccount to send funds to. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -45,17 +45,17 @@ class CreateParams(TypedDict): """ The origin payment method to be debited for the InboundTransfer. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ The complete description that appears on your customers' statements. Maximum 10 characters. """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -63,23 +63,23 @@ class ListParams(TypedDict): """ Returns objects associated with this FinancialAccount. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['canceled', 'failed', 'processing', 'succeeded']" + Literal["canceled", "failed", "processing", "succeeded"] ] """ Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_outbound_payment.py b/stripe/treasury/_outbound_payment.py index 6de6e42af..c843c9866 100644 --- a/stripe/treasury/_outbound_payment.py +++ b/stripe/treasury/_outbound_payment.py @@ -19,6 +19,7 @@ ) if TYPE_CHECKING: + from stripe._mandate import Mandate from stripe.treasury._transaction import Transaction @@ -106,6 +107,10 @@ class UsBankAccount(StripeObject): """ Last four digits of the bank account number. """ + mandate: Optional[ExpandableField["Mandate"]] + """ + ID of the mandate used to make this payment. + """ network: Literal["ach", "us_domestic_wire"] """ The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. @@ -178,7 +183,7 @@ class StatusTransitions(StripeObject): """ class CancelParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -192,15 +197,15 @@ class CreateParams(RequestOptions): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - destination_payment_method: NotRequired["str"] + destination_payment_method: NotRequired[str] """ The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with `destination_payment_method_data`. """ @@ -222,7 +227,7 @@ class CreateParams(RequestOptions): """ End user details. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -230,11 +235,11 @@ class CreateParams(RequestOptions): """ The FinancialAccount to pull funds from. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. The default value is "payment". """ @@ -246,11 +251,11 @@ class CreateParamsDestinationPaymentMethodData(TypedDict): """ Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. """ - financial_account: NotRequired["str"] + financial_account: NotRequired[str] """ Required if type is set to `financial_account`. The FinancialAccount ID to send funds to. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -288,49 +293,49 @@ class CreateParamsDestinationPaymentMethodDataBillingDetails(TypedDict): class CreateParamsDestinationPaymentMethodDataBillingDetailsAddress( TypedDict, ): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsDestinationPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -344,13 +349,13 @@ class CreateParamsDestinationPaymentMethodOptions(TypedDict): """ class CreateParamsDestinationPaymentMethodOptionsUsBankAccount(TypedDict): - network: NotRequired["Literal['ach', 'us_domestic_wire']"] + network: NotRequired[Literal["ach", "us_domestic_wire"]] """ Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. """ class CreateParamsEndUserDetails(TypedDict): - ip_address: NotRequired["str"] + ip_address: NotRequired[str] """ IP address of the user initiating the OutboundPayment. Must be supplied if `present` is set to `true`. """ @@ -360,7 +365,7 @@ class CreateParamsEndUserDetails(TypedDict): """ class FailParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -370,15 +375,15 @@ class ListParams(RequestOptions): """ Only return OutboundPayments that were created during the given date interval. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return OutboundPayments sent to this customer. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -386,53 +391,53 @@ class ListParams(RequestOptions): """ Returns objects associated with this FinancialAccount. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['canceled', 'failed', 'posted', 'processing', 'returned']" + Literal["canceled", "failed", "posted", "processing", "returned"] ] """ Only return OutboundPayments that have the given status: `processing`, `failed`, `posted`, `returned`, or `canceled`. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class PostParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ReturnOutboundPaymentParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -445,7 +450,18 @@ class ReturnOutboundPaymentParams(RequestOptions): class ReturnOutboundPaymentParamsReturnedDetails(TypedDict): code: NotRequired[ - "Literal['account_closed', 'account_frozen', 'bank_account_restricted', 'bank_ownership_changed', 'declined', 'incorrect_account_holder_name', 'invalid_account_number', 'invalid_currency', 'no_account', 'other']" + Literal[ + "account_closed", + "account_frozen", + "bank_account_restricted", + "bank_ownership_changed", + "declined", + "incorrect_account_holder_name", + "invalid_account_number", + "invalid_currency", + "no_account", + "other", + ] ] """ The return code to be set on the OutboundPayment object. diff --git a/stripe/treasury/_outbound_payment_service.py b/stripe/treasury/_outbound_payment_service.py index ec809043c..2a22eb7e2 100644 --- a/stripe/treasury/_outbound_payment_service.py +++ b/stripe/treasury/_outbound_payment_service.py @@ -11,7 +11,7 @@ class OutboundPaymentService(StripeService): class CancelParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -25,15 +25,15 @@ class CreateParams(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - customer: NotRequired["str"] + customer: NotRequired[str] """ ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in. """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - destination_payment_method: NotRequired["str"] + destination_payment_method: NotRequired[str] """ The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with `destination_payment_method_data`. """ @@ -55,7 +55,7 @@ class CreateParams(TypedDict): """ End user details. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -63,11 +63,11 @@ class CreateParams(TypedDict): """ The FinancialAccount to pull funds from. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. The default value is "payment". """ @@ -79,11 +79,11 @@ class CreateParamsDestinationPaymentMethodData(TypedDict): """ Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. """ - financial_account: NotRequired["str"] + financial_account: NotRequired[str] """ Required if type is set to `financial_account`. The FinancialAccount ID to send funds to. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -121,49 +121,49 @@ class CreateParamsDestinationPaymentMethodDataBillingDetails(TypedDict): class CreateParamsDestinationPaymentMethodDataBillingDetailsAddress( TypedDict, ): - city: NotRequired["str"] + city: NotRequired[str] """ City, district, suburb, town, or village. """ - country: NotRequired["str"] + 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"] + line1: NotRequired[str] """ Address line 1 (e.g., street, PO Box, or company name). """ - line2: NotRequired["str"] + line2: NotRequired[str] """ Address line 2 (e.g., apartment, suite, unit, or building). """ - postal_code: NotRequired["str"] + postal_code: NotRequired[str] """ ZIP or postal code. """ - state: NotRequired["str"] + state: NotRequired[str] """ State, county, province, or region. """ class CreateParamsDestinationPaymentMethodDataUsBankAccount(TypedDict): - account_holder_type: NotRequired["Literal['company', 'individual']"] + account_holder_type: NotRequired[Literal["company", "individual"]] """ Account holder type: individual or company. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ Account number of the bank account. """ - account_type: NotRequired["Literal['checking', 'savings']"] + account_type: NotRequired[Literal["checking", "savings"]] """ Account type: checkings or savings. Defaults to checking if omitted. """ - financial_connections_account: NotRequired["str"] + financial_connections_account: NotRequired[str] """ The ID of a Financial Connections Account to use as a payment method. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ Routing number of the bank account. """ @@ -177,13 +177,13 @@ class CreateParamsDestinationPaymentMethodOptions(TypedDict): """ class CreateParamsDestinationPaymentMethodOptionsUsBankAccount(TypedDict): - network: NotRequired["Literal['ach', 'us_domestic_wire']"] + network: NotRequired[Literal["ach", "us_domestic_wire"]] """ Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. """ class CreateParamsEndUserDetails(TypedDict): - ip_address: NotRequired["str"] + ip_address: NotRequired[str] """ IP address of the user initiating the OutboundPayment. Must be supplied if `present` is set to `true`. """ @@ -197,15 +197,15 @@ class ListParams(TypedDict): """ Only return OutboundPayments that were created during the given date interval. """ - customer: NotRequired["str"] + customer: NotRequired[str] """ Only return OutboundPayments sent to this customer. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -213,41 +213,41 @@ class ListParams(TypedDict): """ Returns objects associated with this FinancialAccount. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['canceled', 'failed', 'posted', 'processing', 'returned']" + Literal["canceled", "failed", "posted", "processing", "returned"] ] """ Only return OutboundPayments that have the given status: `processing`, `failed`, `posted`, `returned`, or `canceled`. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_outbound_transfer.py b/stripe/treasury/_outbound_transfer.py index c142f9d8f..63456eea7 100644 --- a/stripe/treasury/_outbound_transfer.py +++ b/stripe/treasury/_outbound_transfer.py @@ -19,6 +19,7 @@ ) if TYPE_CHECKING: + from stripe._mandate import Mandate from stripe.treasury._transaction import Transaction @@ -96,6 +97,10 @@ class UsBankAccount(StripeObject): """ Last four digits of the bank account number. """ + mandate: Optional[ExpandableField["Mandate"]] + """ + ID of the mandate used to make this payment. + """ network: Literal["ach", "us_domestic_wire"] """ The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. @@ -173,7 +178,7 @@ class StatusTransitions(StripeObject): """ class CancelParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -187,11 +192,11 @@ class CreateParams(RequestOptions): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - destination_payment_method: NotRequired["str"] + destination_payment_method: NotRequired[str] """ The PaymentMethod to use as the payment instrument for the OutboundTransfer. """ @@ -201,7 +206,7 @@ class CreateParams(RequestOptions): """ Hash describing payment method configuration details. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -209,7 +214,7 @@ class CreateParams(RequestOptions): """ The FinancialAccount to pull funds from. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -219,7 +224,7 @@ class CreateParams(RequestOptions): """ Details about the network used for the OutboundTransfer. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer". """ @@ -233,7 +238,7 @@ class CreateParamsDestinationPaymentMethodOptions(TypedDict): """ class CreateParamsDestinationPaymentMethodOptionsUsBankAccount(TypedDict): - network: NotRequired["Literal['ach', 'us_domestic_wire']"] + network: NotRequired[Literal["ach", "us_domestic_wire"]] """ Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. """ @@ -249,23 +254,23 @@ class CreateParamsNetworkDetails(TypedDict): """ class CreateParamsNetworkDetailsAch(TypedDict): - addenda: NotRequired["str"] + addenda: NotRequired[str] """ Addenda record data associated with this OutboundTransfer. """ class FailParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -273,35 +278,35 @@ class ListParams(RequestOptions): """ Returns objects associated with this FinancialAccount. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['canceled', 'failed', 'posted', 'processing', 'returned']" + Literal["canceled", "failed", "posted", "processing", "returned"] ] """ Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`. """ class PostParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ class ReturnOutboundTransferParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -314,7 +319,18 @@ class ReturnOutboundTransferParams(RequestOptions): class ReturnOutboundTransferParamsReturnedDetails(TypedDict): code: NotRequired[ - "Literal['account_closed', 'account_frozen', 'bank_account_restricted', 'bank_ownership_changed', 'declined', 'incorrect_account_holder_name', 'invalid_account_number', 'invalid_currency', 'no_account', 'other']" + Literal[ + "account_closed", + "account_frozen", + "bank_account_restricted", + "bank_ownership_changed", + "declined", + "incorrect_account_holder_name", + "invalid_account_number", + "invalid_currency", + "no_account", + "other", + ] ] """ Reason for the return. diff --git a/stripe/treasury/_outbound_transfer_service.py b/stripe/treasury/_outbound_transfer_service.py index 93c04205a..073d6458c 100644 --- a/stripe/treasury/_outbound_transfer_service.py +++ b/stripe/treasury/_outbound_transfer_service.py @@ -11,7 +11,7 @@ class OutboundTransferService(StripeService): class CancelParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -25,11 +25,11 @@ class CreateParams(TypedDict): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - destination_payment_method: NotRequired["str"] + destination_payment_method: NotRequired[str] """ The PaymentMethod to use as the payment instrument for the OutboundTransfer. """ @@ -39,7 +39,7 @@ class CreateParams(TypedDict): """ Hash describing payment method configuration details. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -47,7 +47,7 @@ class CreateParams(TypedDict): """ The FinancialAccount to pull funds from. """ - metadata: NotRequired["Dict[str, str]"] + 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`. """ @@ -57,7 +57,7 @@ class CreateParams(TypedDict): """ Details about the network used for the OutboundTransfer. """ - statement_descriptor: NotRequired["str"] + statement_descriptor: NotRequired[str] """ Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer". """ @@ -71,7 +71,7 @@ class CreateParamsDestinationPaymentMethodOptions(TypedDict): """ class CreateParamsDestinationPaymentMethodOptionsUsBankAccount(TypedDict): - network: NotRequired["Literal['ach', 'us_domestic_wire']"] + network: NotRequired[Literal["ach", "us_domestic_wire"]] """ Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. """ @@ -89,17 +89,17 @@ class CreateParamsNetworkDetails(TypedDict): """ class CreateParamsNetworkDetailsAch(TypedDict): - addenda: NotRequired["str"] + addenda: NotRequired[str] """ Addenda record data associated with this OutboundTransfer. """ class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -107,23 +107,23 @@ class ListParams(TypedDict): """ Returns objects associated with this FinancialAccount. """ - limit: NotRequired["int"] + 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"] + 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. """ status: NotRequired[ - "Literal['canceled', 'failed', 'posted', 'processing', 'returned']" + Literal["canceled", "failed", "posted", "processing", "returned"] ] """ Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_received_credit.py b/stripe/treasury/_received_credit.py index b072092da..9a8d3d177 100644 --- a/stripe/treasury/_received_credit.py +++ b/stripe/treasury/_received_credit.py @@ -222,11 +222,11 @@ class CreateParams(RequestOptions): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -264,15 +264,15 @@ class CreateParamsInitiatingPaymentMethodDetails(TypedDict): """ class CreateParamsInitiatingPaymentMethodDetailsUsBankAccount(TypedDict): - account_holder_name: NotRequired["str"] + account_holder_name: NotRequired[str] """ The bank account holder's name. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The bank account number. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ The bank account's routing number. """ @@ -288,17 +288,17 @@ class CreateParamsNetworkDetails(TypedDict): """ class CreateParamsNetworkDetailsAch(TypedDict): - addenda: NotRequired["str"] + addenda: NotRequired[str] """ ACH Addenda record """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -306,7 +306,7 @@ class ListParams(RequestOptions): """ The FinancialAccount that received the funds. """ - limit: NotRequired["int"] + 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. """ @@ -314,11 +314,11 @@ class ListParams(RequestOptions): """ Only return ReceivedCredits described by the flow. """ - starting_after: NotRequired["str"] + 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. """ - status: NotRequired["Literal['failed', 'succeeded']"] + status: NotRequired[Literal["failed", "succeeded"]] """ Only return ReceivedCredits that have the given status: `succeeded` or `failed`. """ @@ -332,7 +332,7 @@ class ListParamsLinkedFlows(TypedDict): """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_received_credit_service.py b/stripe/treasury/_received_credit_service.py index fc9424aae..250b663e4 100644 --- a/stripe/treasury/_received_credit_service.py +++ b/stripe/treasury/_received_credit_service.py @@ -11,11 +11,11 @@ class ReceivedCreditService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -23,7 +23,7 @@ class ListParams(TypedDict): """ The FinancialAccount that received the funds. """ - limit: NotRequired["int"] + 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. """ @@ -33,11 +33,11 @@ class ListParams(TypedDict): """ Only return ReceivedCredits described by the flow. """ - starting_after: NotRequired["str"] + 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. """ - status: NotRequired["Literal['failed', 'succeeded']"] + status: NotRequired[Literal["failed", "succeeded"]] """ Only return ReceivedCredits that have the given status: `succeeded` or `failed`. """ @@ -51,7 +51,7 @@ class ListParamsLinkedFlows(TypedDict): """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_received_debit.py b/stripe/treasury/_received_debit.py index 42eefb58d..51476ca3d 100644 --- a/stripe/treasury/_received_debit.py +++ b/stripe/treasury/_received_debit.py @@ -189,11 +189,11 @@ class CreateParams(RequestOptions): """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ - description: NotRequired["str"] + description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -231,15 +231,15 @@ class CreateParamsInitiatingPaymentMethodDetails(TypedDict): """ class CreateParamsInitiatingPaymentMethodDetailsUsBankAccount(TypedDict): - account_holder_name: NotRequired["str"] + account_holder_name: NotRequired[str] """ The bank account holder's name. """ - account_number: NotRequired["str"] + account_number: NotRequired[str] """ The bank account number. """ - routing_number: NotRequired["str"] + routing_number: NotRequired[str] """ The bank account's routing number. """ @@ -255,17 +255,17 @@ class CreateParamsNetworkDetails(TypedDict): """ class CreateParamsNetworkDetailsAch(TypedDict): - addenda: NotRequired["str"] + addenda: NotRequired[str] """ Addenda record data associated with this ReceivedDebit. """ class ListParams(RequestOptions): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -273,21 +273,21 @@ class ListParams(RequestOptions): """ The FinancialAccount that funds were pulled from. """ - limit: NotRequired["int"] + 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"] + 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. """ - status: NotRequired["Literal['failed', 'succeeded']"] + status: NotRequired[Literal["failed", "succeeded"]] """ Only return ReceivedDebits that have the given status: `succeeded` or `failed`. """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_received_debit_service.py b/stripe/treasury/_received_debit_service.py index 803b2ebc2..e1ef7306d 100644 --- a/stripe/treasury/_received_debit_service.py +++ b/stripe/treasury/_received_debit_service.py @@ -11,11 +11,11 @@ class ReceivedDebitService(StripeService): class ListParams(TypedDict): - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -23,21 +23,21 @@ class ListParams(TypedDict): """ The FinancialAccount that funds were pulled from. """ - limit: NotRequired["int"] + 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"] + 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. """ - status: NotRequired["Literal['failed', 'succeeded']"] + status: NotRequired[Literal["failed", "succeeded"]] """ Only return ReceivedDebits that have the given status: `succeeded` or `failed`. """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_transaction.py b/stripe/treasury/_transaction.py index 2183cf255..146739365 100644 --- a/stripe/treasury/_transaction.py +++ b/stripe/treasury/_transaction.py @@ -119,11 +119,11 @@ class ListParams(RequestOptions): """ Only return Transactions that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -131,19 +131,19 @@ class ListParams(RequestOptions): """ Returns objects associated with this FinancialAccount. """ - limit: NotRequired["int"] + 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. """ - order_by: NotRequired["Literal['created', 'posted_at']"] + order_by: NotRequired[Literal["created", "posted_at"]] """ The results are in reverse chronological order by `created` or `posted_at`. The default is `created`. """ - starting_after: NotRequired["str"] + 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. """ - status: NotRequired["Literal['open', 'posted', 'void']"] + status: NotRequired[Literal["open", "posted", "void"]] """ Only return Transactions that have the given status: `open`, `posted`, or `void`. """ @@ -155,19 +155,19 @@ class ListParams(RequestOptions): """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ @@ -181,25 +181,25 @@ class ListParamsStatusTransitions(TypedDict): """ class ListParamsStatusTransitionsPostedAt(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_transaction_entry.py b/stripe/treasury/_transaction_entry.py index b76214d46..18ebfe248 100644 --- a/stripe/treasury/_transaction_entry.py +++ b/stripe/treasury/_transaction_entry.py @@ -111,11 +111,11 @@ class ListParams(RequestOptions): Only return TransactionEntries that were created during the given date interval. """ effective_at: NotRequired["TransactionEntry.ListParamsEffectiveAt|int"] - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -123,61 +123,61 @@ class ListParams(RequestOptions): """ Returns objects associated with this FinancialAccount. """ - limit: NotRequired["int"] + 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. """ - order_by: NotRequired["Literal['created', 'effective_at']"] + order_by: NotRequired[Literal["created", "effective_at"]] """ The results are in reverse chronological order by `created` or `effective_at`. The default is `created`. """ - starting_after: NotRequired["str"] + 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. """ - transaction: NotRequired["str"] + transaction: NotRequired[str] """ Only return TransactionEntries associated with this Transaction. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsEffectiveAt(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(RequestOptions): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_transaction_entry_service.py b/stripe/treasury/_transaction_entry_service.py index 9be87ce84..8d720fd40 100644 --- a/stripe/treasury/_transaction_entry_service.py +++ b/stripe/treasury/_transaction_entry_service.py @@ -18,11 +18,11 @@ class ListParams(TypedDict): effective_at: NotRequired[ "TransactionEntryService.ListParamsEffectiveAt|int" ] - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -30,61 +30,61 @@ class ListParams(TypedDict): """ Returns objects associated with this FinancialAccount. """ - limit: NotRequired["int"] + 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. """ - order_by: NotRequired["Literal['created', 'effective_at']"] + order_by: NotRequired[Literal["created", "effective_at"]] """ The results are in reverse chronological order by `created` or `effective_at`. The default is `created`. """ - starting_after: NotRequired["str"] + 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. """ - transaction: NotRequired["str"] + transaction: NotRequired[str] """ Only return TransactionEntries associated with this Transaction. """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class ListParamsEffectiveAt(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ diff --git a/stripe/treasury/_transaction_service.py b/stripe/treasury/_transaction_service.py index 00c34ed26..ac91f7fd8 100644 --- a/stripe/treasury/_transaction_service.py +++ b/stripe/treasury/_transaction_service.py @@ -15,11 +15,11 @@ class ListParams(TypedDict): """ Only return Transactions that were created during the given date interval. """ - ending_before: NotRequired["str"] + 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]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ @@ -27,19 +27,19 @@ class ListParams(TypedDict): """ Returns objects associated with this FinancialAccount. """ - limit: NotRequired["int"] + 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. """ - order_by: NotRequired["Literal['created', 'posted_at']"] + order_by: NotRequired[Literal["created", "posted_at"]] """ The results are in reverse chronological order by `created` or `posted_at`. The default is `created`. """ - starting_after: NotRequired["str"] + 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. """ - status: NotRequired["Literal['open', 'posted', 'void']"] + status: NotRequired[Literal["open", "posted", "void"]] """ Only return Transactions that have the given status: `open`, `posted`, or `void`. """ @@ -51,19 +51,19 @@ class ListParams(TypedDict): """ class ListParamsCreated(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ @@ -77,25 +77,25 @@ class ListParamsStatusTransitions(TypedDict): """ class ListParamsStatusTransitionsPostedAt(TypedDict): - gt: NotRequired["int"] + gt: NotRequired[int] """ Minimum value to filter by (exclusive) """ - gte: NotRequired["int"] + gte: NotRequired[int] """ Minimum value to filter by (inclusive) """ - lt: NotRequired["int"] + lt: NotRequired[int] """ Maximum value to filter by (exclusive) """ - lte: NotRequired["int"] + lte: NotRequired[int] """ Maximum value to filter by (inclusive) """ class RetrieveParams(TypedDict): - expand: NotRequired["List[str]"] + expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """