From c5a31647cabf5a5779e3ea34835f036044a543cb Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Mon, 15 Dec 2025 20:46:55 +0000 Subject: [PATCH 01/10] Update generated code for v2142 and --- API_VERSION | 2 +- OPENAPI_VERSION | 2 +- stripe/_invoice.py | 4 ++++ stripe/_quote_preview_invoice.py | 4 ++++ 4 files changed, 10 insertions(+), 2 deletions(-) diff --git a/API_VERSION b/API_VERSION index e48768f4a..ecd5bb94d 100644 --- a/API_VERSION +++ b/API_VERSION @@ -1 +1 @@ -3602014a6583f6c0fbfdde3c575839ac7d0b4e9c \ No newline at end of file +7b4fc6eca8bc61b5a52339eda297e0273fa6042c \ No newline at end of file diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 4e4ca8e5b..c00bf54a1 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v2141 \ No newline at end of file +v2142 \ No newline at end of file diff --git a/stripe/_invoice.py b/stripe/_invoice.py index b3f1b1d67..0b5929fe4 100644 --- a/stripe/_invoice.py +++ b/stripe/_invoice.py @@ -746,6 +746,10 @@ class ScheduleDetails(StripeObject): """ The schedule that generated this invoice """ + subscription: Optional[ExpandableField["Subscription"]] + """ + The subscription associated with this schedule + """ class SubscriptionDetails(StripeObject): class PauseCollection(StripeObject): diff --git a/stripe/_quote_preview_invoice.py b/stripe/_quote_preview_invoice.py index 02219af9f..1b51fa78d 100644 --- a/stripe/_quote_preview_invoice.py +++ b/stripe/_quote_preview_invoice.py @@ -704,6 +704,10 @@ class ScheduleDetails(StripeObject): """ The schedule that generated this invoice """ + subscription: Optional[ExpandableField["Subscription"]] + """ + The subscription associated with this schedule + """ class SubscriptionDetails(StripeObject): class PauseCollection(StripeObject): From fdafb27a43e00f033fe2aad11c5ab5c7281682c8 Mon Sep 17 00:00:00 2001 From: "stripe-openapi[bot]" <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Mon, 15 Dec 2025 12:51:16 -0800 Subject: [PATCH 02/10] Update generated code (#1696) * Update generated code for v2135 and * Update generated code for v2137 and * Update generated code for v2140 and --------- Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> --- API_VERSION | 2 +- OPENAPI_VERSION | 2 +- stripe/_account.py | 56 +- stripe/_account_link.py | 2 +- stripe/_account_session.py | 4 +- stripe/_api_version.py | 2 +- stripe/_application_fee_refund.py | 4 +- stripe/_balance.py | 4 +- stripe/_balance_settings.py | 2 +- stripe/_balance_transaction.py | 2 +- stripe/_bank_account.py | 20 +- stripe/_capability.py | 32 +- stripe/_card.py | 4 +- stripe/_cash_balance.py | 6 +- stripe/_charge.py | 112 +- stripe/_confirmation_token.py | 42 +- stripe/_coupon.py | 6 +- stripe/_credit_note.py | 13 +- stripe/_credit_note_line_item.py | 3 + stripe/_customer.py | 18 +- stripe/_customer_balance_transaction.py | 14 +- stripe/_customer_cash_balance_transaction.py | 22 +- stripe/_customer_session.py | 4 + stripe/_discount.py | 8 +- stripe/_dispute.py | 10 +- stripe/_event.py | 2 +- stripe/_exchange_rate.py | 4 +- stripe/_file.py | 8 +- stripe/_file_link.py | 2 +- stripe/_funding_instructions.py | 28 +- stripe/_invoice.py | 102 +- stripe/_invoice_item.py | 17 +- stripe/_invoice_item_service.py | 4 +- stripe/_invoice_line_item.py | 16 +- stripe/_invoice_payment.py | 2 +- stripe/_invoice_rendering_template.py | 2 +- stripe/_line_item.py | 10 +- stripe/_login_link.py | 2 +- stripe/_mandate.py | 55 + stripe/_object_classes.py | 11 + stripe/_payment_attempt_record.py | 139 +- stripe/_payment_intent.py | 182 +- ...payment_intent_amount_details_line_item.py | 6 +- stripe/_payment_link.py | 15 +- stripe/_payment_method.py | 48 +- stripe/_payment_method_configuration.py | 32 +- stripe/_payment_method_domain.py | 2 +- stripe/_payment_method_service.py | 8 +- stripe/_payment_record.py | 143 +- stripe/_payout.py | 14 +- stripe/_person.py | 46 +- stripe/_plan.py | 10 +- stripe/_price.py | 12 +- stripe/_product.py | 18 +- stripe/_promotion_code.py | 10 +- stripe/_quote.py | 26 +- stripe/_refund.py | 6 +- stripe/_reversal.py | 8 +- stripe/_review.py | 2 +- stripe/_setup_attempt.py | 44 +- stripe/_setup_intent.py | 107 +- stripe/_shipping_rate.py | 6 +- stripe/_source.py | 16 +- stripe/_source_mandate_notification.py | 6 +- stripe/_subscription.py | 68 +- stripe/_subscription_item.py | 14 +- stripe/_subscription_schedule.py | 20 +- stripe/_subscription_service.py | 4 +- stripe/_tax_id.py | 12 +- stripe/_tax_rate.py | 2 +- stripe/_token.py | 8 +- stripe/_topup.py | 6 +- stripe/_transfer.py | 10 +- stripe/_webhook_endpoint.py | 2 +- stripe/apps/_secret.py | 2 +- stripe/billing/_alert.py | 2 +- stripe/billing/_credit_balance_summary.py | 4 + .../_credit_balance_transaction_service.py | 4 +- stripe/billing/_credit_grant.py | 6 +- stripe/billing/_meter_event.py | 2 +- stripe/billing_portal/_configuration.py | 10 +- stripe/billing_portal/_session.py | 16 +- stripe/billing_portal/_session_service.py | 4 +- stripe/checkout/_session.py | 113 +- stripe/climate/_order.py | 2 +- stripe/entitlements/_active_entitlement.py | 2 +- stripe/financial_connections/_account.py | 7 +- stripe/financial_connections/_session.py | 5 +- stripe/forwarding/_request.py | 2 +- stripe/identity/_verification_report.py | 18 +- stripe/identity/_verification_session.py | 24 +- stripe/issuing/_authorization.py | 40 +- stripe/issuing/_card.py | 24 +- stripe/issuing/_cardholder.py | 28 +- stripe/issuing/_dispute.py | 14 +- stripe/issuing/_personalization_design.py | 2 +- stripe/issuing/_token.py | 2 +- stripe/issuing/_transaction.py | 24 +- stripe/params/__init__.py | 260 + ..._account_create_external_account_params.py | 4 +- stripe/params/_account_create_params.py | 85 +- .../params/_account_create_person_params.py | 20 +- ..._account_external_account_create_params.py | 4 +- ..._account_external_account_update_params.py | 4 +- ..._account_modify_external_account_params.py | 4 +- .../params/_account_modify_person_params.py | 20 +- .../params/_account_person_create_params.py | 20 +- .../params/_account_person_update_params.py | 20 +- stripe/params/_account_update_params.py | 85 +- .../_application_fee_create_refund_params.py | 2 +- .../_application_fee_modify_refund_params.py | 2 +- .../_application_fee_refund_create_params.py | 2 +- .../params/_application_fee_refund_params.py | 2 +- .../_application_fee_refund_update_params.py | 2 +- stripe/params/_charge_capture_params.py | 4 +- stripe/params/_charge_create_params.py | 24 +- stripe/params/_charge_modify_params.py | 6 +- stripe/params/_charge_search_params.py | 2 +- stripe/params/_charge_update_params.py | 6 +- .../_confirmation_token_create_params.py | 33 +- stripe/params/_coupon_create_params.py | 2 +- stripe/params/_coupon_modify_params.py | 2 +- stripe/params/_coupon_update_params.py | 2 +- stripe/params/_credit_note_create_params.py | 2 +- stripe/params/_credit_note_list_params.py | 4 + stripe/params/_credit_note_modify_params.py | 2 +- .../_credit_note_preview_lines_list_params.py | 2 +- .../_credit_note_preview_lines_params.py | 2 +- stripe/params/_credit_note_preview_params.py | 2 +- stripe/params/_credit_note_update_params.py | 2 +- ...tomer_balance_transaction_create_params.py | 4 +- ...ustomer_balance_transaction_list_params.py | 4 + ...tomer_balance_transaction_update_params.py | 2 +- .../_customer_cash_balance_update_params.py | 2 +- ...tomer_create_balance_transaction_params.py | 4 +- stripe/params/_customer_create_params.py | 10 +- .../params/_customer_create_source_params.py | 4 +- .../_customer_fund_cash_balance_params.py | 4 +- ...stomer_list_balance_transactions_params.py | 4 + .../_customer_list_payment_methods_params.py | 1 + ...tomer_modify_balance_transaction_params.py | 2 +- .../_customer_modify_cash_balance_params.py | 2 +- stripe/params/_customer_modify_params.py | 14 +- .../params/_customer_modify_source_params.py | 4 +- .../_customer_payment_method_list_params.py | 1 + .../_customer_payment_source_create_params.py | 4 +- .../_customer_payment_source_update_params.py | 4 +- stripe/params/_customer_search_params.py | 2 +- .../params/_customer_session_create_params.py | 6 +- stripe/params/_customer_update_params.py | 14 +- stripe/params/_dispute_modify_params.py | 6 +- stripe/params/_dispute_update_params.py | 6 +- stripe/params/_file_create_params.py | 6 +- stripe/params/_file_link_create_params.py | 2 +- stripe/params/_file_link_modify_params.py | 2 +- stripe/params/_file_link_update_params.py | 2 +- stripe/params/_invoice_add_lines_params.py | 16 +- stripe/params/_invoice_create_params.py | 72 +- .../params/_invoice_create_preview_params.py | 68 +- .../_invoice_finalize_invoice_params.py | 2 +- stripe/params/_invoice_item_create_params.py | 20 +- stripe/params/_invoice_item_list_params.py | 6 +- stripe/params/_invoice_item_modify_params.py | 12 +- stripe/params/_invoice_item_update_params.py | 12 +- .../_invoice_line_item_update_params.py | 14 +- stripe/params/_invoice_list_params.py | 6 +- stripe/params/_invoice_modify_params.py | 64 +- stripe/params/_invoice_remove_lines_params.py | 2 +- stripe/params/_invoice_search_params.py | 2 +- stripe/params/_invoice_update_lines_params.py | 16 +- stripe/params/_invoice_update_params.py | 64 +- ...nt_intent_apply_customer_balance_params.py | 2 +- .../params/_payment_intent_capture_params.py | 24 +- .../params/_payment_intent_confirm_params.py | 143 +- .../params/_payment_intent_create_params.py | 178 +- ...t_intent_increment_authorization_params.py | 22 +- stripe/params/_payment_intent_list_params.py | 4 + .../params/_payment_intent_modify_params.py | 155 +- .../params/_payment_intent_search_params.py | 2 +- .../params/_payment_intent_update_params.py | 155 +- stripe/params/_payment_link_create_params.py | 39 +- stripe/params/_payment_link_modify_params.py | 20 +- stripe/params/_payment_link_update_params.py | 20 +- .../params/_payment_method_attach_params.py | 6 +- ...ment_method_configuration_create_params.py | 96 +- ...ment_method_configuration_modify_params.py | 96 +- ...ment_method_configuration_update_params.py | 96 +- .../params/_payment_method_create_params.py | 29 +- stripe/params/_payment_method_list_params.py | 9 + .../params/_payment_method_modify_params.py | 23 +- .../params/_payment_method_update_params.py | 23 +- ...rt_payment_attempt_informational_params.py | 4 +- ...nt_record_report_payment_attempt_params.py | 6 +- .../_payment_record_report_payment_params.py | 8 +- .../_payment_record_report_refund_params.py | 6 +- stripe/params/_payout_create_params.py | 2 +- stripe/params/_payout_modify_params.py | 2 +- stripe/params/_payout_reverse_params.py | 2 +- stripe/params/_payout_update_params.py | 2 +- stripe/params/_plan_create_params.py | 8 +- stripe/params/_plan_modify_params.py | 4 +- stripe/params/_plan_update_params.py | 4 +- stripe/params/_price_create_params.py | 12 +- stripe/params/_price_modify_params.py | 6 +- stripe/params/_price_search_params.py | 2 +- stripe/params/_price_update_params.py | 6 +- .../params/_product_create_feature_params.py | 2 +- stripe/params/_product_create_params.py | 14 +- .../params/_product_feature_create_params.py | 2 +- stripe/params/_product_list_params.py | 2 +- stripe/params/_product_modify_params.py | 8 +- stripe/params/_product_search_params.py | 2 +- stripe/params/_product_update_params.py | 8 +- .../params/_promotion_code_create_params.py | 8 +- stripe/params/_promotion_code_list_params.py | 4 + .../params/_promotion_code_modify_params.py | 2 +- .../params/_promotion_code_update_params.py | 2 +- stripe/params/_quote_create_params.py | 12 +- stripe/params/_quote_list_params.py | 6 +- stripe/params/_quote_modify_params.py | 12 +- stripe/params/_quote_update_params.py | 12 +- stripe/params/_refund_create_params.py | 4 +- stripe/params/_refund_modify_params.py | 2 +- stripe/params/_refund_update_params.py | 2 +- stripe/params/_setup_intent_confirm_params.py | 83 +- stripe/params/_setup_intent_create_params.py | 102 +- stripe/params/_setup_intent_list_params.py | 4 + stripe/params/_setup_intent_modify_params.py | 95 +- stripe/params/_setup_intent_update_params.py | 95 +- stripe/params/_shipping_rate_create_params.py | 4 +- stripe/params/_shipping_rate_modify_params.py | 2 +- stripe/params/_shipping_rate_update_params.py | 2 +- stripe/params/_source_create_params.py | 6 +- stripe/params/_source_modify_params.py | 6 +- stripe/params/_source_update_params.py | 6 +- stripe/params/_subscription_create_params.py | 94 +- .../_subscription_item_create_params.py | 20 +- .../_subscription_item_delete_params.py | 4 +- .../_subscription_item_modify_params.py | 20 +- .../_subscription_item_update_params.py | 20 +- stripe/params/_subscription_list_params.py | 8 +- stripe/params/_subscription_modify_params.py | 86 +- stripe/params/_subscription_resume_params.py | 4 +- .../_subscription_schedule_create_params.py | 34 +- .../_subscription_schedule_list_params.py | 4 + .../_subscription_schedule_modify_params.py | 30 +- .../_subscription_schedule_update_params.py | 30 +- stripe/params/_subscription_search_params.py | 2 +- stripe/params/_subscription_update_params.py | 86 +- stripe/params/_tax_id_create_params.py | 6 +- stripe/params/_tax_id_list_params.py | 6 +- stripe/params/_tax_rate_create_params.py | 2 +- stripe/params/_tax_rate_modify_params.py | 2 +- stripe/params/_tax_rate_update_params.py | 2 +- stripe/params/_token_create_params.py | 44 +- stripe/params/_topup_create_params.py | 4 +- stripe/params/_topup_modify_params.py | 2 +- stripe/params/_topup_update_params.py | 2 +- stripe/params/_transfer_create_params.py | 6 +- .../_transfer_create_reversal_params.py | 2 +- stripe/params/_transfer_modify_params.py | 2 +- .../_transfer_modify_reversal_params.py | 2 +- .../_transfer_reversal_create_params.py | 2 +- .../_transfer_reversal_update_params.py | 2 +- stripe/params/_transfer_update_params.py | 2 +- .../params/_webhook_endpoint_create_params.py | 4 +- .../params/_webhook_endpoint_modify_params.py | 2 +- .../params/_webhook_endpoint_update_params.py | 2 +- ..._credit_balance_summary_retrieve_params.py | 8 +- ..._credit_balance_transaction_list_params.py | 8 +- .../billing/_credit_grant_create_params.py | 8 +- .../billing/_credit_grant_list_params.py | 4 + .../billing/_meter_event_create_params.py | 2 +- .../_configuration_create_params.py | 10 +- .../_configuration_modify_params.py | 10 +- .../_configuration_update_params.py | 10 +- .../billing_portal/_session_create_params.py | 20 +- stripe/params/checkout/__init__.py | 60 + .../params/checkout/_session_create_params.py | 142 +- .../params/checkout/_session_list_params.py | 4 + .../params/checkout/_session_modify_params.py | 143 +- .../params/checkout/_session_update_params.py | 143 +- stripe/params/climate/_order_create_params.py | 2 +- stripe/params/climate/_order_modify_params.py | 2 +- stripe/params/climate/_order_update_params.py | 2 +- .../_account_list_params.py | 8 +- .../_session_create_params.py | 8 +- .../forwarding/_request_create_params.py | 2 +- .../_verification_session_create_params.py | 14 +- .../_verification_session_list_params.py | 9 +- .../_verification_session_modify_params.py | 10 +- .../_verification_session_update_params.py | 10 +- .../issuing/_authorization_approve_params.py | 4 +- .../issuing/_authorization_capture_params.py | 2 +- .../issuing/_authorization_create_params.py | 10 +- .../issuing/_authorization_decline_params.py | 2 +- .../_authorization_finalize_amount_params.py | 2 +- .../_authorization_increment_params.py | 4 +- .../issuing/_authorization_modify_params.py | 2 +- .../issuing/_authorization_reverse_params.py | 2 +- .../issuing/_authorization_update_params.py | 2 +- stripe/params/issuing/_card_create_params.py | 14 +- stripe/params/issuing/_card_modify_params.py | 12 +- stripe/params/issuing/_card_update_params.py | 12 +- .../issuing/_cardholder_create_params.py | 22 +- .../issuing/_cardholder_modify_params.py | 20 +- .../issuing/_cardholder_update_params.py | 20 +- .../params/issuing/_dispute_create_params.py | 4 +- .../params/issuing/_dispute_modify_params.py | 4 +- .../params/issuing/_dispute_submit_params.py | 2 +- .../params/issuing/_dispute_update_params.py | 4 +- .../_personalization_design_create_params.py | 2 +- .../_personalization_design_modify_params.py | 2 +- .../_personalization_design_update_params.py | 2 +- ...transaction_create_force_capture_params.py | 4 +- ...ansaction_create_unlinked_refund_params.py | 4 +- .../issuing/_transaction_modify_params.py | 2 +- .../issuing/_transaction_refund_params.py | 2 +- .../issuing/_transaction_update_params.py | 2 +- .../params/radar/_value_list_create_params.py | 2 +- .../params/radar/_value_list_modify_params.py | 2 +- .../params/radar/_value_list_update_params.py | 2 +- .../reporting/_report_run_create_params.py | 4 +- stripe/params/tax/_association_find_params.py | 2 +- .../params/tax/_calculation_create_params.py | 14 +- stripe/params/tax/_settings_modify_params.py | 2 +- stripe/params/tax/_settings_update_params.py | 2 +- ...nsaction_create_from_calculation_params.py | 2 +- .../_transaction_create_reversal_params.py | 18 +- .../terminal/_location_create_params.py | 4 +- .../terminal/_location_modify_params.py | 4 +- .../terminal/_location_update_params.py | 4 +- .../terminal/_reader_collect_inputs_params.py | 2 +- .../params/terminal/_reader_create_params.py | 2 +- .../params/terminal/_reader_modify_params.py | 2 +- .../terminal/_reader_refund_payment_params.py | 2 +- .../_reader_set_reader_display_params.py | 6 +- .../params/terminal/_reader_update_params.py | 2 +- stripe/params/test_helpers/__init__.py | 5 + .../_confirmation_token_create_params.py | 33 +- .../_customer_fund_cash_balance_params.py | 4 +- .../issuing/_authorization_capture_params.py | 2 +- .../issuing/_authorization_create_params.py | 10 +- .../_authorization_finalize_amount_params.py | 2 +- .../_authorization_increment_params.py | 4 +- .../issuing/_authorization_reverse_params.py | 2 +- ...transaction_create_force_capture_params.py | 4 +- ...ansaction_create_unlinked_refund_params.py | 4 +- .../issuing/_transaction_refund_params.py | 2 +- .../_received_credit_create_params.py | 2 +- .../treasury/_received_debit_create_params.py | 2 +- .../_credit_reversal_create_params.py | 2 +- .../treasury/_debit_reversal_create_params.py | 2 +- .../_financial_account_create_params.py | 2 +- .../_financial_account_modify_params.py | 2 +- .../_financial_account_update_params.py | 2 +- .../_inbound_transfer_create_params.py | 4 +- .../_outbound_payment_create_params.py | 10 +- .../_outbound_transfer_create_params.py | 6 +- .../_received_credit_create_params.py | 2 +- .../treasury/_received_debit_create_params.py | 2 +- stripe/params/v2/core/__init__.py | 1670 +++++++ .../params/v2/core/_account_close_params.py | 13 + .../params/v2/core/_account_create_params.py | 2611 ++++++++++ .../v2/core/_account_link_create_params.py | 98 + stripe/params/v2/core/_account_list_params.py | 21 + .../v2/core/_account_retrieve_params.py | 23 + .../v2/core/_account_token_create_params.py | 1303 +++++ .../v2/core/_account_token_retrieve_params.py | 7 + .../params/v2/core/_account_update_params.py | 2675 ++++++++++ stripe/params/v2/core/accounts/__init__.py | 404 ++ .../v2/core/accounts/_person_create_params.py | 545 +++ .../v2/core/accounts/_person_delete_params.py | 7 + .../v2/core/accounts/_person_list_params.py | 10 + .../core/accounts/_person_retrieve_params.py | 7 + .../accounts/_person_token_create_params.py | 541 +++ .../accounts/_person_token_retrieve_params.py | 7 + .../v2/core/accounts/_person_update_params.py | 545 +++ stripe/radar/_early_fraud_warning.py | 2 +- stripe/radar/_value_list.py | 4 +- stripe/radar/_value_list_item.py | 2 +- stripe/reporting/_report_run.py | 6 +- stripe/reporting/_report_type.py | 6 +- stripe/sigma/_scheduled_query_run.py | 2 +- stripe/tax/_association.py | 6 +- stripe/tax/_calculation.py | 24 +- stripe/tax/_calculation_line_item.py | 14 +- stripe/tax/_registration.py | 6 +- stripe/tax/_settings.py | 4 +- stripe/tax/_transaction.py | 18 +- stripe/tax/_transaction_line_item.py | 10 +- stripe/terminal/_connection_token.py | 2 +- stripe/terminal/_location.py | 6 +- stripe/terminal/_reader.py | 20 +- stripe/treasury/_credit_reversal.py | 6 +- stripe/treasury/_debit_reversal.py | 6 +- stripe/treasury/_financial_account.py | 2 +- stripe/treasury/_inbound_transfer.py | 10 +- stripe/treasury/_outbound_payment.py | 12 +- stripe/treasury/_outbound_transfer.py | 10 +- stripe/treasury/_received_credit.py | 20 +- stripe/treasury/_received_debit.py | 14 +- stripe/treasury/_transaction.py | 22 +- stripe/treasury/_transaction_entry.py | 22 +- stripe/v2/_core_service.py | 15 + stripe/v2/core/__init__.py | 26 + stripe/v2/core/_account.py | 4312 +++++++++++++++++ stripe/v2/core/_account_link.py | 121 + stripe/v2/core/_account_link_service.py | 52 + stripe/v2/core/_account_person.py | 562 +++ stripe/v2/core/_account_person_token.py | 39 + stripe/v2/core/_account_service.py | 255 + stripe/v2/core/_account_token.py | 39 + stripe/v2/core/_account_token_service.py | 96 + stripe/v2/core/_event.py | 4 + stripe/v2/core/accounts/__init__.py | 36 + stripe/v2/core/accounts/_person_service.py | 261 + .../v2/core/accounts/_person_token_service.py | 110 + tests/test_generated_examples.py | 353 ++ 419 files changed, 21511 insertions(+), 1960 deletions(-) create mode 100644 stripe/params/v2/core/_account_close_params.py create mode 100644 stripe/params/v2/core/_account_create_params.py create mode 100644 stripe/params/v2/core/_account_link_create_params.py create mode 100644 stripe/params/v2/core/_account_list_params.py create mode 100644 stripe/params/v2/core/_account_retrieve_params.py create mode 100644 stripe/params/v2/core/_account_token_create_params.py create mode 100644 stripe/params/v2/core/_account_token_retrieve_params.py create mode 100644 stripe/params/v2/core/_account_update_params.py create mode 100644 stripe/params/v2/core/accounts/__init__.py create mode 100644 stripe/params/v2/core/accounts/_person_create_params.py create mode 100644 stripe/params/v2/core/accounts/_person_delete_params.py create mode 100644 stripe/params/v2/core/accounts/_person_list_params.py create mode 100644 stripe/params/v2/core/accounts/_person_retrieve_params.py create mode 100644 stripe/params/v2/core/accounts/_person_token_create_params.py create mode 100644 stripe/params/v2/core/accounts/_person_token_retrieve_params.py create mode 100644 stripe/params/v2/core/accounts/_person_update_params.py create mode 100644 stripe/v2/core/_account.py create mode 100644 stripe/v2/core/_account_link.py create mode 100644 stripe/v2/core/_account_link_service.py create mode 100644 stripe/v2/core/_account_person.py create mode 100644 stripe/v2/core/_account_person_token.py create mode 100644 stripe/v2/core/_account_service.py create mode 100644 stripe/v2/core/_account_token.py create mode 100644 stripe/v2/core/_account_token_service.py create mode 100644 stripe/v2/core/accounts/__init__.py create mode 100644 stripe/v2/core/accounts/_person_service.py create mode 100644 stripe/v2/core/accounts/_person_token_service.py diff --git a/API_VERSION b/API_VERSION index dc9d80dc3..93be1cef5 100644 --- a/API_VERSION +++ b/API_VERSION @@ -1 +1 @@ -368be7755d15d02a1038325c7d159703b01662b0 \ No newline at end of file +88aa59022b32620f4d66d6196e3b42d5a0f86bbb \ No newline at end of file diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 1d5ad796c..16739433e 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v2128 \ No newline at end of file +v2140 \ No newline at end of file diff --git a/stripe/_account.py b/stripe/_account.py index 64f50c8a1..30582b94d 100644 --- a/stripe/_account.py +++ b/stripe/_account.py @@ -145,7 +145,7 @@ class SupportAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ annual_revenue: Optional[AnnualRevenue] @@ -402,6 +402,10 @@ class Capabilities(StripeObject): """ The status of the paynow payments capability of the account, or whether the account can directly process paynow charges. """ + payto_payments: Optional[Literal["active", "inactive", "pending"]] + """ + The status of the PayTo capability of the account, or whether the account can directly process PayTo charges. + """ pix_payments: Optional[Literal["active", "inactive", "pending"]] """ The status of the pix payments capability of the account, or whether the account can directly process pix charges. @@ -509,7 +513,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class AddressKana(StripeObject): @@ -632,7 +636,7 @@ class Verification(StripeObject): class Document(StripeObject): back: Optional[ExpandableField["File"]] """ - The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](https://docs.stripe.com/file-upload#uploading-a-file). + The back of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](https://docs.stripe.com/file-upload#uploading-a-file). """ details: Optional[str] """ @@ -644,7 +648,7 @@ class Document(StripeObject): """ front: Optional[ExpandableField["File"]] """ - The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](https://docs.stripe.com/file-upload#uploading-a-file). + The front of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](https://docs.stripe.com/file-upload#uploading-a-file). """ document: Document @@ -661,7 +665,7 @@ class Document(StripeObject): """ directors_provided: Optional[bool] """ - Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided). + Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-directors_provided). """ directorship_declaration: Optional[DirectorshipDeclaration] """ @@ -669,7 +673,7 @@ class Document(StripeObject): """ executives_provided: Optional[bool] """ - Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided. + Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided. """ export_license_id: Optional[str] """ @@ -693,7 +697,7 @@ class Document(StripeObject): """ owners_provided: Optional[bool] """ - Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together). + Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together). """ ownership_declaration: Optional[OwnershipDeclaration] """ @@ -745,7 +749,7 @@ class Document(StripeObject): ] ] """ - The category identifying the legal structure of the company or legal entity. Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. + The category identifying the legal structure of the company or legal entity. Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. """ tax_id_provided: Optional[bool] """ @@ -801,7 +805,7 @@ class StripeDashboard(StripeObject): fees: Optional[Fees] is_controller: Optional[bool] """ - `true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null. + `true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://docs.stripe.com/connect/platform-controls-for-standard-accounts). Otherwise, this field is null. """ losses: Optional[Losses] requirement_collection: Optional[Literal["application", "stripe"]] @@ -823,11 +827,11 @@ class FutureRequirements(StripeObject): class Alternative(StripeObject): alternative_fields_due: List[str] """ - Fields that can be provided to satisfy all fields in `original_fields_due`. + Fields that can be provided to resolve all fields in `original_fields_due`. """ original_fields_due: List[str] """ - Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. + Fields that are due and can be resolved by providing all fields in `alternative_fields_due`. """ class Error(StripeObject): @@ -944,7 +948,7 @@ class Error(StripeObject): alternatives: Optional[List[Alternative]] """ - Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. """ current_deadline: Optional[int] """ @@ -952,7 +956,7 @@ class Error(StripeObject): """ currently_due: Optional[List[str]] """ - Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. + Fields that need to be resolved to keep the account enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. """ disabled_reason: Optional[ Literal[ @@ -978,7 +982,7 @@ class Error(StripeObject): """ errors: Optional[List[Error]] """ - Fields that are `currently_due` and need to be collected again because validation or verification failed. + Details about validation and verification failures for `due` requirements that must be resolved. """ eventually_due: Optional[List[str]] """ @@ -986,29 +990,29 @@ class Error(StripeObject): """ past_due: Optional[List[str]] """ - Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. + Fields that haven't been resolved by `requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`. """ pending_verification: Optional[List[str]] """ - Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. + Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. """ _inner_class_types = {"alternatives": Alternative, "errors": Error} class Groups(StripeObject): payments_pricing: Optional[str] """ - The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details. + The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://docs.stripe.com/connect/platform-pricing-tools) for details. """ class Requirements(StripeObject): class Alternative(StripeObject): alternative_fields_due: List[str] """ - Fields that can be provided to satisfy all fields in `original_fields_due`. + Fields that can be provided to resolve all fields in `original_fields_due`. """ original_fields_due: List[str] """ - Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. + Fields that are due and can be resolved by providing all fields in `alternative_fields_due`. """ class Error(StripeObject): @@ -1125,7 +1129,7 @@ class Error(StripeObject): alternatives: Optional[List[Alternative]] """ - Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. """ current_deadline: Optional[int] """ @@ -1133,7 +1137,7 @@ class Error(StripeObject): """ currently_due: Optional[List[str]] """ - Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. + Fields that need to be resolved to keep the account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled. """ disabled_reason: Optional[ Literal[ @@ -1155,11 +1159,11 @@ class Error(StripeObject): ] ] """ - If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). + If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification). """ errors: Optional[List[Error]] """ - Fields that are `currently_due` and need to be collected again because validation or verification failed. + Details about validation and verification failures for `due` requirements that must be resolved. """ eventually_due: Optional[List[str]] """ @@ -1167,11 +1171,11 @@ class Error(StripeObject): """ past_due: Optional[List[str]] """ - Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. + Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the account. """ pending_verification: Optional[List[str]] """ - Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. + Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. """ _inner_class_types = {"alternatives": Alternative, "errors": Error} @@ -1469,7 +1473,7 @@ class TosAcceptance(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["account"] """ diff --git a/stripe/_account_link.py b/stripe/_account_link.py index 15043e9ee..704721339 100644 --- a/stripe/_account_link.py +++ b/stripe/_account_link.py @@ -15,7 +15,7 @@ class AccountLink(CreateableAPIResource["AccountLink"]): Account Links are the means by which a Connect platform grants a connected account permission to access Stripe-hosted applications, such as Connect Onboarding. - Related guide: [Connect Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding) + Related guide: [Connect Onboarding](https://docs.stripe.com/connect/custom/hosted-onboarding) """ OBJECT_NAME: ClassVar[Literal["account_link"]] = "account_link" diff --git a/stripe/_account_session.py b/stripe/_account_session.py index 0f338bb11..4b750934e 100644 --- a/stripe/_account_session.py +++ b/stripe/_account_session.py @@ -19,7 +19,7 @@ class AccountSession(CreateableAPIResource["AccountSession"]): to your user. Do not save AccountSessions to your database as they expire relatively quickly, and cannot be used more than once. - Related guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) + Related guide: [Connect embedded components](https://docs.stripe.com/connect/get-started-connect-embedded-components) """ OBJECT_NAME: ClassVar[Literal["account_session"]] = "account_session" @@ -463,7 +463,7 @@ class Features(StripeObject): The client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret. - Refer to our docs to [setup Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled. + Refer to our docs to [setup Connect embedded components](https://docs.stripe.com/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled. """ components: Components expires_at: int diff --git a/stripe/_api_version.py b/stripe/_api_version.py index cfb1babef..958a83ae0 100644 --- a/stripe/_api_version.py +++ b/stripe/_api_version.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- # File generated from our OpenAPI spec class _ApiVersion: - CURRENT = "2025-11-17.clover" + CURRENT = "2025-12-15.clover" CURRENT_MAJOR = "clover" diff --git a/stripe/_application_fee_refund.py b/stripe/_application_fee_refund.py index 4ae51aeb3..0c4dc4d76 100644 --- a/stripe/_application_fee_refund.py +++ b/stripe/_application_fee_refund.py @@ -17,7 +17,7 @@ class ApplicationFeeRefund(UpdateableAPIResource["ApplicationFeeRefund"]): has previously been created but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected. - Related guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee) + Related guide: [Refunding application fees](https://docs.stripe.com/connect/destination-charges#refunding-app-fee) """ OBJECT_NAME: ClassVar[Literal["fee_refund"]] = "fee_refund" @@ -47,7 +47,7 @@ class ApplicationFeeRefund(UpdateableAPIResource["ApplicationFeeRefund"]): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["fee_refund"] """ diff --git a/stripe/_balance.py b/stripe/_balance.py index e3a5e8475..4824ba22c 100644 --- a/stripe/_balance.py +++ b/stripe/_balance.py @@ -16,7 +16,7 @@ class Balance(SingletonAPIResource["Balance"]): The top-level `available` and `pending` comprise your "payments balance." - Related guide: [Balances and settlement time](https://stripe.com/docs/payments/balances), [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances) + Related guide: [Balances and settlement time](https://docs.stripe.com/payments/balances), [Understanding Connect account balances](https://docs.stripe.com/connect/account-balances) """ OBJECT_NAME: ClassVar[Literal["balance"]] = "balance" @@ -256,7 +256,7 @@ class SourceTypes(StripeObject): available: List[Available] """ - Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property. + Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://api.stripe.com#transfers) or [Payouts API](https://api.stripe.com#payouts). You can find the available balance for each currency and payment type in the `source_types` property. """ connect_reserved: Optional[List[ConnectReserved]] """ diff --git a/stripe/_balance_settings.py b/stripe/_balance_settings.py index bda6ce9b4..2f0b8bb42 100644 --- a/stripe/_balance_settings.py +++ b/stripe/_balance_settings.py @@ -59,7 +59,7 @@ class Schedule(StripeObject): """ schedule: Optional[Schedule] """ - Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation for details. + Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation for details. """ statement_descriptor: Optional[str] """ diff --git a/stripe/_balance_transaction.py b/stripe/_balance_transaction.py index e8393984c..b6be1dfcf 100644 --- a/stripe/_balance_transaction.py +++ b/stripe/_balance_transaction.py @@ -39,7 +39,7 @@ class BalanceTransaction(ListableAPIResource["BalanceTransaction"]): Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe account balance. - Related guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types) + Related guide: [Balance transaction types](https://docs.stripe.com/reports/balance-transaction-types) """ OBJECT_NAME: ClassVar[Literal["balance_transaction"]] = ( diff --git a/stripe/_bank_account.py b/stripe/_bank_account.py index 3f6dd73c8..49597e4ba 100644 --- a/stripe/_bank_account.py +++ b/stripe/_bank_account.py @@ -151,19 +151,19 @@ class Error(StripeObject): currently_due: Optional[List[str]] """ - Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. + Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled. """ errors: Optional[List[Error]] """ - Fields that are `currently_due` and need to be collected again because validation or verification failed. + Details about validation and verification failures for `due` requirements that must be resolved. """ past_due: Optional[List[str]] """ - Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account. + Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account. """ pending_verification: Optional[List[str]] """ - Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. + Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. """ _inner_class_types = {"errors": Error} @@ -282,19 +282,19 @@ class Error(StripeObject): currently_due: Optional[List[str]] """ - Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. + Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled. """ errors: Optional[List[Error]] """ - Fields that are `currently_due` and need to be collected again because validation or verification failed. + Details about validation and verification failures for `due` requirements that must be resolved. """ past_due: Optional[List[str]] """ - Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account. + Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account. """ pending_verification: Optional[List[str]] """ - Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. + Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. """ _inner_class_types = {"errors": Error} @@ -348,7 +348,7 @@ class Error(StripeObject): """ future_requirements: Optional[FutureRequirements] """ - Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when. + Information about the [upcoming new requirements for the bank account](https://docs.stripe.com/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when. """ id: str """ @@ -360,7 +360,7 @@ class Error(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["bank_account"] """ diff --git a/stripe/_capability.py b/stripe/_capability.py index 8e244eefd..e961576dc 100644 --- a/stripe/_capability.py +++ b/stripe/_capability.py @@ -13,7 +13,7 @@ class Capability(UpdateableAPIResource["Capability"]): """ This is an object representing a capability for a Stripe account. - Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities) + Related guide: [Account capabilities](https://docs.stripe.com/connect/account-capabilities) """ OBJECT_NAME: ClassVar[Literal["capability"]] = "capability" @@ -22,11 +22,11 @@ class FutureRequirements(StripeObject): class Alternative(StripeObject): alternative_fields_due: List[str] """ - Fields that can be provided to satisfy all fields in `original_fields_due`. + Fields that can be provided to resolve all fields in `original_fields_due`. """ original_fields_due: List[str] """ - Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. + Fields that are due and can be resolved by providing all fields in `alternative_fields_due`. """ class Error(StripeObject): @@ -143,7 +143,7 @@ class Error(StripeObject): alternatives: Optional[List[Alternative]] """ - Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields. """ current_deadline: Optional[int] """ @@ -151,7 +151,7 @@ class Error(StripeObject): """ currently_due: List[str] """ - Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. + Fields that need to be resolved to keep the capability enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. """ disabled_reason: Optional[ Literal[ @@ -172,7 +172,7 @@ class Error(StripeObject): """ errors: List[Error] """ - Fields that are `currently_due` and need to be collected again because validation or verification failed. + Details about validation and verification failures for `due` requirements that must be resolved. """ eventually_due: List[str] """ @@ -180,11 +180,11 @@ class Error(StripeObject): """ past_due: List[str] """ - Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. + Fields that haven't been resolved by `requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`. """ pending_verification: List[str] """ - Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. + Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. """ _inner_class_types = {"alternatives": Alternative, "errors": Error} @@ -192,11 +192,11 @@ class Requirements(StripeObject): class Alternative(StripeObject): alternative_fields_due: List[str] """ - Fields that can be provided to satisfy all fields in `original_fields_due`. + Fields that can be provided to resolve all fields in `original_fields_due`. """ original_fields_due: List[str] """ - Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. + Fields that are due and can be resolved by providing all fields in `alternative_fields_due`. """ class Error(StripeObject): @@ -313,7 +313,7 @@ class Error(StripeObject): alternatives: Optional[List[Alternative]] """ - Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields. """ current_deadline: Optional[int] """ @@ -321,7 +321,7 @@ class Error(StripeObject): """ currently_due: List[str] """ - Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled. + Fields that need to be resolved to keep the capability enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the capability is disabled. """ disabled_reason: Optional[ Literal[ @@ -338,11 +338,11 @@ class Error(StripeObject): ] ] """ - Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). + Description of why the capability is disabled. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification). """ errors: List[Error] """ - Fields that are `currently_due` and need to be collected again because validation or verification failed. + Details about validation and verification failures for `due` requirements that must be resolved. """ eventually_due: List[str] """ @@ -350,11 +350,11 @@ class Error(StripeObject): """ past_due: List[str] """ - Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account. + Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the capability on the account. """ pending_verification: List[str] """ - Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. + Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. """ _inner_class_types = {"alternatives": Alternative, "errors": Error} diff --git a/stripe/_card.py b/stripe/_card.py index 5936cc24f..ad341595d 100644 --- a/stripe/_card.py +++ b/stripe/_card.py @@ -22,7 +22,7 @@ class Card(DeletableAPIResource["Card"], UpdateableAPIResource["Card"]): later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. - Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards) + Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) """ OBJECT_NAME: ClassVar[Literal["card"]] = "card" @@ -146,7 +146,7 @@ class Networks(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ name: Optional[str] """ diff --git a/stripe/_cash_balance.py b/stripe/_cash_balance.py index 287e786a8..acd08a752 100644 --- a/stripe/_cash_balance.py +++ b/stripe/_cash_balance.py @@ -26,12 +26,16 @@ class Settings(StripeObject): available: Optional[Dict[str, int]] """ - A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ customer: str """ The ID of the customer whose cash balance this object represents. """ + customer_account: Optional[str] + """ + The ID of an Account representing a customer whose cash balance this object represents. + """ livemode: bool """ Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. diff --git a/stripe/_charge.py b/stripe/_charge.py index da3ce8661..5b29946d7 100644 --- a/stripe/_charge.py +++ b/stripe/_charge.py @@ -61,7 +61,7 @@ class Charge( ): """ The `Charge` object represents a single attempt to move money into your Stripe account. - PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://stripe.com/docs/connect/account-debits) may also create Charges. + PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://docs.stripe.com/connect/account-debits) may also create Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations. """ @@ -91,7 +91,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Optional[Address] @@ -162,7 +162,7 @@ class Rule(StripeObject): Literal["confirm_card_data", "do_not_try_again", "try_again_later"] ] """ - An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines). + An enumerated value providing a more detailed explanation on [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines). """ network_advice_code: Optional[str] """ @@ -174,11 +174,11 @@ class Rule(StripeObject): """ network_status: Optional[str] """ - Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement. + Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://docs.stripe.com/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement. """ reason: Optional[str] """ - An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges blocked because the payment is unlikely to be authorized have the value `low_probability_of_authorization`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details. + An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges blocked because the payment is unlikely to be authorized have the value `low_probability_of_authorization`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://docs.stripe.com/declines) for more details. """ risk_level: Optional[str] """ @@ -198,7 +198,7 @@ class Rule(StripeObject): """ type: str """ - Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details. + Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://docs.stripe.com/declines) and [Radar reviews](https://docs.stripe.com/radar/reviews) for details. """ _inner_class_types = {"rule": Rule} @@ -252,6 +252,10 @@ class AcssDebit(StripeObject): """ Name of the bank associated with the bank account. """ + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ fingerprint: Optional[str] """ Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. @@ -276,11 +280,11 @@ class AcssDebit(StripeObject): class Affirm(StripeObject): location: Optional[str] """ - ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to. + ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. """ reader: Optional[str] """ - ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on. + ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. """ transaction_id: Optional[str] """ @@ -372,6 +376,10 @@ class AuBecsDebit(StripeObject): """ Bank-State-Branch number of the bank account. """ + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ fingerprint: Optional[str] """ Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. @@ -386,6 +394,10 @@ class AuBecsDebit(StripeObject): """ class BacsDebit(StripeObject): + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ fingerprint: Optional[str] """ Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. @@ -627,7 +639,7 @@ class BillingAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class ShippingAddress(StripeObject): @@ -653,7 +665,7 @@ class ShippingAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ billing_address: Optional[BillingAddress] @@ -704,7 +716,7 @@ class BillingAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class ShippingAddress(StripeObject): @@ -730,7 +742,7 @@ class ShippingAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ billing_address: Optional[BillingAddress] @@ -843,7 +855,7 @@ class ShippingAddress(StripeObject): """ Installment details for this payment. - For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). + For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments). """ issuer: Optional[str] """ @@ -1018,7 +1030,7 @@ class Wallet(StripeObject): """ incremental_authorization_supported: bool """ - Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). + Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). """ issuer: Optional[str] """ @@ -1223,6 +1235,7 @@ class Ideal(StripeObject): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -1236,7 +1249,7 @@ class Ideal(StripeObject): ] ] """ - The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. + The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. """ bic: Optional[ Literal[ @@ -1250,6 +1263,7 @@ class Ideal(StripeObject): "HANDNL2A", "INGBNL2A", "KNABNL2H", + "MLLENL2A", "MOYONL21", "NNBANL2G", "NTSBDEB1", @@ -1585,6 +1599,10 @@ class NzBankAccount(StripeObject): """ The numeric code for the bank account's bank branch. """ + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ last4: str """ Last four digits of the bank account number. @@ -1661,11 +1679,11 @@ class Payco(StripeObject): class Paynow(StripeObject): location: Optional[str] """ - ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to. + ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. """ reader: Optional[str] """ - ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on. + ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. """ reference: Optional[str] """ @@ -1715,6 +1733,24 @@ class SellerProtection(StripeObject): """ _inner_class_types = {"seller_protection": SellerProtection} + class Payto(StripeObject): + bsb_number: Optional[str] + """ + Bank-State-Branch number of the bank account. + """ + last4: Optional[str] + """ + Last four digits of the bank account number. + """ + mandate: Optional[str] + """ + ID of the mandate used to make this payment. + """ + pay_id: Optional[str] + """ + The PayID alias for the bank account. + """ + class Pix(StripeObject): bank_transaction_id: Optional[str] """ @@ -1812,6 +1848,10 @@ class SepaDebit(StripeObject): """ Two-letter ISO code representing the country the bank account is located in. """ + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ fingerprint: Optional[str] """ Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. @@ -1822,7 +1862,7 @@ class SepaDebit(StripeObject): """ mandate: Optional[str] """ - Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve). + Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://docs.stripe.com/api/mandates/retrieve). """ class Sofort(StripeObject): @@ -1900,6 +1940,10 @@ class UsBankAccount(StripeObject): """ Name of the bank associated with the bank account. """ + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ fingerprint: Optional[str] """ Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. @@ -1931,11 +1975,11 @@ class WechatPay(StripeObject): """ location: Optional[str] """ - ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to. + ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. """ reader: Optional[str] """ - ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on. + ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. """ transaction_id: Optional[str] """ @@ -1986,6 +2030,7 @@ class Zip(StripeObject): payco: Optional[Payco] paynow: Optional[Paynow] paypal: Optional[Paypal] + payto: Optional[Payto] pix: Optional[Pix] promptpay: Optional[Promptpay] revolut_pay: Optional[RevolutPay] @@ -1999,7 +2044,7 @@ class Zip(StripeObject): twint: Optional[Twint] type: str """ - The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type) for the full list of possible types. + The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) for the full list of possible types. An additional hash is included on `payment_method_details` with a name matching this value. It contains information specific to the payment method. """ @@ -2049,6 +2094,7 @@ class Zip(StripeObject): "payco": Payco, "paynow": Paynow, "paypal": Paypal, + "payto": Payto, "pix": Pix, "promptpay": Promptpay, "revolut_pay": RevolutPay, @@ -2079,7 +2125,7 @@ class PresentmentDetails(StripeObject): class RadarOptions(StripeObject): session: Optional[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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ class Shipping(StripeObject): @@ -2106,7 +2152,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Optional[Address] @@ -2140,7 +2186,7 @@ class TransferData(StripeObject): amount: 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). + Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/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://docs.stripe.com/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). """ amount_captured: int """ @@ -2156,11 +2202,11 @@ class TransferData(StripeObject): """ application_fee: Optional[ExpandableField["ApplicationFee"]] """ - The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. + The application fee (if any) for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details. """ application_fee_amount: Optional[int] """ - The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. + The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details. """ authorization_code: Optional[str] """ @@ -2207,7 +2253,7 @@ class TransferData(StripeObject): """ failure_code: Optional[str] """ - Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes). + Error code explaining reason for charge failure if available (see [the errors section](https://docs.stripe.com/error-codes) for a list of codes). """ failure_message: Optional[str] """ @@ -2228,7 +2274,7 @@ class TransferData(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["charge"] """ @@ -2236,11 +2282,11 @@ class TransferData(StripeObject): """ on_behalf_of: Optional[ExpandableField["Account"]] """ - The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. + The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. """ outcome: Optional[Outcome] """ - Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details. + Details about whether the payment was accepted, and why. See [understanding declines](https://docs.stripe.com/declines) for details. """ paid: bool """ @@ -2261,7 +2307,7 @@ class TransferData(StripeObject): presentment_details: Optional[PresentmentDetails] radar_options: Optional[RadarOptions] """ - Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. """ receipt_email: Optional[str] """ @@ -2319,11 +2365,11 @@ class TransferData(StripeObject): """ transfer_data: Optional[TransferData] """ - 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. + An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. """ transfer_group: Optional[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. + A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. """ @classmethod diff --git a/stripe/_confirmation_token.py b/stripe/_confirmation_token.py index f4b62a6af..0e3d1a4f5 100644 --- a/stripe/_confirmation_token.py +++ b/stripe/_confirmation_token.py @@ -26,8 +26,8 @@ class ConfirmationToken(APIResource["ConfirmationToken"]): is successful, values present on the ConfirmationToken are written onto the Intent. To learn more about how to use ConfirmationToken, visit the related guides: - - [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server) - - [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation). + - [Finalize payments on the server](https://docs.stripe.com/payments/finalize-payments-on-the-server) + - [Build two-step confirmation](https://docs.stripe.com/payments/build-a-two-step-confirmation). """ OBJECT_NAME: ClassVar[Literal["confirmation_token"]] = "confirmation_token" @@ -193,7 +193,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Optional[Address] @@ -368,7 +368,7 @@ class Wallet(StripeObject): """ incremental_authorization_supported: bool """ - Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). + Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). """ issuer: Optional[str] """ @@ -497,7 +497,7 @@ class BillingAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class ShippingAddress(StripeObject): @@ -523,7 +523,7 @@ class ShippingAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ billing_address: Optional[BillingAddress] @@ -574,7 +574,7 @@ class BillingAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class ShippingAddress(StripeObject): @@ -600,7 +600,7 @@ class ShippingAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ billing_address: Optional[BillingAddress] @@ -948,6 +948,7 @@ class Ideal(StripeObject): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -961,7 +962,7 @@ class Ideal(StripeObject): ] ] """ - The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. + The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. """ bic: Optional[ Literal[ @@ -975,6 +976,7 @@ class Ideal(StripeObject): "HANDNL2A", "INGBNL2A", "KNABNL2H", + "MLLENL2A", "MOYONL21", "NNBANL2G", "NTSBDEB1", @@ -1248,6 +1250,20 @@ class Paypal(StripeObject): PayPal account PayerID. This identifier uniquely identifies the PayPal customer. """ + class Payto(StripeObject): + bsb_number: Optional[str] + """ + Bank-State-Branch number of the bank account. + """ + last4: Optional[str] + """ + Last four digits of the bank account number. + """ + pay_id: Optional[str] + """ + The PayID alias for the bank account. + """ + class Pix(StripeObject): pass @@ -1434,6 +1450,7 @@ class Zip(StripeObject): """ The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. """ + customer_account: Optional[str] customer_balance: Optional[CustomerBalance] eps: Optional[Eps] fpx: Optional[Fpx] @@ -1457,6 +1474,7 @@ class Zip(StripeObject): payco: Optional[Payco] paynow: Optional[Paynow] paypal: Optional[Paypal] + payto: Optional[Payto] pix: Optional[Pix] promptpay: Optional[Promptpay] revolut_pay: Optional[RevolutPay] @@ -1507,6 +1525,7 @@ class Zip(StripeObject): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -1567,6 +1586,7 @@ class Zip(StripeObject): "payco": Payco, "paynow": Paynow, "paypal": Paypal, + "payto": Payto, "pix": Pix, "promptpay": Promptpay, "revolut_pay": RevolutPay, @@ -1605,7 +1625,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Address @@ -1663,7 +1683,7 @@ class Address(StripeObject): """ Indicates that you intend to make future payments with this ConfirmationToken's payment method. - The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. + The presence of this property will [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. """ setup_intent: Optional[str] """ diff --git a/stripe/_coupon.py b/stripe/_coupon.py index 92bf85b7c..ef159f3f7 100644 --- a/stripe/_coupon.py +++ b/stripe/_coupon.py @@ -26,8 +26,8 @@ class Coupon( ): """ A coupon contains information about a percent-off or amount-off discount you - might want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices), - [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents). + might want to apply to a customer. Coupons may be applied to [subscriptions](https://api.stripe.com#subscriptions), [invoices](https://api.stripe.com#invoices), + [checkout sessions](https://docs.stripe.com/api/checkout/sessions), [quotes](https://api.stripe.com#quotes), and more. Coupons do not work with conventional one-off [charges](https://api.stripe.com#create_charge) or [payment intents](https://docs.stripe.com/api/payment_intents). """ OBJECT_NAME: ClassVar[Literal["coupon"]] = "coupon" @@ -87,7 +87,7 @@ class CurrencyOptions(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ name: Optional[str] """ diff --git a/stripe/_credit_note.py b/stripe/_credit_note.py index 2140bebd8..921d368a2 100644 --- a/stripe/_credit_note.py +++ b/stripe/_credit_note.py @@ -52,7 +52,7 @@ class CreditNote( """ Issue a credit note to adjust an invoice's amount after the invoice is finalized. - Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes) + Related guide: [Credit notes](https://docs.stripe.com/billing/invoices/credit-notes) """ OBJECT_NAME: ClassVar[Literal["credit_note"]] = "credit_note" @@ -180,6 +180,9 @@ class Tax(StripeObject): class TotalTax(StripeObject): class TaxRateDetails(StripeObject): tax_rate: str + """ + ID of the tax rate + """ amount: int """ @@ -244,6 +247,10 @@ class TaxRateDetails(StripeObject): """ ID of the customer. """ + customer_account: Optional[str] + """ + ID of the account representing the customer. + """ customer_balance_transaction: Optional[ ExpandableField["CustomerBalanceTransaction"] ] @@ -284,7 +291,7 @@ class TaxRateDetails(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ number: str """ @@ -332,7 +339,7 @@ class TaxRateDetails(StripeObject): """ status: Literal["issued", "void"] """ - Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). + Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://docs.stripe.com/billing/invoices/credit-notes#voiding). """ subtotal: int """ diff --git a/stripe/_credit_note_line_item.py b/stripe/_credit_note_line_item.py index 2fe476012..87c510da8 100644 --- a/stripe/_credit_note_line_item.py +++ b/stripe/_credit_note_line_item.py @@ -55,6 +55,9 @@ class PretaxCreditAmount(StripeObject): class Tax(StripeObject): class TaxRateDetails(StripeObject): tax_rate: str + """ + ID of the tax rate + """ amount: int """ diff --git a/stripe/_customer.py b/stripe/_customer.py index cdb343ef0..5c3e48163 100644 --- a/stripe/_customer.py +++ b/stripe/_customer.py @@ -127,7 +127,7 @@ class Customer( UpdateableAPIResource["Customer"], ): """ - This object represents a customer of your business. Use it to [create recurring charges](https://stripe.com/docs/invoicing/customer), [save payment](https://stripe.com/docs/payments/save-during-payment) and contact information, + This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. """ @@ -156,7 +156,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class InvoiceSettings(StripeObject): @@ -225,7 +225,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Optional[Address] @@ -293,7 +293,7 @@ class Location(StripeObject): """ balance: Optional[int] """ - The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance). + The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance). """ business_name: Optional[str] """ @@ -311,13 +311,17 @@ class Location(StripeObject): """ Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. """ + customer_account: Optional[str] + """ + The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter. + """ default_source: Optional[ ExpandableField[Union["Account", "BankAccount", "Card", "Source"]] ] """ ID of the default payment source for the customer. - If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead. + If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead. """ deleted: Optional[Literal[True]] """ @@ -327,7 +331,7 @@ class Location(StripeObject): """ Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`. - If an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`. + If an invoice becomes uncollectible by [dunning](https://docs.stripe.com/billing/automatic-collection), `delinquent` doesn't reset to `false`. If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`. """ @@ -366,7 +370,7 @@ class Location(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ name: Optional[str] """ diff --git a/stripe/_customer_balance_transaction.py b/stripe/_customer_balance_transaction.py index 9ace24801..dafe4b81b 100644 --- a/stripe/_customer_balance_transaction.py +++ b/stripe/_customer_balance_transaction.py @@ -15,12 +15,12 @@ class CustomerBalanceTransaction(APIResource["CustomerBalanceTransaction"]): """ - Each customer has a [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) value, + Each customer has a [Balance](https://docs.stripe.com/api/customers/object#customer_object-balance) value, which denotes a debit or credit that's automatically applied to their next invoice upon finalization. - You may modify the value directly by using the [update customer API](https://stripe.com/docs/api/customers/update), + You may modify the value directly by using the [update customer API](https://docs.stripe.com/api/customers/update), or by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`. - Related guide: [Customer balance](https://stripe.com/docs/billing/customer/balance) + Related guide: [Customer balance](https://docs.stripe.com/billing/customer/balance) """ OBJECT_NAME: ClassVar[Literal["customer_balance_transaction"]] = ( @@ -50,6 +50,10 @@ class CustomerBalanceTransaction(APIResource["CustomerBalanceTransaction"]): """ The ID of the customer the transaction belongs to. """ + customer_account: Optional[str] + """ + The ID of an Account representing a customer that the transaction belongs to. + """ description: Optional[str] """ An arbitrary string attached to the object. Often useful for displaying to users. @@ -72,7 +76,7 @@ class CustomerBalanceTransaction(APIResource["CustomerBalanceTransaction"]): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["customer_balance_transaction"] """ @@ -93,7 +97,7 @@ class CustomerBalanceTransaction(APIResource["CustomerBalanceTransaction"]): "unspent_receiver_credit", ] """ - Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, `unapplied_from_invoice`, `checkout_session_subscription_payment`, or `checkout_session_subscription_payment_canceled`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types. + Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, `unapplied_from_invoice`, `checkout_session_subscription_payment`, or `checkout_session_subscription_payment_canceled`. See the [Customer Balance page](https://docs.stripe.com/billing/customer/balance#types) to learn more about transaction types. """ def instance_url(self): diff --git a/stripe/_customer_cash_balance_transaction.py b/stripe/_customer_cash_balance_transaction.py index 64db2470e..e2aba6550 100644 --- a/stripe/_customer_cash_balance_transaction.py +++ b/stripe/_customer_cash_balance_transaction.py @@ -27,17 +27,17 @@ class CustomerCashBalanceTransaction(StripeObject): class AdjustedForOverdraft(StripeObject): balance_transaction: ExpandableField["BalanceTransaction"] """ - The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance. + The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance. """ linked_transaction: ExpandableField["CustomerCashBalanceTransaction"] """ - The [Cash Balance Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds. + The [Cash Balance Transaction](https://docs.stripe.com/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds. """ class AppliedToPayment(StripeObject): payment_intent: ExpandableField["PaymentIntent"] """ - The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were applied to. + The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were applied to. """ class Funded(StripeObject): @@ -125,19 +125,19 @@ class UsBankTransfer(StripeObject): class RefundedFromPayment(StripeObject): refund: ExpandableField["Refund"] """ - The [Refund](https://stripe.com/docs/api/refunds/object) that moved these funds into the customer's cash balance. + The [Refund](https://docs.stripe.com/api/refunds/object) that moved these funds into the customer's cash balance. """ class TransferredToBalance(StripeObject): balance_transaction: ExpandableField["BalanceTransaction"] """ - The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance. + The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance. """ class UnappliedFromPayment(StripeObject): payment_intent: ExpandableField["PaymentIntent"] """ - The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were unapplied from. + The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were unapplied from. """ adjusted_for_overdraft: Optional[AdjustedForOverdraft] @@ -154,9 +154,13 @@ class UnappliedFromPayment(StripeObject): """ The customer whose available cash balance changed as a result of this transaction. """ + customer_account: Optional[str] + """ + The ID of an Account representing a customer whose available cash balance changed as a result of this transaction. + """ ending_balance: int """ - The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ funded: Optional[Funded] id: str @@ -169,7 +173,7 @@ class UnappliedFromPayment(StripeObject): """ net_amount: int """ - The amount by which the cash balance changed, represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance. + The amount by which the cash balance changed, represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance. """ object: Literal["customer_cash_balance_transaction"] """ @@ -189,7 +193,7 @@ class UnappliedFromPayment(StripeObject): "unapplied_from_payment", ] """ - The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://stripe.com/docs/payments/customer-balance#types) to learn more about these types. + The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://docs.stripe.com/payments/customer-balance#types) to learn more about these types. """ unapplied_from_payment: Optional[UnappliedFromPayment] _inner_class_types = { diff --git a/stripe/_customer_session.py b/stripe/_customer_session.py index b73d0a29c..581274e47 100644 --- a/stripe/_customer_session.py +++ b/stripe/_customer_session.py @@ -207,6 +207,10 @@ class PricingTable(StripeObject): """ The Customer the Customer Session was created for. """ + customer_account: Optional[str] + """ + The Account that the Customer Session was created for. + """ expires_at: int """ The timestamp at which this Customer Session will expire. diff --git a/stripe/_discount.py b/stripe/_discount.py index 1cd39b58a..1637edc79 100644 --- a/stripe/_discount.py +++ b/stripe/_discount.py @@ -13,10 +13,10 @@ class Discount(StripeObject): """ - A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes). + A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. - Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts) + Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) """ OBJECT_NAME: ClassVar[Literal["discount"]] = "discount" @@ -39,6 +39,10 @@ class Source(StripeObject): """ The ID of the customer associated with this discount. """ + customer_account: Optional[str] + """ + The ID of the account representing the customer associated with this discount. + """ deleted: Optional[Literal[True]] """ Always true for a deleted object diff --git a/stripe/_dispute.py b/stripe/_dispute.py index 9c519b4a7..2109b7de4 100644 --- a/stripe/_dispute.py +++ b/stripe/_dispute.py @@ -28,7 +28,7 @@ class Dispute( When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate. - Related guide: [Disputes and fraud](https://stripe.com/docs/disputes) + Related guide: [Disputes and fraud](https://docs.stripe.com/disputes) """ OBJECT_NAME: ClassVar[Literal["dispute"]] = "dispute" @@ -60,7 +60,7 @@ class ShippingAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ customer_account_id: Optional[str] @@ -123,7 +123,7 @@ class ShippingAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ charge: str @@ -453,7 +453,7 @@ class Paypal(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ network_reason_code: Optional[str] """ @@ -470,7 +470,7 @@ class Paypal(StripeObject): payment_method_details: Optional[PaymentMethodDetails] reason: str """ - Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories). + Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://docs.stripe.com/disputes/categories). """ status: Literal[ "lost", diff --git a/stripe/_event.py b/stripe/_event.py index c876e32b3..e203bf164 100644 --- a/stripe/_event.py +++ b/stripe/_event.py @@ -39,7 +39,7 @@ class Event(ListableAPIResource["Event"]): class Data(StripeObject): object: Dict[str, "Any"] """ - Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key. + Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://api.stripe.com#invoice_object) as the value of the object key. """ previous_attributes: Optional[Dict[str, "Any"]] """ diff --git a/stripe/_exchange_rate.py b/stripe/_exchange_rate.py index 4e7bdfff4..1414c522f 100644 --- a/stripe/_exchange_rate.py +++ b/stripe/_exchange_rate.py @@ -23,13 +23,13 @@ class ExchangeRate(ListableAPIResource["ExchangeRate"]): rate (for example, to dynamically price an item for a user with a default payment in a foreign currency). - Please refer to our [Exchange Rates API](https://stripe.com/docs/fx-rates) guide for more details. + Please refer to our [Exchange Rates API](https://docs.stripe.com/fx-rates) guide for more details. *[Note: this integration path is supported but no longer recommended]* Additionally, you can guarantee that a charge is made with an exchange rate that you expect is current. To do so, you must pass in the exchange_rate to charges endpoints. If the value is no longer up to date, the charge won't go through. Please refer to our - [Using with charges](https://stripe.com/docs/exchange-rates) guide for more details. + [Using with charges](https://docs.stripe.com/exchange-rates) guide for more details. ----- diff --git a/stripe/_file.py b/stripe/_file.py index 78a817632..c20e8ec31 100644 --- a/stripe/_file.py +++ b/stripe/_file.py @@ -16,12 +16,12 @@ class File(CreateableAPIResource["File"], ListableAPIResource["File"]): """ This object represents files hosted on Stripe's servers. You can upload - files with the [create file](https://stripe.com/docs/api#create_file) request + files with the [create file](https://api.stripe.com#create_file) request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a [Sigma scheduled query](https://docs.stripe.com/api#scheduled_queries)). - Related guide: [File upload guide](https://stripe.com/docs/file-upload) + Related guide: [File upload guide](https://docs.stripe.com/file-upload) """ OBJECT_NAME: ClassVar[Literal["file"]] = "file" @@ -43,7 +43,7 @@ class File(CreateableAPIResource["File"], ListableAPIResource["File"]): """ links: Optional[ListObject["FileLink"]] """ - A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. + A list of [file links](https://api.stripe.com#file_links) that point at this file. """ object: Literal["file"] """ @@ -71,7 +71,7 @@ class File(CreateableAPIResource["File"], ListableAPIResource["File"]): "terminal_reader_splashscreen", ] """ - The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. + The [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file. """ size: int """ diff --git a/stripe/_file_link.py b/stripe/_file_link.py index d72e14894..620bede1d 100644 --- a/stripe/_file_link.py +++ b/stripe/_file_link.py @@ -55,7 +55,7 @@ class FileLink( """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["file_link"] """ diff --git a/stripe/_funding_instructions.py b/stripe/_funding_instructions.py index 2ca103b74..5e7841e77 100644 --- a/stripe/_funding_instructions.py +++ b/stripe/_funding_instructions.py @@ -7,11 +7,11 @@ class FundingInstructions(StripeObject): """ - Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is + Each customer has a [`balance`](https://docs.stripe.com/api/customers/object#customer_object-balance) that is automatically applied to future invoices and payments using the `customer_balance` payment method. Customers can fund this balance by initiating a bank transfer to any account in the `financial_addresses` field. - Related guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions) + Related guide: [Customer balance funding instructions](https://docs.stripe.com/payments/customer-balance/funding-instructions) """ OBJECT_NAME: ClassVar[Literal["funding_instructions"]] = ( @@ -44,7 +44,7 @@ class AccountHolderAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class BankAddress(StripeObject): @@ -70,7 +70,7 @@ class BankAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ account_holder_address: AccountHolderAddress @@ -124,7 +124,7 @@ class AccountHolderAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class BankAddress(StripeObject): @@ -150,7 +150,7 @@ class BankAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ account_holder_address: AccountHolderAddress @@ -200,7 +200,7 @@ class AccountHolderAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class BankAddress(StripeObject): @@ -226,7 +226,7 @@ class BankAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ account_holder_address: AccountHolderAddress @@ -272,7 +272,7 @@ class AccountHolderAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class BankAddress(StripeObject): @@ -298,7 +298,7 @@ class BankAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ account_holder_address: AccountHolderAddress @@ -348,7 +348,7 @@ class AccountHolderAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class BankAddress(StripeObject): @@ -374,7 +374,7 @@ class BankAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ account_holder_address: AccountHolderAddress @@ -428,7 +428,7 @@ class AccountHolderAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class BankAddress(StripeObject): @@ -454,7 +454,7 @@ class BankAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ account_holder_address: AccountHolderAddress diff --git a/stripe/_invoice.py b/stripe/_invoice.py index 8bb7ed6a5..35b6320a1 100644 --- a/stripe/_invoice.py +++ b/stripe/_invoice.py @@ -92,13 +92,13 @@ class Invoice( Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription. - They contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments + They contain [invoice items](https://api.stripe.com#invoiceitems), and proration adjustments that may be caused by subscription upgrades/downgrades (if necessary). If your invoice is configured to be billed through automatic charges, Stripe automatically finalizes your invoice and attempts payment. Note that finalizing the invoice, - [when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does + [when automatic](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection), does not happen immediately as the invoice is created. Stripe waits until one hour after the last webhook was successfully sent (or the last webhook timed out after failing). If you (and the platforms you may have @@ -118,9 +118,9 @@ class Invoice( customer's credit balance which is applied to the next invoice. More details on the customer's credit balance are - [here](https://stripe.com/docs/billing/customer/balance). + [here](https://docs.stripe.com/billing/customer/balance). - Related guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending) + Related guide: [Send invoices to customers](https://docs.stripe.com/billing/invoices/sending) """ OBJECT_NAME: ClassVar[Literal["invoice"]] = "invoice" @@ -147,7 +147,7 @@ class Liability(StripeObject): """ enabled: bool """ - Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. + Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. """ liability: Optional[Liability] """ @@ -208,7 +208,7 @@ class CustomerAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class CustomerShipping(StripeObject): @@ -235,7 +235,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Optional[Address] @@ -402,7 +402,7 @@ class Issuer(StripeObject): class LastFinalizationError(StripeObject): advice_code: Optional[str] """ - For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one. + For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one. """ charge: Optional[str] """ @@ -416,6 +416,7 @@ class LastFinalizationError(StripeObject): "account_information_mismatch", "account_invalid", "account_number_invalid", + "account_token_required_for_v2_account", "acss_debit_session_incomplete", "alipay_upgrade_required", "amount_too_large", @@ -594,15 +595,15 @@ class LastFinalizationError(StripeObject): ] ] """ - For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. + For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported. """ decline_code: Optional[str] """ - For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one. + For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one. """ doc_url: Optional[str] """ - A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. + A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported. """ message: Optional[str] """ @@ -628,19 +629,19 @@ class LastFinalizationError(StripeObject): see the history of payment attempts for a particular session. A PaymentIntent transitions through - [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses) + [multiple statuses](https://docs.stripe.com/payments/paymentintents/lifecycle) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. - Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents) + Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents) """ payment_method: Optional["PaymentMethod"] """ PaymentMethod objects represent your customer's payment instruments. - You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to + You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. - Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). + Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). """ payment_method_type: Optional[str] """ @@ -654,7 +655,7 @@ class LastFinalizationError(StripeObject): """ A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. - Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow. + Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow. Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. @@ -665,9 +666,9 @@ class LastFinalizationError(StripeObject): For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents). - If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), + If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer), it automatically attaches the resulting payment method to that Customer after successful setup. - We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on + We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods. By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. @@ -697,7 +698,7 @@ class QuoteDetails(StripeObject): class SubscriptionDetails(StripeObject): metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. *Note: This attribute is populated only for invoices created on or after June 29, 2023.* """ subscription: ExpandableField["Subscription"] @@ -762,7 +763,7 @@ class Installments(StripeObject): 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. + 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ _inner_class_types = {"installments": Installments} @@ -791,6 +792,38 @@ class EuBankTransfer(StripeObject): class Konbini(StripeObject): pass + class Payto(StripeObject): + class MandateOptions(StripeObject): + amount: Optional[int] + """ + The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit. + """ + amount_type: Optional[Literal["fixed", "maximum"]] + """ + Only `maximum` is supported. + """ + purpose: Optional[ + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + + mandate_options: Optional[MandateOptions] + _inner_class_types = {"mandate_options": MandateOptions} + class SepaDebit(StripeObject): pass @@ -857,6 +890,10 @@ class Filters(StripeObject): """ If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent. """ + payto: Optional[Payto] + """ + If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice's PaymentIntent. + """ sepa_debit: Optional[SepaDebit] """ If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent. @@ -871,6 +908,7 @@ class Filters(StripeObject): "card": Card, "customer_balance": CustomerBalance, "konbini": Konbini, + "payto": Payto, "sepa_debit": SepaDebit, "us_bank_account": UsBankAccount, } @@ -918,6 +956,7 @@ class Filters(StripeObject): "payco", "paynow", "paypal", + "payto", "promptpay", "revolut_pay", "sepa_credit_transfer", @@ -1044,7 +1083,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Optional[Address] @@ -1138,6 +1177,9 @@ class TotalPretaxCreditAmount(StripeObject): class TotalTax(StripeObject): class TaxRateDetails(StripeObject): tax_rate: str + """ + ID of the tax rate + """ amount: int """ @@ -1228,7 +1270,7 @@ class TaxRateDetails(StripeObject): """ auto_advance: Optional[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. + Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. """ automatic_tax: AutomaticTax automatically_finalizes_at: Optional[int] @@ -1281,7 +1323,11 @@ class TaxRateDetails(StripeObject): """ customer: Optional[ExpandableField["Customer"]] """ - The ID of the customer who will be billed. + The ID of the customer to bill. + """ + customer_account: Optional[str] + """ + The ID of the account representing the customer to bill. """ customer_address: Optional[CustomerAddress] """ @@ -1357,7 +1403,7 @@ class TaxRateDetails(StripeObject): """ from_invoice: Optional[FromInvoice] """ - Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details. + Details of the invoice that was cloned. See the [revision documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details. """ hosted_invoice_url: Optional[str] """ @@ -1390,7 +1436,7 @@ class TaxRateDetails(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ next_payment_attempt: Optional[int] """ @@ -1406,7 +1452,7 @@ class TaxRateDetails(StripeObject): """ on_behalf_of: Optional[ExpandableField["Account"]] """ - 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. + 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://docs.stripe.com/billing/invoices/connect) documentation for details. """ parent: Optional[Parent] """ @@ -1459,7 +1505,7 @@ class TaxRateDetails(StripeObject): """ status: Optional[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) + The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview) """ status_transitions: StatusTransitions subtotal: int @@ -1497,7 +1543,7 @@ class TaxRateDetails(StripeObject): """ webhooks_delivered_at: Optional[int] """ - Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created. + Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://docs.stripe.com/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created. """ @classmethod diff --git a/stripe/_invoice_item.py b/stripe/_invoice_item.py index ab1b503e6..6fe83f387 100644 --- a/stripe/_invoice_item.py +++ b/stripe/_invoice_item.py @@ -15,6 +15,7 @@ from stripe._customer import Customer from stripe._discount import Discount from stripe._invoice import Invoice + from stripe._price import Price from stripe._tax_rate import TaxRate from stripe.params._invoice_item_create_params import ( InvoiceItemCreateParams, @@ -39,14 +40,14 @@ class InvoiceItem( UpdateableAPIResource["InvoiceItem"], ): """ - Invoice Items represent the component lines of an [invoice](https://stripe.com/docs/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://stripe.com/docs/api/invoices/line_item) within [invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines). + Invoice Items represent the component lines of an [invoice](https://docs.stripe.com/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://docs.stripe.com/api/invoices/line_item) within [invoice.lines](https://docs.stripe.com/api/invoices/object#invoice_object-lines). Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined - with a [subscription](https://stripe.com/docs/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge + with a [subscription](https://docs.stripe.com/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge or credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals. - Related guides: [Integrate with the Invoicing API](https://stripe.com/docs/invoicing/integration), [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items). + Related guides: [Integrate with the Invoicing API](https://docs.stripe.com/invoicing/integration), [Subscription Invoices](https://docs.stripe.com/billing/invoices/subscription#adding-upcoming-invoice-items). """ OBJECT_NAME: ClassVar[Literal["invoiceitem"]] = "invoiceitem" @@ -84,7 +85,7 @@ class Period(StripeObject): class Pricing(StripeObject): class PriceDetails(StripeObject): - price: str + price: ExpandableField["Price"] """ The ID of the price this item is associated with. """ @@ -131,7 +132,11 @@ class DiscountAmount(StripeObject): """ customer: ExpandableField["Customer"] """ - The ID of the customer who will be billed when this invoice item is billed. + The ID of the customer to bill for this invoice item. + """ + customer_account: Optional[str] + """ + The ID of the account to bill for this invoice item. """ date: int """ @@ -167,7 +172,7 @@ class DiscountAmount(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ net_amount: Optional[int] """ diff --git a/stripe/_invoice_item_service.py b/stripe/_invoice_item_service.py index 1b8a8098c..975b632c3 100644 --- a/stripe/_invoice_item_service.py +++ b/stripe/_invoice_item_service.py @@ -197,7 +197,7 @@ async def list_async( def create( self, - params: "InvoiceItemCreateParams", + params: Optional["InvoiceItemCreateParams"] = None, options: Optional["RequestOptions"] = None, ) -> "InvoiceItem": """ @@ -216,7 +216,7 @@ def create( async def create_async( self, - params: "InvoiceItemCreateParams", + params: Optional["InvoiceItemCreateParams"] = None, options: Optional["RequestOptions"] = None, ) -> "InvoiceItem": """ diff --git a/stripe/_invoice_line_item.py b/stripe/_invoice_line_item.py index b14627234..edcfcf2fe 100644 --- a/stripe/_invoice_line_item.py +++ b/stripe/_invoice_line_item.py @@ -9,6 +9,7 @@ if TYPE_CHECKING: from stripe._discount import Discount + from stripe._price import Price from stripe._subscription import Subscription from stripe.billing._credit_balance_transaction import ( CreditBalanceTransaction, @@ -17,9 +18,9 @@ class InvoiceLineItem(UpdateableAPIResource["InvoiceLineItem"]): """ - Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice. + Invoice Line Items represent the individual lines within an [invoice](https://docs.stripe.com/api/invoices) and only exist within the context of an invoice. - Each line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items). + Each line item is backed by either an [invoice item](https://docs.stripe.com/api/invoiceitems) or a [subscription item](https://docs.stripe.com/api/subscription_items). """ OBJECT_NAME: ClassVar[Literal["line_item"]] = "line_item" @@ -160,7 +161,7 @@ class PretaxCreditAmount(StripeObject): class Pricing(StripeObject): class PriceDetails(StripeObject): - price: str + price: ExpandableField["Price"] """ The ID of the price this item is associated with. """ @@ -183,6 +184,9 @@ class PriceDetails(StripeObject): class Tax(StripeObject): class TaxRateDetails(StripeObject): tax_rate: str + """ + ID of the tax rate + """ amount: int """ @@ -265,7 +269,7 @@ class TaxRateDetails(StripeObject): """ metadata: 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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation. """ object: Literal["line_item"] """ @@ -289,6 +293,10 @@ class TaxRateDetails(StripeObject): The quantity of the subscription, if the line item is a subscription or a proration. """ subscription: Optional[ExpandableField["Subscription"]] + subtotal: int + """ + The subtotal of the line item, in cents (or local equivalent), before any discounts or taxes. + """ taxes: Optional[List[Tax]] """ The tax information of the line item. diff --git a/stripe/_invoice_payment.py b/stripe/_invoice_payment.py index a66e08069..2ae5a43a2 100644 --- a/stripe/_invoice_payment.py +++ b/stripe/_invoice_payment.py @@ -24,7 +24,7 @@ class InvoicePayment(ListableAPIResource["InvoicePayment"]): """ Invoice Payments represent payments made against invoices. Invoice Payments can be accessed in two ways: - 1. By expanding the `payments` field on the [Invoice](https://stripe.com/docs/api#invoice) resource. + 1. By expanding the `payments` field on the [Invoice](https://api.stripe.com#invoice) resource. 2. By using the Invoice Payment retrieve and list endpoints. Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices. diff --git a/stripe/_invoice_rendering_template.py b/stripe/_invoice_rendering_template.py index 93965201c..3991ec483 100644 --- a/stripe/_invoice_rendering_template.py +++ b/stripe/_invoice_rendering_template.py @@ -46,7 +46,7 @@ class InvoiceRenderingTemplate( """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ nickname: Optional[str] """ diff --git a/stripe/_line_item.py b/stripe/_line_item.py index 1df60f0aa..87109379a 100644 --- a/stripe/_line_item.py +++ b/stripe/_line_item.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # File generated from our OpenAPI spec from stripe._stripe_object import StripeObject -from typing import ClassVar, List, Optional +from typing import ClassVar, Dict, List, Optional from typing_extensions import Literal, TYPE_CHECKING if TYPE_CHECKING: @@ -24,10 +24,10 @@ class Discount(StripeObject): """ discount: "DiscountResource" """ - A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes). + A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. - Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts) + Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) """ class Tax(StripeObject): @@ -100,6 +100,10 @@ class Tax(StripeObject): """ Unique identifier for the object. """ + metadata: Optional[Dict[str, str]] + """ + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + """ object: Literal["item"] """ String representing the object's type. Objects of the same type share the same value. diff --git a/stripe/_login_link.py b/stripe/_login_link.py index d3cc679d6..cbe2ae3cb 100644 --- a/stripe/_login_link.py +++ b/stripe/_login_link.py @@ -8,7 +8,7 @@ class LoginLink(StripeObject): """ Login Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard. - A Login Link differs from an [Account Link](https://stripe.com/docs/api/account_links) in that it takes the user directly to their [Express dashboard for the specified account](https://stripe.com/docs/connect/integrate-express-dashboard#create-login-link) + A Login Link differs from an [Account Link](https://docs.stripe.com/api/account_links) in that it takes the user directly to their [Express dashboard for the specified account](https://docs.stripe.com/connect/integrate-express-dashboard#create-login-link) """ OBJECT_NAME: ClassVar[Literal["login_link"]] = "login_link" diff --git a/stripe/_mandate.py b/stripe/_mandate.py index 41cdf5f64..2cb297715 100644 --- a/stripe/_mandate.py +++ b/stripe/_mandate.py @@ -137,6 +137,59 @@ class Paypal(StripeObject): PayPal account PayerID. This identifier uniquely identifies the PayPal customer. """ + class Payto(StripeObject): + amount: Optional[int] + """ + Amount that will be collected. It is required when `amount_type` is `fixed`. + """ + amount_type: 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. Defaults to `maximum`. + """ + end_date: Optional[str] + """ + Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. + """ + payment_schedule: Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] + """ + The periodicity at which payments will be collected. Defaults to `adhoc`. + """ + payments_per_period: Optional[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: Optional[ + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + start_date: Optional[str] + """ + Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. + """ + class RevolutPay(StripeObject): pass @@ -169,6 +222,7 @@ class UsBankAccount(StripeObject): naver_pay: Optional[NaverPay] nz_bank_account: Optional[NzBankAccount] paypal: Optional[Paypal] + payto: Optional[Payto] revolut_pay: Optional[RevolutPay] sepa_debit: Optional[SepaDebit] type: str @@ -190,6 +244,7 @@ class UsBankAccount(StripeObject): "naver_pay": NaverPay, "nz_bank_account": NzBankAccount, "paypal": Paypal, + "payto": Payto, "revolut_pay": RevolutPay, "sepa_debit": SepaDebit, "us_bank_account": UsBankAccount, diff --git a/stripe/_object_classes.py b/stripe/_object_classes.py index 5b3e63507..a3e382179 100644 --- a/stripe/_object_classes.py +++ b/stripe/_object_classes.py @@ -329,6 +329,17 @@ "stripe.v2.billing._meter_event_session", "MeterEventSession", ), + "v2.core.account": ("stripe.v2.core._account", "Account"), + "v2.core.account_link": ("stripe.v2.core._account_link", "AccountLink"), + "v2.core.account_person": ( + "stripe.v2.core._account_person", + "AccountPerson", + ), + "v2.core.account_person_token": ( + "stripe.v2.core._account_person_token", + "AccountPersonToken", + ), + "v2.core.account_token": ("stripe.v2.core._account_token", "AccountToken"), "v2.core.event": ("stripe.v2.core._event", "Event"), "v2.core.event_destination": ( "stripe.v2.core._event_destination", diff --git a/stripe/_payment_attempt_record.py b/stripe/_payment_attempt_record.py index bc1bef3eb..95c44c9ca 100644 --- a/stripe/_payment_attempt_record.py +++ b/stripe/_payment_attempt_record.py @@ -37,7 +37,7 @@ class Amount(StripeObject): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ class AmountAuthorized(StripeObject): @@ -47,7 +47,7 @@ class AmountAuthorized(StripeObject): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ class AmountCanceled(StripeObject): @@ -57,7 +57,7 @@ class AmountCanceled(StripeObject): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ class AmountFailed(StripeObject): @@ -67,7 +67,7 @@ class AmountFailed(StripeObject): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ class AmountGuaranteed(StripeObject): @@ -77,7 +77,7 @@ class AmountGuaranteed(StripeObject): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ class AmountRefunded(StripeObject): @@ -87,7 +87,7 @@ class AmountRefunded(StripeObject): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ class AmountRequested(StripeObject): @@ -97,7 +97,7 @@ class AmountRequested(StripeObject): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ class CustomerDetails(StripeObject): @@ -168,6 +168,10 @@ class AcssDebit(StripeObject): """ Name of the bank associated with the bank account. """ + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ fingerprint: Optional[str] """ Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. @@ -192,11 +196,11 @@ class AcssDebit(StripeObject): class Affirm(StripeObject): location: Optional[str] """ - ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to. + ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. """ reader: Optional[str] """ - ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on. + ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. """ transaction_id: Optional[str] """ @@ -288,6 +292,10 @@ class AuBecsDebit(StripeObject): """ Bank-State-Branch number of the bank account. """ + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ fingerprint: Optional[str] """ Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. @@ -302,6 +310,10 @@ class AuBecsDebit(StripeObject): """ class BacsDebit(StripeObject): + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ fingerprint: Optional[str] """ Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. @@ -385,7 +397,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Address @@ -430,6 +442,24 @@ class Checks(StripeObject): Literal["fail", "pass", "unavailable", "unchecked"] ] + class Installments(StripeObject): + class Plan(StripeObject): + count: Optional[int] + """ + For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. + """ + interval: Optional[Literal["month"]] + """ + For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. One of `month`. + """ + type: Literal["bonus", "fixed_count", "revolving"] + """ + Type of installment plan, one of `fixed_count`, `revolving`, or `bonus`. + """ + + plan: Optional[Plan] + _inner_class_types = {"plan": Plan} + class NetworkToken(StripeObject): used: bool """ @@ -488,6 +518,10 @@ class GooglePay(StripeObject): "google_pay": GooglePay, } + authorization_code: Optional[str] + """ + The authorization code of the payment. + """ brand: Literal[ "amex", "cartes_bancaires", @@ -517,6 +551,10 @@ class GooglePay(StripeObject): """ Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. """ + description: Optional[str] + """ + A high-level description of the type of cards issued in this range. + """ exp_month: int """ Two-digit number representing the card's expiration month. @@ -535,6 +573,18 @@ class GooglePay(StripeObject): """ Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. """ + iin: Optional[str] + """ + Issuer identification number of the card. + """ + installments: Optional[Installments] + """ + Installment details for this payment. + """ + issuer: Optional[str] + """ + The name of the card's issuing bank. + """ last4: str """ The last four digits of the card. @@ -562,6 +612,14 @@ class GooglePay(StripeObject): """ Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. """ + network_advice_code: Optional[str] + """ + Advice code from the card network for the failed payment. + """ + network_decline_code: Optional[str] + """ + Decline code from the card network for the failed payment. + """ network_token: Optional[NetworkToken] """ If this card has network token credentials, this contains the details of the network token credentials. @@ -570,6 +628,12 @@ class GooglePay(StripeObject): """ This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. """ + stored_credential_usage: Optional[ + Literal["recurring", "unscheduled"] + ] + """ + The transaction type that was passed for an off-session, Merchant-Initiated transaction, one of `recurring` or `unscheduled`. + """ three_d_secure: Optional[ThreeDSecure] """ Populated if this transaction used 3D Secure authentication. @@ -580,6 +644,7 @@ class GooglePay(StripeObject): """ _inner_class_types = { "checks": Checks, + "installments": Installments, "network_token": NetworkToken, "three_d_secure": ThreeDSecure, "wallet": Wallet, @@ -704,7 +769,7 @@ class Wallet(StripeObject): """ incremental_authorization_supported: bool """ - Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). + Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). """ issuer: Optional[str] """ @@ -919,6 +984,7 @@ class Ideal(StripeObject): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -932,7 +998,7 @@ class Ideal(StripeObject): ] ] """ - The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. + The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. """ bic: Optional[ Literal[ @@ -946,6 +1012,7 @@ class Ideal(StripeObject): "HANDNL2A", "INGBNL2A", "KNABNL2H", + "MLLENL2A", "MOYONL21", "NNBANL2G", "NTSBDEB1", @@ -1281,6 +1348,10 @@ class NzBankAccount(StripeObject): """ The numeric code for the bank account's bank branch. """ + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ last4: str """ Last four digits of the bank account number. @@ -1357,11 +1428,11 @@ class Payco(StripeObject): class Paynow(StripeObject): location: Optional[str] """ - ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to. + ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. """ reader: Optional[str] """ - ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on. + ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. """ reference: Optional[str] """ @@ -1411,6 +1482,24 @@ class SellerProtection(StripeObject): """ _inner_class_types = {"seller_protection": SellerProtection} + class Payto(StripeObject): + bsb_number: Optional[str] + """ + Bank-State-Branch number of the bank account. + """ + last4: Optional[str] + """ + Last four digits of the bank account number. + """ + mandate: Optional[str] + """ + ID of the mandate used to make this payment. + """ + pay_id: Optional[str] + """ + The PayID alias for the bank account. + """ + class Pix(StripeObject): bank_transaction_id: Optional[str] """ @@ -1508,6 +1597,10 @@ class SepaDebit(StripeObject): """ Two-letter ISO code representing the country the bank account is located in. """ + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ fingerprint: Optional[str] """ Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. @@ -1518,7 +1611,7 @@ class SepaDebit(StripeObject): """ mandate: Optional[str] """ - Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve). + Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://docs.stripe.com/api/mandates/retrieve). """ class Sofort(StripeObject): @@ -1596,6 +1689,10 @@ class UsBankAccount(StripeObject): """ Name of the bank associated with the bank account. """ + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ fingerprint: Optional[str] """ Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. @@ -1627,11 +1724,11 @@ class WechatPay(StripeObject): """ location: Optional[str] """ - ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to. + ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. """ reader: Optional[str] """ - ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on. + ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. """ transaction_id: Optional[str] """ @@ -1699,6 +1796,7 @@ class Zip(StripeObject): """ paynow: Optional[Paynow] paypal: Optional[Paypal] + payto: Optional[Payto] pix: Optional[Pix] promptpay: Optional[Promptpay] revolut_pay: Optional[RevolutPay] @@ -1712,7 +1810,7 @@ class Zip(StripeObject): twint: Optional[Twint] type: str """ - The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type) for the full list of possible types. + The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) for the full list of possible types. An additional hash is included on `payment_method_details` with a name matching this value. It contains information specific to the payment method. """ @@ -1764,6 +1862,7 @@ class Zip(StripeObject): "payco": Payco, "paynow": Paynow, "paypal": Paypal, + "payto": Payto, "pix": Pix, "promptpay": Promptpay, "revolut_pay": RevolutPay, @@ -1824,7 +1923,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Address @@ -1899,7 +1998,7 @@ class Address(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["payment_attempt_record"] """ diff --git a/stripe/_payment_intent.py b/stripe/_payment_intent.py index c10b4193a..6e20c1c8b 100644 --- a/stripe/_payment_intent.py +++ b/stripe/_payment_intent.py @@ -90,11 +90,11 @@ class PaymentIntent( see the history of payment attempts for a particular session. A PaymentIntent transitions through - [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses) + [multiple statuses](https://docs.stripe.com/payments/paymentintents/lifecycle) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. - Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents) + Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents) """ OBJECT_NAME: ClassVar[Literal["payment_intent"]] = "payment_intent" @@ -103,7 +103,7 @@ class AmountDetails(StripeObject): class Shipping(StripeObject): amount: Optional[int] """ - If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. + If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0. """ from_postal_code: Optional[str] """ @@ -117,7 +117,7 @@ class Shipping(StripeObject): class Tax(StripeObject): total_tax_amount: Optional[int] """ - The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. """ @@ -130,13 +130,13 @@ class Tip(StripeObject): discount_amount: Optional[int] """ - The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. """ line_items: Optional[ListObject["PaymentIntentAmountDetailsLineItem"]] """ - A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items. + A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items. """ shipping: Optional[Shipping] tax: Optional[Tax] @@ -148,7 +148,7 @@ class AutomaticPaymentMethods(StripeObject): """ Controls whether this PaymentIntent will accept redirect-based payment methods. - Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment. + Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://docs.stripe.com/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment. """ enabled: bool """ @@ -160,7 +160,7 @@ class Inputs(StripeObject): class Tax(StripeObject): calculation: str """ - The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id + The [TaxCalculation](https://docs.stripe.com/api/tax/calculations) id """ tax: Optional[Tax] @@ -172,7 +172,7 @@ class Tax(StripeObject): class LastPaymentError(StripeObject): advice_code: Optional[str] """ - For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one. + For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one. """ charge: Optional[str] """ @@ -186,6 +186,7 @@ class LastPaymentError(StripeObject): "account_information_mismatch", "account_invalid", "account_number_invalid", + "account_token_required_for_v2_account", "acss_debit_session_incomplete", "alipay_upgrade_required", "amount_too_large", @@ -364,15 +365,15 @@ class LastPaymentError(StripeObject): ] ] """ - For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. + For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported. """ decline_code: Optional[str] """ - For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one. + For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one. """ doc_url: Optional[str] """ - A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. + A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported. """ message: Optional[str] """ @@ -398,19 +399,19 @@ class LastPaymentError(StripeObject): see the history of payment attempts for a particular session. A PaymentIntent transitions through - [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses) + [multiple statuses](https://docs.stripe.com/payments/paymentintents/lifecycle) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. - Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents) + Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents) """ payment_method: Optional["PaymentMethod"] """ PaymentMethod objects represent your customer's payment instruments. - You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to + You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. - Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). + Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). """ payment_method_type: Optional[str] """ @@ -424,7 +425,7 @@ class LastPaymentError(StripeObject): """ A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. - Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow. + Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow. Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. @@ -435,9 +436,9 @@ class LastPaymentError(StripeObject): For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents). - If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), + If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer), it automatically attaches the resulting payment method to that Customer after successful setup. - We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on + We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods. By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. @@ -556,7 +557,7 @@ class AccountHolderAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class BankAddress(StripeObject): @@ -582,7 +583,7 @@ class BankAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ account_holder_address: AccountHolderAddress @@ -636,7 +637,7 @@ class AccountHolderAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class BankAddress(StripeObject): @@ -662,7 +663,7 @@ class BankAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ account_holder_address: AccountHolderAddress @@ -712,7 +713,7 @@ class AccountHolderAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class BankAddress(StripeObject): @@ -738,7 +739,7 @@ class BankAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ account_holder_address: AccountHolderAddress @@ -784,7 +785,7 @@ class AccountHolderAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class BankAddress(StripeObject): @@ -810,7 +811,7 @@ class BankAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ account_holder_address: AccountHolderAddress @@ -860,7 +861,7 @@ class AccountHolderAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class BankAddress(StripeObject): @@ -886,7 +887,7 @@ class BankAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ account_holder_address: AccountHolderAddress @@ -940,7 +941,7 @@ class AccountHolderAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class BankAddress(StripeObject): @@ -966,7 +967,7 @@ class BankAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ account_holder_address: AccountHolderAddress @@ -1758,7 +1759,7 @@ class MandateOptions(StripeObject): """ Installment details for this payment. - For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). + For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments). """ mandate_options: Optional[MandateOptions] """ @@ -1788,27 +1789,27 @@ class MandateOptions(StripeObject): 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 ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this PaymentIntent. """ request_incremental_authorization: Optional[ Literal["if_available", "never"] ] """ - Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. + Request ability to [increment the authorization](https://docs.stripe.com/payments/incremental-authorization) for this PaymentIntent. """ request_multicapture: Optional[Literal["if_available", "never"]] """ - Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent. + Request ability to make [multiple captures](https://docs.stripe.com/payments/multicapture) for this PaymentIntent. """ request_overcapture: Optional[Literal["if_available", "never"]] """ - Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent. + Request ability to [overcapture](https://docs.stripe.com/payments/overcapture) for this PaymentIntent. """ request_three_d_secure: Optional[ 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. + 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://docs.stripe.com/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://docs.stripe.com/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: Optional[bool] """ @@ -1854,11 +1855,11 @@ class Routing(StripeObject): """ request_extended_authorization: Optional[bool] """ - Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity) + Request ability to capture this payment beyond the standard [authorization validity window](https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity) """ request_incremental_authorization_support: Optional[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 ability to [increment](https://docs.stripe.com/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://docs.stripe.com/api/payment_intents/confirm) response to verify support. """ routing: Optional[Routing] _inner_class_types = {"routing": Routing} @@ -2263,6 +2264,71 @@ class Paypal(StripeObject): When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication). """ + class Payto(StripeObject): + class MandateOptions(StripeObject): + amount: Optional[int] + """ + Amount that will be collected. It is required when `amount_type` is `fixed`. + """ + amount_type: Optional[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. Defaults to `maximum`. + """ + end_date: Optional[str] + """ + Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. + """ + payment_schedule: Optional[ + Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] + ] + """ + The periodicity at which payments will be collected. Defaults to `adhoc`. + """ + payments_per_period: Optional[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: Optional[ + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + + mandate_options: Optional[MandateOptions] + setup_future_usage: Optional[Literal["none", "off_session"]] + """ + Indicates that you intend to make future payments with this PaymentIntent's payment method. + + If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes. + + If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. + + When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication). + """ + _inner_class_types = {"mandate_options": MandateOptions} + class Pix(StripeObject): amount_includes_iof: Optional[Literal["always", "never"]] """ @@ -2547,6 +2613,7 @@ class Zip(StripeObject): payco: Optional[Payco] paynow: Optional[Paynow] paypal: Optional[Paypal] + payto: Optional[Payto] pix: Optional[Pix] promptpay: Optional[Promptpay] revolut_pay: Optional[RevolutPay] @@ -2599,6 +2666,7 @@ class Zip(StripeObject): "payco": Payco, "paynow": Paynow, "paypal": Paypal, + "payto": Payto, "pix": Pix, "promptpay": Promptpay, "revolut_pay": RevolutPay, @@ -2671,7 +2739,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Optional[Address] @@ -2697,7 +2765,7 @@ class TransferData(StripeObject): amount: Optional[int] """ The amount transferred to the destination account. This transfer will occur automatically after the payment succeeds. If no amount is specified, by default the entire payment amount is transferred to the destination account. - The amount must be less than or equal to the [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount), and must be a positive integer + The amount must be less than or equal to the [amount](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-amount), and must be a positive integer representing how much to transfer in the smallest currency unit (e.g., 100 cents to charge $1.00). """ destination: ExpandableField["Account"] @@ -2707,7 +2775,7 @@ class TransferData(StripeObject): amount: 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). + Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/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://docs.stripe.com/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). """ amount_capturable: int """ @@ -2724,7 +2792,7 @@ class TransferData(StripeObject): """ application_fee_amount: Optional[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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + 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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). """ automatic_payment_methods: Optional[AutomaticPaymentMethods] """ @@ -2759,7 +2827,7 @@ class TransferData(StripeObject): The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. - Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled. + Refer to our docs to [accept a payment](https://docs.stripe.com/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled. """ confirmation_method: Literal["automatic", "manual"] """ @@ -2779,7 +2847,15 @@ class TransferData(StripeObject): Payment methods attached to other Customers cannot be used with this PaymentIntent. - If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + """ + customer_account: Optional[str] + """ + ID of the Account representing the customer that this PaymentIntent belongs to, if one exists. + + Payment methods attached to other Accounts cannot be used with this PaymentIntent. + + If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead. """ description: Optional[str] """ @@ -2824,6 +2900,7 @@ class TransferData(StripeObject): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -2853,7 +2930,7 @@ class TransferData(StripeObject): """ latest_charge: Optional[ExpandableField["Charge"]] """ - ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted. + ID of the latest [Charge object](https://docs.stripe.com/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted. """ livemode: bool """ @@ -2861,7 +2938,7 @@ class TransferData(StripeObject): """ metadata: 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. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://docs.stripe.com/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). """ next_action: Optional[NextAction] """ @@ -2873,7 +2950,8 @@ class TransferData(StripeObject): """ on_behalf_of: Optional[ExpandableField["Account"]] """ - The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. + You can specify the settlement merchant as the + connected account using the `on_behalf_of` attribute on the charge. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts) for details. """ payment_details: Optional[PaymentDetails] payment_method: Optional[ExpandableField["PaymentMethod"]] @@ -2884,7 +2962,7 @@ class TransferData(StripeObject): PaymentMethodConfigurationDetails ] """ - Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent. + Information about the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) used for this PaymentIntent. """ payment_method_options: Optional[PaymentMethodOptions] """ @@ -2949,15 +3027,15 @@ class TransferData(StripeObject): "succeeded", ] """ - Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses). + Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://docs.stripe.com/payments/intents#intent-statuses). """ transfer_data: Optional[TransferData] """ - The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). """ transfer_group: Optional[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). + A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers). """ @classmethod diff --git a/stripe/_payment_intent_amount_details_line_item.py b/stripe/_payment_intent_amount_details_line_item.py index 2c1e291f8..789feefc7 100644 --- a/stripe/_payment_intent_amount_details_line_item.py +++ b/stripe/_payment_intent_amount_details_line_item.py @@ -53,14 +53,14 @@ class Paypal(StripeObject): class Tax(StripeObject): total_tax_amount: int """ - The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. """ discount_amount: Optional[int] """ - The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[discount_amount]` field. """ @@ -96,7 +96,7 @@ class Tax(StripeObject): """ unit_cost: int """ - The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. """ unit_of_measure: Optional[str] """ diff --git a/stripe/_payment_link.py b/stripe/_payment_link.py index 2a89ae8a1..bb8f1573d 100644 --- a/stripe/_payment_link.py +++ b/stripe/_payment_link.py @@ -39,9 +39,9 @@ class PaymentLink( """ A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times. - When a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links. + When a customer opens a payment link it will open a new [checkout session](https://docs.stripe.com/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://docs.stripe.com/api/events/types#event_types-checkout.session.completed) to track payments through payment links. - Related guide: [Payment Links API](https://stripe.com/docs/payment-links) + Related guide: [Payment Links API](https://docs.stripe.com/payment-links) """ OBJECT_NAME: ClassVar[Literal["payment_link"]] = "payment_link" @@ -301,7 +301,7 @@ class RenderingOptions(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ rendering_options: Optional[RenderingOptions] """ @@ -381,7 +381,7 @@ class PaymentIntentData(StripeObject): """ metadata: Dict[str, str] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link. """ setup_future_usage: Optional[Literal["off_session", "on_session"]] """ @@ -397,7 +397,7 @@ class PaymentIntentData(StripeObject): """ transfer_group: Optional[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. + A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. """ class PhoneNumberCollection(StripeObject): @@ -714,7 +714,7 @@ class EndBehavior(StripeObject): invoice_settings: InvoiceSettings metadata: Dict[str, str] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link. """ trial_period_days: Optional[int] """ @@ -811,7 +811,7 @@ class TransferData(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ name_collection: Optional[NameCollection] object: Literal["payment_link"] @@ -865,6 +865,7 @@ class TransferData(StripeObject): "pay_by_bank", "paynow", "paypal", + "payto", "pix", "promptpay", "satispay", diff --git a/stripe/_payment_method.py b/stripe/_payment_method.py index aa950badf..afd16acf3 100644 --- a/stripe/_payment_method.py +++ b/stripe/_payment_method.py @@ -41,10 +41,10 @@ class PaymentMethod( ): """ PaymentMethod objects represent your customer's payment instruments. - You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to + You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. - Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). + Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). """ OBJECT_NAME: ClassVar[Literal["payment_method"]] = "payment_method" @@ -144,7 +144,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Optional[Address] @@ -314,7 +314,7 @@ class Wallet(StripeObject): """ incremental_authorization_supported: bool """ - Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). + Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). """ issuer: Optional[str] """ @@ -443,7 +443,7 @@ class BillingAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class ShippingAddress(StripeObject): @@ -469,7 +469,7 @@ class ShippingAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ billing_address: Optional[BillingAddress] @@ -520,7 +520,7 @@ class BillingAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class ShippingAddress(StripeObject): @@ -546,7 +546,7 @@ class ShippingAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ billing_address: Optional[BillingAddress] @@ -917,6 +917,7 @@ class Ideal(StripeObject): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -930,7 +931,7 @@ class Ideal(StripeObject): ] ] """ - The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. + The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. """ bic: Optional[ Literal[ @@ -944,6 +945,7 @@ class Ideal(StripeObject): "HANDNL2A", "INGBNL2A", "KNABNL2H", + "MLLENL2A", "MOYONL21", "NNBANL2G", "NTSBDEB1", @@ -1217,6 +1219,20 @@ class Paypal(StripeObject): PayPal account PayerID. This identifier uniquely identifies the PayPal customer. """ + class Payto(StripeObject): + bsb_number: Optional[str] + """ + Bank-State-Branch number of the bank account. + """ + last4: Optional[str] + """ + Last four digits of the bank account number. + """ + pay_id: Optional[str] + """ + The PayID alias for the bank account. + """ + class Pix(StripeObject): pass @@ -1226,7 +1242,7 @@ class Promptpay(StripeObject): class RadarOptions(StripeObject): session: Optional[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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ class RevolutPay(StripeObject): @@ -1414,6 +1430,7 @@ class Zip(StripeObject): """ The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. """ + customer_account: Optional[str] customer_balance: Optional[CustomerBalance] eps: Optional[Eps] fpx: Optional[Fpx] @@ -1437,7 +1454,7 @@ class Zip(StripeObject): mb_way: Optional[MbWay] metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ mobilepay: Optional[Mobilepay] multibanco: Optional[Multibanco] @@ -1453,11 +1470,12 @@ class Zip(StripeObject): payco: Optional[Payco] paynow: Optional[Paynow] paypal: Optional[Paypal] + payto: Optional[Payto] pix: Optional[Pix] promptpay: Optional[Promptpay] radar_options: Optional[RadarOptions] """ - Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. """ revolut_pay: Optional[RevolutPay] samsung_pay: Optional[SamsungPay] @@ -1507,6 +1525,7 @@ class Zip(StripeObject): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -1884,7 +1903,7 @@ def list( cls, **params: Unpack["PaymentMethodListParams"] ) -> ListObject["PaymentMethod"]: """ - Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer_list) API instead. + Returns a list of all PaymentMethods. """ result = cls._static_request( "get", @@ -1904,7 +1923,7 @@ async def list_async( cls, **params: Unpack["PaymentMethodListParams"] ) -> ListObject["PaymentMethod"]: """ - Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer_list) API instead. + Returns a list of all PaymentMethods. """ result = await cls._static_request_async( "get", @@ -2017,6 +2036,7 @@ async def retrieve_async( "payco": Payco, "paynow": Paynow, "paypal": Paypal, + "payto": Payto, "pix": Pix, "promptpay": Promptpay, "radar_options": RadarOptions, diff --git a/stripe/_payment_method_configuration.py b/stripe/_payment_method_configuration.py index 0ecd5efb1..710a23580 100644 --- a/stripe/_payment_method_configuration.py +++ b/stripe/_payment_method_configuration.py @@ -32,7 +32,7 @@ class PaymentMethodConfiguration( """ PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios. - There are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://stripe.com/docs/connect/charges): + There are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://docs.stripe.com/connect/charges): **Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect. @@ -41,9 +41,9 @@ class PaymentMethodConfiguration( Child configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account's associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API. Related guides: - - [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations) - - [Multiple configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs) - - [Multiple configurations for your Connect accounts](https://stripe.com/docs/connect/multiple-payment-method-configurations) + - [Payment Method Configurations API](https://docs.stripe.com/connect/payment-method-configurations) + - [Multiple configurations on dynamic payment methods](https://docs.stripe.com/payments/multiple-payment-method-configs) + - [Multiple configurations for your Connect accounts](https://docs.stripe.com/connect/multiple-payment-method-configurations) """ OBJECT_NAME: ClassVar[Literal["payment_method_configuration"]] = ( @@ -952,6 +952,28 @@ class DisplayPreference(StripeObject): display_preference: DisplayPreference _inner_class_types = {"display_preference": DisplayPreference} + class Payto(StripeObject): + class DisplayPreference(StripeObject): + overridable: Optional[bool] + """ + For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + """ + preference: Literal["none", "off", "on"] + """ + The account's display preference. + """ + value: Literal["off", "on"] + """ + The effective display preference value. + """ + + available: bool + """ + Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. + """ + display_preference: DisplayPreference + _inner_class_types = {"display_preference": DisplayPreference} + class Pix(StripeObject): class DisplayPreference(StripeObject): overridable: Optional[bool] @@ -1289,6 +1311,7 @@ class DisplayPreference(StripeObject): payco: Optional[Payco] paynow: Optional[Paynow] paypal: Optional[Paypal] + payto: Optional[Payto] pix: Optional[Pix] promptpay: Optional[Promptpay] revolut_pay: Optional[RevolutPay] @@ -1480,6 +1503,7 @@ async def retrieve_async( "payco": Payco, "paynow": Paynow, "paypal": Paypal, + "payto": Payto, "pix": Pix, "promptpay": Promptpay, "revolut_pay": RevolutPay, diff --git a/stripe/_payment_method_domain.py b/stripe/_payment_method_domain.py index bf61a3fc9..c60a1c116 100644 --- a/stripe/_payment_method_domain.py +++ b/stripe/_payment_method_domain.py @@ -36,7 +36,7 @@ class PaymentMethodDomain( A payment method domain represents a web domain that you have registered with Stripe. Stripe Elements use registered payment method domains to control where certain payment methods are shown. - Related guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). + Related guide: [Payment method domains](https://docs.stripe.com/payments/payment-methods/pmd-registration). """ OBJECT_NAME: ClassVar[Literal["payment_method_domain"]] = ( diff --git a/stripe/_payment_method_service.py b/stripe/_payment_method_service.py index 34d867ef4..77013f1de 100644 --- a/stripe/_payment_method_service.py +++ b/stripe/_payment_method_service.py @@ -36,7 +36,7 @@ def list( options: Optional["RequestOptions"] = None, ) -> "ListObject[PaymentMethod]": """ - Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer_list) API instead. + Returns a list of all PaymentMethods. """ return cast( "ListObject[PaymentMethod]", @@ -55,7 +55,7 @@ async def list_async( options: Optional["RequestOptions"] = None, ) -> "ListObject[PaymentMethod]": """ - Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer_list) API instead. + Returns a list of all PaymentMethods. """ return cast( "ListObject[PaymentMethod]", @@ -201,7 +201,7 @@ async def update_async( def attach( self, payment_method: str, - params: "PaymentMethodAttachParams", + params: Optional["PaymentMethodAttachParams"] = None, options: Optional["RequestOptions"] = None, ) -> "PaymentMethod": """ @@ -235,7 +235,7 @@ def attach( async def attach_async( self, payment_method: str, - params: "PaymentMethodAttachParams", + params: Optional["PaymentMethodAttachParams"] = None, options: Optional["RequestOptions"] = None, ) -> "PaymentMethod": """ diff --git a/stripe/_payment_record.py b/stripe/_payment_record.py index 572685bb4..e5871dcbd 100644 --- a/stripe/_payment_record.py +++ b/stripe/_payment_record.py @@ -53,7 +53,7 @@ class Amount(StripeObject): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ class AmountAuthorized(StripeObject): @@ -63,7 +63,7 @@ class AmountAuthorized(StripeObject): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ class AmountCanceled(StripeObject): @@ -73,7 +73,7 @@ class AmountCanceled(StripeObject): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ class AmountFailed(StripeObject): @@ -83,7 +83,7 @@ class AmountFailed(StripeObject): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ class AmountGuaranteed(StripeObject): @@ -93,7 +93,7 @@ class AmountGuaranteed(StripeObject): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ class AmountRefunded(StripeObject): @@ -103,7 +103,7 @@ class AmountRefunded(StripeObject): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ class AmountRequested(StripeObject): @@ -113,7 +113,7 @@ class AmountRequested(StripeObject): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ class CustomerDetails(StripeObject): @@ -184,6 +184,10 @@ class AcssDebit(StripeObject): """ Name of the bank associated with the bank account. """ + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ fingerprint: Optional[str] """ Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. @@ -208,11 +212,11 @@ class AcssDebit(StripeObject): class Affirm(StripeObject): location: Optional[str] """ - ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to. + ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. """ reader: Optional[str] """ - ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on. + ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. """ transaction_id: Optional[str] """ @@ -304,6 +308,10 @@ class AuBecsDebit(StripeObject): """ Bank-State-Branch number of the bank account. """ + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ fingerprint: Optional[str] """ Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. @@ -318,6 +326,10 @@ class AuBecsDebit(StripeObject): """ class BacsDebit(StripeObject): + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ fingerprint: Optional[str] """ Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. @@ -401,7 +413,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Address @@ -446,6 +458,24 @@ class Checks(StripeObject): Literal["fail", "pass", "unavailable", "unchecked"] ] + class Installments(StripeObject): + class Plan(StripeObject): + count: Optional[int] + """ + For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. + """ + interval: Optional[Literal["month"]] + """ + For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. One of `month`. + """ + type: Literal["bonus", "fixed_count", "revolving"] + """ + Type of installment plan, one of `fixed_count`, `revolving`, or `bonus`. + """ + + plan: Optional[Plan] + _inner_class_types = {"plan": Plan} + class NetworkToken(StripeObject): used: bool """ @@ -504,6 +534,10 @@ class GooglePay(StripeObject): "google_pay": GooglePay, } + authorization_code: Optional[str] + """ + The authorization code of the payment. + """ brand: Literal[ "amex", "cartes_bancaires", @@ -533,6 +567,10 @@ class GooglePay(StripeObject): """ Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. """ + description: Optional[str] + """ + A high-level description of the type of cards issued in this range. + """ exp_month: int """ Two-digit number representing the card's expiration month. @@ -551,6 +589,18 @@ class GooglePay(StripeObject): """ Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. """ + iin: Optional[str] + """ + Issuer identification number of the card. + """ + installments: Optional[Installments] + """ + Installment details for this payment. + """ + issuer: Optional[str] + """ + The name of the card's issuing bank. + """ last4: str """ The last four digits of the card. @@ -578,6 +628,14 @@ class GooglePay(StripeObject): """ Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. """ + network_advice_code: Optional[str] + """ + Advice code from the card network for the failed payment. + """ + network_decline_code: Optional[str] + """ + Decline code from the card network for the failed payment. + """ network_token: Optional[NetworkToken] """ If this card has network token credentials, this contains the details of the network token credentials. @@ -586,6 +644,12 @@ class GooglePay(StripeObject): """ This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. """ + stored_credential_usage: Optional[ + Literal["recurring", "unscheduled"] + ] + """ + The transaction type that was passed for an off-session, Merchant-Initiated transaction, one of `recurring` or `unscheduled`. + """ three_d_secure: Optional[ThreeDSecure] """ Populated if this transaction used 3D Secure authentication. @@ -596,6 +660,7 @@ class GooglePay(StripeObject): """ _inner_class_types = { "checks": Checks, + "installments": Installments, "network_token": NetworkToken, "three_d_secure": ThreeDSecure, "wallet": Wallet, @@ -720,7 +785,7 @@ class Wallet(StripeObject): """ incremental_authorization_supported: bool """ - Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). + Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). """ issuer: Optional[str] """ @@ -935,6 +1000,7 @@ class Ideal(StripeObject): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -948,7 +1014,7 @@ class Ideal(StripeObject): ] ] """ - The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. + The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. """ bic: Optional[ Literal[ @@ -962,6 +1028,7 @@ class Ideal(StripeObject): "HANDNL2A", "INGBNL2A", "KNABNL2H", + "MLLENL2A", "MOYONL21", "NNBANL2G", "NTSBDEB1", @@ -1297,6 +1364,10 @@ class NzBankAccount(StripeObject): """ The numeric code for the bank account's bank branch. """ + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ last4: str """ Last four digits of the bank account number. @@ -1373,11 +1444,11 @@ class Payco(StripeObject): class Paynow(StripeObject): location: Optional[str] """ - ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to. + ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. """ reader: Optional[str] """ - ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on. + ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. """ reference: Optional[str] """ @@ -1427,6 +1498,24 @@ class SellerProtection(StripeObject): """ _inner_class_types = {"seller_protection": SellerProtection} + class Payto(StripeObject): + bsb_number: Optional[str] + """ + Bank-State-Branch number of the bank account. + """ + last4: Optional[str] + """ + Last four digits of the bank account number. + """ + mandate: Optional[str] + """ + ID of the mandate used to make this payment. + """ + pay_id: Optional[str] + """ + The PayID alias for the bank account. + """ + class Pix(StripeObject): bank_transaction_id: Optional[str] """ @@ -1524,6 +1613,10 @@ class SepaDebit(StripeObject): """ Two-letter ISO code representing the country the bank account is located in. """ + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ fingerprint: Optional[str] """ Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. @@ -1534,7 +1627,7 @@ class SepaDebit(StripeObject): """ mandate: Optional[str] """ - Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve). + Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://docs.stripe.com/api/mandates/retrieve). """ class Sofort(StripeObject): @@ -1612,6 +1705,10 @@ class UsBankAccount(StripeObject): """ Name of the bank associated with the bank account. """ + expected_debit_date: Optional[str] + """ + Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. + """ fingerprint: Optional[str] """ Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. @@ -1643,11 +1740,11 @@ class WechatPay(StripeObject): """ location: Optional[str] """ - ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to. + ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. """ reader: Optional[str] """ - ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on. + ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. """ transaction_id: Optional[str] """ @@ -1715,6 +1812,7 @@ class Zip(StripeObject): """ paynow: Optional[Paynow] paypal: Optional[Paypal] + payto: Optional[Payto] pix: Optional[Pix] promptpay: Optional[Promptpay] revolut_pay: Optional[RevolutPay] @@ -1728,7 +1826,7 @@ class Zip(StripeObject): twint: Optional[Twint] type: str """ - The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type) for the full list of possible types. + The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) for the full list of possible types. An additional hash is included on `payment_method_details` with a name matching this value. It contains information specific to the payment method. """ @@ -1780,6 +1878,7 @@ class Zip(StripeObject): "payco": Payco, "paynow": Paynow, "paypal": Paypal, + "payto": Payto, "pix": Pix, "promptpay": Promptpay, "revolut_pay": RevolutPay, @@ -1840,7 +1939,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Address @@ -1919,7 +2018,7 @@ class Address(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["payment_record"] """ @@ -1933,6 +2032,10 @@ class Address(StripeObject): """ Processor information associated with this payment. """ + reported_by: Literal["self", "stripe"] + """ + Indicates who reported the payment. + """ shipping_details: Optional[ShippingDetails] """ Shipping information for this payment. diff --git a/stripe/_payout.py b/stripe/_payout.py index e707c2e2f..93d1652cb 100644 --- a/stripe/_payout.py +++ b/stripe/_payout.py @@ -36,7 +36,7 @@ class Payout( schedules](https://docs.stripe.com/docs/connect/manage-payout-schedule), depending on your country and industry. - Related guide: [Receiving payouts](https://stripe.com/docs/payouts) + Related guide: [Receiving payouts](https://docs.stripe.com/payouts) """ OBJECT_NAME: ClassVar[Literal["payout"]] = "payout" @@ -57,11 +57,11 @@ class TraceId(StripeObject): """ application_fee: Optional[ExpandableField["ApplicationFee"]] """ - The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details. + The application fee (if any) for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details. """ application_fee_amount: Optional[int] """ - The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details. + The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details. """ arrival_date: int """ @@ -69,7 +69,7 @@ class TraceId(StripeObject): """ automatic: bool """ - Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts). + Returns `true` if the payout is created by an [automated payout schedule](https://docs.stripe.com/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts). """ balance_transaction: Optional[ExpandableField["BalanceTransaction"]] """ @@ -99,7 +99,7 @@ class TraceId(StripeObject): """ failure_code: Optional[str] """ - Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures). + Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://docs.stripe.com/api#payout_failures). """ failure_message: Optional[str] """ @@ -115,7 +115,7 @@ class TraceId(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ method: str """ @@ -137,7 +137,7 @@ class TraceId(StripeObject): "completed", "in_progress", "not_applicable" ] """ - If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout. + If `completed`, you can use the [Balance Transactions API](https://docs.stripe.com/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout. """ reversed_by: Optional[ExpandableField["Payout"]] """ diff --git a/stripe/_person.py b/stripe/_person.py index 6c9e2a76c..850f382a6 100644 --- a/stripe/_person.py +++ b/stripe/_person.py @@ -67,7 +67,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class AddressKana(StripeObject): @@ -148,11 +148,11 @@ class FutureRequirements(StripeObject): class Alternative(StripeObject): alternative_fields_due: List[str] """ - Fields that can be provided to satisfy all fields in `original_fields_due`. + Fields that can be provided to resolve all fields in `original_fields_due`. """ original_fields_due: List[str] """ - Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. + Fields that are due and can be resolved by providing all fields in `alternative_fields_due`. """ class Error(StripeObject): @@ -269,15 +269,15 @@ class Error(StripeObject): alternatives: Optional[List[Alternative]] """ - Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. """ currently_due: List[str] """ - Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition. + Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition. """ errors: List[Error] """ - Fields that are `currently_due` and need to be collected again because validation or verification failed. + Details about validation and verification failures for `due` requirements that must be resolved. """ eventually_due: List[str] """ @@ -285,11 +285,11 @@ class Error(StripeObject): """ past_due: List[str] """ - Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. + Fields that haven't been resolved by the account's `requirements.current_deadline`. These fields need to be resolved to enable the person's account. `future_requirements.past_due` is a subset of `requirements.past_due`. """ pending_verification: List[str] """ - Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. + Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. """ _inner_class_types = {"alternatives": Alternative, "errors": Error} @@ -316,7 +316,7 @@ class RegisteredAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class Relationship(StripeObject): @@ -357,11 +357,11 @@ class Requirements(StripeObject): class Alternative(StripeObject): alternative_fields_due: List[str] """ - Fields that can be provided to satisfy all fields in `original_fields_due`. + Fields that can be provided to resolve all fields in `original_fields_due`. """ original_fields_due: List[str] """ - Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. + Fields that are due and can be resolved by providing all fields in `alternative_fields_due`. """ class Error(StripeObject): @@ -478,15 +478,15 @@ class Error(StripeObject): alternatives: Optional[List[Alternative]] """ - Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. """ currently_due: List[str] """ - Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. + Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled. """ errors: List[Error] """ - Fields that are `currently_due` and need to be collected again because validation or verification failed. + Details about validation and verification failures for `due` requirements that must be resolved. """ eventually_due: List[str] """ @@ -494,11 +494,11 @@ class Error(StripeObject): """ past_due: List[str] """ - Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account. + Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the person's account. """ pending_verification: List[str] """ - Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. + Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. """ _inner_class_types = {"alternatives": Alternative, "errors": Error} @@ -585,7 +585,7 @@ class Verification(StripeObject): class AdditionalDocument(StripeObject): back: Optional[ExpandableField["File"]] """ - 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 back of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. """ details: Optional[str] """ @@ -597,13 +597,13 @@ class AdditionalDocument(StripeObject): """ front: Optional[ExpandableField["File"]] """ - 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 front of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. """ class Document(StripeObject): back: Optional[ExpandableField["File"]] """ - 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 back of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. """ details: Optional[str] """ @@ -615,7 +615,7 @@ class Document(StripeObject): """ front: Optional[ExpandableField["File"]] """ - 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 front of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. """ additional_document: Optional[AdditionalDocument] @@ -633,7 +633,7 @@ class Document(StripeObject): document: Optional[Document] status: str """ - The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. Please refer [guide](https://stripe.com/docs/connect/handling-api-verification) to handle verification updates. + The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. Please refer [guide](https://docs.stripe.com/connect/handling-api-verification) to handle verification updates. """ _inner_class_types = { "additional_document": AdditionalDocument, @@ -685,7 +685,7 @@ class Document(StripeObject): """ future_requirements: Optional[FutureRequirements] """ - Information about the [upcoming new requirements for this person](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when. + Information about the [upcoming new requirements for this person](https://docs.stripe.com/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when. """ gender: Optional[str] """ @@ -721,7 +721,7 @@ class Document(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ nationality: Optional[str] """ diff --git a/stripe/_plan.py b/stripe/_plan.py index 644a58386..27ac67046 100644 --- a/stripe/_plan.py +++ b/stripe/_plan.py @@ -27,14 +27,14 @@ class Plan( UpdateableAPIResource["Plan"], ): """ - You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. + You can now model subscriptions more flexibly using the [Prices API](https://api.stripe.com#prices). It replaces the Plans API and is backwards compatible to simplify your migration. Plans define the base price, currency, and billing cycle for recurring purchases of products. - [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme. + [Products](https://api.stripe.com#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year. - Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview). + Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription) and more about [products and prices](https://docs.stripe.com/products-prices/overview). """ OBJECT_NAME: ClassVar[Literal["plan"]] = "plan" @@ -117,7 +117,7 @@ class TransformUsage(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ meter: Optional[str] """ @@ -149,7 +149,7 @@ class TransformUsage(StripeObject): """ trial_period_days: Optional[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). + Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan). """ usage_type: Literal["licensed", "metered"] """ diff --git a/stripe/_price.py b/stripe/_price.py index 5ba57213c..42e5de8d5 100644 --- a/stripe/_price.py +++ b/stripe/_price.py @@ -37,11 +37,11 @@ class Price( ): """ Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. - [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. + [Products](https://api.stripe.com#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once. - Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview). + Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), [create an invoice](https://docs.stripe.com/billing/invoices/create), and more about [products and prices](https://docs.stripe.com/products-prices/overview). """ OBJECT_NAME: ClassVar[Literal["price"]] = "price" @@ -91,7 +91,7 @@ class Tier(StripeObject): 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. + Only required if a [default tax behavior](https://docs.stripe.com/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: Optional[List[Tier]] """ @@ -139,7 +139,7 @@ class Recurring(StripeObject): """ trial_period_days: Optional[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). + Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan). """ usage_type: Literal["licensed", "metered"] """ @@ -220,7 +220,7 @@ class TransformQuantity(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ nickname: Optional[str] """ @@ -240,7 +240,7 @@ class TransformQuantity(StripeObject): """ tax_behavior: Optional[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. + Only required if a [default tax behavior](https://docs.stripe.com/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: Optional[List[Tier]] """ diff --git a/stripe/_product.py b/stripe/_product.py index aa29a9eae..3eac066e0 100644 --- a/stripe/_product.py +++ b/stripe/_product.py @@ -58,12 +58,12 @@ class Product( """ Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product. - They can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions. + They can be used in conjunction with [Prices](https://api.stripe.com#prices) to configure pricing in Payment Links, Checkout, and Subscriptions. - Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), - [share a Payment Link](https://stripe.com/docs/payment-links), - [accept payments with Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront), - and more about [Products and Prices](https://stripe.com/docs/products-prices/overview) + Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), + [share a Payment Link](https://docs.stripe.com/payment-links), + [accept payments with Checkout](https://docs.stripe.com/payments/accept-a-payment#create-product-prices-upfront), + and more about [Products and Prices](https://docs.stripe.com/products-prices/overview) """ OBJECT_NAME: ClassVar[Literal["product"]] = "product" @@ -102,7 +102,7 @@ class PackageDimensions(StripeObject): """ default_price: Optional[ExpandableField["Price"]] """ - The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product. + The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product. """ deleted: Optional[Literal[True]] """ @@ -126,11 +126,11 @@ class PackageDimensions(StripeObject): """ marketing_features: List[MarketingFeature] """ - 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). + A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table). """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ name: str """ @@ -154,7 +154,7 @@ class PackageDimensions(StripeObject): """ tax_code: Optional[ExpandableField["TaxCode"]] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ type: Literal["good", "service"] """ diff --git a/stripe/_promotion_code.py b/stripe/_promotion_code.py index d97e75dea..65e0bbcd5 100644 --- a/stripe/_promotion_code.py +++ b/stripe/_promotion_code.py @@ -36,7 +36,7 @@ class PromotionCode( A Promotion Code represents a customer-redeemable code for an underlying promotion. You can create multiple codes for a single promotion. - If you enable promotion codes in your [customer portal configuration](https://stripe.com/docs/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal. + If you enable promotion codes in your [customer portal configuration](https://docs.stripe.com/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal. Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal. """ @@ -92,7 +92,11 @@ class CurrencyOptions(StripeObject): """ customer: Optional[ExpandableField["Customer"]] """ - The customer that this promotion code can be used by. + The customer who can use this promotion code. + """ + customer_account: Optional[str] + """ + The account representing the customer who can use this promotion code. """ expires_at: Optional[int] """ @@ -112,7 +116,7 @@ class CurrencyOptions(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["promotion_code"] """ diff --git a/stripe/_quote.py b/stripe/_quote.py index 7319501a1..9c19717ee 100644 --- a/stripe/_quote.py +++ b/stripe/_quote.py @@ -93,10 +93,10 @@ class Discount(StripeObject): """ discount: "DiscountResource" """ - A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes). + A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. - Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts) + Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) """ class Tax(StripeObject): @@ -191,10 +191,10 @@ class Discount(StripeObject): """ discount: "DiscountResource" """ - A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes). + A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. - Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts) + Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) """ class Tax(StripeObject): @@ -353,7 +353,7 @@ class Flexible(StripeObject): """ metadata: Optional[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. + Set of [key-value pairs](https://docs.stripe.com/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. """ trial_period_days: Optional[int] """ @@ -370,10 +370,10 @@ class Discount(StripeObject): """ discount: "DiscountResource" """ - A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes). + A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. - Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts) + Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) """ class Tax(StripeObject): @@ -489,7 +489,11 @@ class TransferData(StripeObject): """ customer: Optional[ExpandableField["Customer"]] """ - The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. + The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it. + """ + customer_account: Optional[str] + """ + The account representing the customer who received this quote. A customer or account is required to finalize the quote. Once specified, you can't change it. """ default_tax_rates: Optional[List[ExpandableField["TaxRate"]]] """ @@ -513,7 +517,7 @@ class TransferData(StripeObject): """ from_quote: Optional[FromQuote] """ - Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. + Details of the quote that was cloned. See the [cloning documentation](https://docs.stripe.com/quotes/clone) for more details. """ header: Optional[str] """ @@ -538,11 +542,11 @@ class TransferData(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ number: Optional[str] """ - A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize). + A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://docs.stripe.com/quotes/overview#finalize). """ object: Literal["quote"] """ diff --git a/stripe/_refund.py b/stripe/_refund.py index 2fae712bd..088ef61a9 100644 --- a/stripe/_refund.py +++ b/stripe/_refund.py @@ -34,7 +34,7 @@ class Refund( refunded yet. Funds are refunded to the credit or debit card that's initially charged. - Related guide: [Refunds](https://stripe.com/docs/refunds) + Related guide: [Refunds](https://docs.stripe.com/refunds) """ OBJECT_NAME: ClassVar[Literal["refund"]] = "refund" @@ -416,7 +416,7 @@ class PresentmentDetails(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ next_action: Optional[NextAction] object: Literal["refund"] @@ -455,7 +455,7 @@ class PresentmentDetails(StripeObject): """ status: Optional[str] """ - Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds). + Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://docs.stripe.com/refunds#failed-refunds). """ transfer_reversal: Optional[ExpandableField["Reversal"]] """ diff --git a/stripe/_reversal.py b/stripe/_reversal.py index 25bbb80c1..94654232f 100644 --- a/stripe/_reversal.py +++ b/stripe/_reversal.py @@ -14,7 +14,7 @@ class Reversal(UpdateableAPIResource["Reversal"]): """ - [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a + [Stripe Connect](https://docs.stripe.com/connect) platforms can reverse transfers made to a connected account, either entirely or partially, and can also specify whether to refund any related application fees. Transfer reversals add to the platform's balance and subtract from the destination account's balance. @@ -22,11 +22,11 @@ class Reversal(UpdateableAPIResource["Reversal"]): Reversing a transfer that was made for a [destination charge](https://docs.stripe.com/docs/connect/destination-charges) is allowed only up to the amount of the charge. It is possible to reverse a - [transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) + [transfer_group](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) transfer only if the destination account has enough balance to cover the reversal. - Related guide: [Reverse transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers) + Related guide: [Reverse transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#reverse-transfers) """ OBJECT_NAME: ClassVar[Literal["transfer_reversal"]] = "transfer_reversal" @@ -56,7 +56,7 @@ class Reversal(UpdateableAPIResource["Reversal"]): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["transfer_reversal"] """ diff --git a/stripe/_review.py b/stripe/_review.py index d03e8462f..13a14b9d4 100644 --- a/stripe/_review.py +++ b/stripe/_review.py @@ -21,7 +21,7 @@ class Review(ListableAPIResource["Review"]): Reviews can be used to supplement automated fraud detection with human expertise. Learn more about [Radar](https://docs.stripe.com/radar) and reviewing payments - [here](https://stripe.com/docs/radar/reviews). + [here](https://docs.stripe.com/radar/reviews). """ OBJECT_NAME: ClassVar[Literal["review"]] = "review" diff --git a/stripe/_setup_attempt.py b/stripe/_setup_attempt.py index 39e2a09ce..04ea9a532 100644 --- a/stripe/_setup_attempt.py +++ b/stripe/_setup_attempt.py @@ -268,6 +268,7 @@ class Ideal(StripeObject): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -281,7 +282,7 @@ class Ideal(StripeObject): ] ] """ - The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. + The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. """ bic: Optional[ Literal[ @@ -295,6 +296,7 @@ class Ideal(StripeObject): "HANDNL2A", "INGBNL2A", "KNABNL2H", + "MLLENL2A", "MOYONL21", "NNBANL2G", "NTSBDEB1", @@ -351,6 +353,9 @@ class NzBankAccount(StripeObject): class Paypal(StripeObject): pass + class Payto(StripeObject): + pass + class RevolutPay(StripeObject): pass @@ -413,6 +418,7 @@ class UsBankAccount(StripeObject): naver_pay: Optional[NaverPay] nz_bank_account: Optional[NzBankAccount] paypal: Optional[Paypal] + payto: Optional[Payto] revolut_pay: Optional[RevolutPay] sepa_debit: Optional[SepaDebit] sofort: Optional[Sofort] @@ -439,6 +445,7 @@ class UsBankAccount(StripeObject): "naver_pay": NaverPay, "nz_bank_account": NzBankAccount, "paypal": Paypal, + "payto": Payto, "revolut_pay": RevolutPay, "sepa_debit": SepaDebit, "sofort": Sofort, @@ -448,7 +455,7 @@ class UsBankAccount(StripeObject): class SetupError(StripeObject): advice_code: Optional[str] """ - For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one. + For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one. """ charge: Optional[str] """ @@ -462,6 +469,7 @@ class SetupError(StripeObject): "account_information_mismatch", "account_invalid", "account_number_invalid", + "account_token_required_for_v2_account", "acss_debit_session_incomplete", "alipay_upgrade_required", "amount_too_large", @@ -640,15 +648,15 @@ class SetupError(StripeObject): ] ] """ - For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. + For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported. """ decline_code: Optional[str] """ - For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one. + For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one. """ doc_url: Optional[str] """ - A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. + A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported. """ message: Optional[str] """ @@ -674,19 +682,19 @@ class SetupError(StripeObject): see the history of payment attempts for a particular session. A PaymentIntent transitions through - [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses) + [multiple statuses](https://docs.stripe.com/payments/paymentintents/lifecycle) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. - Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents) + Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents) """ payment_method: Optional["PaymentMethod"] """ PaymentMethod objects represent your customer's payment instruments. - You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to + You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. - Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). + Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). """ payment_method_type: Optional[str] """ @@ -700,7 +708,7 @@ class SetupError(StripeObject): """ A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. - Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow. + Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow. Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. @@ -711,9 +719,9 @@ class SetupError(StripeObject): For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents). - If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), + If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer), it automatically attaches the resulting payment method to that Customer after successful setup. - We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on + We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods. By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. @@ -735,7 +743,7 @@ class SetupError(StripeObject): application: Optional[ExpandableField["Application"]] """ - The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation. + The value of [application](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation. """ attach_to_self: Optional[bool] """ @@ -749,7 +757,11 @@ class SetupError(StripeObject): """ customer: Optional[ExpandableField["Customer"]] """ - The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation. + The value of [customer](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation. + """ + customer_account: Optional[str] + """ + The value of [customer_account](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-customer_account) on the SetupIntent at the time of this confirmation. """ flow_directions: Optional[List[Literal["inbound", "outbound"]]] """ @@ -771,7 +783,7 @@ class SetupError(StripeObject): """ on_behalf_of: Optional[ExpandableField["Account"]] """ - The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation. + The value of [on_behalf_of](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation. """ payment_method: ExpandableField["PaymentMethod"] """ @@ -792,7 +804,7 @@ class SetupError(StripeObject): """ usage: str """ - The value of [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`. + The value of [usage](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`. """ @classmethod diff --git a/stripe/_setup_intent.py b/stripe/_setup_intent.py index f3e927baa..69fb205a0 100644 --- a/stripe/_setup_intent.py +++ b/stripe/_setup_intent.py @@ -51,7 +51,7 @@ class SetupIntent( """ A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. - Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow. + Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow. Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. @@ -62,9 +62,9 @@ class SetupIntent( For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents). - If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), + If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer), it automatically attaches the resulting payment method to that Customer after successful setup. - We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on + We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods. By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. @@ -79,7 +79,7 @@ class AutomaticPaymentMethods(StripeObject): """ Controls whether this SetupIntent will accept redirect-based payment methods. - Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup. + Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://docs.stripe.com/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup. """ enabled: Optional[bool] """ @@ -89,7 +89,7 @@ class AutomaticPaymentMethods(StripeObject): class LastSetupError(StripeObject): advice_code: Optional[str] """ - For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one. + For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one. """ charge: Optional[str] """ @@ -103,6 +103,7 @@ class LastSetupError(StripeObject): "account_information_mismatch", "account_invalid", "account_number_invalid", + "account_token_required_for_v2_account", "acss_debit_session_incomplete", "alipay_upgrade_required", "amount_too_large", @@ -281,15 +282,15 @@ class LastSetupError(StripeObject): ] ] """ - For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. + For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported. """ decline_code: Optional[str] """ - For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one. + For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one. """ doc_url: Optional[str] """ - A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. + A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported. """ message: Optional[str] """ @@ -315,19 +316,19 @@ class LastSetupError(StripeObject): see the history of payment attempts for a particular session. A PaymentIntent transitions through - [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses) + [multiple statuses](https://docs.stripe.com/payments/paymentintents/lifecycle) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. - Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents) + Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents) """ payment_method: Optional["PaymentMethod"] """ PaymentMethod objects represent your customer's payment instruments. - You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to + You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. - Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). + Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). """ payment_method_type: Optional[str] """ @@ -341,7 +342,7 @@ class LastSetupError(StripeObject): """ A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. - Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow. + Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow. Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. @@ -352,9 +353,9 @@ class LastSetupError(StripeObject): For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents). - If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), + If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer), it automatically attaches the resulting payment method to that Customer after successful setup. - We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on + We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods. By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. @@ -577,7 +578,7 @@ class MandateOptions(StripeObject): 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. + 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ _inner_class_types = {"mandate_options": MandateOptions} @@ -606,6 +607,65 @@ class Paypal(StripeObject): The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. """ + class Payto(StripeObject): + class MandateOptions(StripeObject): + amount: Optional[int] + """ + Amount that will be collected. It is required when `amount_type` is `fixed`. + """ + amount_type: Optional[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. Defaults to `maximum`. + """ + end_date: Optional[str] + """ + Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. + """ + payment_schedule: Optional[ + Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] + ] + """ + The periodicity at which payments will be collected. Defaults to `adhoc`. + """ + payments_per_period: Optional[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: Optional[ + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + start_date: Optional[str] + """ + Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. + """ + + mandate_options: Optional[MandateOptions] + _inner_class_types = {"mandate_options": MandateOptions} + class SepaDebit(StripeObject): class MandateOptions(StripeObject): reference_prefix: Optional[str] @@ -679,6 +739,7 @@ class MandateOptions(StripeObject): klarna: Optional[Klarna] link: Optional[Link] paypal: Optional[Paypal] + payto: Optional[Payto] sepa_debit: Optional[SepaDebit] us_bank_account: Optional[UsBankAccount] _inner_class_types = { @@ -690,6 +751,7 @@ class MandateOptions(StripeObject): "klarna": Klarna, "link": Link, "paypal": Paypal, + "payto": Payto, "sepa_debit": SepaDebit, "us_bank_account": UsBankAccount, } @@ -730,6 +792,12 @@ class MandateOptions(StripeObject): 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. """ + customer_account: Optional[str] + """ + ID of the Account this SetupIntent belongs to, if one exists. + + If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent. + """ description: Optional[str] """ An arbitrary string attached to the object. Often useful for displaying to users. @@ -773,6 +841,7 @@ class MandateOptions(StripeObject): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -819,7 +888,7 @@ class MandateOptions(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ next_action: Optional[NextAction] """ @@ -841,7 +910,7 @@ class MandateOptions(StripeObject): PaymentMethodConfigurationDetails ] """ - Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent. + Information about the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) used for this Setup Intent. """ payment_method_options: Optional[PaymentMethodOptions] """ @@ -864,7 +933,7 @@ class MandateOptions(StripeObject): "succeeded", ] """ - [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. + [Status](https://docs.stripe.com/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. """ usage: str """ diff --git a/stripe/_shipping_rate.py b/stripe/_shipping_rate.py index 1389c7506..d62ef0b46 100644 --- a/stripe/_shipping_rate.py +++ b/stripe/_shipping_rate.py @@ -31,7 +31,7 @@ class ShippingRate( ): """ Shipping rates describe the price of shipping presented to your customers and - applied to a purchase. For more information, see [Charge for shipping](https://stripe.com/docs/payments/during-payment/charge-shipping). + applied to a purchase. For more information, see [Charge for shipping](https://docs.stripe.com/payments/during-payment/charge-shipping). """ OBJECT_NAME: ClassVar[Literal["shipping_rate"]] = "shipping_rate" @@ -120,7 +120,7 @@ class CurrencyOptions(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["shipping_rate"] """ @@ -132,7 +132,7 @@ class CurrencyOptions(StripeObject): """ tax_code: Optional[ExpandableField["TaxCode"]] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ type: Literal["fixed_amount"] """ diff --git a/stripe/_source.py b/stripe/_source.py index c7f66c53a..27d5795cd 100644 --- a/stripe/_source.py +++ b/stripe/_source.py @@ -28,11 +28,11 @@ class Source(CreateableAPIResource["Source"], UpdateableAPIResource["Source"]): just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. - Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources). - We recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods). + Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). + We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. - Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). + Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). """ OBJECT_NAME: ClassVar[Literal["source"]] = "source" @@ -222,7 +222,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class VerifiedAddress(StripeObject): @@ -248,7 +248,7 @@ class VerifiedAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Optional[Address] @@ -417,7 +417,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Optional[Address] @@ -536,7 +536,7 @@ class Wechat(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ multibanco: Optional[Multibanco] object: Literal["source"] @@ -585,7 +585,7 @@ class Wechat(StripeObject): "wechat", ] """ - The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used. + The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://docs.stripe.com/sources) used. """ usage: Optional[str] """ diff --git a/stripe/_source_mandate_notification.py b/stripe/_source_mandate_notification.py index 2d6a62020..4d99bffe1 100644 --- a/stripe/_source_mandate_notification.py +++ b/stripe/_source_mandate_notification.py @@ -79,11 +79,11 @@ class SepaDebit(StripeObject): just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. - Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources). - We recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods). + Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). + We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. - Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). + Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). """ status: str """ diff --git a/stripe/_subscription.py b/stripe/_subscription.py index 05db3e645..a7c731321 100644 --- a/stripe/_subscription.py +++ b/stripe/_subscription.py @@ -76,7 +76,7 @@ class Subscription( """ Subscriptions allow you to charge a customer on a recurring basis. - Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating) + Related guide: [Creating subscriptions](https://docs.stripe.com/billing/subscriptions/creating) """ OBJECT_NAME: ClassVar[Literal["subscription"]] = "subscription" @@ -280,7 +280,7 @@ class MandateOptions(StripeObject): 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. + 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ _inner_class_types = {"mandate_options": MandateOptions} @@ -309,6 +309,38 @@ class EuBankTransfer(StripeObject): class Konbini(StripeObject): pass + class Payto(StripeObject): + class MandateOptions(StripeObject): + amount: Optional[int] + """ + The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit. + """ + amount_type: Optional[Literal["fixed", "maximum"]] + """ + Only `maximum` is supported. + """ + purpose: Optional[ + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + + mandate_options: Optional[MandateOptions] + _inner_class_types = {"mandate_options": MandateOptions} + class SepaDebit(StripeObject): pass @@ -375,6 +407,10 @@ class Filters(StripeObject): """ This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription. """ + payto: Optional[Payto] + """ + This sub-hash contains details about the PayTo payment method options to pass to invoices created by the subscription. + """ sepa_debit: Optional[SepaDebit] """ This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription. @@ -389,6 +425,7 @@ class Filters(StripeObject): "card": Card, "customer_balance": CustomerBalance, "konbini": Konbini, + "payto": Payto, "sepa_debit": SepaDebit, "us_bank_account": UsBankAccount, } @@ -432,6 +469,7 @@ class Filters(StripeObject): "payco", "paynow", "paypal", + "payto", "promptpay", "revolut_pay", "sepa_credit_transfer", @@ -483,7 +521,7 @@ class PendingUpdate(StripeObject): """ trial_from_plan: Optional[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. + 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://docs.stripe.com/billing/subscriptions/trials) to learn more. """ class TransferData(StripeObject): @@ -522,7 +560,7 @@ class EndBehavior(StripeObject): automatic_tax: AutomaticTax billing_cycle_anchor: int """ - The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/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. The timestamp is in UTC format. + The reference point that aligns future [billing cycle](https://docs.stripe.com/subscriptions/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. The timestamp is in UTC format. """ billing_cycle_anchor_config: Optional[BillingCycleAnchorConfig] """ @@ -568,13 +606,17 @@ class EndBehavior(StripeObject): """ ID of the customer who owns the subscription. """ + customer_account: Optional[str] + """ + ID of the account representing the customer who owns the subscription. + """ days_until_due: Optional[int] """ Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`. """ default_payment_method: Optional[ExpandableField["PaymentMethod"]] """ - 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). + 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://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). """ default_source: Optional[ ExpandableField[ @@ -582,7 +624,7 @@ class EndBehavior(StripeObject): ] ] """ - 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). + 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://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). """ default_tax_rates: Optional[List["TaxRate"]] """ @@ -619,7 +661,7 @@ class EndBehavior(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ next_pending_invoice_item_invoice: Optional[int] """ @@ -631,11 +673,11 @@ class EndBehavior(StripeObject): """ on_behalf_of: Optional[ExpandableField["Account"]] """ - The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://stripe.com/docs/connect/subscriptions#on-behalf-of) for details. + The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://docs.stripe.com/connect/subscriptions#on-behalf-of) for details. """ pause_collection: Optional[PauseCollection] """ - 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/docs/billing/subscriptions/pause-payment). + 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://docs.stripe.com/billing/subscriptions/pause-payment). """ payment_settings: Optional[PaymentSettings] """ @@ -643,15 +685,15 @@ class EndBehavior(StripeObject): """ pending_invoice_item_interval: Optional[PendingInvoiceItemInterval] """ - Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. + Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval. """ pending_setup_intent: Optional[ExpandableField["SetupIntent"]] """ - You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2). + You can use this [SetupIntent](https://docs.stripe.com/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2). """ pending_update: Optional[PendingUpdate] """ - If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid. + If specified, [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid. """ schedule: Optional[ExpandableField["SubscriptionSchedule"]] """ @@ -678,7 +720,7 @@ class EndBehavior(StripeObject): A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. - A subscription can only enter a `paused` status [when a trial ends without a payment method](https://stripe.com/docs/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. + A subscription can only enter a `paused` status [when a trial ends without a payment method](https://docs.stripe.com/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. If subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). diff --git a/stripe/_subscription_item.py b/stripe/_subscription_item.py index 939eb0b82..6db7dbfb1 100644 --- a/stripe/_subscription_item.py +++ b/stripe/_subscription_item.py @@ -82,7 +82,7 @@ class BillingThresholds(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["subscription_item"] """ @@ -90,27 +90,27 @@ class BillingThresholds(StripeObject): """ plan: "Plan" """ - You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. + You can now model subscriptions more flexibly using the [Prices API](https://api.stripe.com#prices). It replaces the Plans API and is backwards compatible to simplify your migration. Plans define the base price, currency, and billing cycle for recurring purchases of products. - [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme. + [Products](https://api.stripe.com#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year. - Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview). + Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription) and more about [products and prices](https://docs.stripe.com/products-prices/overview). """ price: "Price" """ Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. - [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. + [Products](https://api.stripe.com#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once. - Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview). + Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), [create an invoice](https://docs.stripe.com/billing/invoices/create), and more about [products and prices](https://docs.stripe.com/products-prices/overview). """ quantity: Optional[int] """ - The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed. + The [quantity](https://docs.stripe.com/subscriptions/quantities) of the plan to which the customer should be subscribed. """ subscription: str """ diff --git a/stripe/_subscription_schedule.py b/stripe/_subscription_schedule.py index 3a2279d16..310f53f35 100644 --- a/stripe/_subscription_schedule.py +++ b/stripe/_subscription_schedule.py @@ -52,7 +52,7 @@ class SubscriptionSchedule( """ A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. - Related guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules) + Related guide: [Subscription schedules](https://docs.stripe.com/billing/subscriptions/subscription-schedules) """ OBJECT_NAME: ClassVar[Literal["subscription_schedule"]] = ( @@ -165,7 +165,7 @@ class TransferData(StripeObject): automatic_tax: Optional[AutomaticTax] billing_cycle_anchor: Literal["automatic", "phase_start"] """ - Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). + Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle). """ billing_thresholds: Optional[BillingThresholds] """ @@ -252,7 +252,7 @@ class Start(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ period: Period price: ExpandableField["Price"] @@ -374,7 +374,7 @@ class Discount(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered. """ plan: ExpandableField["Plan"] """ @@ -418,7 +418,7 @@ class TransferData(StripeObject): automatic_tax: Optional[AutomaticTax] billing_cycle_anchor: Optional[Literal["automatic", "phase_start"]] """ - Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). + Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle). """ billing_thresholds: Optional[BillingThresholds] """ @@ -464,7 +464,7 @@ class TransferData(StripeObject): """ metadata: Optional[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. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`. + Set of [key-value pairs](https://docs.stripe.com/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. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`. """ on_behalf_of: Optional[ExpandableField["Account"]] """ @@ -526,6 +526,10 @@ class TransferData(StripeObject): """ ID of the customer who owns the subscription schedule. """ + customer_account: Optional[str] + """ + ID of the account who owns the subscription schedule. + """ default_settings: DefaultSettings end_behavior: Literal["cancel", "none", "release", "renew"] """ @@ -541,7 +545,7 @@ class TransferData(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["subscription_schedule"] """ @@ -563,7 +567,7 @@ class TransferData(StripeObject): "active", "canceled", "completed", "not_started", "released" ] """ - The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules). + The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://docs.stripe.com/billing/subscriptions/subscription-schedules). """ subscription: Optional[ExpandableField["Subscription"]] """ diff --git a/stripe/_subscription_service.py b/stripe/_subscription_service.py index a6ee5f999..e1793f584 100644 --- a/stripe/_subscription_service.py +++ b/stripe/_subscription_service.py @@ -319,7 +319,7 @@ async def list_async( def create( self, - params: "SubscriptionCreateParams", + params: Optional["SubscriptionCreateParams"] = None, options: Optional["RequestOptions"] = None, ) -> "Subscription": """ @@ -344,7 +344,7 @@ def create( async def create_async( self, - params: "SubscriptionCreateParams", + params: Optional["SubscriptionCreateParams"] = None, options: Optional["RequestOptions"] = None, ) -> "Subscription": """ diff --git a/stripe/_tax_id.py b/stripe/_tax_id.py index 2a508a400..c724f2835 100644 --- a/stripe/_tax_id.py +++ b/stripe/_tax_id.py @@ -26,10 +26,10 @@ class TaxId( ListableAPIResource["TaxId"], ): """ - You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account. + You can add one or multiple tax IDs to a [customer](https://docs.stripe.com/api/customers) or account. Customer and account tax IDs get displayed on related invoices and credit notes. - Related guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids) + Related guides: [Customer tax identification numbers](https://docs.stripe.com/billing/taxes/tax-ids), [Account tax IDs](https://docs.stripe.com/invoicing/connect#account-tax-ids) """ OBJECT_NAME: ClassVar[Literal["tax_id"]] = "tax_id" @@ -47,6 +47,10 @@ class Owner(StripeObject): """ The customer being referenced when `type` is `customer`. """ + customer_account: Optional[str] + """ + The Account representing the customer being referenced when `type` is `customer`. + """ type: Literal["account", "application", "customer", "self"] """ Type of owner referenced. @@ -78,6 +82,10 @@ class Verification(StripeObject): """ ID of the customer. """ + customer_account: Optional[str] + """ + ID of the Account representing the customer. + """ deleted: Optional[Literal[True]] """ Always true for a deleted object diff --git a/stripe/_tax_rate.py b/stripe/_tax_rate.py index ec57166e9..017cbf94f 100644 --- a/stripe/_tax_rate.py +++ b/stripe/_tax_rate.py @@ -93,7 +93,7 @@ class FlatAmount(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["tax_rate"] """ diff --git a/stripe/_token.py b/stripe/_token.py index bf02e107e..4415cb529 100644 --- a/stripe/_token.py +++ b/stripe/_token.py @@ -17,7 +17,7 @@ class Token(CreateableAPIResource["Token"]): account details, or personally identifiable information (PII), directly from your customers in a secure manner. A token representing this information is returned to your server to use. Use our - [recommended payments integrations](https://stripe.com/docs/payments) to perform this process + [recommended payments integrations](https://docs.stripe.com/payments) to perform this process on the client-side. This guarantees that no sensitive card data touches your server, and allows your integration to operate in a PCI-compliant way. @@ -29,9 +29,9 @@ class Token(CreateableAPIResource["Token"]): Stripe, so we can't determine how it's handled or stored. You can't store or use tokens more than once. To store card or bank account - information for later use, create [Customer](https://stripe.com/docs/api#customers) + information for later use, create [Customer](https://docs.stripe.com/api#customers) objects or [External accounts](https://docs.stripe.com/api#external_accounts). - [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection, + [Radar](https://docs.stripe.com/radar), our integrated solution for automatic fraud protection, performs best with integrations that use client-side tokenization. """ @@ -52,7 +52,7 @@ class Token(CreateableAPIResource["Token"]): later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. - Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards) + Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) """ client_ip: Optional[str] """ diff --git a/stripe/_topup.py b/stripe/_topup.py index e95ddfd20..dab41171d 100644 --- a/stripe/_topup.py +++ b/stripe/_topup.py @@ -29,7 +29,7 @@ class Topup( individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID. - Related guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups) + Related guide: [Topping up your platform account](https://docs.stripe.com/connect/top-ups) """ OBJECT_NAME: ClassVar[Literal["topup"]] = "topup" @@ -59,7 +59,7 @@ class Topup( """ failure_code: Optional[str] """ - Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). + Error code explaining reason for top-up failure if available (see [the errors section](https://docs.stripe.com/api#errors) for a list of codes). """ failure_message: Optional[str] """ @@ -75,7 +75,7 @@ class Topup( """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["topup"] """ diff --git a/stripe/_transfer.py b/stripe/_transfer.py index b45980e9f..d7a6a2179 100644 --- a/stripe/_transfer.py +++ b/stripe/_transfer.py @@ -45,11 +45,11 @@ class Transfer( Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split - out into a [Payout](https://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more + out into a [Payout](https://api.stripe.com#payout_object) object, with corresponding payout endpoints. For more information, read about the - [transfer/payout split](https://stripe.com/docs/transfer-payout-split). + [transfer/payout split](https://docs.stripe.com/transfer-payout-split). - Related guide: [Creating separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) + Related guide: [Creating separate charges and transfers](https://docs.stripe.com/connect/separate-charges-and-transfers) """ OBJECT_NAME: ClassVar[Literal["transfer"]] = "transfer" @@ -95,7 +95,7 @@ class Transfer( """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["transfer"] """ @@ -119,7 +119,7 @@ class Transfer( """ transfer_group: Optional[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. + A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. """ @classmethod diff --git a/stripe/_webhook_endpoint.py b/stripe/_webhook_endpoint.py index 50c1d8cf0..100640ce0 100644 --- a/stripe/_webhook_endpoint.py +++ b/stripe/_webhook_endpoint.py @@ -78,7 +78,7 @@ class WebhookEndpoint( """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["webhook_endpoint"] """ diff --git a/stripe/apps/_secret.py b/stripe/apps/_secret.py index 9ff3f402a..d258c4ddc 100644 --- a/stripe/apps/_secret.py +++ b/stripe/apps/_secret.py @@ -26,7 +26,7 @@ class Secret(CreateableAPIResource["Secret"], ListableAPIResource["Secret"]): A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions. - Related guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects) + Related guide: [Store data between page reloads](https://docs.stripe.com/stripe-apps/store-auth-data-custom-objects) """ OBJECT_NAME: ClassVar[Literal["apps.secret"]] = "apps.secret" diff --git a/stripe/billing/_alert.py b/stripe/billing/_alert.py index e7b6b800c..3699c662c 100644 --- a/stripe/billing/_alert.py +++ b/stripe/billing/_alert.py @@ -85,7 +85,7 @@ class Filter(StripeObject): """ usage_threshold: Optional[UsageThreshold] """ - Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter). + Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://docs.stripe.com/api/billing/meter). """ @classmethod diff --git a/stripe/billing/_credit_balance_summary.py b/stripe/billing/_credit_balance_summary.py index 27c5eedce..c7a5c9a18 100644 --- a/stripe/billing/_credit_balance_summary.py +++ b/stripe/billing/_credit_balance_summary.py @@ -80,6 +80,10 @@ class Monetary(StripeObject): """ The customer the balance is for. """ + customer_account: Optional[str] + """ + The account the balance is for. + """ livemode: bool """ Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. diff --git a/stripe/billing/_credit_balance_transaction_service.py b/stripe/billing/_credit_balance_transaction_service.py index 5aea7ea7e..52f511b49 100644 --- a/stripe/billing/_credit_balance_transaction_service.py +++ b/stripe/billing/_credit_balance_transaction_service.py @@ -22,7 +22,7 @@ class CreditBalanceTransactionService(StripeService): def list( self, - params: "CreditBalanceTransactionListParams", + params: Optional["CreditBalanceTransactionListParams"] = None, options: Optional["RequestOptions"] = None, ) -> "ListObject[CreditBalanceTransaction]": """ @@ -41,7 +41,7 @@ def list( async def list_async( self, - params: "CreditBalanceTransactionListParams", + params: Optional["CreditBalanceTransactionListParams"] = None, options: Optional["RequestOptions"] = None, ) -> "ListObject[CreditBalanceTransaction]": """ diff --git a/stripe/billing/_credit_grant.py b/stripe/billing/_credit_grant.py index fda5610a2..2c091e302 100644 --- a/stripe/billing/_credit_grant.py +++ b/stripe/billing/_credit_grant.py @@ -104,6 +104,10 @@ class Price(StripeObject): """ ID of the customer receiving the billing credits. """ + customer_account: Optional[str] + """ + ID of the account representing the customer receiving the billing credits + """ effective_at: Optional[int] """ The time when the billing credits become effective-when they're eligible for use. @@ -122,7 +126,7 @@ class Price(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ name: Optional[str] """ diff --git a/stripe/billing/_meter_event.py b/stripe/billing/_meter_event.py index 53dcfa569..8fa8003d3 100644 --- a/stripe/billing/_meter_event.py +++ b/stripe/billing/_meter_event.py @@ -40,7 +40,7 @@ class MeterEvent(CreateableAPIResource["MeterEvent"]): """ payload: Dict[str, str] """ - The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). + The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/meters/configure#meter-configuration-attributes). """ timestamp: int """ diff --git a/stripe/billing_portal/_configuration.py b/stripe/billing_portal/_configuration.py index 451dca049..3dc14ebc1 100644 --- a/stripe/billing_portal/_configuration.py +++ b/stripe/billing_portal/_configuration.py @@ -167,6 +167,10 @@ class Condition(StripeObject): """ _inner_class_types = {"conditions": Condition} + billing_cycle_anchor: Optional[Literal["now", "unchanged"]] + """ + Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `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://docs.stripe.com/billing/subscriptions/billing-cycle). + """ default_allowed_updates: List[ Literal["price", "promotion_code", "quantity"] ] @@ -219,7 +223,7 @@ class LoginPage(StripeObject): """ url: Optional[str] """ - A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal. + A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://docs.stripe.com/api/customers/object#customer_object-email) and receive a link to their customer portal. """ active: bool @@ -237,7 +241,7 @@ class LoginPage(StripeObject): """ default_return_url: Optional[str] """ - 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. + 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://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. """ features: Features id: str @@ -255,7 +259,7 @@ class LoginPage(StripeObject): login_page: LoginPage metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ name: Optional[str] """ diff --git a/stripe/billing_portal/_session.py b/stripe/billing_portal/_session.py index c8d22f301..fe61bda62 100644 --- a/stripe/billing_portal/_session.py +++ b/stripe/billing_portal/_session.py @@ -114,15 +114,15 @@ class Discount(StripeObject): class Item(StripeObject): id: Optional[str] """ - The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated. + The ID of the [subscription item](https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id) to be updated. """ price: Optional[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). + 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://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). """ quantity: Optional[int] """ - [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow. + [Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow. """ discounts: Optional[List[Discount]] @@ -131,7 +131,7 @@ class Item(StripeObject): """ items: List[Item] """ - The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable. + The [subscription item](https://docs.stripe.com/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable. """ subscription: str """ @@ -180,9 +180,13 @@ class Item(StripeObject): """ The ID of the customer for this session. """ + customer_account: Optional[str] + """ + The ID of the account for this session. + """ flow: Optional[Flow] """ - 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. + Information about a specific flow for the customer to go through. See the [docs](https://docs.stripe.com/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. """ id: str """ @@ -252,7 +256,7 @@ class Item(StripeObject): """ on_behalf_of: Optional[str] """ - The account for which the session was created on behalf of. 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#settlement-merchant). 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. + The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://docs.stripe.com/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. """ return_url: Optional[str] """ diff --git a/stripe/billing_portal/_session_service.py b/stripe/billing_portal/_session_service.py index c8e8224af..5e77ddef0 100644 --- a/stripe/billing_portal/_session_service.py +++ b/stripe/billing_portal/_session_service.py @@ -15,7 +15,7 @@ class SessionService(StripeService): def create( self, - params: "SessionCreateParams", + params: Optional["SessionCreateParams"] = None, options: Optional["RequestOptions"] = None, ) -> "Session": """ @@ -34,7 +34,7 @@ def create( async def create_async( self, - params: "SessionCreateParams", + params: Optional["SessionCreateParams"] = None, options: Optional["RequestOptions"] = None, ) -> "Session": """ diff --git a/stripe/checkout/_session.py b/stripe/checkout/_session.py index 469ccbfae..0ce3ded81 100644 --- a/stripe/checkout/_session.py +++ b/stripe/checkout/_session.py @@ -50,19 +50,19 @@ class Session( ): """ A Checkout Session represents your customer's session as they pay for - one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout) - or [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a + one-time purchases or subscriptions through [Checkout](https://docs.stripe.com/payments/checkout) + or [Payment Links](https://docs.stripe.com/payments/payment-links). We recommend creating a new Session each time your customer attempts to pay. Once payment is successful, the Checkout Session will contain a reference - to the [Customer](https://stripe.com/docs/api/customers), and either the successful - [PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active - [Subscription](https://stripe.com/docs/api/subscriptions). + to the [Customer](https://docs.stripe.com/api/customers), and either the successful + [PaymentIntent](https://docs.stripe.com/api/payment_intents) or an active + [Subscription](https://docs.stripe.com/api/subscriptions). You can create a Checkout Session on your server and redirect to its URL to begin Checkout. - Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart) + Related guide: [Checkout quickstart](https://docs.stripe.com/checkout/quickstart) """ OBJECT_NAME: ClassVar[Literal["checkout.session"]] = "checkout.session" @@ -215,7 +215,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Address @@ -462,7 +462,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class TaxId(StripeObject): @@ -686,7 +686,7 @@ class RenderingOptions(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ rendering_options: Optional[RenderingOptions] """ @@ -1008,7 +1008,7 @@ class Restrictions(StripeObject): """ request_three_d_secure: 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. + 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ restrictions: Optional[Restrictions] setup_future_usage: Optional[ @@ -1366,6 +1366,75 @@ class Paypal(StripeObject): When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication). """ + class Payto(StripeObject): + class MandateOptions(StripeObject): + amount: Optional[int] + """ + Amount that will be collected. It is required when `amount_type` is `fixed`. + """ + amount_type: Optional[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. Defaults to `maximum`. + """ + end_date: Optional[str] + """ + Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. + """ + payment_schedule: Optional[ + Literal[ + "adhoc", + "annual", + "daily", + "fortnightly", + "monthly", + "quarterly", + "semi_annual", + "weekly", + ] + ] + """ + The periodicity at which payments will be collected. Defaults to `adhoc`. + """ + payments_per_period: Optional[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: Optional[ + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + start_date: Optional[str] + """ + Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. + """ + + mandate_options: Optional[MandateOptions] + setup_future_usage: Optional[Literal["none", "off_session"]] + """ + Indicates that you intend to make future payments with this PaymentIntent's payment method. + + If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes. + + If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. + + When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication). + """ + _inner_class_types = {"mandate_options": MandateOptions} + class Pix(StripeObject): amount_includes_iof: Optional[Literal["always", "never"]] """ @@ -1563,6 +1632,7 @@ class Filters(StripeObject): payco: Optional[Payco] paynow: Optional[Paynow] paypal: Optional[Paypal] + payto: Optional[Payto] pix: Optional[Pix] revolut_pay: Optional[RevolutPay] samsung_pay: Optional[SamsungPay] @@ -1605,6 +1675,7 @@ class Filters(StripeObject): "payco": Payco, "paynow": Paynow, "paypal": Paypal, + "payto": Payto, "pix": Pix, "revolut_pay": RevolutPay, "samsung_pay": SamsungPay, @@ -1998,10 +2069,10 @@ class Discount(StripeObject): """ discount: "DiscountResource" """ - A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes). + A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. - Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts) + Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) """ class Tax(StripeObject): @@ -2116,7 +2187,7 @@ class Link(StripeObject): client_secret: Optional[str] """ The client secret of your Checkout Session. Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. For `ui_mode: embedded`, the client secret is to be used when initializing Stripe.js embedded checkout. - For `ui_mode: custom`, use the client secret with [initCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end. + For `ui_mode: custom`, use the client secret with [initCheckout](https://docs.stripe.com/js/custom_checkout/init) on your front end. """ collected_information: Optional[CollectedInformation] """ @@ -2155,6 +2226,10 @@ class Link(StripeObject): during the payment flow unless an existing customer was provided when the Session was created. """ + customer_account: Optional[str] + """ + The ID of the account for this Session. + """ customer_creation: Optional[Literal["always", "if_required"]] """ Configure whether a Checkout Session creates a Customer when the Checkout Session completes. @@ -2253,7 +2328,7 @@ class Link(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ mode: Literal["payment", "setup", "subscription"] """ @@ -2274,7 +2349,7 @@ class Link(StripeObject): """ payment_intent: Optional[ExpandableField["PaymentIntent"]] """ - The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://docs.stripe.com/api/checkout/sessions/expire) instead. """ payment_link: Optional[ExpandableField["PaymentLink"]] """ @@ -2318,7 +2393,7 @@ class Link(StripeObject): """ redirect_on_completion: Optional[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-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. + This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. """ return_url: Optional[str] """ @@ -2330,7 +2405,7 @@ class Link(StripeObject): """ setup_intent: Optional[ExpandableField["SetupIntent"]] """ - The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://docs.stripe.com/api/checkout/sessions/expire) instead. """ shipping_address_collection: Optional[ShippingAddressCollection] """ @@ -2358,7 +2433,7 @@ class Link(StripeObject): """ subscription: Optional[ExpandableField["Subscription"]] """ - The ID of the [Subscription](https://stripe.com/docs/api/subscriptions) for Checkout Sessions in `subscription` mode. + The ID of the [Subscription](https://docs.stripe.com/api/subscriptions) for Checkout Sessions in `subscription` mode. """ success_url: Optional[str] """ @@ -2376,7 +2451,7 @@ class Link(StripeObject): """ url: Optional[str] """ - The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted`. Redirect customers to this URL to take them to Checkout. If you're using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it'll use `checkout.stripe.com.` + The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted`. Redirect customers to this URL to take them to Checkout. If you're using [Custom Domains](https://docs.stripe.com/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it'll use `checkout.stripe.com.` This value is only present when the session is active. """ wallet_options: Optional[WalletOptions] diff --git a/stripe/climate/_order.py b/stripe/climate/_order.py index 477690ee9..2e92175f0 100644 --- a/stripe/climate/_order.py +++ b/stripe/climate/_order.py @@ -150,7 +150,7 @@ class Location(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ metric_tons: str """ diff --git a/stripe/entitlements/_active_entitlement.py b/stripe/entitlements/_active_entitlement.py index 9e95b282d..b9b6c4ead 100644 --- a/stripe/entitlements/_active_entitlement.py +++ b/stripe/entitlements/_active_entitlement.py @@ -26,7 +26,7 @@ class ActiveEntitlement(ListableAPIResource["ActiveEntitlement"]): ) feature: ExpandableField["Feature"] """ - The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to. + The [Feature](https://docs.stripe.com/api/entitlements/feature) that the customer is entitled to. """ id: str """ diff --git a/stripe/financial_connections/_account.py b/stripe/financial_connections/_account.py index ba13ca94c..60377b1d6 100644 --- a/stripe/financial_connections/_account.py +++ b/stripe/financial_connections/_account.py @@ -50,12 +50,13 @@ class Account(ListableAPIResource["Account"]): class AccountHolder(StripeObject): account: Optional[ExpandableField["AccountResource"]] """ - The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`. + The ID of the Stripe account that this account belongs to. Only available when `account_holder.type` is `account`. """ customer: Optional[ExpandableField["Customer"]] """ - ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`. + The ID for an Account representing a customer that this account belongs to. Only available when `account_holder.type` is `customer`. """ + customer_account: Optional[str] type: Literal["account", "customer"] """ Type of account holder that this account belongs to. @@ -264,7 +265,7 @@ class TransactionRefresh(StripeObject): """ supported_payment_method_types: List[Literal["link", "us_bank_account"]] """ - The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account. + The [PaymentMethod type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account. """ transaction_refresh: Optional[TransactionRefresh] """ diff --git a/stripe/financial_connections/_session.py b/stripe/financial_connections/_session.py index ca069370c..c466897b2 100644 --- a/stripe/financial_connections/_session.py +++ b/stripe/financial_connections/_session.py @@ -33,12 +33,13 @@ class Session(CreateableAPIResource["Session"]): class AccountHolder(StripeObject): account: Optional[ExpandableField["AccountResource"]] """ - The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`. + The ID of the Stripe account that this account belongs to. Only available when `account_holder.type` is `account`. """ customer: Optional[ExpandableField["Customer"]] """ - ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`. + The ID for an Account representing a customer that this account belongs to. Only available when `account_holder.type` is `customer`. """ + customer_account: Optional[str] type: Literal["account", "customer"] """ Type of account holder that this account belongs to. diff --git a/stripe/forwarding/_request.py b/stripe/forwarding/_request.py index cd1bd7016..2c6f23971 100644 --- a/stripe/forwarding/_request.py +++ b/stripe/forwarding/_request.py @@ -115,7 +115,7 @@ class Header(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["forwarding.request"] """ diff --git a/stripe/identity/_verification_report.py b/stripe/identity/_verification_report.py index 335851502..df53ce6fb 100644 --- a/stripe/identity/_verification_report.py +++ b/stripe/identity/_verification_report.py @@ -23,11 +23,11 @@ class VerificationReport(ListableAPIResource["VerificationReport"]): appropriate sub-resource: `document`, `id_number`, `selfie`. Each VerificationReport contains a copy of any data collected by the user as well as - reference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files) + reference IDs which can be used to access collected images through the [FileUpload](https://docs.stripe.com/api/files) API. To configure and create VerificationReports, use the - [VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API. + [VerificationSession](https://docs.stripe.com/api/identity/verification_sessions) API. - Related guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). + Related guide: [Accessing verification results](https://docs.stripe.com/identity/verification-sessions#results). """ OBJECT_NAME: ClassVar[Literal["identity.verification_report"]] = ( @@ -58,7 +58,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class Dob(StripeObject): @@ -137,7 +137,7 @@ class IssuedDate(StripeObject): """ files: Optional[List[str]] """ - Array of [File](https://stripe.com/docs/api/files) ids containing images for this document. + Array of [File](https://docs.stripe.com/api/files) ids containing images for this document. """ first_name: Optional[str] """ @@ -287,7 +287,7 @@ class Document(StripeObject): """ require_id_number: Optional[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. + Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document's extracted name and date of birth. """ require_live_capture: Optional[bool] """ @@ -295,7 +295,7 @@ class Document(StripeObject): """ require_matching_selfie: Optional[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). + Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://docs.stripe.com/identity/selfie). """ class IdNumber(StripeObject): @@ -354,7 +354,7 @@ class Error(StripeObject): document: Optional[str] """ - ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check. + ID of the [File](https://docs.stripe.com/api/files) holding the image of the identity document used in this check. """ error: Optional[Error] """ @@ -362,7 +362,7 @@ class Error(StripeObject): """ selfie: Optional[str] """ - ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check. + ID of the [File](https://docs.stripe.com/api/files) holding the image of the selfie used in this check. """ status: Literal["unverified", "verified"] """ diff --git a/stripe/identity/_verification_session.py b/stripe/identity/_verification_session.py index 7c7fe4982..374f3d5bd 100644 --- a/stripe/identity/_verification_session.py +++ b/stripe/identity/_verification_session.py @@ -48,7 +48,7 @@ class VerificationSession( the verification flow. The VerificationSession contains the user's verified data after verification checks are complete. - Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions) + Related guide: [The Verification Sessions API](https://docs.stripe.com/identity/verification-sessions) """ OBJECT_NAME: ClassVar[Literal["identity.verification_session"]] = ( @@ -97,7 +97,7 @@ class Document(StripeObject): """ require_id_number: Optional[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. + Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document's extracted name and date of birth. """ require_live_capture: Optional[bool] """ @@ -105,7 +105,7 @@ class Document(StripeObject): """ require_matching_selfie: Optional[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). + Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://docs.stripe.com/identity/selfie). """ class Email(StripeObject): @@ -196,7 +196,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class Dob(StripeObject): @@ -265,7 +265,7 @@ class Dob(StripeObject): """ client_secret: Optional[str] """ - The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don't store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more. + The short-lived client secret used by Stripe.js to [show a verification modal](https://docs.stripe.com/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don't store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://docs.stripe.com/identity/verification-sessions#client-secret) to learn more. """ created: int """ @@ -281,7 +281,7 @@ class Dob(StripeObject): """ last_verification_report: Optional[ExpandableField["VerificationReport"]] """ - ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results) + ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://docs.stripe.com/identity/verification-sessions#results) """ livemode: bool """ @@ -289,7 +289,7 @@ class Dob(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["identity.verification_session"] """ @@ -311,18 +311,22 @@ class Dob(StripeObject): """ Customer ID """ + related_customer_account: Optional[str] + """ + The ID of the Account representing a customer. + """ related_person: Optional[RelatedPerson] status: Literal["canceled", "processing", "requires_input", "verified"] """ - Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). + Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work). """ type: Literal["document", "id_number", "verification_flow"] """ - The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. + The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed. """ url: Optional[str] """ - The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don't store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe. + The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don't store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://docs.stripe.com/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe. """ verification_flow: Optional[str] """ diff --git a/stripe/issuing/_authorization.py b/stripe/issuing/_authorization.py index 60e775d02..55dbb593d 100644 --- a/stripe/issuing/_authorization.py +++ b/stripe/issuing/_authorization.py @@ -59,11 +59,11 @@ class Authorization( UpdateableAPIResource["Authorization"], ): """ - When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization` - object is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the + When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization` + object is created. [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the purchase to be completed successfully. - Related guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations) + Related guide: [Issued card authorizations](https://docs.stripe.com/issuing/purchases/authorizations) """ OBJECT_NAME: ClassVar[Literal["issuing.authorization"]] = ( @@ -239,7 +239,7 @@ class Fuel(StripeObject): class MerchantData(StripeObject): category: str """ - 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. + A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values. """ category_code: str """ @@ -309,11 +309,11 @@ class AmountDetails(StripeObject): amount: int """ - The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://docs.stripe.com/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ amount_details: Optional[AmountDetails] """ - Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ currency: str """ @@ -321,11 +321,11 @@ class AmountDetails(StripeObject): """ is_amount_controllable: 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. + If set `true`, you may provide [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. """ merchant_amount: int """ - The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ merchant_currency: str """ @@ -350,11 +350,11 @@ class AmountDetails(StripeObject): amount: int """ - The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved. + The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved. """ amount_details: Optional[AmountDetails] """ - Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ approved: bool """ @@ -374,7 +374,7 @@ class AmountDetails(StripeObject): """ merchant_amount: int """ - The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ merchant_currency: str """ @@ -422,15 +422,15 @@ class AmountDetails(StripeObject): class Treasury(StripeObject): received_credits: List[str] """ - The array of [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) associated with this authorization + The array of [ReceivedCredits](https://docs.stripe.com/api/treasury/received_credits) associated with this authorization """ received_debits: List[str] """ - The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization + The array of [ReceivedDebits](https://docs.stripe.com/api/treasury/received_debits) associated with this authorization """ transaction: Optional[str] """ - The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization + The Treasury [Transaction](https://docs.stripe.com/api/treasury/transactions) associated with this authorization """ class VerificationData(StripeObject): @@ -493,7 +493,7 @@ class ThreeDSecure(StripeObject): """ amount_details: Optional[AmountDetails] """ - Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ approved: bool """ @@ -511,7 +511,7 @@ class ThreeDSecure(StripeObject): """ card: "Card" """ - You can [create physical or virtual cards](https://stripe.com/docs/issuing) that are issued to cardholders. + You can [create physical or virtual cards](https://docs.stripe.com/issuing) that are issued to cardholders. """ cardholder: Optional[ExpandableField["Cardholder"]] """ @@ -556,7 +556,7 @@ class ThreeDSecure(StripeObject): merchant_data: MerchantData metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ network_data: Optional[NetworkData] """ @@ -580,15 +580,15 @@ class ThreeDSecure(StripeObject): """ token: Optional[ExpandableField["Token"]] """ - [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null. + [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null. """ transactions: List["Transaction"] """ - List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. + List of [transactions](https://docs.stripe.com/api/issuing/transactions) associated with this authorization. """ treasury: Optional[Treasury] """ - [Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts). + [Treasury](https://docs.stripe.com/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://docs.stripe.com/api/treasury/financial_accounts). """ verification_data: VerificationData verified_by_fraud_challenge: Optional[bool] diff --git a/stripe/issuing/_card.py b/stripe/issuing/_card.py index bd805f845..c45204df3 100644 --- a/stripe/issuing/_card.py +++ b/stripe/issuing/_card.py @@ -37,7 +37,7 @@ class Card( UpdateableAPIResource["Card"], ): """ - You can [create physical or virtual cards](https://stripe.com/docs/issuing) that are issued to cardholders. + You can [create physical or virtual cards](https://docs.stripe.com/issuing) that are issued to cardholders. """ OBJECT_NAME: ClassVar[Literal["issuing.card"]] = "issuing.card" @@ -83,7 +83,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class AddressValidation(StripeObject): @@ -110,7 +110,7 @@ class NormalizedAddress(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ mode: Literal[ @@ -212,7 +212,7 @@ class SpendingControls(StripeObject): class SpendingLimit(StripeObject): amount: int """ - Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ categories: Optional[ List[ @@ -516,7 +516,7 @@ class SpendingLimit(StripeObject): ] ] """ - 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. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. """ interval: Literal[ "all_time", @@ -832,7 +832,7 @@ class SpendingLimit(StripeObject): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ allowed_merchant_countries: Optional[List[str]] """ @@ -1140,7 +1140,7 @@ class SpendingLimit(StripeObject): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ blocked_merchant_countries: Optional[List[str]] """ @@ -1207,9 +1207,9 @@ class GooglePay(StripeObject): """ cardholder: "Cardholder" """ - An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards. + An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://docs.stripe.com/issuing) cards. - Related guide: [How to create a cardholder](https://stripe.com/docs/issuing/cards/virtual/issue-cards#create-cardholder) + Related guide: [How to create a cardholder](https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder) """ created: int """ @@ -1221,7 +1221,7 @@ class GooglePay(StripeObject): """ cvc: Optional[str] """ - The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. + The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. """ exp_month: int """ @@ -1253,11 +1253,11 @@ class GooglePay(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ number: Optional[str] """ - The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. + The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. """ object: Literal["issuing.card"] """ diff --git a/stripe/issuing/_cardholder.py b/stripe/issuing/_cardholder.py index 673668b82..15aecebe0 100644 --- a/stripe/issuing/_cardholder.py +++ b/stripe/issuing/_cardholder.py @@ -32,9 +32,9 @@ class Cardholder( UpdateableAPIResource["Cardholder"], ): """ - An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards. + An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://docs.stripe.com/issuing) cards. - Related guide: [How to create a cardholder](https://stripe.com/docs/issuing/cards/virtual/issue-cards#create-cardholder) + Related guide: [How to create a cardholder](https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder) """ OBJECT_NAME: ClassVar[Literal["issuing.cardholder"]] = "issuing.cardholder" @@ -63,7 +63,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Address @@ -115,11 +115,11 @@ class Verification(StripeObject): class Document(StripeObject): back: Optional[ExpandableField["File"]] """ - The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. + The back of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. """ front: Optional[ExpandableField["File"]] """ - The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. + The front of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. """ document: Optional[Document] @@ -189,7 +189,7 @@ class SpendingControls(StripeObject): class SpendingLimit(StripeObject): amount: int """ - Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ categories: Optional[ List[ @@ -493,7 +493,7 @@ class SpendingLimit(StripeObject): ] ] """ - 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. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. """ interval: Literal[ "all_time", @@ -809,7 +809,7 @@ class SpendingLimit(StripeObject): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ allowed_merchant_countries: Optional[List[str]] """ @@ -1117,7 +1117,7 @@ class SpendingLimit(StripeObject): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ blocked_merchant_countries: Optional[List[str]] """ @@ -1160,7 +1160,7 @@ class SpendingLimit(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ name: str """ @@ -1172,17 +1172,17 @@ class SpendingLimit(StripeObject): """ phone_number: Optional[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#when-is-3d-secure-applied) for more details. + The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details. """ preferred_locales: Optional[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`. - This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. + This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder. """ requirements: Requirements spending_controls: Optional[SpendingControls] """ - Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. + Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. """ status: Literal["active", "blocked", "inactive"] """ @@ -1190,7 +1190,7 @@ class SpendingLimit(StripeObject): """ type: Literal["company", "individual"] """ - One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details. + One of `individual` or `company`. See [Choose a cardholder type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details. """ @classmethod diff --git a/stripe/issuing/_dispute.py b/stripe/issuing/_dispute.py index 2be6f914d..b9a4a9fd3 100644 --- a/stripe/issuing/_dispute.py +++ b/stripe/issuing/_dispute.py @@ -35,9 +35,9 @@ class Dispute( UpdateableAPIResource["Dispute"], ): """ - As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with. + As a [card issuer](https://docs.stripe.com/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with. - Related guide: [Issuing disputes](https://stripe.com/docs/issuing/purchases/disputes) + Related guide: [Issuing disputes](https://docs.stripe.com/issuing/purchases/disputes) """ OBJECT_NAME: ClassVar[Literal["issuing.dispute"]] = "issuing.dispute" @@ -254,16 +254,16 @@ class ServiceNotAsDescribed(StripeObject): class Treasury(StripeObject): debit_reversal: Optional[str] """ - The Treasury [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) representing this Issuing dispute + The Treasury [DebitReversal](https://docs.stripe.com/api/treasury/debit_reversals) representing this Issuing dispute """ received_debit: str """ - The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) that is being disputed. + The Treasury [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) that is being disputed. """ amount: int """ - Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). + Disputed amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). """ balance_transactions: Optional[List["BalanceTransaction"]] """ @@ -315,7 +315,7 @@ class Treasury(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["issuing.dispute"] """ @@ -331,7 +331,7 @@ class Treasury(StripeObject): """ treasury: Optional[Treasury] """ - [Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts + [Treasury](https://docs.stripe.com/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts """ @classmethod diff --git a/stripe/issuing/_personalization_design.py b/stripe/issuing/_personalization_design.py index fd65ab0ac..fcdcc5e96 100644 --- a/stripe/issuing/_personalization_design.py +++ b/stripe/issuing/_personalization_design.py @@ -139,7 +139,7 @@ class RejectionReasons(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ name: Optional[str] """ diff --git a/stripe/issuing/_token.py b/stripe/issuing/_token.py index 85434e3ea..1a76ce121 100644 --- a/stripe/issuing/_token.py +++ b/stripe/issuing/_token.py @@ -20,7 +20,7 @@ class Token(ListableAPIResource["Token"], UpdateableAPIResource["Token"]): """ - An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe. + An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://docs.stripe.com/issuing), you can [view and manage these tokens](https://docs.stripe.com/issuing/controls/token-management) through Stripe. """ OBJECT_NAME: ClassVar[Literal["issuing.token"]] = "issuing.token" diff --git a/stripe/issuing/_transaction.py b/stripe/issuing/_transaction.py index 4677555a5..c5b3dff39 100644 --- a/stripe/issuing/_transaction.py +++ b/stripe/issuing/_transaction.py @@ -42,11 +42,11 @@ class Transaction( UpdateableAPIResource["Transaction"], ): """ - Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving + Any use of an [issued card](https://docs.stripe.com/issuing) that results in funds entering or leaving your Stripe account, such as a completed purchase or refund, is represented by an Issuing `Transaction` object. - Related guide: [Issued card transactions](https://stripe.com/docs/issuing/purchases/transactions) + Related guide: [Issued card transactions](https://docs.stripe.com/issuing/purchases/transactions) """ OBJECT_NAME: ClassVar[Literal["issuing.transaction"]] = ( @@ -66,7 +66,7 @@ class AmountDetails(StripeObject): class MerchantData(StripeObject): category: str """ - 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. + A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values. """ category_code: str """ @@ -343,20 +343,20 @@ class Receipt(StripeObject): class Treasury(StripeObject): received_credit: Optional[str] """ - The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund + The Treasury [ReceivedCredit](https://docs.stripe.com/api/treasury/received_credits) representing this Issuing transaction if it is a refund """ received_debit: Optional[str] """ - The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture + The Treasury [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) representing this Issuing transaction if it is a capture """ amount: int """ - The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ amount_details: Optional[AmountDetails] """ - Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ authorization: Optional[ExpandableField["Authorization"]] """ @@ -364,7 +364,7 @@ class Treasury(StripeObject): """ balance_transaction: Optional[ExpandableField["BalanceTransaction"]] """ - ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. + ID of the [balance transaction](https://docs.stripe.com/api/balance_transactions) associated with this transaction. """ card: ExpandableField["Card"] """ @@ -396,7 +396,7 @@ class Treasury(StripeObject): """ merchant_amount: int """ - The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. + The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. """ merchant_currency: str """ @@ -405,7 +405,7 @@ class Treasury(StripeObject): merchant_data: MerchantData metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ network_data: Optional[NetworkData] """ @@ -421,11 +421,11 @@ class Treasury(StripeObject): """ token: Optional[ExpandableField["Token"]] """ - [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. + [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. """ treasury: Optional[Treasury] """ - [Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts + [Treasury](https://docs.stripe.com/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts """ type: Literal["capture", "refund"] """ diff --git a/stripe/params/__init__.py b/stripe/params/__init__.py index 774da99ba..c1740f278 100644 --- a/stripe/params/__init__.py +++ b/stripe/params/__init__.py @@ -92,6 +92,7 @@ AccountCreateParamsCapabilitiesPayByBankPayments as AccountCreateParamsCapabilitiesPayByBankPayments, AccountCreateParamsCapabilitiesPaycoPayments as AccountCreateParamsCapabilitiesPaycoPayments, AccountCreateParamsCapabilitiesPaynowPayments as AccountCreateParamsCapabilitiesPaynowPayments, + AccountCreateParamsCapabilitiesPaytoPayments as AccountCreateParamsCapabilitiesPaytoPayments, AccountCreateParamsCapabilitiesPixPayments as AccountCreateParamsCapabilitiesPixPayments, AccountCreateParamsCapabilitiesPromptpayPayments as AccountCreateParamsCapabilitiesPromptpayPayments, AccountCreateParamsCapabilitiesRevolutPayPayments as AccountCreateParamsCapabilitiesRevolutPayPayments, @@ -134,7 +135,9 @@ AccountCreateParamsDocumentsCompanyTaxIdVerification as AccountCreateParamsDocumentsCompanyTaxIdVerification, AccountCreateParamsDocumentsProofOfAddress as AccountCreateParamsDocumentsProofOfAddress, AccountCreateParamsDocumentsProofOfRegistration as AccountCreateParamsDocumentsProofOfRegistration, + AccountCreateParamsDocumentsProofOfRegistrationSigner as AccountCreateParamsDocumentsProofOfRegistrationSigner, AccountCreateParamsDocumentsProofOfUltimateBeneficialOwnership as AccountCreateParamsDocumentsProofOfUltimateBeneficialOwnership, + AccountCreateParamsDocumentsProofOfUltimateBeneficialOwnershipSigner as AccountCreateParamsDocumentsProofOfUltimateBeneficialOwnershipSigner, AccountCreateParamsGroups as AccountCreateParamsGroups, AccountCreateParamsIndividual as AccountCreateParamsIndividual, AccountCreateParamsIndividualAddress as AccountCreateParamsIndividualAddress, @@ -428,6 +431,7 @@ AccountUpdateParamsCapabilitiesPayByBankPayments as AccountUpdateParamsCapabilitiesPayByBankPayments, AccountUpdateParamsCapabilitiesPaycoPayments as AccountUpdateParamsCapabilitiesPaycoPayments, AccountUpdateParamsCapabilitiesPaynowPayments as AccountUpdateParamsCapabilitiesPaynowPayments, + AccountUpdateParamsCapabilitiesPaytoPayments as AccountUpdateParamsCapabilitiesPaytoPayments, AccountUpdateParamsCapabilitiesPixPayments as AccountUpdateParamsCapabilitiesPixPayments, AccountUpdateParamsCapabilitiesPromptpayPayments as AccountUpdateParamsCapabilitiesPromptpayPayments, AccountUpdateParamsCapabilitiesRevolutPayPayments as AccountUpdateParamsCapabilitiesRevolutPayPayments, @@ -466,7 +470,9 @@ AccountUpdateParamsDocumentsCompanyTaxIdVerification as AccountUpdateParamsDocumentsCompanyTaxIdVerification, AccountUpdateParamsDocumentsProofOfAddress as AccountUpdateParamsDocumentsProofOfAddress, AccountUpdateParamsDocumentsProofOfRegistration as AccountUpdateParamsDocumentsProofOfRegistration, + AccountUpdateParamsDocumentsProofOfRegistrationSigner as AccountUpdateParamsDocumentsProofOfRegistrationSigner, AccountUpdateParamsDocumentsProofOfUltimateBeneficialOwnership as AccountUpdateParamsDocumentsProofOfUltimateBeneficialOwnership, + AccountUpdateParamsDocumentsProofOfUltimateBeneficialOwnershipSigner as AccountUpdateParamsDocumentsProofOfUltimateBeneficialOwnershipSigner, AccountUpdateParamsGroups as AccountUpdateParamsGroups, AccountUpdateParamsIndividual as AccountUpdateParamsIndividual, AccountUpdateParamsIndividualAddress as AccountUpdateParamsIndividualAddress, @@ -655,6 +661,7 @@ ConfirmationTokenCreateParamsPaymentMethodDataPayco as ConfirmationTokenCreateParamsPaymentMethodDataPayco, ConfirmationTokenCreateParamsPaymentMethodDataPaynow as ConfirmationTokenCreateParamsPaymentMethodDataPaynow, ConfirmationTokenCreateParamsPaymentMethodDataPaypal as ConfirmationTokenCreateParamsPaymentMethodDataPaypal, + ConfirmationTokenCreateParamsPaymentMethodDataPayto as ConfirmationTokenCreateParamsPaymentMethodDataPayto, ConfirmationTokenCreateParamsPaymentMethodDataPix as ConfirmationTokenCreateParamsPaymentMethodDataPix, ConfirmationTokenCreateParamsPaymentMethodDataPromptpay as ConfirmationTokenCreateParamsPaymentMethodDataPromptpay, ConfirmationTokenCreateParamsPaymentMethodDataRadarOptions as ConfirmationTokenCreateParamsPaymentMethodDataRadarOptions, @@ -1076,6 +1083,8 @@ InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer as InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer, InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer as InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer, InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsKonbini as InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsKonbini, + InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsPayto as InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsPayto, + InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions as InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions, InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsSepaDebit as InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsSepaDebit, InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccount as InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccount, InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections as InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections, @@ -1221,6 +1230,8 @@ InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer as InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer, InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer as InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer, InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsKonbini as InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsKonbini, + InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsPayto as InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsPayto, + InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions as InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions, InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsSepaDebit as InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsSepaDebit, InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsUsBankAccount as InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsUsBankAccount, InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections as InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections, @@ -1304,6 +1315,8 @@ InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer as InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer, InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer as InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer, InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsKonbini as InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsKonbini, + InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsPayto as InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsPayto, + InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions as InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions, InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsSepaDebit as InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsSepaDebit, InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsUsBankAccount as InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsUsBankAccount, InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections as InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections, @@ -1421,6 +1434,7 @@ PaymentIntentConfirmParamsPaymentMethodDataPayco as PaymentIntentConfirmParamsPaymentMethodDataPayco, PaymentIntentConfirmParamsPaymentMethodDataPaynow as PaymentIntentConfirmParamsPaymentMethodDataPaynow, PaymentIntentConfirmParamsPaymentMethodDataPaypal as PaymentIntentConfirmParamsPaymentMethodDataPaypal, + PaymentIntentConfirmParamsPaymentMethodDataPayto as PaymentIntentConfirmParamsPaymentMethodDataPayto, PaymentIntentConfirmParamsPaymentMethodDataPix as PaymentIntentConfirmParamsPaymentMethodDataPix, PaymentIntentConfirmParamsPaymentMethodDataPromptpay as PaymentIntentConfirmParamsPaymentMethodDataPromptpay, PaymentIntentConfirmParamsPaymentMethodDataRadarOptions as PaymentIntentConfirmParamsPaymentMethodDataRadarOptions, @@ -1488,6 +1502,8 @@ PaymentIntentConfirmParamsPaymentMethodOptionsPayco as PaymentIntentConfirmParamsPaymentMethodOptionsPayco, PaymentIntentConfirmParamsPaymentMethodOptionsPaynow as PaymentIntentConfirmParamsPaymentMethodOptionsPaynow, PaymentIntentConfirmParamsPaymentMethodOptionsPaypal as PaymentIntentConfirmParamsPaymentMethodOptionsPaypal, + PaymentIntentConfirmParamsPaymentMethodOptionsPayto as PaymentIntentConfirmParamsPaymentMethodOptionsPayto, + PaymentIntentConfirmParamsPaymentMethodOptionsPaytoMandateOptions as PaymentIntentConfirmParamsPaymentMethodOptionsPaytoMandateOptions, PaymentIntentConfirmParamsPaymentMethodOptionsPix as PaymentIntentConfirmParamsPaymentMethodOptionsPix, PaymentIntentConfirmParamsPaymentMethodOptionsPromptpay as PaymentIntentConfirmParamsPaymentMethodOptionsPromptpay, PaymentIntentConfirmParamsPaymentMethodOptionsRevolutPay as PaymentIntentConfirmParamsPaymentMethodOptionsRevolutPay, @@ -1571,6 +1587,7 @@ PaymentIntentCreateParamsPaymentMethodDataPayco as PaymentIntentCreateParamsPaymentMethodDataPayco, PaymentIntentCreateParamsPaymentMethodDataPaynow as PaymentIntentCreateParamsPaymentMethodDataPaynow, PaymentIntentCreateParamsPaymentMethodDataPaypal as PaymentIntentCreateParamsPaymentMethodDataPaypal, + PaymentIntentCreateParamsPaymentMethodDataPayto as PaymentIntentCreateParamsPaymentMethodDataPayto, PaymentIntentCreateParamsPaymentMethodDataPix as PaymentIntentCreateParamsPaymentMethodDataPix, PaymentIntentCreateParamsPaymentMethodDataPromptpay as PaymentIntentCreateParamsPaymentMethodDataPromptpay, PaymentIntentCreateParamsPaymentMethodDataRadarOptions as PaymentIntentCreateParamsPaymentMethodDataRadarOptions, @@ -1638,6 +1655,8 @@ PaymentIntentCreateParamsPaymentMethodOptionsPayco as PaymentIntentCreateParamsPaymentMethodOptionsPayco, PaymentIntentCreateParamsPaymentMethodOptionsPaynow as PaymentIntentCreateParamsPaymentMethodOptionsPaynow, PaymentIntentCreateParamsPaymentMethodOptionsPaypal as PaymentIntentCreateParamsPaymentMethodOptionsPaypal, + PaymentIntentCreateParamsPaymentMethodOptionsPayto as PaymentIntentCreateParamsPaymentMethodOptionsPayto, + PaymentIntentCreateParamsPaymentMethodOptionsPaytoMandateOptions as PaymentIntentCreateParamsPaymentMethodOptionsPaytoMandateOptions, PaymentIntentCreateParamsPaymentMethodOptionsPix as PaymentIntentCreateParamsPaymentMethodOptionsPix, PaymentIntentCreateParamsPaymentMethodOptionsPromptpay as PaymentIntentCreateParamsPaymentMethodOptionsPromptpay, PaymentIntentCreateParamsPaymentMethodOptionsRevolutPay as PaymentIntentCreateParamsPaymentMethodOptionsRevolutPay, @@ -1742,6 +1761,7 @@ PaymentIntentModifyParamsPaymentMethodDataPayco as PaymentIntentModifyParamsPaymentMethodDataPayco, PaymentIntentModifyParamsPaymentMethodDataPaynow as PaymentIntentModifyParamsPaymentMethodDataPaynow, PaymentIntentModifyParamsPaymentMethodDataPaypal as PaymentIntentModifyParamsPaymentMethodDataPaypal, + PaymentIntentModifyParamsPaymentMethodDataPayto as PaymentIntentModifyParamsPaymentMethodDataPayto, PaymentIntentModifyParamsPaymentMethodDataPix as PaymentIntentModifyParamsPaymentMethodDataPix, PaymentIntentModifyParamsPaymentMethodDataPromptpay as PaymentIntentModifyParamsPaymentMethodDataPromptpay, PaymentIntentModifyParamsPaymentMethodDataRadarOptions as PaymentIntentModifyParamsPaymentMethodDataRadarOptions, @@ -1809,6 +1829,8 @@ PaymentIntentModifyParamsPaymentMethodOptionsPayco as PaymentIntentModifyParamsPaymentMethodOptionsPayco, PaymentIntentModifyParamsPaymentMethodOptionsPaynow as PaymentIntentModifyParamsPaymentMethodOptionsPaynow, PaymentIntentModifyParamsPaymentMethodOptionsPaypal as PaymentIntentModifyParamsPaymentMethodOptionsPaypal, + PaymentIntentModifyParamsPaymentMethodOptionsPayto as PaymentIntentModifyParamsPaymentMethodOptionsPayto, + PaymentIntentModifyParamsPaymentMethodOptionsPaytoMandateOptions as PaymentIntentModifyParamsPaymentMethodOptionsPaytoMandateOptions, PaymentIntentModifyParamsPaymentMethodOptionsPix as PaymentIntentModifyParamsPaymentMethodOptionsPix, PaymentIntentModifyParamsPaymentMethodOptionsPromptpay as PaymentIntentModifyParamsPaymentMethodOptionsPromptpay, PaymentIntentModifyParamsPaymentMethodOptionsRevolutPay as PaymentIntentModifyParamsPaymentMethodOptionsRevolutPay, @@ -1893,6 +1915,7 @@ PaymentIntentUpdateParamsPaymentMethodDataPayco as PaymentIntentUpdateParamsPaymentMethodDataPayco, PaymentIntentUpdateParamsPaymentMethodDataPaynow as PaymentIntentUpdateParamsPaymentMethodDataPaynow, PaymentIntentUpdateParamsPaymentMethodDataPaypal as PaymentIntentUpdateParamsPaymentMethodDataPaypal, + PaymentIntentUpdateParamsPaymentMethodDataPayto as PaymentIntentUpdateParamsPaymentMethodDataPayto, PaymentIntentUpdateParamsPaymentMethodDataPix as PaymentIntentUpdateParamsPaymentMethodDataPix, PaymentIntentUpdateParamsPaymentMethodDataPromptpay as PaymentIntentUpdateParamsPaymentMethodDataPromptpay, PaymentIntentUpdateParamsPaymentMethodDataRadarOptions as PaymentIntentUpdateParamsPaymentMethodDataRadarOptions, @@ -1960,6 +1983,8 @@ PaymentIntentUpdateParamsPaymentMethodOptionsPayco as PaymentIntentUpdateParamsPaymentMethodOptionsPayco, PaymentIntentUpdateParamsPaymentMethodOptionsPaynow as PaymentIntentUpdateParamsPaymentMethodOptionsPaynow, PaymentIntentUpdateParamsPaymentMethodOptionsPaypal as PaymentIntentUpdateParamsPaymentMethodOptionsPaypal, + PaymentIntentUpdateParamsPaymentMethodOptionsPayto as PaymentIntentUpdateParamsPaymentMethodOptionsPayto, + PaymentIntentUpdateParamsPaymentMethodOptionsPaytoMandateOptions as PaymentIntentUpdateParamsPaymentMethodOptionsPaytoMandateOptions, PaymentIntentUpdateParamsPaymentMethodOptionsPix as PaymentIntentUpdateParamsPaymentMethodOptionsPix, PaymentIntentUpdateParamsPaymentMethodOptionsPromptpay as PaymentIntentUpdateParamsPaymentMethodOptionsPromptpay, PaymentIntentUpdateParamsPaymentMethodOptionsRevolutPay as PaymentIntentUpdateParamsPaymentMethodOptionsRevolutPay, @@ -2216,6 +2241,8 @@ PaymentMethodConfigurationCreateParamsPaynowDisplayPreference as PaymentMethodConfigurationCreateParamsPaynowDisplayPreference, PaymentMethodConfigurationCreateParamsPaypal as PaymentMethodConfigurationCreateParamsPaypal, PaymentMethodConfigurationCreateParamsPaypalDisplayPreference as PaymentMethodConfigurationCreateParamsPaypalDisplayPreference, + PaymentMethodConfigurationCreateParamsPayto as PaymentMethodConfigurationCreateParamsPayto, + PaymentMethodConfigurationCreateParamsPaytoDisplayPreference as PaymentMethodConfigurationCreateParamsPaytoDisplayPreference, PaymentMethodConfigurationCreateParamsPix as PaymentMethodConfigurationCreateParamsPix, PaymentMethodConfigurationCreateParamsPixDisplayPreference as PaymentMethodConfigurationCreateParamsPixDisplayPreference, PaymentMethodConfigurationCreateParamsPromptpay as PaymentMethodConfigurationCreateParamsPromptpay, @@ -2332,6 +2359,8 @@ PaymentMethodConfigurationModifyParamsPaynowDisplayPreference as PaymentMethodConfigurationModifyParamsPaynowDisplayPreference, PaymentMethodConfigurationModifyParamsPaypal as PaymentMethodConfigurationModifyParamsPaypal, PaymentMethodConfigurationModifyParamsPaypalDisplayPreference as PaymentMethodConfigurationModifyParamsPaypalDisplayPreference, + PaymentMethodConfigurationModifyParamsPayto as PaymentMethodConfigurationModifyParamsPayto, + PaymentMethodConfigurationModifyParamsPaytoDisplayPreference as PaymentMethodConfigurationModifyParamsPaytoDisplayPreference, PaymentMethodConfigurationModifyParamsPix as PaymentMethodConfigurationModifyParamsPix, PaymentMethodConfigurationModifyParamsPixDisplayPreference as PaymentMethodConfigurationModifyParamsPixDisplayPreference, PaymentMethodConfigurationModifyParamsPromptpay as PaymentMethodConfigurationModifyParamsPromptpay, @@ -2448,6 +2477,8 @@ PaymentMethodConfigurationUpdateParamsPaynowDisplayPreference as PaymentMethodConfigurationUpdateParamsPaynowDisplayPreference, PaymentMethodConfigurationUpdateParamsPaypal as PaymentMethodConfigurationUpdateParamsPaypal, PaymentMethodConfigurationUpdateParamsPaypalDisplayPreference as PaymentMethodConfigurationUpdateParamsPaypalDisplayPreference, + PaymentMethodConfigurationUpdateParamsPayto as PaymentMethodConfigurationUpdateParamsPayto, + PaymentMethodConfigurationUpdateParamsPaytoDisplayPreference as PaymentMethodConfigurationUpdateParamsPaytoDisplayPreference, PaymentMethodConfigurationUpdateParamsPix as PaymentMethodConfigurationUpdateParamsPix, PaymentMethodConfigurationUpdateParamsPixDisplayPreference as PaymentMethodConfigurationUpdateParamsPixDisplayPreference, PaymentMethodConfigurationUpdateParamsPromptpay as PaymentMethodConfigurationUpdateParamsPromptpay, @@ -2518,6 +2549,7 @@ PaymentMethodCreateParamsPayco as PaymentMethodCreateParamsPayco, PaymentMethodCreateParamsPaynow as PaymentMethodCreateParamsPaynow, PaymentMethodCreateParamsPaypal as PaymentMethodCreateParamsPaypal, + PaymentMethodCreateParamsPayto as PaymentMethodCreateParamsPayto, PaymentMethodCreateParamsPix as PaymentMethodCreateParamsPix, PaymentMethodCreateParamsPromptpay as PaymentMethodCreateParamsPromptpay, PaymentMethodCreateParamsRadarOptions as PaymentMethodCreateParamsRadarOptions, @@ -2562,6 +2594,7 @@ PaymentMethodModifyParamsBillingDetailsAddress as PaymentMethodModifyParamsBillingDetailsAddress, PaymentMethodModifyParamsCard as PaymentMethodModifyParamsCard, PaymentMethodModifyParamsCardNetworks as PaymentMethodModifyParamsCardNetworks, + PaymentMethodModifyParamsPayto as PaymentMethodModifyParamsPayto, PaymentMethodModifyParamsUsBankAccount as PaymentMethodModifyParamsUsBankAccount, ) from stripe.params._payment_method_retrieve_params import ( @@ -2573,6 +2606,7 @@ PaymentMethodUpdateParamsBillingDetailsAddress as PaymentMethodUpdateParamsBillingDetailsAddress, PaymentMethodUpdateParamsCard as PaymentMethodUpdateParamsCard, PaymentMethodUpdateParamsCardNetworks as PaymentMethodUpdateParamsCardNetworks, + PaymentMethodUpdateParamsPayto as PaymentMethodUpdateParamsPayto, PaymentMethodUpdateParamsUsBankAccount as PaymentMethodUpdateParamsUsBankAccount, ) from stripe.params._payment_record_report_payment_attempt_canceled_params import ( @@ -2947,6 +2981,7 @@ SetupIntentConfirmParamsPaymentMethodDataPayco as SetupIntentConfirmParamsPaymentMethodDataPayco, SetupIntentConfirmParamsPaymentMethodDataPaynow as SetupIntentConfirmParamsPaymentMethodDataPaynow, SetupIntentConfirmParamsPaymentMethodDataPaypal as SetupIntentConfirmParamsPaymentMethodDataPaypal, + SetupIntentConfirmParamsPaymentMethodDataPayto as SetupIntentConfirmParamsPaymentMethodDataPayto, SetupIntentConfirmParamsPaymentMethodDataPix as SetupIntentConfirmParamsPaymentMethodDataPix, SetupIntentConfirmParamsPaymentMethodDataPromptpay as SetupIntentConfirmParamsPaymentMethodDataPromptpay, SetupIntentConfirmParamsPaymentMethodDataRadarOptions as SetupIntentConfirmParamsPaymentMethodDataRadarOptions, @@ -2978,6 +3013,8 @@ SetupIntentConfirmParamsPaymentMethodOptionsKlarnaSubscriptionNextBilling as SetupIntentConfirmParamsPaymentMethodOptionsKlarnaSubscriptionNextBilling, SetupIntentConfirmParamsPaymentMethodOptionsLink as SetupIntentConfirmParamsPaymentMethodOptionsLink, SetupIntentConfirmParamsPaymentMethodOptionsPaypal as SetupIntentConfirmParamsPaymentMethodOptionsPaypal, + SetupIntentConfirmParamsPaymentMethodOptionsPayto as SetupIntentConfirmParamsPaymentMethodOptionsPayto, + SetupIntentConfirmParamsPaymentMethodOptionsPaytoMandateOptions as SetupIntentConfirmParamsPaymentMethodOptionsPaytoMandateOptions, SetupIntentConfirmParamsPaymentMethodOptionsSepaDebit as SetupIntentConfirmParamsPaymentMethodOptionsSepaDebit, SetupIntentConfirmParamsPaymentMethodOptionsSepaDebitMandateOptions as SetupIntentConfirmParamsPaymentMethodOptionsSepaDebitMandateOptions, SetupIntentConfirmParamsPaymentMethodOptionsUsBankAccount as SetupIntentConfirmParamsPaymentMethodOptionsUsBankAccount, @@ -3034,6 +3071,7 @@ SetupIntentCreateParamsPaymentMethodDataPayco as SetupIntentCreateParamsPaymentMethodDataPayco, SetupIntentCreateParamsPaymentMethodDataPaynow as SetupIntentCreateParamsPaymentMethodDataPaynow, SetupIntentCreateParamsPaymentMethodDataPaypal as SetupIntentCreateParamsPaymentMethodDataPaypal, + SetupIntentCreateParamsPaymentMethodDataPayto as SetupIntentCreateParamsPaymentMethodDataPayto, SetupIntentCreateParamsPaymentMethodDataPix as SetupIntentCreateParamsPaymentMethodDataPix, SetupIntentCreateParamsPaymentMethodDataPromptpay as SetupIntentCreateParamsPaymentMethodDataPromptpay, SetupIntentCreateParamsPaymentMethodDataRadarOptions as SetupIntentCreateParamsPaymentMethodDataRadarOptions, @@ -3065,6 +3103,8 @@ SetupIntentCreateParamsPaymentMethodOptionsKlarnaSubscriptionNextBilling as SetupIntentCreateParamsPaymentMethodOptionsKlarnaSubscriptionNextBilling, SetupIntentCreateParamsPaymentMethodOptionsLink as SetupIntentCreateParamsPaymentMethodOptionsLink, SetupIntentCreateParamsPaymentMethodOptionsPaypal as SetupIntentCreateParamsPaymentMethodOptionsPaypal, + SetupIntentCreateParamsPaymentMethodOptionsPayto as SetupIntentCreateParamsPaymentMethodOptionsPayto, + SetupIntentCreateParamsPaymentMethodOptionsPaytoMandateOptions as SetupIntentCreateParamsPaymentMethodOptionsPaytoMandateOptions, SetupIntentCreateParamsPaymentMethodOptionsSepaDebit as SetupIntentCreateParamsPaymentMethodOptionsSepaDebit, SetupIntentCreateParamsPaymentMethodOptionsSepaDebitMandateOptions as SetupIntentCreateParamsPaymentMethodOptionsSepaDebitMandateOptions, SetupIntentCreateParamsPaymentMethodOptionsUsBankAccount as SetupIntentCreateParamsPaymentMethodOptionsUsBankAccount, @@ -3121,6 +3161,7 @@ SetupIntentModifyParamsPaymentMethodDataPayco as SetupIntentModifyParamsPaymentMethodDataPayco, SetupIntentModifyParamsPaymentMethodDataPaynow as SetupIntentModifyParamsPaymentMethodDataPaynow, SetupIntentModifyParamsPaymentMethodDataPaypal as SetupIntentModifyParamsPaymentMethodDataPaypal, + SetupIntentModifyParamsPaymentMethodDataPayto as SetupIntentModifyParamsPaymentMethodDataPayto, SetupIntentModifyParamsPaymentMethodDataPix as SetupIntentModifyParamsPaymentMethodDataPix, SetupIntentModifyParamsPaymentMethodDataPromptpay as SetupIntentModifyParamsPaymentMethodDataPromptpay, SetupIntentModifyParamsPaymentMethodDataRadarOptions as SetupIntentModifyParamsPaymentMethodDataRadarOptions, @@ -3152,6 +3193,8 @@ SetupIntentModifyParamsPaymentMethodOptionsKlarnaSubscriptionNextBilling as SetupIntentModifyParamsPaymentMethodOptionsKlarnaSubscriptionNextBilling, SetupIntentModifyParamsPaymentMethodOptionsLink as SetupIntentModifyParamsPaymentMethodOptionsLink, SetupIntentModifyParamsPaymentMethodOptionsPaypal as SetupIntentModifyParamsPaymentMethodOptionsPaypal, + SetupIntentModifyParamsPaymentMethodOptionsPayto as SetupIntentModifyParamsPaymentMethodOptionsPayto, + SetupIntentModifyParamsPaymentMethodOptionsPaytoMandateOptions as SetupIntentModifyParamsPaymentMethodOptionsPaytoMandateOptions, SetupIntentModifyParamsPaymentMethodOptionsSepaDebit as SetupIntentModifyParamsPaymentMethodOptionsSepaDebit, SetupIntentModifyParamsPaymentMethodOptionsSepaDebitMandateOptions as SetupIntentModifyParamsPaymentMethodOptionsSepaDebitMandateOptions, SetupIntentModifyParamsPaymentMethodOptionsUsBankAccount as SetupIntentModifyParamsPaymentMethodOptionsUsBankAccount, @@ -3206,6 +3249,7 @@ SetupIntentUpdateParamsPaymentMethodDataPayco as SetupIntentUpdateParamsPaymentMethodDataPayco, SetupIntentUpdateParamsPaymentMethodDataPaynow as SetupIntentUpdateParamsPaymentMethodDataPaynow, SetupIntentUpdateParamsPaymentMethodDataPaypal as SetupIntentUpdateParamsPaymentMethodDataPaypal, + SetupIntentUpdateParamsPaymentMethodDataPayto as SetupIntentUpdateParamsPaymentMethodDataPayto, SetupIntentUpdateParamsPaymentMethodDataPix as SetupIntentUpdateParamsPaymentMethodDataPix, SetupIntentUpdateParamsPaymentMethodDataPromptpay as SetupIntentUpdateParamsPaymentMethodDataPromptpay, SetupIntentUpdateParamsPaymentMethodDataRadarOptions as SetupIntentUpdateParamsPaymentMethodDataRadarOptions, @@ -3237,6 +3281,8 @@ SetupIntentUpdateParamsPaymentMethodOptionsKlarnaSubscriptionNextBilling as SetupIntentUpdateParamsPaymentMethodOptionsKlarnaSubscriptionNextBilling, SetupIntentUpdateParamsPaymentMethodOptionsLink as SetupIntentUpdateParamsPaymentMethodOptionsLink, SetupIntentUpdateParamsPaymentMethodOptionsPaypal as SetupIntentUpdateParamsPaymentMethodOptionsPaypal, + SetupIntentUpdateParamsPaymentMethodOptionsPayto as SetupIntentUpdateParamsPaymentMethodOptionsPayto, + SetupIntentUpdateParamsPaymentMethodOptionsPaytoMandateOptions as SetupIntentUpdateParamsPaymentMethodOptionsPaytoMandateOptions, SetupIntentUpdateParamsPaymentMethodOptionsSepaDebit as SetupIntentUpdateParamsPaymentMethodOptionsSepaDebit, SetupIntentUpdateParamsPaymentMethodOptionsSepaDebitMandateOptions as SetupIntentUpdateParamsPaymentMethodOptionsSepaDebitMandateOptions, SetupIntentUpdateParamsPaymentMethodOptionsUsBankAccount as SetupIntentUpdateParamsPaymentMethodOptionsUsBankAccount, @@ -3366,6 +3412,8 @@ SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer as SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer, SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer as SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer, SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsKonbini as SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsKonbini, + SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsPayto as SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsPayto, + SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions as SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions, SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsSepaDebit as SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsSepaDebit, SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccount as SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccount, SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections as SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections, @@ -3452,6 +3500,8 @@ SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer as SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer, SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer as SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer, SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsKonbini as SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsKonbini, + SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsPayto as SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsPayto, + SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions as SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions, SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsSepaDebit as SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsSepaDebit, SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsUsBankAccount as SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsUsBankAccount, SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections as SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections, @@ -3610,6 +3660,8 @@ SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer as SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer, SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer as SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer, SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsKonbini as SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsKonbini, + SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsPayto as SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsPayto, + SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions as SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions, SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsSepaDebit as SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsSepaDebit, SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsUsBankAccount as SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsUsBankAccount, SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections as SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections, @@ -4033,6 +4085,10 @@ "stripe.params._account_create_params", False, ), + "AccountCreateParamsCapabilitiesPaytoPayments": ( + "stripe.params._account_create_params", + False, + ), "AccountCreateParamsCapabilitiesPixPayments": ( "stripe.params._account_create_params", False, @@ -4198,10 +4254,18 @@ "stripe.params._account_create_params", False, ), + "AccountCreateParamsDocumentsProofOfRegistrationSigner": ( + "stripe.params._account_create_params", + False, + ), "AccountCreateParamsDocumentsProofOfUltimateBeneficialOwnership": ( "stripe.params._account_create_params", False, ), + "AccountCreateParamsDocumentsProofOfUltimateBeneficialOwnershipSigner": ( + "stripe.params._account_create_params", + False, + ), "AccountCreateParamsGroups": ( "stripe.params._account_create_params", False, @@ -5097,6 +5161,10 @@ "stripe.params._account_update_params", False, ), + "AccountUpdateParamsCapabilitiesPaytoPayments": ( + "stripe.params._account_update_params", + False, + ), "AccountUpdateParamsCapabilitiesPixPayments": ( "stripe.params._account_update_params", False, @@ -5246,10 +5314,18 @@ "stripe.params._account_update_params", False, ), + "AccountUpdateParamsDocumentsProofOfRegistrationSigner": ( + "stripe.params._account_update_params", + False, + ), "AccountUpdateParamsDocumentsProofOfUltimateBeneficialOwnership": ( "stripe.params._account_update_params", False, ), + "AccountUpdateParamsDocumentsProofOfUltimateBeneficialOwnershipSigner": ( + "stripe.params._account_update_params", + False, + ), "AccountUpdateParamsGroups": ( "stripe.params._account_update_params", False, @@ -5708,6 +5784,10 @@ "stripe.params._confirmation_token_create_params", False, ), + "ConfirmationTokenCreateParamsPaymentMethodDataPayto": ( + "stripe.params._confirmation_token_create_params", + False, + ), "ConfirmationTokenCreateParamsPaymentMethodDataPix": ( "stripe.params._confirmation_token_create_params", False, @@ -6552,6 +6632,14 @@ "stripe.params._invoice_create_params", False, ), + "InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsPayto": ( + "stripe.params._invoice_create_params", + False, + ), + "InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions": ( + "stripe.params._invoice_create_params", + False, + ), "InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsSepaDebit": ( "stripe.params._invoice_create_params", False, @@ -6997,6 +7085,14 @@ "stripe.params._invoice_modify_params", False, ), + "InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsPayto": ( + "stripe.params._invoice_modify_params", + False, + ), + "InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions": ( + "stripe.params._invoice_modify_params", + False, + ), "InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsSepaDebit": ( "stripe.params._invoice_modify_params", False, @@ -7213,6 +7309,14 @@ "stripe.params._invoice_update_params", False, ), + "InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsPayto": ( + "stripe.params._invoice_update_params", + False, + ), + "InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions": ( + "stripe.params._invoice_update_params", + False, + ), "InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsSepaDebit": ( "stripe.params._invoice_update_params", False, @@ -7606,6 +7710,10 @@ "stripe.params._payment_intent_confirm_params", False, ), + "PaymentIntentConfirmParamsPaymentMethodDataPayto": ( + "stripe.params._payment_intent_confirm_params", + False, + ), "PaymentIntentConfirmParamsPaymentMethodDataPix": ( "stripe.params._payment_intent_confirm_params", False, @@ -7874,6 +7982,14 @@ "stripe.params._payment_intent_confirm_params", False, ), + "PaymentIntentConfirmParamsPaymentMethodOptionsPayto": ( + "stripe.params._payment_intent_confirm_params", + False, + ), + "PaymentIntentConfirmParamsPaymentMethodOptionsPaytoMandateOptions": ( + "stripe.params._payment_intent_confirm_params", + False, + ), "PaymentIntentConfirmParamsPaymentMethodOptionsPix": ( "stripe.params._payment_intent_confirm_params", False, @@ -8198,6 +8314,10 @@ "stripe.params._payment_intent_create_params", False, ), + "PaymentIntentCreateParamsPaymentMethodDataPayto": ( + "stripe.params._payment_intent_create_params", + False, + ), "PaymentIntentCreateParamsPaymentMethodDataPix": ( "stripe.params._payment_intent_create_params", False, @@ -8466,6 +8586,14 @@ "stripe.params._payment_intent_create_params", False, ), + "PaymentIntentCreateParamsPaymentMethodOptionsPayto": ( + "stripe.params._payment_intent_create_params", + False, + ), + "PaymentIntentCreateParamsPaymentMethodOptionsPaytoMandateOptions": ( + "stripe.params._payment_intent_create_params", + False, + ), "PaymentIntentCreateParamsPaymentMethodOptionsPix": ( "stripe.params._payment_intent_create_params", False, @@ -8850,6 +8978,10 @@ "stripe.params._payment_intent_modify_params", False, ), + "PaymentIntentModifyParamsPaymentMethodDataPayto": ( + "stripe.params._payment_intent_modify_params", + False, + ), "PaymentIntentModifyParamsPaymentMethodDataPix": ( "stripe.params._payment_intent_modify_params", False, @@ -9118,6 +9250,14 @@ "stripe.params._payment_intent_modify_params", False, ), + "PaymentIntentModifyParamsPaymentMethodOptionsPayto": ( + "stripe.params._payment_intent_modify_params", + False, + ), + "PaymentIntentModifyParamsPaymentMethodOptionsPaytoMandateOptions": ( + "stripe.params._payment_intent_modify_params", + False, + ), "PaymentIntentModifyParamsPaymentMethodOptionsPix": ( "stripe.params._payment_intent_modify_params", False, @@ -9430,6 +9570,10 @@ "stripe.params._payment_intent_update_params", False, ), + "PaymentIntentUpdateParamsPaymentMethodDataPayto": ( + "stripe.params._payment_intent_update_params", + False, + ), "PaymentIntentUpdateParamsPaymentMethodDataPix": ( "stripe.params._payment_intent_update_params", False, @@ -9698,6 +9842,14 @@ "stripe.params._payment_intent_update_params", False, ), + "PaymentIntentUpdateParamsPaymentMethodOptionsPayto": ( + "stripe.params._payment_intent_update_params", + False, + ), + "PaymentIntentUpdateParamsPaymentMethodOptionsPaytoMandateOptions": ( + "stripe.params._payment_intent_update_params", + False, + ), "PaymentIntentUpdateParamsPaymentMethodOptionsPix": ( "stripe.params._payment_intent_update_params", False, @@ -10642,6 +10794,14 @@ "stripe.params._payment_method_configuration_create_params", False, ), + "PaymentMethodConfigurationCreateParamsPayto": ( + "stripe.params._payment_method_configuration_create_params", + False, + ), + "PaymentMethodConfigurationCreateParamsPaytoDisplayPreference": ( + "stripe.params._payment_method_configuration_create_params", + False, + ), "PaymentMethodConfigurationCreateParamsPix": ( "stripe.params._payment_method_configuration_create_params", False, @@ -11090,6 +11250,14 @@ "stripe.params._payment_method_configuration_modify_params", False, ), + "PaymentMethodConfigurationModifyParamsPayto": ( + "stripe.params._payment_method_configuration_modify_params", + False, + ), + "PaymentMethodConfigurationModifyParamsPaytoDisplayPreference": ( + "stripe.params._payment_method_configuration_modify_params", + False, + ), "PaymentMethodConfigurationModifyParamsPix": ( "stripe.params._payment_method_configuration_modify_params", False, @@ -11538,6 +11706,14 @@ "stripe.params._payment_method_configuration_update_params", False, ), + "PaymentMethodConfigurationUpdateParamsPayto": ( + "stripe.params._payment_method_configuration_update_params", + False, + ), + "PaymentMethodConfigurationUpdateParamsPaytoDisplayPreference": ( + "stripe.params._payment_method_configuration_update_params", + False, + ), "PaymentMethodConfigurationUpdateParamsPix": ( "stripe.params._payment_method_configuration_update_params", False, @@ -11810,6 +11986,10 @@ "stripe.params._payment_method_create_params", False, ), + "PaymentMethodCreateParamsPayto": ( + "stripe.params._payment_method_create_params", + False, + ), "PaymentMethodCreateParamsPix": ( "stripe.params._payment_method_create_params", False, @@ -11914,6 +12094,10 @@ "stripe.params._payment_method_modify_params", False, ), + "PaymentMethodModifyParamsPayto": ( + "stripe.params._payment_method_modify_params", + False, + ), "PaymentMethodModifyParamsUsBankAccount": ( "stripe.params._payment_method_modify_params", False, @@ -11942,6 +12126,10 @@ "stripe.params._payment_method_update_params", False, ), + "PaymentMethodUpdateParamsPayto": ( + "stripe.params._payment_method_update_params", + False, + ), "PaymentMethodUpdateParamsUsBankAccount": ( "stripe.params._payment_method_update_params", False, @@ -12674,6 +12862,10 @@ "stripe.params._setup_intent_confirm_params", False, ), + "SetupIntentConfirmParamsPaymentMethodDataPayto": ( + "stripe.params._setup_intent_confirm_params", + False, + ), "SetupIntentConfirmParamsPaymentMethodDataPix": ( "stripe.params._setup_intent_confirm_params", False, @@ -12798,6 +12990,14 @@ "stripe.params._setup_intent_confirm_params", False, ), + "SetupIntentConfirmParamsPaymentMethodOptionsPayto": ( + "stripe.params._setup_intent_confirm_params", + False, + ), + "SetupIntentConfirmParamsPaymentMethodOptionsPaytoMandateOptions": ( + "stripe.params._setup_intent_confirm_params", + False, + ), "SetupIntentConfirmParamsPaymentMethodOptionsSepaDebit": ( "stripe.params._setup_intent_confirm_params", False, @@ -13014,6 +13214,10 @@ "stripe.params._setup_intent_create_params", False, ), + "SetupIntentCreateParamsPaymentMethodDataPayto": ( + "stripe.params._setup_intent_create_params", + False, + ), "SetupIntentCreateParamsPaymentMethodDataPix": ( "stripe.params._setup_intent_create_params", False, @@ -13138,6 +13342,14 @@ "stripe.params._setup_intent_create_params", False, ), + "SetupIntentCreateParamsPaymentMethodOptionsPayto": ( + "stripe.params._setup_intent_create_params", + False, + ), + "SetupIntentCreateParamsPaymentMethodOptionsPaytoMandateOptions": ( + "stripe.params._setup_intent_create_params", + False, + ), "SetupIntentCreateParamsPaymentMethodOptionsSepaDebit": ( "stripe.params._setup_intent_create_params", False, @@ -13346,6 +13558,10 @@ "stripe.params._setup_intent_modify_params", False, ), + "SetupIntentModifyParamsPaymentMethodDataPayto": ( + "stripe.params._setup_intent_modify_params", + False, + ), "SetupIntentModifyParamsPaymentMethodDataPix": ( "stripe.params._setup_intent_modify_params", False, @@ -13470,6 +13686,14 @@ "stripe.params._setup_intent_modify_params", False, ), + "SetupIntentModifyParamsPaymentMethodOptionsPayto": ( + "stripe.params._setup_intent_modify_params", + False, + ), + "SetupIntentModifyParamsPaymentMethodOptionsPaytoMandateOptions": ( + "stripe.params._setup_intent_modify_params", + False, + ), "SetupIntentModifyParamsPaymentMethodOptionsSepaDebit": ( "stripe.params._setup_intent_modify_params", False, @@ -13670,6 +13894,10 @@ "stripe.params._setup_intent_update_params", False, ), + "SetupIntentUpdateParamsPaymentMethodDataPayto": ( + "stripe.params._setup_intent_update_params", + False, + ), "SetupIntentUpdateParamsPaymentMethodDataPix": ( "stripe.params._setup_intent_update_params", False, @@ -13794,6 +14022,14 @@ "stripe.params._setup_intent_update_params", False, ), + "SetupIntentUpdateParamsPaymentMethodOptionsPayto": ( + "stripe.params._setup_intent_update_params", + False, + ), + "SetupIntentUpdateParamsPaymentMethodOptionsPaytoMandateOptions": ( + "stripe.params._setup_intent_update_params", + False, + ), "SetupIntentUpdateParamsPaymentMethodOptionsSepaDebit": ( "stripe.params._setup_intent_update_params", False, @@ -14155,6 +14391,14 @@ "stripe.params._subscription_create_params", False, ), + "SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsPayto": ( + "stripe.params._subscription_create_params", + False, + ), + "SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions": ( + "stripe.params._subscription_create_params", + False, + ), "SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsSepaDebit": ( "stripe.params._subscription_create_params", False, @@ -14419,6 +14663,14 @@ "stripe.params._subscription_modify_params", False, ), + "SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsPayto": ( + "stripe.params._subscription_modify_params", + False, + ), + "SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions": ( + "stripe.params._subscription_modify_params", + False, + ), "SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsSepaDebit": ( "stripe.params._subscription_modify_params", False, @@ -14963,6 +15215,14 @@ "stripe.params._subscription_update_params", False, ), + "SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsPayto": ( + "stripe.params._subscription_update_params", + False, + ), + "SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions": ( + "stripe.params._subscription_update_params", + False, + ), "SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsSepaDebit": ( "stripe.params._subscription_update_params", False, diff --git a/stripe/params/_account_create_external_account_params.py b/stripe/params/_account_create_external_account_params.py index 82ccbfb58..0bc9334b0 100644 --- a/stripe/params/_account_create_external_account_params.py +++ b/stripe/params/_account_create_external_account_params.py @@ -21,11 +21,11 @@ class AccountCreateExternalAccountParams(RequestOptions): "AccountCreateExternalAccountParamsCardToken", ] """ - A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js) or a dictionary containing a user's external account details (with the options shown below). Please refer to full [documentation](https://stripe.com/docs/api/external_accounts) instead. + A token, like the ones returned by [Stripe.js](https://docs.stripe.com/js) or a dictionary containing a user's external account details (with the options shown below). Please refer to full [documentation](https://stripe.com/docs/api/external_accounts) instead. """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_account_create_params.py b/stripe/params/_account_create_params.py index f77ac9d77..b9925f7ee 100644 --- a/stripe/params/_account_create_params.py +++ b/stripe/params/_account_create_params.py @@ -8,7 +8,7 @@ class AccountCreateParams(RequestOptions): account_token: NotRequired[str] """ - An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. + An [account token](https://api.stripe.com#create_account_token), used to securely provide details to the account. """ business_profile: NotRequired["AccountCreateParamsBusinessProfile"] """ @@ -77,7 +77,7 @@ class AccountCreateParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ settings: NotRequired["AccountCreateParamsSettings"] """ @@ -209,7 +209,7 @@ class AccountCreateParamsBusinessProfileSupportAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -448,6 +448,10 @@ class AccountCreateParamsCapabilities(TypedDict): """ The paynow_payments capability. """ + payto_payments: NotRequired["AccountCreateParamsCapabilitiesPaytoPayments"] + """ + The payto_payments capability. + """ pix_payments: NotRequired["AccountCreateParamsCapabilitiesPixPayments"] """ The pix_payments capability. @@ -841,6 +845,13 @@ class AccountCreateParamsCapabilitiesPaynowPayments(TypedDict): """ +class AccountCreateParamsCapabilitiesPaytoPayments(TypedDict): + 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 AccountCreateParamsCapabilitiesPixPayments(TypedDict): requested: NotRequired[bool] """ @@ -1090,7 +1101,7 @@ class AccountCreateParamsCompanyAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -1226,11 +1237,11 @@ class AccountCreateParamsCompanyVerification(TypedDict): class AccountCreateParamsCompanyVerificationDocument(TypedDict): 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. + The back of a document returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of a document returned by a [file upload](https://api.stripe.com#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. """ @@ -1332,56 +1343,69 @@ class AccountCreateParamsDocuments(TypedDict): class AccountCreateParamsDocumentsBankAccountOwnershipVerification(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountCreateParamsDocumentsCompanyLicense(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountCreateParamsDocumentsCompanyMemorandumOfAssociation(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountCreateParamsDocumentsCompanyMinisterialDecree(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountCreateParamsDocumentsCompanyRegistrationVerification(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountCreateParamsDocumentsCompanyTaxIdVerification(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountCreateParamsDocumentsProofOfAddress(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountCreateParamsDocumentsProofOfRegistration(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. + """ + signer: NotRequired[ + "AccountCreateParamsDocumentsProofOfRegistrationSigner" + ] + """ + Information regarding the person signing the document if applicable. + """ + + +class AccountCreateParamsDocumentsProofOfRegistrationSigner(TypedDict): + person: NotRequired[str] + """ + The token of the person signing the document, if applicable. """ @@ -1390,7 +1414,22 @@ class AccountCreateParamsDocumentsProofOfUltimateBeneficialOwnership( ): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. + """ + signer: NotRequired[ + "AccountCreateParamsDocumentsProofOfUltimateBeneficialOwnershipSigner" + ] + """ + Information regarding the person signing the document if applicable. + """ + + +class AccountCreateParamsDocumentsProofOfUltimateBeneficialOwnershipSigner( + TypedDict, +): + person: NotRequired[str] + """ + The token of the person signing the document, if applicable. """ @@ -1452,7 +1491,7 @@ class AccountCreateParamsCardToken(TypedDict): class AccountCreateParamsGroups(TypedDict): payments_pricing: NotRequired["Literal['']|str"] """ - The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details. + The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://docs.stripe.com/connect/platform-pricing-tools) for details. """ @@ -1523,7 +1562,7 @@ class AccountCreateParamsIndividual(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ phone: NotRequired[str] """ @@ -1576,7 +1615,7 @@ class AccountCreateParamsIndividualAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -1680,7 +1719,7 @@ class AccountCreateParamsIndividualRegisteredAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -1723,22 +1762,22 @@ class AccountCreateParamsIndividualVerification(TypedDict): class AccountCreateParamsIndividualVerificationAdditionalDocument(TypedDict): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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 AccountCreateParamsIndividualVerificationDocument(TypedDict): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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/params/_account_create_person_params.py b/stripe/params/_account_create_person_params.py index d52502b95..7e4eef2f6 100644 --- a/stripe/params/_account_create_person_params.py +++ b/stripe/params/_account_create_person_params.py @@ -86,7 +86,7 @@ class AccountCreatePersonParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ nationality: NotRequired[str] """ @@ -175,7 +175,7 @@ class AccountCreatePersonParamsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -276,21 +276,21 @@ class AccountCreatePersonParamsDocuments(TypedDict): class AccountCreatePersonParamsDocumentsCompanyAuthorization(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountCreatePersonParamsDocumentsPassport(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountCreatePersonParamsDocumentsVisa(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ @@ -317,7 +317,7 @@ class AccountCreatePersonParamsRegisteredAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -452,20 +452,20 @@ class AccountCreatePersonParamsVerification(TypedDict): class AccountCreatePersonParamsVerificationAdditionalDocument(TypedDict): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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 AccountCreatePersonParamsVerificationDocument(TypedDict): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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/params/_account_external_account_create_params.py b/stripe/params/_account_external_account_create_params.py index 144d75853..c780935fc 100644 --- a/stripe/params/_account_external_account_create_params.py +++ b/stripe/params/_account_external_account_create_params.py @@ -20,11 +20,11 @@ class AccountExternalAccountCreateParams(TypedDict): "AccountExternalAccountCreateParamsCardToken", ] """ - A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js) or a dictionary containing a user's external account details (with the options shown below). Please refer to full [documentation](https://stripe.com/docs/api/external_accounts) instead. + A token, like the ones returned by [Stripe.js](https://docs.stripe.com/js) or a dictionary containing a user's external account details (with the options shown below). Please refer to full [documentation](https://stripe.com/docs/api/external_accounts) instead. """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_account_external_account_update_params.py b/stripe/params/_account_external_account_update_params.py index 04642cd79..6b1d5d29f 100644 --- a/stripe/params/_account_external_account_update_params.py +++ b/stripe/params/_account_external_account_update_params.py @@ -65,7 +65,7 @@ class AccountExternalAccountUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired[str] """ @@ -87,5 +87,5 @@ class AccountExternalAccountUpdateParamsDocumentsBankAccountOwnershipVerificatio ): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ diff --git a/stripe/params/_account_modify_external_account_params.py b/stripe/params/_account_modify_external_account_params.py index 682ec49ed..0a83d10f6 100644 --- a/stripe/params/_account_modify_external_account_params.py +++ b/stripe/params/_account_modify_external_account_params.py @@ -66,7 +66,7 @@ class AccountModifyExternalAccountParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired[str] """ @@ -88,5 +88,5 @@ class AccountModifyExternalAccountParamsDocumentsBankAccountOwnershipVerificatio ): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ diff --git a/stripe/params/_account_modify_person_params.py b/stripe/params/_account_modify_person_params.py index 08a3455a9..5ab1aac5f 100644 --- a/stripe/params/_account_modify_person_params.py +++ b/stripe/params/_account_modify_person_params.py @@ -86,7 +86,7 @@ class AccountModifyPersonParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ nationality: NotRequired[str] """ @@ -175,7 +175,7 @@ class AccountModifyPersonParamsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -276,21 +276,21 @@ class AccountModifyPersonParamsDocuments(TypedDict): class AccountModifyPersonParamsDocumentsCompanyAuthorization(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountModifyPersonParamsDocumentsPassport(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountModifyPersonParamsDocumentsVisa(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ @@ -317,7 +317,7 @@ class AccountModifyPersonParamsRegisteredAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -452,20 +452,20 @@ class AccountModifyPersonParamsVerification(TypedDict): class AccountModifyPersonParamsVerificationAdditionalDocument(TypedDict): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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 AccountModifyPersonParamsVerificationDocument(TypedDict): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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/params/_account_person_create_params.py b/stripe/params/_account_person_create_params.py index bf5abaf4c..749d0a3fe 100644 --- a/stripe/params/_account_person_create_params.py +++ b/stripe/params/_account_person_create_params.py @@ -85,7 +85,7 @@ class AccountPersonCreateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ nationality: NotRequired[str] """ @@ -174,7 +174,7 @@ class AccountPersonCreateParamsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -275,21 +275,21 @@ class AccountPersonCreateParamsDocuments(TypedDict): class AccountPersonCreateParamsDocumentsCompanyAuthorization(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountPersonCreateParamsDocumentsPassport(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountPersonCreateParamsDocumentsVisa(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ @@ -316,7 +316,7 @@ class AccountPersonCreateParamsRegisteredAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -451,20 +451,20 @@ class AccountPersonCreateParamsVerification(TypedDict): class AccountPersonCreateParamsVerificationAdditionalDocument(TypedDict): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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 AccountPersonCreateParamsVerificationDocument(TypedDict): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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/params/_account_person_update_params.py b/stripe/params/_account_person_update_params.py index c15713705..0b8854917 100644 --- a/stripe/params/_account_person_update_params.py +++ b/stripe/params/_account_person_update_params.py @@ -85,7 +85,7 @@ class AccountPersonUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ nationality: NotRequired[str] """ @@ -174,7 +174,7 @@ class AccountPersonUpdateParamsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -275,21 +275,21 @@ class AccountPersonUpdateParamsDocuments(TypedDict): class AccountPersonUpdateParamsDocumentsCompanyAuthorization(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountPersonUpdateParamsDocumentsPassport(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountPersonUpdateParamsDocumentsVisa(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ @@ -316,7 +316,7 @@ class AccountPersonUpdateParamsRegisteredAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -451,20 +451,20 @@ class AccountPersonUpdateParamsVerification(TypedDict): class AccountPersonUpdateParamsVerificationAdditionalDocument(TypedDict): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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 AccountPersonUpdateParamsVerificationDocument(TypedDict): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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/params/_account_update_params.py b/stripe/params/_account_update_params.py index 0b3275ff1..bb8c8ea81 100644 --- a/stripe/params/_account_update_params.py +++ b/stripe/params/_account_update_params.py @@ -7,7 +7,7 @@ class AccountUpdateParams(TypedDict): account_token: NotRequired[str] """ - An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. + An [account token](https://api.stripe.com#create_account_token), used to securely provide details to the account. """ business_profile: NotRequired["AccountUpdateParamsBusinessProfile"] """ @@ -68,7 +68,7 @@ class AccountUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ settings: NotRequired["AccountUpdateParamsSettings"] """ @@ -196,7 +196,7 @@ class AccountUpdateParamsBusinessProfileSupportAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -435,6 +435,10 @@ class AccountUpdateParamsCapabilities(TypedDict): """ The paynow_payments capability. """ + payto_payments: NotRequired["AccountUpdateParamsCapabilitiesPaytoPayments"] + """ + The payto_payments capability. + """ pix_payments: NotRequired["AccountUpdateParamsCapabilitiesPixPayments"] """ The pix_payments capability. @@ -828,6 +832,13 @@ class AccountUpdateParamsCapabilitiesPaynowPayments(TypedDict): """ +class AccountUpdateParamsCapabilitiesPaytoPayments(TypedDict): + 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 AccountUpdateParamsCapabilitiesPixPayments(TypedDict): requested: NotRequired[bool] """ @@ -1074,7 +1085,7 @@ class AccountUpdateParamsCompanyAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -1210,11 +1221,11 @@ class AccountUpdateParamsCompanyVerification(TypedDict): class AccountUpdateParamsCompanyVerificationDocument(TypedDict): 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. + The back of a document returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of a document returned by a [file upload](https://api.stripe.com#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. """ @@ -1274,56 +1285,69 @@ class AccountUpdateParamsDocuments(TypedDict): class AccountUpdateParamsDocumentsBankAccountOwnershipVerification(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountUpdateParamsDocumentsCompanyLicense(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountUpdateParamsDocumentsCompanyMemorandumOfAssociation(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountUpdateParamsDocumentsCompanyMinisterialDecree(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountUpdateParamsDocumentsCompanyRegistrationVerification(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountUpdateParamsDocumentsCompanyTaxIdVerification(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountUpdateParamsDocumentsProofOfAddress(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class AccountUpdateParamsDocumentsProofOfRegistration(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. + """ + signer: NotRequired[ + "AccountUpdateParamsDocumentsProofOfRegistrationSigner" + ] + """ + Information regarding the person signing the document if applicable. + """ + + +class AccountUpdateParamsDocumentsProofOfRegistrationSigner(TypedDict): + person: NotRequired[str] + """ + The token of the person signing the document, if applicable. """ @@ -1332,7 +1356,22 @@ class AccountUpdateParamsDocumentsProofOfUltimateBeneficialOwnership( ): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. + """ + signer: NotRequired[ + "AccountUpdateParamsDocumentsProofOfUltimateBeneficialOwnershipSigner" + ] + """ + Information regarding the person signing the document if applicable. + """ + + +class AccountUpdateParamsDocumentsProofOfUltimateBeneficialOwnershipSigner( + TypedDict, +): + person: NotRequired[str] + """ + The token of the person signing the document, if applicable. """ @@ -1394,7 +1433,7 @@ class AccountUpdateParamsCardToken(TypedDict): class AccountUpdateParamsGroups(TypedDict): payments_pricing: NotRequired["Literal['']|str"] """ - The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details. + The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://docs.stripe.com/connect/platform-pricing-tools) for details. """ @@ -1465,7 +1504,7 @@ class AccountUpdateParamsIndividual(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ phone: NotRequired[str] """ @@ -1518,7 +1557,7 @@ class AccountUpdateParamsIndividualAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -1622,7 +1661,7 @@ class AccountUpdateParamsIndividualRegisteredAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -1665,22 +1704,22 @@ class AccountUpdateParamsIndividualVerification(TypedDict): class AccountUpdateParamsIndividualVerificationAdditionalDocument(TypedDict): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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 AccountUpdateParamsIndividualVerificationDocument(TypedDict): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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/params/_application_fee_create_refund_params.py b/stripe/params/_application_fee_create_refund_params.py index 4d209e6a4..d6c0f11af 100644 --- a/stripe/params/_application_fee_create_refund_params.py +++ b/stripe/params/_application_fee_create_refund_params.py @@ -16,5 +16,5 @@ class ApplicationFeeCreateRefundParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_application_fee_modify_refund_params.py b/stripe/params/_application_fee_modify_refund_params.py index a0b49b616..d2382e52e 100644 --- a/stripe/params/_application_fee_modify_refund_params.py +++ b/stripe/params/_application_fee_modify_refund_params.py @@ -12,5 +12,5 @@ class ApplicationFeeModifyRefundParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_application_fee_refund_create_params.py b/stripe/params/_application_fee_refund_create_params.py index 6f7a75697..ecb1bbcea 100644 --- a/stripe/params/_application_fee_refund_create_params.py +++ b/stripe/params/_application_fee_refund_create_params.py @@ -15,5 +15,5 @@ class ApplicationFeeRefundCreateParams(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_application_fee_refund_params.py b/stripe/params/_application_fee_refund_params.py index 66e53b611..a6cbc410a 100644 --- a/stripe/params/_application_fee_refund_params.py +++ b/stripe/params/_application_fee_refund_params.py @@ -16,5 +16,5 @@ class ApplicationFeeRefundParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_application_fee_refund_update_params.py b/stripe/params/_application_fee_refund_update_params.py index 9d2a63eb6..cbfcb830c 100644 --- a/stripe/params/_application_fee_refund_update_params.py +++ b/stripe/params/_application_fee_refund_update_params.py @@ -11,5 +11,5 @@ class ApplicationFeeRefundUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_charge_capture_params.py b/stripe/params/_charge_capture_params.py index 6de381293..340c3e3db 100644 --- a/stripe/params/_charge_capture_params.py +++ b/stripe/params/_charge_capture_params.py @@ -38,11 +38,11 @@ class ChargeCaptureParams(RequestOptions): """ transfer_data: NotRequired["ChargeCaptureParamsTransferData"] """ - 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. + An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. """ 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. + 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://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. """ diff --git a/stripe/params/_charge_create_params.py b/stripe/params/_charge_create_params.py index a305b0f81..d746556dd 100644 --- a/stripe/params/_charge_create_params.py +++ b/stripe/params/_charge_create_params.py @@ -8,16 +8,16 @@ class ChargeCreateParams(RequestOptions): 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). + Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/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://docs.stripe.com/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] """ - 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#collect-fees). + 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://docs.stripe.com/connect/direct-charges#collect-fees). """ 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. + 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://api.stripe.com#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://docs.stripe.com/charges/placing-a-hold) documentation. """ currency: NotRequired[str] """ @@ -38,19 +38,19 @@ class ChargeCreateParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ 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#settlement-merchant). + The Stripe account ID for which these funds are intended. You can specify the business of record as the connected account using the `on_behalf_of` attribute on the charge. For details, see [Creating Separate Charges and Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). """ radar_options: NotRequired["ChargeCreateParamsRadarOptions"] """ - Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. """ 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). + The email address to which this charge's [receipt](https://docs.stripe.com/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://docs.stripe.com/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). """ shipping: NotRequired["ChargeCreateParamsShipping"] """ @@ -58,7 +58,7 @@ class ChargeCreateParams(RequestOptions): """ 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. + A payment source to be charged. This can be the ID of a [card](https://docs.stripe.com/api#cards) (i.e., credit or debit card), a [bank account](https://docs.stripe.com/api#bank_accounts), a [source](https://docs.stripe.com/api#sources), a [token](https://docs.stripe.com/api#tokens), or a [connected account](https://docs.stripe.com/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://docs.stripe.com/api#cards), [bank accounts](https://docs.stripe.com/api#bank_accounts), and attached [sources](https://docs.stripe.com/api#sources)---you must also pass the ID of the associated customer. """ statement_descriptor: NotRequired[str] """ @@ -72,11 +72,11 @@ class ChargeCreateParams(RequestOptions): """ transfer_data: NotRequired["ChargeCreateParamsTransferData"] """ - 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. + An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. """ 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). + A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options). """ @@ -94,7 +94,7 @@ class ChargeCreateParamsDestination(TypedDict): class ChargeCreateParamsRadarOptions(TypedDict): 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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -144,7 +144,7 @@ class ChargeCreateParamsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_charge_modify_params.py b/stripe/params/_charge_modify_params.py index dd881f578..b2cc347c2 100644 --- a/stripe/params/_charge_modify_params.py +++ b/stripe/params/_charge_modify_params.py @@ -24,7 +24,7 @@ class ChargeModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ receipt_email: NotRequired[str] """ @@ -36,7 +36,7 @@ class ChargeModifyParams(RequestOptions): """ 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. + 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://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. """ @@ -93,5 +93,5 @@ class ChargeModifyParamsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_charge_search_params.py b/stripe/params/_charge_search_params.py index a936ec939..129829849 100644 --- a/stripe/params/_charge_search_params.py +++ b/stripe/params/_charge_search_params.py @@ -20,5 +20,5 @@ class ChargeSearchParams(RequestOptions): """ query: str """ - The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges). + The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for charges](https://docs.stripe.com/search#query-fields-for-charges). """ diff --git a/stripe/params/_charge_update_params.py b/stripe/params/_charge_update_params.py index be2e3c23a..0f0ae7b0b 100644 --- a/stripe/params/_charge_update_params.py +++ b/stripe/params/_charge_update_params.py @@ -23,7 +23,7 @@ class ChargeUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ receipt_email: NotRequired[str] """ @@ -35,7 +35,7 @@ class ChargeUpdateParams(TypedDict): """ 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. + 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://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. """ @@ -92,5 +92,5 @@ class ChargeUpdateParamsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_confirmation_token_create_params.py b/stripe/params/_confirmation_token_create_params.py index 270e21021..e4893de52 100644 --- a/stripe/params/_confirmation_token_create_params.py +++ b/stripe/params/_confirmation_token_create_params.py @@ -34,7 +34,7 @@ class ConfirmationTokenCreateParams(RequestOptions): """ Indicates that you intend to make future payments with this ConfirmationToken's payment method. - The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. + The presence of this property will [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. """ shipping: NotRequired["ConfirmationTokenCreateParamsShipping"] """ @@ -191,7 +191,7 @@ class ConfirmationTokenCreateParamsPaymentMethodData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ mobilepay: NotRequired[ "ConfirmationTokenCreateParamsPaymentMethodDataMobilepay" @@ -243,6 +243,10 @@ class ConfirmationTokenCreateParamsPaymentMethodData(TypedDict): """ If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. """ + payto: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataPayto"] + """ + If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. + """ pix: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataPix"] """ If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. @@ -257,7 +261,7 @@ class ConfirmationTokenCreateParamsPaymentMethodData(TypedDict): "ConfirmationTokenCreateParamsPaymentMethodDataRadarOptions" ] """ - Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. """ revolut_pay: NotRequired[ "ConfirmationTokenCreateParamsPaymentMethodDataRevolutPay" @@ -332,6 +336,7 @@ class ConfirmationTokenCreateParamsPaymentMethodData(TypedDict): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -483,7 +488,7 @@ class ConfirmationTokenCreateParamsPaymentMethodDataBillingDetailsAddress( """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -601,6 +606,7 @@ class ConfirmationTokenCreateParamsPaymentMethodDataIdeal(TypedDict): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -759,6 +765,21 @@ class ConfirmationTokenCreateParamsPaymentMethodDataPaypal(TypedDict): pass +class ConfirmationTokenCreateParamsPaymentMethodDataPayto(TypedDict): + account_number: NotRequired[str] + """ + The account number for the bank account. + """ + bsb_number: NotRequired[str] + """ + Bank-State-Branch number of the bank account. + """ + pay_id: NotRequired[str] + """ + The PayID alias for the bank account. + """ + + class ConfirmationTokenCreateParamsPaymentMethodDataPix(TypedDict): pass @@ -770,7 +791,7 @@ class ConfirmationTokenCreateParamsPaymentMethodDataPromptpay(TypedDict): class ConfirmationTokenCreateParamsPaymentMethodDataRadarOptions(TypedDict): 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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -923,5 +944,5 @@ class ConfirmationTokenCreateParamsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_coupon_create_params.py b/stripe/params/_coupon_create_params.py index f6b02506f..fc8a2483c 100644 --- a/stripe/params/_coupon_create_params.py +++ b/stripe/params/_coupon_create_params.py @@ -46,7 +46,7 @@ class CouponCreateParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired[str] """ diff --git a/stripe/params/_coupon_modify_params.py b/stripe/params/_coupon_modify_params.py index 3a40e77aa..10a6fbaf5 100644 --- a/stripe/params/_coupon_modify_params.py +++ b/stripe/params/_coupon_modify_params.py @@ -18,7 +18,7 @@ class CouponModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired[str] """ diff --git a/stripe/params/_coupon_update_params.py b/stripe/params/_coupon_update_params.py index bbd7d067b..82ad710a5 100644 --- a/stripe/params/_coupon_update_params.py +++ b/stripe/params/_coupon_update_params.py @@ -17,7 +17,7 @@ class CouponUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired[str] """ diff --git a/stripe/params/_credit_note_create_params.py b/stripe/params/_credit_note_create_params.py index 349d1d6f0..6fe871bad 100644 --- a/stripe/params/_credit_note_create_params.py +++ b/stripe/params/_credit_note_create_params.py @@ -40,7 +40,7 @@ class CreditNoteCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ out_of_band_amount: NotRequired[int] """ diff --git a/stripe/params/_credit_note_list_params.py b/stripe/params/_credit_note_list_params.py index 1f2f7e638..49e66c686 100644 --- a/stripe/params/_credit_note_list_params.py +++ b/stripe/params/_credit_note_list_params.py @@ -14,6 +14,10 @@ class CreditNoteListParams(RequestOptions): """ Only return credit notes for the customer specified by this customer ID. """ + customer_account: NotRequired[str] + """ + Only return credit notes for the account representing the customer specified by this account ID. + """ 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. diff --git a/stripe/params/_credit_note_modify_params.py b/stripe/params/_credit_note_modify_params.py index 7b53aa673..fe69c0423 100644 --- a/stripe/params/_credit_note_modify_params.py +++ b/stripe/params/_credit_note_modify_params.py @@ -16,5 +16,5 @@ class CreditNoteModifyParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_credit_note_preview_lines_list_params.py b/stripe/params/_credit_note_preview_lines_list_params.py index 337f7e9d3..a62d86ebf 100644 --- a/stripe/params/_credit_note_preview_lines_list_params.py +++ b/stripe/params/_credit_note_preview_lines_list_params.py @@ -47,7 +47,7 @@ class CreditNotePreviewLinesListParams(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ out_of_band_amount: NotRequired[int] """ diff --git a/stripe/params/_credit_note_preview_lines_params.py b/stripe/params/_credit_note_preview_lines_params.py index c1a761dc3..111011f14 100644 --- a/stripe/params/_credit_note_preview_lines_params.py +++ b/stripe/params/_credit_note_preview_lines_params.py @@ -48,7 +48,7 @@ class CreditNotePreviewLinesParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ out_of_band_amount: NotRequired[int] """ diff --git a/stripe/params/_credit_note_preview_params.py b/stripe/params/_credit_note_preview_params.py index 9626dba96..aa978ab53 100644 --- a/stripe/params/_credit_note_preview_params.py +++ b/stripe/params/_credit_note_preview_params.py @@ -40,7 +40,7 @@ class CreditNotePreviewParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ out_of_band_amount: NotRequired[int] """ diff --git a/stripe/params/_credit_note_update_params.py b/stripe/params/_credit_note_update_params.py index 240ca2645..f3a374c86 100644 --- a/stripe/params/_credit_note_update_params.py +++ b/stripe/params/_credit_note_update_params.py @@ -15,5 +15,5 @@ class CreditNoteUpdateParams(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_customer_balance_transaction_create_params.py b/stripe/params/_customer_balance_transaction_create_params.py index 4795d1b73..bee7dd142 100644 --- a/stripe/params/_customer_balance_transaction_create_params.py +++ b/stripe/params/_customer_balance_transaction_create_params.py @@ -11,7 +11,7 @@ class CustomerBalanceTransactionCreateParams(TypedDict): """ currency: 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). 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. + 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://docs.stripe.com/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] """ @@ -23,5 +23,5 @@ class CustomerBalanceTransactionCreateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_customer_balance_transaction_list_params.py b/stripe/params/_customer_balance_transaction_list_params.py index 826403276..a90aa1a15 100644 --- a/stripe/params/_customer_balance_transaction_list_params.py +++ b/stripe/params/_customer_balance_transaction_list_params.py @@ -17,6 +17,10 @@ class CustomerBalanceTransactionListParams(TypedDict): """ Specifies which fields in the response should be expanded. """ + invoice: NotRequired[str] + """ + Only return transactions that are related to the specified invoice. + """ limit: NotRequired[int] """ A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. diff --git a/stripe/params/_customer_balance_transaction_update_params.py b/stripe/params/_customer_balance_transaction_update_params.py index d4766b557..5e792783a 100644 --- a/stripe/params/_customer_balance_transaction_update_params.py +++ b/stripe/params/_customer_balance_transaction_update_params.py @@ -15,5 +15,5 @@ class CustomerBalanceTransactionUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_customer_cash_balance_update_params.py b/stripe/params/_customer_cash_balance_update_params.py index 2f1bd2ced..47b4e048d 100644 --- a/stripe/params/_customer_cash_balance_update_params.py +++ b/stripe/params/_customer_cash_balance_update_params.py @@ -20,5 +20,5 @@ class CustomerCashBalanceUpdateParamsSettings(TypedDict): 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). + 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://docs.stripe.com/payments/customer-balance/reconciliation). """ diff --git a/stripe/params/_customer_create_balance_transaction_params.py b/stripe/params/_customer_create_balance_transaction_params.py index 7d979c0a6..c20c785a7 100644 --- a/stripe/params/_customer_create_balance_transaction_params.py +++ b/stripe/params/_customer_create_balance_transaction_params.py @@ -12,7 +12,7 @@ class CustomerCreateBalanceTransactionParams(RequestOptions): """ currency: 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). 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. + 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://docs.stripe.com/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] """ @@ -24,5 +24,5 @@ class CustomerCreateBalanceTransactionParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_customer_create_params.py b/stripe/params/_customer_create_params.py index 3d7ae3df9..d930a2617 100644 --- a/stripe/params/_customer_create_params.py +++ b/stripe/params/_customer_create_params.py @@ -8,7 +8,7 @@ class CustomerCreateParams(RequestOptions): address: NotRequired["Literal['']|CustomerCreateParamsAddress"] """ - The customer's address. + The customer's address. Learn about [country-specific requirements for calculating tax](https://docs.stripe.com/invoicing/taxes?dashboard-or-api=dashboard#set-up-customer). """ balance: NotRequired[int] """ @@ -48,7 +48,7 @@ class CustomerCreateParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired[str] """ @@ -114,7 +114,7 @@ class CustomerCreateParamsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -131,7 +131,7 @@ class CustomerCreateParamsCashBalanceSettings(TypedDict): 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). + 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://docs.stripe.com/payments/customer-balance/reconciliation). """ @@ -220,7 +220,7 @@ class CustomerCreateParamsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_customer_create_source_params.py b/stripe/params/_customer_create_source_params.py index 80318b03a..d58379e59 100644 --- a/stripe/params/_customer_create_source_params.py +++ b/stripe/params/_customer_create_source_params.py @@ -12,10 +12,10 @@ class CustomerCreateSourceParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ source: str """ - Please refer to full [documentation](https://stripe.com/docs/api) instead. + Please refer to full [documentation](https://api.stripe.com) instead. """ validate: NotRequired[bool] diff --git a/stripe/params/_customer_fund_cash_balance_params.py b/stripe/params/_customer_fund_cash_balance_params.py index 50645a32f..ee3294982 100644 --- a/stripe/params/_customer_fund_cash_balance_params.py +++ b/stripe/params/_customer_fund_cash_balance_params.py @@ -8,7 +8,7 @@ class CustomerFundCashBalanceParams(RequestOptions): amount: int """ - Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency). + Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency). """ currency: str """ @@ -20,5 +20,5 @@ class CustomerFundCashBalanceParams(RequestOptions): """ 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. + 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://docs.stripe.com/payments/customer-balance/reconciliation) applies to different user inputs. """ diff --git a/stripe/params/_customer_list_balance_transactions_params.py b/stripe/params/_customer_list_balance_transactions_params.py index 9175024be..c5f62dc9e 100644 --- a/stripe/params/_customer_list_balance_transactions_params.py +++ b/stripe/params/_customer_list_balance_transactions_params.py @@ -18,6 +18,10 @@ class CustomerListBalanceTransactionsParams(RequestOptions): """ Specifies which fields in the response should be expanded. """ + invoice: NotRequired[str] + """ + Only return transactions that are related to the specified invoice. + """ limit: NotRequired[int] """ A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. diff --git a/stripe/params/_customer_list_payment_methods_params.py b/stripe/params/_customer_list_payment_methods_params.py index ed2ff348e..8803d7ea7 100644 --- a/stripe/params/_customer_list_payment_methods_params.py +++ b/stripe/params/_customer_list_payment_methods_params.py @@ -66,6 +66,7 @@ class CustomerListPaymentMethodsParams(RequestOptions): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", diff --git a/stripe/params/_customer_modify_balance_transaction_params.py b/stripe/params/_customer_modify_balance_transaction_params.py index 9201b6263..ba32df38b 100644 --- a/stripe/params/_customer_modify_balance_transaction_params.py +++ b/stripe/params/_customer_modify_balance_transaction_params.py @@ -16,5 +16,5 @@ class CustomerModifyBalanceTransactionParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_customer_modify_cash_balance_params.py b/stripe/params/_customer_modify_cash_balance_params.py index 825733e11..d3b2ce817 100644 --- a/stripe/params/_customer_modify_cash_balance_params.py +++ b/stripe/params/_customer_modify_cash_balance_params.py @@ -21,5 +21,5 @@ class CustomerModifyCashBalanceParamsSettings(TypedDict): 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). + 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://docs.stripe.com/payments/customer-balance/reconciliation). """ diff --git a/stripe/params/_customer_modify_params.py b/stripe/params/_customer_modify_params.py index 4e1f5e8be..d0eaa699a 100644 --- a/stripe/params/_customer_modify_params.py +++ b/stripe/params/_customer_modify_params.py @@ -8,7 +8,7 @@ class CustomerModifyParams(RequestOptions): address: NotRequired["Literal['']|CustomerModifyParamsAddress"] """ - The customer's address. + The customer's address. Learn about [country-specific requirements for calculating tax](https://docs.stripe.com/invoicing/taxes?dashboard-or-api=dashboard#set-up-customer). """ balance: NotRequired[int] """ @@ -24,11 +24,11 @@ class CustomerModifyParams(RequestOptions): """ 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. + If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. Provide the ID of a payment source already attached to this customer to make it this customer's default payment source. - 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. + If you want to add a new payment source and make it the default, see the [source](https://docs.stripe.com/api/customers/update#update_customer-source) property. """ description: NotRequired[str] """ @@ -56,7 +56,7 @@ class CustomerModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired[str] """ @@ -113,7 +113,7 @@ class CustomerModifyParamsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -130,7 +130,7 @@ class CustomerModifyParamsCashBalanceSettings(TypedDict): 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). + 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://docs.stripe.com/payments/customer-balance/reconciliation). """ @@ -219,7 +219,7 @@ class CustomerModifyParamsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_customer_modify_source_params.py b/stripe/params/_customer_modify_source_params.py index 844a6a70a..a3044e727 100644 --- a/stripe/params/_customer_modify_source_params.py +++ b/stripe/params/_customer_modify_source_params.py @@ -52,7 +52,7 @@ class CustomerModifySourceParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired[str] """ @@ -103,5 +103,5 @@ class CustomerModifySourceParamsOwnerAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_customer_payment_method_list_params.py b/stripe/params/_customer_payment_method_list_params.py index e13f8cd1f..026497553 100644 --- a/stripe/params/_customer_payment_method_list_params.py +++ b/stripe/params/_customer_payment_method_list_params.py @@ -65,6 +65,7 @@ class CustomerPaymentMethodListParams(TypedDict): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", diff --git a/stripe/params/_customer_payment_source_create_params.py b/stripe/params/_customer_payment_source_create_params.py index 20c45c9f8..a44db1a90 100644 --- a/stripe/params/_customer_payment_source_create_params.py +++ b/stripe/params/_customer_payment_source_create_params.py @@ -11,10 +11,10 @@ class CustomerPaymentSourceCreateParams(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ source: str """ - Please refer to full [documentation](https://stripe.com/docs/api) instead. + Please refer to full [documentation](https://api.stripe.com) instead. """ validate: NotRequired[bool] diff --git a/stripe/params/_customer_payment_source_update_params.py b/stripe/params/_customer_payment_source_update_params.py index 33e5b3520..258c1be3f 100644 --- a/stripe/params/_customer_payment_source_update_params.py +++ b/stripe/params/_customer_payment_source_update_params.py @@ -51,7 +51,7 @@ class CustomerPaymentSourceUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired[str] """ @@ -102,5 +102,5 @@ class CustomerPaymentSourceUpdateParamsOwnerAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_customer_search_params.py b/stripe/params/_customer_search_params.py index 7cb556101..a67752be9 100644 --- a/stripe/params/_customer_search_params.py +++ b/stripe/params/_customer_search_params.py @@ -20,5 +20,5 @@ class CustomerSearchParams(RequestOptions): """ query: str """ - The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers). + The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for customers](https://docs.stripe.com/search#query-fields-for-customers). """ diff --git a/stripe/params/_customer_session_create_params.py b/stripe/params/_customer_session_create_params.py index 04316c59a..5a6d98fc0 100644 --- a/stripe/params/_customer_session_create_params.py +++ b/stripe/params/_customer_session_create_params.py @@ -10,10 +10,14 @@ class CustomerSessionCreateParams(RequestOptions): """ Configuration for each component. At least 1 component must be enabled. """ - customer: str + customer: NotRequired[str] """ The ID of an existing customer for which to create the Customer Session. """ + customer_account: NotRequired[str] + """ + The ID of an existing Account for which to create the Customer Session. + """ expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. diff --git a/stripe/params/_customer_update_params.py b/stripe/params/_customer_update_params.py index b325846dc..188f68eea 100644 --- a/stripe/params/_customer_update_params.py +++ b/stripe/params/_customer_update_params.py @@ -7,7 +7,7 @@ class CustomerUpdateParams(TypedDict): address: NotRequired["Literal['']|CustomerUpdateParamsAddress"] """ - The customer's address. + The customer's address. Learn about [country-specific requirements for calculating tax](https://docs.stripe.com/invoicing/taxes?dashboard-or-api=dashboard#set-up-customer). """ balance: NotRequired[int] """ @@ -23,11 +23,11 @@ class CustomerUpdateParams(TypedDict): """ 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. + If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. Provide the ID of a payment source already attached to this customer to make it this customer's default payment source. - 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. + If you want to add a new payment source and make it the default, see the [source](https://docs.stripe.com/api/customers/update#update_customer-source) property. """ description: NotRequired[str] """ @@ -55,7 +55,7 @@ class CustomerUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired[str] """ @@ -112,7 +112,7 @@ class CustomerUpdateParamsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -129,7 +129,7 @@ class CustomerUpdateParamsCashBalanceSettings(TypedDict): 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). + 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://docs.stripe.com/payments/customer-balance/reconciliation). """ @@ -218,7 +218,7 @@ class CustomerUpdateParamsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_dispute_modify_params.py b/stripe/params/_dispute_modify_params.py index 5f8f30a57..0059c31de 100644 --- a/stripe/params/_dispute_modify_params.py +++ b/stripe/params/_dispute_modify_params.py @@ -16,7 +16,7 @@ class DisputeModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ submit: NotRequired[bool] """ @@ -239,7 +239,7 @@ class DisputeModifyParamsEvidenceEnhancedEvidenceVisaCompellingEvidence3Disputed """ state: NotRequired["Literal['']|str"] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -307,7 +307,7 @@ class DisputeModifyParamsEvidenceEnhancedEvidenceVisaCompellingEvidence3PriorUnd """ state: NotRequired["Literal['']|str"] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_dispute_update_params.py b/stripe/params/_dispute_update_params.py index b09f6f5f3..7259c217d 100644 --- a/stripe/params/_dispute_update_params.py +++ b/stripe/params/_dispute_update_params.py @@ -15,7 +15,7 @@ class DisputeUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ submit: NotRequired[bool] """ @@ -238,7 +238,7 @@ class DisputeUpdateParamsEvidenceEnhancedEvidenceVisaCompellingEvidence3Disputed """ state: NotRequired["Literal['']|str"] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -306,7 +306,7 @@ class DisputeUpdateParamsEvidenceEnhancedEvidenceVisaCompellingEvidence3PriorUnd """ state: NotRequired["Literal['']|str"] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_file_create_params.py b/stripe/params/_file_create_params.py index 00b5f427f..a65648464 100644 --- a/stripe/params/_file_create_params.py +++ b/stripe/params/_file_create_params.py @@ -16,7 +16,7 @@ class FileCreateParams(RequestOptions): """ file_link_data: NotRequired["FileCreateParamsFileLinkData"] """ - Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file. + Optional parameters that automatically create a [file link](https://api.stripe.com#file_links) for the newly created file. """ purpose: Literal[ "account_requirement", @@ -34,7 +34,7 @@ class FileCreateParams(RequestOptions): "terminal_reader_splashscreen", ] """ - The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. + The [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file. """ @@ -49,5 +49,5 @@ class FileCreateParamsFileLinkData(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_file_link_create_params.py b/stripe/params/_file_link_create_params.py index 08c6e4489..75ea9de90 100644 --- a/stripe/params/_file_link_create_params.py +++ b/stripe/params/_file_link_create_params.py @@ -20,5 +20,5 @@ class FileLinkCreateParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_file_link_modify_params.py b/stripe/params/_file_link_modify_params.py index 2dda56a17..62f80dedd 100644 --- a/stripe/params/_file_link_modify_params.py +++ b/stripe/params/_file_link_modify_params.py @@ -16,5 +16,5 @@ class FileLinkModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_file_link_update_params.py b/stripe/params/_file_link_update_params.py index 0c5ee8a36..34cd70f86 100644 --- a/stripe/params/_file_link_update_params.py +++ b/stripe/params/_file_link_update_params.py @@ -15,5 +15,5 @@ class FileLinkUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_invoice_add_lines_params.py b/stripe/params/_invoice_add_lines_params.py index 3104b23fd..8f0b41d7b 100644 --- a/stripe/params/_invoice_add_lines_params.py +++ b/stripe/params/_invoice_add_lines_params.py @@ -12,7 +12,7 @@ class InvoiceAddLinesParams(RequestOptions): """ invoice_metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ lines: List["InvoiceAddLinesParamsLine"] """ @@ -45,15 +45,15 @@ class InvoiceAddLinesParamsLine(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ period: NotRequired["InvoiceAddLinesParamsLinePeriod"] """ - 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. + 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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ price_data: NotRequired["InvoiceAddLinesParamsLinePriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. """ pricing: NotRequired["InvoiceAddLinesParamsLinePricing"] """ @@ -67,7 +67,7 @@ class InvoiceAddLinesParamsLine(TypedDict): "Literal['']|List[InvoiceAddLinesParamsLineTaxAmount]" ] """ - A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts. + A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://docs.stripe.com/tax/invoicing). Pass an empty string to remove previously defined tax amounts. """ tax_rates: NotRequired["Literal['']|List[str]"] """ @@ -116,7 +116,7 @@ class InvoiceAddLinesParamsLinePriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -139,7 +139,7 @@ class InvoiceAddLinesParamsLinePriceDataProductData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: str """ @@ -147,7 +147,7 @@ class InvoiceAddLinesParamsLinePriceDataProductData(TypedDict): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ unit_label: NotRequired[str] """ diff --git a/stripe/params/_invoice_create_params.py b/stripe/params/_invoice_create_params.py index 3e0e00997..cf6829eb9 100644 --- a/stripe/params/_invoice_create_params.py +++ b/stripe/params/_invoice_create_params.py @@ -12,11 +12,11 @@ class InvoiceCreateParams(RequestOptions): """ 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). + 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://docs.stripe.com/billing/invoices/connect#collecting-fees). """ 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. Defaults to false. + Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. Defaults to false. """ automatic_tax: NotRequired["InvoiceCreateParamsAutomaticTax"] """ @@ -44,7 +44,11 @@ class InvoiceCreateParams(RequestOptions): """ customer: NotRequired[str] """ - The ID of the customer who will be billed. + The ID of the customer to bill. + """ + customer_account: NotRequired[str] + """ + The ID of the account to bill. """ days_until_due: NotRequired[int] """ @@ -88,7 +92,7 @@ class InvoiceCreateParams(RequestOptions): """ from_invoice: NotRequired["InvoiceCreateParamsFromInvoice"] """ - Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details. + Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details. """ issuer: NotRequired["InvoiceCreateParamsIssuer"] """ @@ -96,7 +100,7 @@ class InvoiceCreateParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ number: NotRequired[str] """ @@ -104,7 +108,7 @@ class InvoiceCreateParams(RequestOptions): """ 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. + 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://docs.stripe.com/billing/invoices/connect) documentation for details. """ payment_settings: NotRequired["InvoiceCreateParamsPaymentSettings"] """ @@ -143,7 +147,7 @@ class InvoiceCreateParams(RequestOptions): class InvoiceCreateParamsAutomaticTax(TypedDict): enabled: bool """ - Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. + Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. """ liability: NotRequired["InvoiceCreateParamsAutomaticTaxLiability"] """ @@ -222,7 +226,7 @@ class InvoiceCreateParamsPaymentSettings(TypedDict): Payment-method-specific configuration to provide to the invoice's PaymentIntent. """ payment_method_types: NotRequired[ - "Literal['']|List[Literal['ach_credit_transfer', 'ach_debit', 'acss_debit', 'affirm', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'boleto', 'card', 'cashapp', 'crypto', 'custom', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'jp_credit_transfer', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'link', 'multibanco', 'naver_pay', 'nz_bank_account', 'p24', 'payco', 'paynow', 'paypal', 'promptpay', 'revolut_pay', 'sepa_credit_transfer', 'sepa_debit', 'sofort', 'swish', 'us_bank_account', 'wechat_pay']]" + "Literal['']|List[Literal['ach_credit_transfer', 'ach_debit', 'acss_debit', 'affirm', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'boleto', 'card', 'cashapp', 'crypto', 'custom', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'jp_credit_transfer', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'link', 'multibanco', 'naver_pay', 'nz_bank_account', 'p24', 'payco', 'paynow', 'paypal', 'payto', 'promptpay', 'revolut_pay', 'sepa_credit_transfer', 'sepa_debit', 'sofort', 'swish', 'us_bank_account', 'wechat_pay']]" ] """ 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). @@ -260,6 +264,12 @@ class InvoiceCreateParamsPaymentSettingsPaymentMethodOptions(TypedDict): """ If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent. """ + payto: NotRequired[ + "Literal['']|InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsPayto" + ] + """ + If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice's PaymentIntent. + """ sepa_debit: NotRequired[ "Literal['']|InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsSepaDebit" ] @@ -316,13 +326,13 @@ class InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): """ Installment configuration for payments attempted on this invoice. - For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). + For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments). """ request_three_d_secure: NotRequired[ 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. + 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ @@ -403,6 +413,42 @@ class InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsKonbini(TypedDict): pass +class InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsPayto(TypedDict): + mandate_options: NotRequired[ + "InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions" + ] + """ + Additional fields for Mandate creation. + """ + + +class InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions( + TypedDict, +): + amount: NotRequired[int] + """ + The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit. + """ + purpose: NotRequired[ + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + + class InvoiceCreateParamsPaymentSettingsPaymentMethodOptionsSepaDebit( TypedDict, ): @@ -522,7 +568,7 @@ class InvoiceCreateParamsShippingCostShippingRateData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ tax_behavior: NotRequired[Literal["exclusive", "inclusive", "unspecified"]] """ @@ -530,7 +576,7 @@ class InvoiceCreateParamsShippingCostShippingRateData(TypedDict): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ type: NotRequired[Literal["fixed_amount"]] """ @@ -652,7 +698,7 @@ class InvoiceCreateParamsShippingDetailsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_invoice_create_preview_params.py b/stripe/params/_invoice_create_preview_params.py index c6a803455..66980f77c 100644 --- a/stripe/params/_invoice_create_preview_params.py +++ b/stripe/params/_invoice_create_preview_params.py @@ -16,7 +16,11 @@ class InvoiceCreatePreviewParams(RequestOptions): """ 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. + The identifier of the customer whose upcoming invoice you're retrieving. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. + """ + customer_account: NotRequired[str] + """ + The identifier of the account representing the customer whose upcoming invoice you're retrieving. If `automatic_tax` is enabled then one of `customer`, `customer_account`, `customer_details`, `subscription`, or `schedule` must be set. """ customer_details: NotRequired["InvoiceCreatePreviewParamsCustomerDetails"] """ @@ -42,7 +46,7 @@ class InvoiceCreatePreviewParams(RequestOptions): """ on_behalf_of: NotRequired["Literal['']|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. + 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://docs.stripe.com/billing/invoices/connect) documentation for details. """ preview_mode: NotRequired[Literal["next", "recurring"]] """ @@ -71,7 +75,7 @@ class InvoiceCreatePreviewParams(RequestOptions): class InvoiceCreatePreviewParamsAutomaticTax(TypedDict): enabled: bool """ - Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. + Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. """ liability: NotRequired["InvoiceCreatePreviewParamsAutomaticTaxLiability"] """ @@ -95,7 +99,7 @@ class InvoiceCreatePreviewParamsCustomerDetails(TypedDict): "Literal['']|InvoiceCreatePreviewParamsCustomerDetailsAddress" ] """ - The customer's address. + The customer's address. Learn about [country-specific requirements for calculating tax](https://docs.stripe.com/invoicing/taxes?dashboard-or-api=dashboard#set-up-customer). """ shipping: NotRequired[ "Literal['']|InvoiceCreatePreviewParamsCustomerDetailsShipping" @@ -142,7 +146,7 @@ class InvoiceCreatePreviewParamsCustomerDetailsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -184,7 +188,7 @@ class InvoiceCreatePreviewParamsCustomerDetailsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -361,11 +365,11 @@ class InvoiceCreatePreviewParamsInvoiceItem(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ period: NotRequired["InvoiceCreatePreviewParamsInvoiceItemPeriod"] """ - 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. + 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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ price: NotRequired[str] """ @@ -373,7 +377,7 @@ class InvoiceCreatePreviewParamsInvoiceItem(TypedDict): """ price_data: NotRequired["InvoiceCreatePreviewParamsInvoiceItemPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: NotRequired[int] """ @@ -381,11 +385,11 @@ class InvoiceCreatePreviewParamsInvoiceItem(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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. """ tax_code: NotRequired["Literal['']|str"] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ tax_rates: NotRequired["Literal['']|List[str]"] """ @@ -438,7 +442,7 @@ class InvoiceCreatePreviewParamsInvoiceItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -523,7 +527,7 @@ class InvoiceCreatePreviewParamsScheduleDetailsPhase(TypedDict): """ 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). + 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://docs.stripe.com/billing/subscriptions/billing-cycle). """ billing_thresholds: NotRequired[ "Literal['']|InvoiceCreatePreviewParamsScheduleDetailsPhaseBillingThresholds" @@ -547,7 +551,7 @@ class InvoiceCreatePreviewParamsScheduleDetailsPhase(TypedDict): """ default_tax_rates: NotRequired["Literal['']|List[str]"] """ - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase. + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase. """ description: NotRequired["Literal['']|str"] """ @@ -567,7 +571,7 @@ class InvoiceCreatePreviewParamsScheduleDetailsPhase(TypedDict): """ end_date: NotRequired["int|Literal['now']"] """ - The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set. + The date at which this phase of the subscription schedule ends. If set, `duration` must not be set. """ invoice_settings: NotRequired[ "InvoiceCreatePreviewParamsScheduleDetailsPhaseInvoiceSettings" @@ -581,7 +585,7 @@ class InvoiceCreatePreviewParamsScheduleDetailsPhase(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/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] """ @@ -591,7 +595,7 @@ class InvoiceCreatePreviewParamsScheduleDetailsPhase(TypedDict): Literal["always_invoice", "create_prorations", "none"] ] """ - Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. 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 (item price, quantity, etc.) of the current phase. + Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. """ start_date: NotRequired["int|Literal['now']"] """ @@ -624,7 +628,7 @@ class InvoiceCreatePreviewParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ period: NotRequired[ "InvoiceCreatePreviewParamsScheduleDetailsPhaseAddInvoiceItemPeriod" @@ -640,7 +644,7 @@ class InvoiceCreatePreviewParamsScheduleDetailsPhaseAddInvoiceItem(TypedDict): "InvoiceCreatePreviewParamsScheduleDetailsPhaseAddInvoiceItemPriceData" ] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: NotRequired[int] """ @@ -723,7 +727,7 @@ class InvoiceCreatePreviewParamsScheduleDetailsPhaseAddInvoiceItemPriceData( """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -845,7 +849,7 @@ class InvoiceCreatePreviewParamsScheduleDetailsPhaseItem(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/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] """ @@ -859,7 +863,7 @@ class InvoiceCreatePreviewParamsScheduleDetailsPhaseItem(TypedDict): "InvoiceCreatePreviewParamsScheduleDetailsPhaseItemPriceData" ] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. """ quantity: NotRequired[int] """ @@ -867,7 +871,7 @@ class InvoiceCreatePreviewParamsScheduleDetailsPhaseItem(TypedDict): """ tax_rates: NotRequired["Literal['']|List[str]"] """ - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. """ @@ -876,7 +880,7 @@ class InvoiceCreatePreviewParamsScheduleDetailsPhaseItemBillingThresholds( ): usage_gte: int """ - Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) """ @@ -912,7 +916,7 @@ class InvoiceCreatePreviewParamsScheduleDetailsPhaseItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -951,7 +955,7 @@ class InvoiceCreatePreviewParamsScheduleDetailsPhaseTransferData(TypedDict): class InvoiceCreatePreviewParamsSubscriptionDetails(TypedDict): billing_cycle_anchor: NotRequired["Literal['now', 'unchanged']|int"] """ - For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. + For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. """ billing_mode: NotRequired[ "InvoiceCreatePreviewParamsSubscriptionDetailsBillingMode" @@ -987,7 +991,7 @@ class InvoiceCreatePreviewParamsSubscriptionDetails(TypedDict): 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`. + Determines how to handle [prorations](https://docs.stripe.com/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] """ @@ -1056,7 +1060,7 @@ class InvoiceCreatePreviewParamsSubscriptionDetailsItem(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ plan: NotRequired[str] """ @@ -1070,7 +1074,7 @@ class InvoiceCreatePreviewParamsSubscriptionDetailsItem(TypedDict): "InvoiceCreatePreviewParamsSubscriptionDetailsItemPriceData" ] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: NotRequired[int] """ @@ -1078,7 +1082,7 @@ class InvoiceCreatePreviewParamsSubscriptionDetailsItem(TypedDict): """ tax_rates: NotRequired["Literal['']|List[str]"] """ - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. """ @@ -1087,7 +1091,7 @@ class InvoiceCreatePreviewParamsSubscriptionDetailsItemBillingThresholds( ): usage_gte: int """ - Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) """ @@ -1123,7 +1127,7 @@ class InvoiceCreatePreviewParamsSubscriptionDetailsItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ diff --git a/stripe/params/_invoice_finalize_invoice_params.py b/stripe/params/_invoice_finalize_invoice_params.py index 14613f6eb..95d5c92bc 100644 --- a/stripe/params/_invoice_finalize_invoice_params.py +++ b/stripe/params/_invoice_finalize_invoice_params.py @@ -8,7 +8,7 @@ class InvoiceFinalizeInvoiceParams(RequestOptions): 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. + Controls whether Stripe performs [automatic collection](https://docs.stripe.com/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]] """ diff --git a/stripe/params/_invoice_item_create_params.py b/stripe/params/_invoice_item_create_params.py index 84e9f4cb3..aa6098154 100644 --- a/stripe/params/_invoice_item_create_params.py +++ b/stripe/params/_invoice_item_create_params.py @@ -14,9 +14,13 @@ class InvoiceItemCreateParams(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: str + customer: NotRequired[str] """ - The ID of the customer who will be billed when this invoice item is billed. + The ID of the customer to bill for this invoice item. + """ + customer_account: NotRequired[str] + """ + The ID of the account representing the customer to bill for this invoice item. """ description: NotRequired[str] """ @@ -40,15 +44,15 @@ class InvoiceItemCreateParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ period: NotRequired["InvoiceItemCreateParamsPeriod"] """ - 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. + 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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ price_data: NotRequired["InvoiceItemCreateParamsPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. """ pricing: NotRequired["InvoiceItemCreateParamsPricing"] """ @@ -64,11 +68,11 @@ class InvoiceItemCreateParams(RequestOptions): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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. """ tax_code: NotRequired["Literal['']|str"] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ tax_rates: NotRequired[List[str]] """ @@ -117,7 +121,7 @@ class InvoiceItemCreateParamsPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ diff --git a/stripe/params/_invoice_item_list_params.py b/stripe/params/_invoice_item_list_params.py index d5bd75a37..20df34a7b 100644 --- a/stripe/params/_invoice_item_list_params.py +++ b/stripe/params/_invoice_item_list_params.py @@ -12,7 +12,11 @@ class InvoiceItemListParams(RequestOptions): """ customer: NotRequired[str] """ - The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. + The identifier of the customer whose invoice items to return. If none is provided, returns all invoice items. + """ + customer_account: NotRequired[str] + """ + The identifier of the account representing the customer whose invoice items to return. If none is provided, returns all invoice items. """ ending_before: NotRequired[str] """ diff --git a/stripe/params/_invoice_item_modify_params.py b/stripe/params/_invoice_item_modify_params.py index eadfca4c7..e0e187bdd 100644 --- a/stripe/params/_invoice_item_modify_params.py +++ b/stripe/params/_invoice_item_modify_params.py @@ -28,15 +28,15 @@ class InvoiceItemModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ period: NotRequired["InvoiceItemModifyParamsPeriod"] """ - 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. + 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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ price_data: NotRequired["InvoiceItemModifyParamsPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. """ pricing: NotRequired["InvoiceItemModifyParamsPricing"] """ @@ -48,11 +48,11 @@ class InvoiceItemModifyParams(RequestOptions): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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. """ tax_code: NotRequired["Literal['']|str"] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ tax_rates: NotRequired["Literal['']|List[str]"] """ @@ -101,7 +101,7 @@ class InvoiceItemModifyParamsPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ diff --git a/stripe/params/_invoice_item_update_params.py b/stripe/params/_invoice_item_update_params.py index 5bb3e0fd5..0546c29fb 100644 --- a/stripe/params/_invoice_item_update_params.py +++ b/stripe/params/_invoice_item_update_params.py @@ -27,15 +27,15 @@ class InvoiceItemUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ period: NotRequired["InvoiceItemUpdateParamsPeriod"] """ - 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. + 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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ price_data: NotRequired["InvoiceItemUpdateParamsPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. """ pricing: NotRequired["InvoiceItemUpdateParamsPricing"] """ @@ -47,11 +47,11 @@ class InvoiceItemUpdateParams(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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. """ tax_code: NotRequired["Literal['']|str"] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ tax_rates: NotRequired["Literal['']|List[str]"] """ @@ -100,7 +100,7 @@ class InvoiceItemUpdateParamsPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ diff --git a/stripe/params/_invoice_line_item_update_params.py b/stripe/params/_invoice_line_item_update_params.py index 49335ed80..51047aefe 100644 --- a/stripe/params/_invoice_line_item_update_params.py +++ b/stripe/params/_invoice_line_item_update_params.py @@ -29,15 +29,15 @@ class InvoiceLineItemUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data. """ period: NotRequired["InvoiceLineItemUpdateParamsPeriod"] """ - 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. + 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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ price_data: NotRequired["InvoiceLineItemUpdateParamsPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. """ pricing: NotRequired["InvoiceLineItemUpdateParamsPricing"] """ @@ -51,7 +51,7 @@ class InvoiceLineItemUpdateParams(TypedDict): "Literal['']|List[InvoiceLineItemUpdateParamsTaxAmount]" ] """ - A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts. + A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://docs.stripe.com/tax/invoicing). Pass an empty string to remove previously defined tax amounts. """ tax_rates: NotRequired["Literal['']|List[str]"] """ @@ -102,7 +102,7 @@ class InvoiceLineItemUpdateParamsPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -125,7 +125,7 @@ class InvoiceLineItemUpdateParamsPriceDataProductData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: str """ @@ -133,7 +133,7 @@ class InvoiceLineItemUpdateParamsPriceDataProductData(TypedDict): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ unit_label: NotRequired[str] """ diff --git a/stripe/params/_invoice_list_params.py b/stripe/params/_invoice_list_params.py index e3d159c09..6e7a934b3 100644 --- a/stripe/params/_invoice_list_params.py +++ b/stripe/params/_invoice_list_params.py @@ -20,6 +20,10 @@ class InvoiceListParams(RequestOptions): """ Only return invoices for the customer specified by this customer ID. """ + customer_account: NotRequired[str] + """ + Only return invoices for the account representing the customer specified by this account ID. + """ due_date: NotRequired["InvoiceListParamsDueDate|int"] ending_before: NotRequired[str] """ @@ -41,7 +45,7 @@ class InvoiceListParams(RequestOptions): 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) + The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview) """ subscription: NotRequired[str] """ diff --git a/stripe/params/_invoice_modify_params.py b/stripe/params/_invoice_modify_params.py index ed27c0bad..cf77a12ad 100644 --- a/stripe/params/_invoice_modify_params.py +++ b/stripe/params/_invoice_modify_params.py @@ -12,11 +12,11 @@ class InvoiceModifyParams(RequestOptions): """ 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). + 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://docs.stripe.com/billing/invoices/connect#collecting-fees). """ auto_advance: NotRequired[bool] """ - Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. + Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. """ automatic_tax: NotRequired["InvoiceModifyParamsAutomaticTax"] """ @@ -84,7 +84,7 @@ class InvoiceModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ number: NotRequired["Literal['']|str"] """ @@ -92,7 +92,7 @@ class InvoiceModifyParams(RequestOptions): """ on_behalf_of: NotRequired["Literal['']|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. + 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://docs.stripe.com/billing/invoices/connect) documentation for details. """ payment_settings: NotRequired["InvoiceModifyParamsPaymentSettings"] """ @@ -125,7 +125,7 @@ class InvoiceModifyParams(RequestOptions): class InvoiceModifyParamsAutomaticTax(TypedDict): enabled: bool """ - Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. + Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. """ liability: NotRequired["InvoiceModifyParamsAutomaticTaxLiability"] """ @@ -193,7 +193,7 @@ class InvoiceModifyParamsPaymentSettings(TypedDict): Payment-method-specific configuration to provide to the invoice's PaymentIntent. """ payment_method_types: NotRequired[ - "Literal['']|List[Literal['ach_credit_transfer', 'ach_debit', 'acss_debit', 'affirm', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'boleto', 'card', 'cashapp', 'crypto', 'custom', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'jp_credit_transfer', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'link', 'multibanco', 'naver_pay', 'nz_bank_account', 'p24', 'payco', 'paynow', 'paypal', 'promptpay', 'revolut_pay', 'sepa_credit_transfer', 'sepa_debit', 'sofort', 'swish', 'us_bank_account', 'wechat_pay']]" + "Literal['']|List[Literal['ach_credit_transfer', 'ach_debit', 'acss_debit', 'affirm', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'boleto', 'card', 'cashapp', 'crypto', 'custom', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'jp_credit_transfer', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'link', 'multibanco', 'naver_pay', 'nz_bank_account', 'p24', 'payco', 'paynow', 'paypal', 'payto', 'promptpay', 'revolut_pay', 'sepa_credit_transfer', 'sepa_debit', 'sofort', 'swish', 'us_bank_account', 'wechat_pay']]" ] """ 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). @@ -231,6 +231,12 @@ class InvoiceModifyParamsPaymentSettingsPaymentMethodOptions(TypedDict): """ If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent. """ + payto: NotRequired[ + "Literal['']|InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsPayto" + ] + """ + If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice's PaymentIntent. + """ sepa_debit: NotRequired[ "Literal['']|InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsSepaDebit" ] @@ -287,13 +293,13 @@ class InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): """ Installment configuration for payments attempted on this invoice. - For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). + For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments). """ request_three_d_secure: NotRequired[ 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. + 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ @@ -374,6 +380,42 @@ class InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsKonbini(TypedDict): pass +class InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsPayto(TypedDict): + mandate_options: NotRequired[ + "InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions" + ] + """ + Additional fields for Mandate creation. + """ + + +class InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions( + TypedDict, +): + amount: NotRequired[int] + """ + The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit. + """ + purpose: NotRequired[ + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + + class InvoiceModifyParamsPaymentSettingsPaymentMethodOptionsSepaDebit( TypedDict, ): @@ -493,7 +535,7 @@ class InvoiceModifyParamsShippingCostShippingRateData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ tax_behavior: NotRequired[Literal["exclusive", "inclusive", "unspecified"]] """ @@ -501,7 +543,7 @@ class InvoiceModifyParamsShippingCostShippingRateData(TypedDict): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ type: NotRequired[Literal["fixed_amount"]] """ @@ -623,7 +665,7 @@ class InvoiceModifyParamsShippingDetailsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_invoice_remove_lines_params.py b/stripe/params/_invoice_remove_lines_params.py index b6796164e..b89b8b543 100644 --- a/stripe/params/_invoice_remove_lines_params.py +++ b/stripe/params/_invoice_remove_lines_params.py @@ -12,7 +12,7 @@ class InvoiceRemoveLinesParams(RequestOptions): """ invoice_metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ lines: List["InvoiceRemoveLinesParamsLine"] """ diff --git a/stripe/params/_invoice_search_params.py b/stripe/params/_invoice_search_params.py index 1ee516f8f..f43214b34 100644 --- a/stripe/params/_invoice_search_params.py +++ b/stripe/params/_invoice_search_params.py @@ -20,5 +20,5 @@ class InvoiceSearchParams(RequestOptions): """ query: str """ - The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices). + The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for invoices](https://docs.stripe.com/search#query-fields-for-invoices). """ diff --git a/stripe/params/_invoice_update_lines_params.py b/stripe/params/_invoice_update_lines_params.py index 7e8fa6f1f..1067b2c71 100644 --- a/stripe/params/_invoice_update_lines_params.py +++ b/stripe/params/_invoice_update_lines_params.py @@ -12,7 +12,7 @@ class InvoiceUpdateLinesParams(RequestOptions): """ invoice_metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data. """ lines: List["InvoiceUpdateLinesParamsLine"] """ @@ -45,15 +45,15 @@ class InvoiceUpdateLinesParamsLine(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data. """ period: NotRequired["InvoiceUpdateLinesParamsLinePeriod"] """ - 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. + 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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details. """ price_data: NotRequired["InvoiceUpdateLinesParamsLinePriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. """ pricing: NotRequired["InvoiceUpdateLinesParamsLinePricing"] """ @@ -67,7 +67,7 @@ class InvoiceUpdateLinesParamsLine(TypedDict): "Literal['']|List[InvoiceUpdateLinesParamsLineTaxAmount]" ] """ - A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts. + A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://docs.stripe.com/tax/invoicing). Pass an empty string to remove previously defined tax amounts. """ tax_rates: NotRequired["Literal['']|List[str]"] """ @@ -118,7 +118,7 @@ class InvoiceUpdateLinesParamsLinePriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -141,7 +141,7 @@ class InvoiceUpdateLinesParamsLinePriceDataProductData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: str """ @@ -149,7 +149,7 @@ class InvoiceUpdateLinesParamsLinePriceDataProductData(TypedDict): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ unit_label: NotRequired[str] """ diff --git a/stripe/params/_invoice_update_params.py b/stripe/params/_invoice_update_params.py index 0680005b3..019aed872 100644 --- a/stripe/params/_invoice_update_params.py +++ b/stripe/params/_invoice_update_params.py @@ -11,11 +11,11 @@ class InvoiceUpdateParams(TypedDict): """ 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). + 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://docs.stripe.com/billing/invoices/connect#collecting-fees). """ auto_advance: NotRequired[bool] """ - Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. + Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. """ automatic_tax: NotRequired["InvoiceUpdateParamsAutomaticTax"] """ @@ -83,7 +83,7 @@ class InvoiceUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ number: NotRequired["Literal['']|str"] """ @@ -91,7 +91,7 @@ class InvoiceUpdateParams(TypedDict): """ on_behalf_of: NotRequired["Literal['']|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. + 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://docs.stripe.com/billing/invoices/connect) documentation for details. """ payment_settings: NotRequired["InvoiceUpdateParamsPaymentSettings"] """ @@ -124,7 +124,7 @@ class InvoiceUpdateParams(TypedDict): class InvoiceUpdateParamsAutomaticTax(TypedDict): enabled: bool """ - Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. + Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. """ liability: NotRequired["InvoiceUpdateParamsAutomaticTaxLiability"] """ @@ -192,7 +192,7 @@ class InvoiceUpdateParamsPaymentSettings(TypedDict): Payment-method-specific configuration to provide to the invoice's PaymentIntent. """ payment_method_types: NotRequired[ - "Literal['']|List[Literal['ach_credit_transfer', 'ach_debit', 'acss_debit', 'affirm', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'boleto', 'card', 'cashapp', 'crypto', 'custom', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'jp_credit_transfer', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'link', 'multibanco', 'naver_pay', 'nz_bank_account', 'p24', 'payco', 'paynow', 'paypal', 'promptpay', 'revolut_pay', 'sepa_credit_transfer', 'sepa_debit', 'sofort', 'swish', 'us_bank_account', 'wechat_pay']]" + "Literal['']|List[Literal['ach_credit_transfer', 'ach_debit', 'acss_debit', 'affirm', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'boleto', 'card', 'cashapp', 'crypto', 'custom', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'jp_credit_transfer', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'link', 'multibanco', 'naver_pay', 'nz_bank_account', 'p24', 'payco', 'paynow', 'paypal', 'payto', 'promptpay', 'revolut_pay', 'sepa_credit_transfer', 'sepa_debit', 'sofort', 'swish', 'us_bank_account', 'wechat_pay']]" ] """ 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). @@ -230,6 +230,12 @@ class InvoiceUpdateParamsPaymentSettingsPaymentMethodOptions(TypedDict): """ If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent. """ + payto: NotRequired[ + "Literal['']|InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsPayto" + ] + """ + If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice's PaymentIntent. + """ sepa_debit: NotRequired[ "Literal['']|InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsSepaDebit" ] @@ -286,13 +292,13 @@ class InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsCard(TypedDict): """ Installment configuration for payments attempted on this invoice. - For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). + For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments). """ request_three_d_secure: NotRequired[ 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. + 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ @@ -373,6 +379,42 @@ class InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsKonbini(TypedDict): pass +class InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsPayto(TypedDict): + mandate_options: NotRequired[ + "InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions" + ] + """ + Additional fields for Mandate creation. + """ + + +class InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions( + TypedDict, +): + amount: NotRequired[int] + """ + The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit. + """ + purpose: NotRequired[ + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + + class InvoiceUpdateParamsPaymentSettingsPaymentMethodOptionsSepaDebit( TypedDict, ): @@ -492,7 +534,7 @@ class InvoiceUpdateParamsShippingCostShippingRateData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ tax_behavior: NotRequired[Literal["exclusive", "inclusive", "unspecified"]] """ @@ -500,7 +542,7 @@ class InvoiceUpdateParamsShippingCostShippingRateData(TypedDict): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ type: NotRequired[Literal["fixed_amount"]] """ @@ -622,7 +664,7 @@ class InvoiceUpdateParamsShippingDetailsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_payment_intent_apply_customer_balance_params.py b/stripe/params/_payment_intent_apply_customer_balance_params.py index f3f3b05cc..ec70e53ca 100644 --- a/stripe/params/_payment_intent_apply_customer_balance_params.py +++ b/stripe/params/_payment_intent_apply_customer_balance_params.py @@ -10,7 +10,7 @@ class PaymentIntentApplyCustomerBalanceParams(RequestOptions): """ Amount that you intend to apply to this PaymentIntent from the customer's cash balance. If the PaymentIntent was created by an Invoice, the full amount of the PaymentIntent is applied regardless of this parameter. - A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent. + A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent. When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent. """ diff --git a/stripe/params/_payment_intent_capture_params.py b/stripe/params/_payment_intent_capture_params.py index 2bb89fe0b..9876c1044 100644 --- a/stripe/params/_payment_intent_capture_params.py +++ b/stripe/params/_payment_intent_capture_params.py @@ -16,7 +16,7 @@ class PaymentIntentCaptureParams(RequestOptions): """ 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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + 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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). """ expand: NotRequired[List[str]] """ @@ -24,7 +24,7 @@ class PaymentIntentCaptureParams(RequestOptions): """ 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. + 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://docs.stripe.com/payments/multicapture) is available for PaymentIntents. """ hooks: NotRequired["PaymentIntentCaptureParamsHooks"] """ @@ -32,7 +32,7 @@ class PaymentIntentCaptureParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ payment_details: NotRequired[ "Literal['']|PaymentIntentCaptureParamsPaymentDetails" @@ -53,14 +53,14 @@ class PaymentIntentCaptureParams(RequestOptions): transfer_data: NotRequired["PaymentIntentCaptureParamsTransferData"] """ The parameters that you can use to automatically create a transfer after the payment - is captured. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + is captured. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). """ class PaymentIntentCaptureParamsAmountDetails(TypedDict): discount_amount: NotRequired["Literal['']|int"] """ - The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. """ @@ -68,7 +68,7 @@ class PaymentIntentCaptureParamsAmountDetails(TypedDict): "Literal['']|List[PaymentIntentCaptureParamsAmountDetailsLineItem]" ] """ - A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items. + A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items. """ shipping: NotRequired[ "Literal['']|PaymentIntentCaptureParamsAmountDetailsShipping" @@ -85,7 +85,7 @@ class PaymentIntentCaptureParamsAmountDetails(TypedDict): class PaymentIntentCaptureParamsAmountDetailsLineItem(TypedDict): discount_amount: NotRequired[int] """ - The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[discount_amount]` field. """ @@ -115,7 +115,7 @@ class PaymentIntentCaptureParamsAmountDetailsLineItem(TypedDict): """ unit_cost: int """ - The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. """ unit_of_measure: NotRequired[str] """ @@ -213,7 +213,7 @@ class PaymentIntentCaptureParamsAmountDetailsLineItemPaymentMethodOptionsPaypal( class PaymentIntentCaptureParamsAmountDetailsLineItemTax(TypedDict): total_tax_amount: int """ - The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + The total amount of tax on a single line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. """ @@ -222,7 +222,7 @@ class PaymentIntentCaptureParamsAmountDetailsLineItemTax(TypedDict): class PaymentIntentCaptureParamsAmountDetailsShipping(TypedDict): amount: NotRequired["Literal['']|int"] """ - If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. + If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0. """ from_postal_code: NotRequired["Literal['']|str"] """ @@ -237,7 +237,7 @@ class PaymentIntentCaptureParamsAmountDetailsShipping(TypedDict): class PaymentIntentCaptureParamsAmountDetailsTax(TypedDict): total_tax_amount: int """ - The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. """ @@ -260,7 +260,7 @@ class PaymentIntentCaptureParamsHooksInputs(TypedDict): class PaymentIntentCaptureParamsHooksInputsTax(TypedDict): calculation: Union[Literal[""], str] """ - The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id + The [TaxCalculation](https://docs.stripe.com/api/tax/calculations) id """ diff --git a/stripe/params/_payment_intent_confirm_params.py b/stripe/params/_payment_intent_confirm_params.py index 7ed7f8018..fe11b6a99 100644 --- a/stripe/params/_payment_intent_confirm_params.py +++ b/stripe/params/_payment_intent_confirm_params.py @@ -26,10 +26,10 @@ class PaymentIntentConfirmParams(RequestOptions): """ 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). + 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://docs.stripe.com/payments/save-card-without-authentication). """ excluded_payment_method_types: NotRequired[ - "Literal['']|List[Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'alma', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'billie', 'blik', 'boleto', 'card', 'cashapp', 'crypto', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'mb_way', 'mobilepay', 'multibanco', 'naver_pay', 'nz_bank_account', 'oxxo', 'p24', 'pay_by_bank', 'payco', 'paynow', 'paypal', 'pix', 'promptpay', 'revolut_pay', 'samsung_pay', 'satispay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" + "Literal['']|List[Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'alma', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'billie', 'blik', 'boleto', 'card', 'cashapp', 'crypto', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'mb_way', 'mobilepay', 'multibanco', 'naver_pay', 'nz_bank_account', 'oxxo', 'p24', 'pay_by_bank', 'payco', 'paynow', 'paypal', 'payto', 'pix', 'promptpay', 'revolut_pay', 'samsung_pay', 'satispay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" ] """ The list of payment method types to exclude from use with this payment. @@ -51,7 +51,7 @@ class PaymentIntentConfirmParams(RequestOptions): ] off_session: NotRequired["bool|Literal['one_off', 'recurring']"] """ - 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). + 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://docs.stripe.com/payments/cards/charging-saved-cards). """ payment_details: NotRequired[ "Literal['']|PaymentIntentConfirmParamsPaymentDetails" @@ -61,15 +61,15 @@ class PaymentIntentConfirmParams(RequestOptions): """ 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. - If the payment method is attached to a Customer, it must match the [customer](https://stripe.com/docs/api#create_payment_intent-customer) that is set on this PaymentIntent. + ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://docs.stripe.com/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. + If the payment method is attached to a Customer, it must match the [customer](https://api.stripe.com#create_payment_intent-customer) that is set on this PaymentIntent. """ payment_method_data: NotRequired[ "PaymentIntentConfirmParamsPaymentMethodData" ] """ If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear - in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) + in the [payment_method](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent. """ payment_method_options: NotRequired[ @@ -84,7 +84,7 @@ class PaymentIntentConfirmParams(RequestOptions): """ radar_options: NotRequired["PaymentIntentConfirmParamsRadarOptions"] """ - Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session). + Options to configure Radar. Learn more about [Radar Sessions](https://docs.stripe.com/radar/radar-session). """ receipt_email: NotRequired["Literal['']|str"] """ @@ -123,7 +123,7 @@ class PaymentIntentConfirmParams(RequestOptions): class PaymentIntentConfirmParamsAmountDetails(TypedDict): discount_amount: NotRequired["Literal['']|int"] """ - The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. """ @@ -131,7 +131,7 @@ class PaymentIntentConfirmParamsAmountDetails(TypedDict): "Literal['']|List[PaymentIntentConfirmParamsAmountDetailsLineItem]" ] """ - A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items. + A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items. """ shipping: NotRequired[ "Literal['']|PaymentIntentConfirmParamsAmountDetailsShipping" @@ -148,7 +148,7 @@ class PaymentIntentConfirmParamsAmountDetails(TypedDict): class PaymentIntentConfirmParamsAmountDetailsLineItem(TypedDict): discount_amount: NotRequired[int] """ - The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[discount_amount]` field. """ @@ -178,7 +178,7 @@ class PaymentIntentConfirmParamsAmountDetailsLineItem(TypedDict): """ unit_cost: int """ - The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. """ unit_of_measure: NotRequired[str] """ @@ -276,7 +276,7 @@ class PaymentIntentConfirmParamsAmountDetailsLineItemPaymentMethodOptionsPaypal( class PaymentIntentConfirmParamsAmountDetailsLineItemTax(TypedDict): total_tax_amount: int """ - The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + The total amount of tax on a single line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. """ @@ -285,7 +285,7 @@ class PaymentIntentConfirmParamsAmountDetailsLineItemTax(TypedDict): class PaymentIntentConfirmParamsAmountDetailsShipping(TypedDict): amount: NotRequired["Literal['']|int"] """ - If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. + If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0. """ from_postal_code: NotRequired["Literal['']|str"] """ @@ -300,7 +300,7 @@ class PaymentIntentConfirmParamsAmountDetailsShipping(TypedDict): class PaymentIntentConfirmParamsAmountDetailsTax(TypedDict): total_tax_amount: int """ - The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. """ @@ -323,7 +323,7 @@ class PaymentIntentConfirmParamsHooksInputs(TypedDict): class PaymentIntentConfirmParamsHooksInputsTax(TypedDict): calculation: Union[Literal[""], str] """ - The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id + The [TaxCalculation](https://docs.stripe.com/api/tax/calculations) id """ @@ -532,7 +532,7 @@ class PaymentIntentConfirmParamsPaymentMethodData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ mobilepay: NotRequired[ "PaymentIntentConfirmParamsPaymentMethodDataMobilepay" @@ -584,6 +584,10 @@ class PaymentIntentConfirmParamsPaymentMethodData(TypedDict): """ If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. """ + payto: NotRequired["PaymentIntentConfirmParamsPaymentMethodDataPayto"] + """ + If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. + """ pix: NotRequired["PaymentIntentConfirmParamsPaymentMethodDataPix"] """ If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. @@ -598,7 +602,7 @@ class PaymentIntentConfirmParamsPaymentMethodData(TypedDict): "PaymentIntentConfirmParamsPaymentMethodDataRadarOptions" ] """ - Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. """ revolut_pay: NotRequired[ "PaymentIntentConfirmParamsPaymentMethodDataRevolutPay" @@ -673,6 +677,7 @@ class PaymentIntentConfirmParamsPaymentMethodData(TypedDict): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -822,7 +827,7 @@ class PaymentIntentConfirmParamsPaymentMethodDataBillingDetailsAddress( """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -940,6 +945,7 @@ class PaymentIntentConfirmParamsPaymentMethodDataIdeal(TypedDict): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -1098,6 +1104,21 @@ class PaymentIntentConfirmParamsPaymentMethodDataPaypal(TypedDict): pass +class PaymentIntentConfirmParamsPaymentMethodDataPayto(TypedDict): + account_number: NotRequired[str] + """ + The account number for the bank account. + """ + bsb_number: NotRequired[str] + """ + Bank-State-Branch number of the bank account. + """ + pay_id: NotRequired[str] + """ + The PayID alias for the bank account. + """ + + class PaymentIntentConfirmParamsPaymentMethodDataPix(TypedDict): pass @@ -1109,7 +1130,7 @@ class PaymentIntentConfirmParamsPaymentMethodDataPromptpay(TypedDict): class PaymentIntentConfirmParamsPaymentMethodDataRadarOptions(TypedDict): 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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -1413,6 +1434,12 @@ class PaymentIntentConfirmParamsPaymentMethodOptions(TypedDict): """ If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options. """ + payto: NotRequired[ + "Literal['']|PaymentIntentConfirmParamsPaymentMethodOptionsPayto" + ] + """ + If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options. + """ pix: NotRequired[ "Literal['']|PaymentIntentConfirmParamsPaymentMethodOptionsPix" ] @@ -1799,7 +1826,7 @@ class PaymentIntentConfirmParamsPaymentMethodOptionsCard(TypedDict): """ Installment configuration for payments attempted on this PaymentIntent. - For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). + For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments). """ mandate_options: NotRequired[ "PaymentIntentConfirmParamsPaymentMethodOptionsCardMandateOptions" @@ -1837,27 +1864,27 @@ class PaymentIntentConfirmParamsPaymentMethodOptionsCard(TypedDict): 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 ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this PaymentIntent. """ request_incremental_authorization: NotRequired[ Literal["if_available", "never"] ] """ - Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. + Request ability to [increment the authorization](https://docs.stripe.com/payments/incremental-authorization) for this PaymentIntent. """ request_multicapture: NotRequired[Literal["if_available", "never"]] """ - Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent. + Request ability to make [multiple captures](https://docs.stripe.com/payments/multicapture) for this PaymentIntent. """ request_overcapture: NotRequired[Literal["if_available", "never"]] """ - Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent. + Request ability to [overcapture](https://docs.stripe.com/payments/overcapture) for this PaymentIntent. """ request_three_d_secure: NotRequired[ 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. + 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://docs.stripe.com/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://docs.stripe.com/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] """ @@ -2065,11 +2092,11 @@ class PaymentIntentConfirmParamsPaymentMethodOptionsCardPresent(TypedDict): """ 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 ability to capture this payment beyond the standard [authorization validity window](https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity) """ 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 ability to [increment](https://docs.stripe.com/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://docs.stripe.com/api/payment_intents/confirm) response to verify support. """ routing: NotRequired[ "PaymentIntentConfirmParamsPaymentMethodOptionsCardPresentRouting" @@ -2731,7 +2758,7 @@ class PaymentIntentConfirmParamsPaymentMethodOptionsPaypal(TypedDict): ] ] """ - [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. + [Preferred locale](https://docs.stripe.com/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ reference: NotRequired[str] """ @@ -2757,6 +2784,62 @@ class PaymentIntentConfirmParamsPaymentMethodOptionsPaypal(TypedDict): """ +class PaymentIntentConfirmParamsPaymentMethodOptionsPayto(TypedDict): + mandate_options: NotRequired[ + "PaymentIntentConfirmParamsPaymentMethodOptionsPaytoMandateOptions" + ] + """ + Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session` + """ + setup_future_usage: NotRequired[ + "Literal['']|Literal['none', 'off_session']" + ] + """ + Indicates that you intend to make future payments with this PaymentIntent's payment method. + + If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes. + + If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. + + When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication). + + If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. + """ + + +class PaymentIntentConfirmParamsPaymentMethodOptionsPaytoMandateOptions( + TypedDict, +): + amount: NotRequired["Literal['']|int"] + """ + Amount that will be collected. It is required when `amount_type` is `fixed`. + """ + amount_type: NotRequired["Literal['']|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. Defaults to `maximum`. + """ + end_date: NotRequired["Literal['']|str"] + """ + Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. + """ + payment_schedule: NotRequired[ + "Literal['']|Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + ] + """ + The periodicity at which payments will be collected. Defaults to `adhoc`. + """ + payments_per_period: NotRequired["Literal['']|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['']|Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + + class PaymentIntentConfirmParamsPaymentMethodOptionsPix(TypedDict): amount_includes_iof: NotRequired[Literal["always", "never"]] """ @@ -3085,7 +3168,7 @@ class PaymentIntentConfirmParamsPaymentMethodOptionsZip(TypedDict): class PaymentIntentConfirmParamsRadarOptions(TypedDict): 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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -3135,5 +3218,5 @@ class PaymentIntentConfirmParamsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_payment_intent_create_params.py b/stripe/params/_payment_intent_create_params.py index 625ed10de..2e699632d 100644 --- a/stripe/params/_payment_intent_create_params.py +++ b/stripe/params/_payment_intent_create_params.py @@ -8,7 +8,7 @@ class PaymentIntentCreateParams(RequestOptions): amount: 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). + Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/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://docs.stripe.com/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). """ amount_details: NotRequired["PaymentIntentCreateParamsAmountDetails"] """ @@ -16,7 +16,7 @@ class PaymentIntentCreateParams(RequestOptions): """ 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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + 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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). """ automatic_payment_methods: NotRequired[ "PaymentIntentCreateParamsAutomaticPaymentMethods" @@ -32,7 +32,7 @@ class PaymentIntentCreateParams(RequestOptions): """ 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). + Set to `true` to attempt to [confirm this PaymentIntent](https://docs.stripe.com/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://docs.stripe.com/api/payment_intents/confirm). """ confirmation_method: NotRequired[Literal["automatic", "manual"]] """ @@ -54,7 +54,15 @@ class PaymentIntentCreateParams(RequestOptions): Payment methods attached to other Customers cannot be used with this PaymentIntent. - If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + """ + customer_account: NotRequired[str] + """ + ID of the Account representing the customer that this PaymentIntent belongs to, if one exists. + + Payment methods attached to other Accounts cannot be used with this PaymentIntent. + + If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead. """ description: NotRequired[str] """ @@ -62,7 +70,7 @@ class PaymentIntentCreateParams(RequestOptions): """ 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). + 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://docs.stripe.com/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm). """ excluded_payment_method_types: NotRequired[ List[ @@ -103,6 +111,7 @@ class PaymentIntentCreateParams(RequestOptions): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -131,25 +140,25 @@ class PaymentIntentCreateParams(RequestOptions): """ 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). + ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm). """ mandate_data: NotRequired[ "Literal['']|PaymentIntentCreateParamsMandateData" ] """ - 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). + This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm). """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ off_session: NotRequired["bool|Literal['one_off', 'recurring']"] """ - 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). + 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://docs.stripe.com/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm). """ 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). + The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). """ payment_details: NotRequired["PaymentIntentCreateParamsPaymentDetails"] """ @@ -157,22 +166,22 @@ class PaymentIntentCreateParams(RequestOptions): """ 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. + ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://docs.stripe.com/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. - If the payment method is attached to a Customer, you must also provide the ID of that Customer as the [customer](https://stripe.com/docs/api#create_payment_intent-customer) parameter of this PaymentIntent. + If the payment method is attached to a Customer, you must also provide the ID of that Customer as the [customer](https://api.stripe.com#create_payment_intent-customer) parameter of this PaymentIntent. end """ payment_method_configuration: NotRequired[str] """ - The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent. + The ID of the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this PaymentIntent. """ payment_method_data: NotRequired[ "PaymentIntentCreateParamsPaymentMethodData" ] """ If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear - in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) + in the [payment_method](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent. """ payment_method_options: NotRequired[ @@ -187,7 +196,7 @@ class PaymentIntentCreateParams(RequestOptions): """ radar_options: NotRequired["PaymentIntentCreateParamsRadarOptions"] """ - Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session). + Options to configure Radar. Learn more about [Radar Sessions](https://docs.stripe.com/radar/radar-session). """ receipt_email: NotRequired[str] """ @@ -195,7 +204,7 @@ class PaymentIntentCreateParams(RequestOptions): """ 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). + 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://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm). """ setup_future_usage: NotRequired[Literal["off_session", "on_session"]] """ @@ -224,11 +233,11 @@ class PaymentIntentCreateParams(RequestOptions): transfer_data: NotRequired["PaymentIntentCreateParamsTransferData"] """ 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). + Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). """ 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). + A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers). """ use_stripe_sdk: NotRequired[bool] """ @@ -239,7 +248,7 @@ class PaymentIntentCreateParams(RequestOptions): class PaymentIntentCreateParamsAmountDetails(TypedDict): discount_amount: NotRequired["Literal['']|int"] """ - The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. """ @@ -247,7 +256,7 @@ class PaymentIntentCreateParamsAmountDetails(TypedDict): "Literal['']|List[PaymentIntentCreateParamsAmountDetailsLineItem]" ] """ - A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items. + A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items. """ shipping: NotRequired[ "Literal['']|PaymentIntentCreateParamsAmountDetailsShipping" @@ -264,7 +273,7 @@ class PaymentIntentCreateParamsAmountDetails(TypedDict): class PaymentIntentCreateParamsAmountDetailsLineItem(TypedDict): discount_amount: NotRequired[int] """ - The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[discount_amount]` field. """ @@ -294,7 +303,7 @@ class PaymentIntentCreateParamsAmountDetailsLineItem(TypedDict): """ unit_cost: int """ - The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. """ unit_of_measure: NotRequired[str] """ @@ -392,7 +401,7 @@ class PaymentIntentCreateParamsAmountDetailsLineItemPaymentMethodOptionsPaypal( class PaymentIntentCreateParamsAmountDetailsLineItemTax(TypedDict): total_tax_amount: int """ - The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + The total amount of tax on a single line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. """ @@ -401,7 +410,7 @@ class PaymentIntentCreateParamsAmountDetailsLineItemTax(TypedDict): class PaymentIntentCreateParamsAmountDetailsShipping(TypedDict): amount: NotRequired["Literal['']|int"] """ - If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. + If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0. """ from_postal_code: NotRequired["Literal['']|str"] """ @@ -416,7 +425,7 @@ class PaymentIntentCreateParamsAmountDetailsShipping(TypedDict): class PaymentIntentCreateParamsAmountDetailsTax(TypedDict): total_tax_amount: int """ - The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. """ @@ -427,7 +436,7 @@ class PaymentIntentCreateParamsAutomaticPaymentMethods(TypedDict): """ Controls whether this PaymentIntent will accept redirect-based payment methods. - Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment. + Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://docs.stripe.com/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment. """ enabled: bool """ @@ -452,7 +461,7 @@ class PaymentIntentCreateParamsHooksInputs(TypedDict): class PaymentIntentCreateParamsHooksInputsTax(TypedDict): calculation: Union[Literal[""], str] """ - The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id + The [TaxCalculation](https://docs.stripe.com/api/tax/calculations) id """ @@ -659,7 +668,7 @@ class PaymentIntentCreateParamsPaymentMethodData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ mobilepay: NotRequired[ "PaymentIntentCreateParamsPaymentMethodDataMobilepay" @@ -711,6 +720,10 @@ class PaymentIntentCreateParamsPaymentMethodData(TypedDict): """ If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. """ + payto: NotRequired["PaymentIntentCreateParamsPaymentMethodDataPayto"] + """ + If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. + """ pix: NotRequired["PaymentIntentCreateParamsPaymentMethodDataPix"] """ If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. @@ -725,7 +738,7 @@ class PaymentIntentCreateParamsPaymentMethodData(TypedDict): "PaymentIntentCreateParamsPaymentMethodDataRadarOptions" ] """ - Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. """ revolut_pay: NotRequired[ "PaymentIntentCreateParamsPaymentMethodDataRevolutPay" @@ -798,6 +811,7 @@ class PaymentIntentCreateParamsPaymentMethodData(TypedDict): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -947,7 +961,7 @@ class PaymentIntentCreateParamsPaymentMethodDataBillingDetailsAddress( """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -1065,6 +1079,7 @@ class PaymentIntentCreateParamsPaymentMethodDataIdeal(TypedDict): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -1223,6 +1238,21 @@ class PaymentIntentCreateParamsPaymentMethodDataPaypal(TypedDict): pass +class PaymentIntentCreateParamsPaymentMethodDataPayto(TypedDict): + account_number: NotRequired[str] + """ + The account number for the bank account. + """ + bsb_number: NotRequired[str] + """ + Bank-State-Branch number of the bank account. + """ + pay_id: NotRequired[str] + """ + The PayID alias for the bank account. + """ + + class PaymentIntentCreateParamsPaymentMethodDataPix(TypedDict): pass @@ -1234,7 +1264,7 @@ class PaymentIntentCreateParamsPaymentMethodDataPromptpay(TypedDict): class PaymentIntentCreateParamsPaymentMethodDataRadarOptions(TypedDict): 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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -1538,6 +1568,12 @@ class PaymentIntentCreateParamsPaymentMethodOptions(TypedDict): """ If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options. """ + payto: NotRequired[ + "Literal['']|PaymentIntentCreateParamsPaymentMethodOptionsPayto" + ] + """ + If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options. + """ pix: NotRequired[ "Literal['']|PaymentIntentCreateParamsPaymentMethodOptionsPix" ] @@ -1922,7 +1958,7 @@ class PaymentIntentCreateParamsPaymentMethodOptionsCard(TypedDict): """ Installment configuration for payments attempted on this PaymentIntent. - For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). + For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments). """ mandate_options: NotRequired[ "PaymentIntentCreateParamsPaymentMethodOptionsCardMandateOptions" @@ -1960,27 +1996,27 @@ class PaymentIntentCreateParamsPaymentMethodOptionsCard(TypedDict): 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 ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this PaymentIntent. """ request_incremental_authorization: NotRequired[ Literal["if_available", "never"] ] """ - Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. + Request ability to [increment the authorization](https://docs.stripe.com/payments/incremental-authorization) for this PaymentIntent. """ request_multicapture: NotRequired[Literal["if_available", "never"]] """ - Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent. + Request ability to make [multiple captures](https://docs.stripe.com/payments/multicapture) for this PaymentIntent. """ request_overcapture: NotRequired[Literal["if_available", "never"]] """ - Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent. + Request ability to [overcapture](https://docs.stripe.com/payments/overcapture) for this PaymentIntent. """ request_three_d_secure: NotRequired[ 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. + 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://docs.stripe.com/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://docs.stripe.com/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] """ @@ -2184,11 +2220,11 @@ class PaymentIntentCreateParamsPaymentMethodOptionsCardPresent(TypedDict): """ 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 ability to capture this payment beyond the standard [authorization validity window](https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity) """ 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 ability to [increment](https://docs.stripe.com/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://docs.stripe.com/api/payment_intents/confirm) response to verify support. """ routing: NotRequired[ "PaymentIntentCreateParamsPaymentMethodOptionsCardPresentRouting" @@ -2850,7 +2886,7 @@ class PaymentIntentCreateParamsPaymentMethodOptionsPaypal(TypedDict): ] ] """ - [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. + [Preferred locale](https://docs.stripe.com/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ reference: NotRequired[str] """ @@ -2876,6 +2912,62 @@ class PaymentIntentCreateParamsPaymentMethodOptionsPaypal(TypedDict): """ +class PaymentIntentCreateParamsPaymentMethodOptionsPayto(TypedDict): + mandate_options: NotRequired[ + "PaymentIntentCreateParamsPaymentMethodOptionsPaytoMandateOptions" + ] + """ + Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session` + """ + setup_future_usage: NotRequired[ + "Literal['']|Literal['none', 'off_session']" + ] + """ + Indicates that you intend to make future payments with this PaymentIntent's payment method. + + If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes. + + If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. + + When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication). + + If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. + """ + + +class PaymentIntentCreateParamsPaymentMethodOptionsPaytoMandateOptions( + TypedDict, +): + amount: NotRequired["Literal['']|int"] + """ + Amount that will be collected. It is required when `amount_type` is `fixed`. + """ + amount_type: NotRequired["Literal['']|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. Defaults to `maximum`. + """ + end_date: NotRequired["Literal['']|str"] + """ + Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. + """ + payment_schedule: NotRequired[ + "Literal['']|Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + ] + """ + The periodicity at which payments will be collected. Defaults to `adhoc`. + """ + payments_per_period: NotRequired["Literal['']|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['']|Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + + class PaymentIntentCreateParamsPaymentMethodOptionsPix(TypedDict): amount_includes_iof: NotRequired[Literal["always", "never"]] """ @@ -3204,7 +3296,7 @@ class PaymentIntentCreateParamsPaymentMethodOptionsZip(TypedDict): class PaymentIntentCreateParamsRadarOptions(TypedDict): 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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -3254,7 +3346,7 @@ class PaymentIntentCreateParamsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -3266,7 +3358,7 @@ class PaymentIntentCreateParamsTransferData(TypedDict): the full amount is transferred. If you intend to collect a fee and you need a more robust reporting experience, using - [application_fee_amount](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-application_fee_amount) + [application_fee_amount](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-application_fee_amount) might be a better fit for your integration. """ destination: str diff --git a/stripe/params/_payment_intent_increment_authorization_params.py b/stripe/params/_payment_intent_increment_authorization_params.py index 7a5157d6a..b0b37133b 100644 --- a/stripe/params/_payment_intent_increment_authorization_params.py +++ b/stripe/params/_payment_intent_increment_authorization_params.py @@ -18,7 +18,7 @@ class PaymentIntentIncrementAuthorizationParams(RequestOptions): """ 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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + 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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). """ description: NotRequired[str] """ @@ -34,7 +34,7 @@ class PaymentIntentIncrementAuthorizationParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ payment_details: NotRequired[ "PaymentIntentIncrementAuthorizationParamsPaymentDetails" @@ -51,14 +51,14 @@ class PaymentIntentIncrementAuthorizationParams(RequestOptions): ] """ The parameters used to automatically create a transfer after the payment is captured. - Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). """ class PaymentIntentIncrementAuthorizationParamsAmountDetails(TypedDict): discount_amount: NotRequired["Literal['']|int"] """ - The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. """ @@ -66,7 +66,7 @@ class PaymentIntentIncrementAuthorizationParamsAmountDetails(TypedDict): "Literal['']|List[PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItem]" ] """ - A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items. + A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items. """ shipping: NotRequired[ "Literal['']|PaymentIntentIncrementAuthorizationParamsAmountDetailsShipping" @@ -87,7 +87,7 @@ class PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItem( ): discount_amount: NotRequired[int] """ - The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[discount_amount]` field. """ @@ -119,7 +119,7 @@ class PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItem( """ unit_cost: int """ - The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. """ unit_of_measure: NotRequired[str] """ @@ -219,7 +219,7 @@ class PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItemTax( ): total_tax_amount: int """ - The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + The total amount of tax on a single line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. """ @@ -230,7 +230,7 @@ class PaymentIntentIncrementAuthorizationParamsAmountDetailsShipping( ): amount: NotRequired["Literal['']|int"] """ - If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. + If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0. """ from_postal_code: NotRequired["Literal['']|str"] """ @@ -245,7 +245,7 @@ class PaymentIntentIncrementAuthorizationParamsAmountDetailsShipping( class PaymentIntentIncrementAuthorizationParamsAmountDetailsTax(TypedDict): total_tax_amount: int """ - The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. """ @@ -268,7 +268,7 @@ class PaymentIntentIncrementAuthorizationParamsHooksInputs(TypedDict): class PaymentIntentIncrementAuthorizationParamsHooksInputsTax(TypedDict): calculation: Union[Literal[""], str] """ - The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id + The [TaxCalculation](https://docs.stripe.com/api/tax/calculations) id """ diff --git a/stripe/params/_payment_intent_list_params.py b/stripe/params/_payment_intent_list_params.py index 711a58f45..10ec58a94 100644 --- a/stripe/params/_payment_intent_list_params.py +++ b/stripe/params/_payment_intent_list_params.py @@ -14,6 +14,10 @@ class PaymentIntentListParams(RequestOptions): """ Only return PaymentIntents for the customer that this customer ID specifies. """ + customer_account: NotRequired[str] + """ + Only return PaymentIntents for the account representing the customer that this ID specifies. + """ 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. diff --git a/stripe/params/_payment_intent_modify_params.py b/stripe/params/_payment_intent_modify_params.py index fa3f2fa98..6a5dea72c 100644 --- a/stripe/params/_payment_intent_modify_params.py +++ b/stripe/params/_payment_intent_modify_params.py @@ -8,7 +8,7 @@ class PaymentIntentModifyParams(RequestOptions): 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). + Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/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://docs.stripe.com/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). """ amount_details: NotRequired[ "Literal['']|PaymentIntentModifyParamsAmountDetails" @@ -18,7 +18,7 @@ class PaymentIntentModifyParams(RequestOptions): """ application_fee_amount: NotRequired["Literal['']|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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + 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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). """ capture_method: NotRequired[ Literal["automatic", "automatic_async", "manual"] @@ -36,14 +36,22 @@ class PaymentIntentModifyParams(RequestOptions): Payment methods attached to other Customers cannot be used with this PaymentIntent. - If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + """ + customer_account: NotRequired[str] + """ + ID of the Account representing the customer that this PaymentIntent belongs to, if one exists. + + Payment methods attached to other Accounts cannot be used with this PaymentIntent. + + If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead. """ description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ excluded_payment_method_types: NotRequired[ - "Literal['']|List[Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'alma', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'billie', 'blik', 'boleto', 'card', 'cashapp', 'crypto', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'mb_way', 'mobilepay', 'multibanco', 'naver_pay', 'nz_bank_account', 'oxxo', 'p24', 'pay_by_bank', 'payco', 'paynow', 'paypal', 'pix', 'promptpay', 'revolut_pay', 'samsung_pay', 'satispay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" + "Literal['']|List[Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'alma', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'billie', 'blik', 'boleto', 'card', 'cashapp', 'crypto', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'mb_way', 'mobilepay', 'multibanco', 'naver_pay', 'nz_bank_account', 'oxxo', 'p24', 'pay_by_bank', 'payco', 'paynow', 'paypal', 'payto', 'pix', 'promptpay', 'revolut_pay', 'samsung_pay', 'satispay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" ] """ The list of payment method types to exclude from use with this payment. @@ -58,7 +66,7 @@ class PaymentIntentModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ payment_details: NotRequired[ "Literal['']|PaymentIntentModifyParamsPaymentDetails" @@ -68,18 +76,18 @@ class PaymentIntentModifyParams(RequestOptions): """ 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. To unset this field to null, pass in an empty string. + ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://docs.stripe.com/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. To unset this field to null, pass in an empty string. """ payment_method_configuration: NotRequired[str] """ - The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent. + The ID of the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this PaymentIntent. """ payment_method_data: NotRequired[ "PaymentIntentModifyParamsPaymentMethodData" ] """ If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear - in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) + in the [payment_method](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent. """ payment_method_options: NotRequired[ @@ -126,18 +134,18 @@ class PaymentIntentModifyParams(RequestOptions): """ transfer_data: NotRequired["PaymentIntentModifyParamsTransferData"] """ - 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). + Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). """ 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). + 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://docs.stripe.com/payments/connected-accounts). """ class PaymentIntentModifyParamsAmountDetails(TypedDict): discount_amount: NotRequired["Literal['']|int"] """ - The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. """ @@ -145,7 +153,7 @@ class PaymentIntentModifyParamsAmountDetails(TypedDict): "Literal['']|List[PaymentIntentModifyParamsAmountDetailsLineItem]" ] """ - A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items. + A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items. """ shipping: NotRequired[ "Literal['']|PaymentIntentModifyParamsAmountDetailsShipping" @@ -162,7 +170,7 @@ class PaymentIntentModifyParamsAmountDetails(TypedDict): class PaymentIntentModifyParamsAmountDetailsLineItem(TypedDict): discount_amount: NotRequired[int] """ - The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[discount_amount]` field. """ @@ -192,7 +200,7 @@ class PaymentIntentModifyParamsAmountDetailsLineItem(TypedDict): """ unit_cost: int """ - The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. """ unit_of_measure: NotRequired[str] """ @@ -290,7 +298,7 @@ class PaymentIntentModifyParamsAmountDetailsLineItemPaymentMethodOptionsPaypal( class PaymentIntentModifyParamsAmountDetailsLineItemTax(TypedDict): total_tax_amount: int """ - The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + The total amount of tax on a single line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. """ @@ -299,7 +307,7 @@ class PaymentIntentModifyParamsAmountDetailsLineItemTax(TypedDict): class PaymentIntentModifyParamsAmountDetailsShipping(TypedDict): amount: NotRequired["Literal['']|int"] """ - If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. + If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0. """ from_postal_code: NotRequired["Literal['']|str"] """ @@ -314,7 +322,7 @@ class PaymentIntentModifyParamsAmountDetailsShipping(TypedDict): class PaymentIntentModifyParamsAmountDetailsTax(TypedDict): total_tax_amount: int """ - The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. """ @@ -337,7 +345,7 @@ class PaymentIntentModifyParamsHooksInputs(TypedDict): class PaymentIntentModifyParamsHooksInputsTax(TypedDict): calculation: Union[Literal[""], str] """ - The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id + The [TaxCalculation](https://docs.stripe.com/api/tax/calculations) id """ @@ -497,7 +505,7 @@ class PaymentIntentModifyParamsPaymentMethodData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ mobilepay: NotRequired[ "PaymentIntentModifyParamsPaymentMethodDataMobilepay" @@ -549,6 +557,10 @@ class PaymentIntentModifyParamsPaymentMethodData(TypedDict): """ If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. """ + payto: NotRequired["PaymentIntentModifyParamsPaymentMethodDataPayto"] + """ + If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. + """ pix: NotRequired["PaymentIntentModifyParamsPaymentMethodDataPix"] """ If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. @@ -563,7 +575,7 @@ class PaymentIntentModifyParamsPaymentMethodData(TypedDict): "PaymentIntentModifyParamsPaymentMethodDataRadarOptions" ] """ - Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. """ revolut_pay: NotRequired[ "PaymentIntentModifyParamsPaymentMethodDataRevolutPay" @@ -636,6 +648,7 @@ class PaymentIntentModifyParamsPaymentMethodData(TypedDict): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -785,7 +798,7 @@ class PaymentIntentModifyParamsPaymentMethodDataBillingDetailsAddress( """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -903,6 +916,7 @@ class PaymentIntentModifyParamsPaymentMethodDataIdeal(TypedDict): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -1061,6 +1075,21 @@ class PaymentIntentModifyParamsPaymentMethodDataPaypal(TypedDict): pass +class PaymentIntentModifyParamsPaymentMethodDataPayto(TypedDict): + account_number: NotRequired[str] + """ + The account number for the bank account. + """ + bsb_number: NotRequired[str] + """ + Bank-State-Branch number of the bank account. + """ + pay_id: NotRequired[str] + """ + The PayID alias for the bank account. + """ + + class PaymentIntentModifyParamsPaymentMethodDataPix(TypedDict): pass @@ -1072,7 +1101,7 @@ class PaymentIntentModifyParamsPaymentMethodDataPromptpay(TypedDict): class PaymentIntentModifyParamsPaymentMethodDataRadarOptions(TypedDict): 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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -1376,6 +1405,12 @@ class PaymentIntentModifyParamsPaymentMethodOptions(TypedDict): """ If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options. """ + payto: NotRequired[ + "Literal['']|PaymentIntentModifyParamsPaymentMethodOptionsPayto" + ] + """ + If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options. + """ pix: NotRequired[ "Literal['']|PaymentIntentModifyParamsPaymentMethodOptionsPix" ] @@ -1760,7 +1795,7 @@ class PaymentIntentModifyParamsPaymentMethodOptionsCard(TypedDict): """ Installment configuration for payments attempted on this PaymentIntent. - For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). + For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments). """ mandate_options: NotRequired[ "PaymentIntentModifyParamsPaymentMethodOptionsCardMandateOptions" @@ -1798,27 +1833,27 @@ class PaymentIntentModifyParamsPaymentMethodOptionsCard(TypedDict): 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 ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this PaymentIntent. """ request_incremental_authorization: NotRequired[ Literal["if_available", "never"] ] """ - Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. + Request ability to [increment the authorization](https://docs.stripe.com/payments/incremental-authorization) for this PaymentIntent. """ request_multicapture: NotRequired[Literal["if_available", "never"]] """ - Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent. + Request ability to make [multiple captures](https://docs.stripe.com/payments/multicapture) for this PaymentIntent. """ request_overcapture: NotRequired[Literal["if_available", "never"]] """ - Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent. + Request ability to [overcapture](https://docs.stripe.com/payments/overcapture) for this PaymentIntent. """ request_three_d_secure: NotRequired[ 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. + 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://docs.stripe.com/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://docs.stripe.com/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] """ @@ -2022,11 +2057,11 @@ class PaymentIntentModifyParamsPaymentMethodOptionsCardPresent(TypedDict): """ 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 ability to capture this payment beyond the standard [authorization validity window](https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity) """ 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 ability to [increment](https://docs.stripe.com/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://docs.stripe.com/api/payment_intents/confirm) response to verify support. """ routing: NotRequired[ "PaymentIntentModifyParamsPaymentMethodOptionsCardPresentRouting" @@ -2688,7 +2723,7 @@ class PaymentIntentModifyParamsPaymentMethodOptionsPaypal(TypedDict): ] ] """ - [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. + [Preferred locale](https://docs.stripe.com/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ reference: NotRequired[str] """ @@ -2714,6 +2749,62 @@ class PaymentIntentModifyParamsPaymentMethodOptionsPaypal(TypedDict): """ +class PaymentIntentModifyParamsPaymentMethodOptionsPayto(TypedDict): + mandate_options: NotRequired[ + "PaymentIntentModifyParamsPaymentMethodOptionsPaytoMandateOptions" + ] + """ + Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session` + """ + setup_future_usage: NotRequired[ + "Literal['']|Literal['none', 'off_session']" + ] + """ + Indicates that you intend to make future payments with this PaymentIntent's payment method. + + If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes. + + If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. + + When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication). + + If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. + """ + + +class PaymentIntentModifyParamsPaymentMethodOptionsPaytoMandateOptions( + TypedDict, +): + amount: NotRequired["Literal['']|int"] + """ + Amount that will be collected. It is required when `amount_type` is `fixed`. + """ + amount_type: NotRequired["Literal['']|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. Defaults to `maximum`. + """ + end_date: NotRequired["Literal['']|str"] + """ + Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. + """ + payment_schedule: NotRequired[ + "Literal['']|Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + ] + """ + The periodicity at which payments will be collected. Defaults to `adhoc`. + """ + payments_per_period: NotRequired["Literal['']|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['']|Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + + class PaymentIntentModifyParamsPaymentMethodOptionsPix(TypedDict): amount_includes_iof: NotRequired[Literal["always", "never"]] """ @@ -3085,7 +3176,7 @@ class PaymentIntentModifyParamsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_payment_intent_search_params.py b/stripe/params/_payment_intent_search_params.py index 53c3cc376..516352aec 100644 --- a/stripe/params/_payment_intent_search_params.py +++ b/stripe/params/_payment_intent_search_params.py @@ -20,5 +20,5 @@ class PaymentIntentSearchParams(RequestOptions): """ query: str """ - The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for payment intents](https://stripe.com/docs/search#query-fields-for-payment-intents). + The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for payment intents](https://docs.stripe.com/search#query-fields-for-payment-intents). """ diff --git a/stripe/params/_payment_intent_update_params.py b/stripe/params/_payment_intent_update_params.py index 6109a20f8..59a8179fd 100644 --- a/stripe/params/_payment_intent_update_params.py +++ b/stripe/params/_payment_intent_update_params.py @@ -7,7 +7,7 @@ class PaymentIntentUpdateParams(TypedDict): 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). + Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/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://docs.stripe.com/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). """ amount_details: NotRequired[ "Literal['']|PaymentIntentUpdateParamsAmountDetails" @@ -17,7 +17,7 @@ class PaymentIntentUpdateParams(TypedDict): """ application_fee_amount: NotRequired["Literal['']|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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + 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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). """ capture_method: NotRequired[ Literal["automatic", "automatic_async", "manual"] @@ -35,14 +35,22 @@ class PaymentIntentUpdateParams(TypedDict): Payment methods attached to other Customers cannot be used with this PaymentIntent. - If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + """ + customer_account: NotRequired[str] + """ + ID of the Account representing the customer that this PaymentIntent belongs to, if one exists. + + Payment methods attached to other Accounts cannot be used with this PaymentIntent. + + If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead. """ description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ excluded_payment_method_types: NotRequired[ - "Literal['']|List[Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'alma', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'billie', 'blik', 'boleto', 'card', 'cashapp', 'crypto', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'mb_way', 'mobilepay', 'multibanco', 'naver_pay', 'nz_bank_account', 'oxxo', 'p24', 'pay_by_bank', 'payco', 'paynow', 'paypal', 'pix', 'promptpay', 'revolut_pay', 'samsung_pay', 'satispay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" + "Literal['']|List[Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'alma', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'billie', 'blik', 'boleto', 'card', 'cashapp', 'crypto', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'mb_way', 'mobilepay', 'multibanco', 'naver_pay', 'nz_bank_account', 'oxxo', 'p24', 'pay_by_bank', 'payco', 'paynow', 'paypal', 'payto', 'pix', 'promptpay', 'revolut_pay', 'samsung_pay', 'satispay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" ] """ The list of payment method types to exclude from use with this payment. @@ -57,7 +65,7 @@ class PaymentIntentUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ payment_details: NotRequired[ "Literal['']|PaymentIntentUpdateParamsPaymentDetails" @@ -67,18 +75,18 @@ class PaymentIntentUpdateParams(TypedDict): """ 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. To unset this field to null, pass in an empty string. + ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://docs.stripe.com/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. To unset this field to null, pass in an empty string. """ payment_method_configuration: NotRequired[str] """ - The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent. + The ID of the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this PaymentIntent. """ payment_method_data: NotRequired[ "PaymentIntentUpdateParamsPaymentMethodData" ] """ If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear - in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) + in the [payment_method](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent. """ payment_method_options: NotRequired[ @@ -125,18 +133,18 @@ class PaymentIntentUpdateParams(TypedDict): """ transfer_data: NotRequired["PaymentIntentUpdateParamsTransferData"] """ - 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). + Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). """ 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). + 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://docs.stripe.com/payments/connected-accounts). """ class PaymentIntentUpdateParamsAmountDetails(TypedDict): discount_amount: NotRequired["Literal['']|int"] """ - The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. """ @@ -144,7 +152,7 @@ class PaymentIntentUpdateParamsAmountDetails(TypedDict): "Literal['']|List[PaymentIntentUpdateParamsAmountDetailsLineItem]" ] """ - A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items. + A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items. """ shipping: NotRequired[ "Literal['']|PaymentIntentUpdateParamsAmountDetailsShipping" @@ -161,7 +169,7 @@ class PaymentIntentUpdateParamsAmountDetails(TypedDict): class PaymentIntentUpdateParamsAmountDetailsLineItem(TypedDict): discount_amount: NotRequired[int] """ - The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0. + The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[discount_amount]` field. """ @@ -191,7 +199,7 @@ class PaymentIntentUpdateParamsAmountDetailsLineItem(TypedDict): """ unit_cost: int """ - The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. """ unit_of_measure: NotRequired[str] """ @@ -289,7 +297,7 @@ class PaymentIntentUpdateParamsAmountDetailsLineItemPaymentMethodOptionsPaypal( class PaymentIntentUpdateParamsAmountDetailsLineItemTax(TypedDict): total_tax_amount: int """ - The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. + The total amount of tax on a single line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. """ @@ -298,7 +306,7 @@ class PaymentIntentUpdateParamsAmountDetailsLineItemTax(TypedDict): class PaymentIntentUpdateParamsAmountDetailsShipping(TypedDict): amount: NotRequired["Literal['']|int"] """ - If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0. + If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0. """ from_postal_code: NotRequired["Literal['']|str"] """ @@ -313,7 +321,7 @@ class PaymentIntentUpdateParamsAmountDetailsShipping(TypedDict): class PaymentIntentUpdateParamsAmountDetailsTax(TypedDict): total_tax_amount: int """ - The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. """ @@ -336,7 +344,7 @@ class PaymentIntentUpdateParamsHooksInputs(TypedDict): class PaymentIntentUpdateParamsHooksInputsTax(TypedDict): calculation: Union[Literal[""], str] """ - The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id + The [TaxCalculation](https://docs.stripe.com/api/tax/calculations) id """ @@ -496,7 +504,7 @@ class PaymentIntentUpdateParamsPaymentMethodData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ mobilepay: NotRequired[ "PaymentIntentUpdateParamsPaymentMethodDataMobilepay" @@ -548,6 +556,10 @@ class PaymentIntentUpdateParamsPaymentMethodData(TypedDict): """ If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. """ + payto: NotRequired["PaymentIntentUpdateParamsPaymentMethodDataPayto"] + """ + If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. + """ pix: NotRequired["PaymentIntentUpdateParamsPaymentMethodDataPix"] """ If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. @@ -562,7 +574,7 @@ class PaymentIntentUpdateParamsPaymentMethodData(TypedDict): "PaymentIntentUpdateParamsPaymentMethodDataRadarOptions" ] """ - Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. """ revolut_pay: NotRequired[ "PaymentIntentUpdateParamsPaymentMethodDataRevolutPay" @@ -635,6 +647,7 @@ class PaymentIntentUpdateParamsPaymentMethodData(TypedDict): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -784,7 +797,7 @@ class PaymentIntentUpdateParamsPaymentMethodDataBillingDetailsAddress( """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -902,6 +915,7 @@ class PaymentIntentUpdateParamsPaymentMethodDataIdeal(TypedDict): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -1060,6 +1074,21 @@ class PaymentIntentUpdateParamsPaymentMethodDataPaypal(TypedDict): pass +class PaymentIntentUpdateParamsPaymentMethodDataPayto(TypedDict): + account_number: NotRequired[str] + """ + The account number for the bank account. + """ + bsb_number: NotRequired[str] + """ + Bank-State-Branch number of the bank account. + """ + pay_id: NotRequired[str] + """ + The PayID alias for the bank account. + """ + + class PaymentIntentUpdateParamsPaymentMethodDataPix(TypedDict): pass @@ -1071,7 +1100,7 @@ class PaymentIntentUpdateParamsPaymentMethodDataPromptpay(TypedDict): class PaymentIntentUpdateParamsPaymentMethodDataRadarOptions(TypedDict): 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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -1375,6 +1404,12 @@ class PaymentIntentUpdateParamsPaymentMethodOptions(TypedDict): """ If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options. """ + payto: NotRequired[ + "Literal['']|PaymentIntentUpdateParamsPaymentMethodOptionsPayto" + ] + """ + If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options. + """ pix: NotRequired[ "Literal['']|PaymentIntentUpdateParamsPaymentMethodOptionsPix" ] @@ -1759,7 +1794,7 @@ class PaymentIntentUpdateParamsPaymentMethodOptionsCard(TypedDict): """ Installment configuration for payments attempted on this PaymentIntent. - For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). + For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments). """ mandate_options: NotRequired[ "PaymentIntentUpdateParamsPaymentMethodOptionsCardMandateOptions" @@ -1797,27 +1832,27 @@ class PaymentIntentUpdateParamsPaymentMethodOptionsCard(TypedDict): 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 ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this PaymentIntent. """ request_incremental_authorization: NotRequired[ Literal["if_available", "never"] ] """ - Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. + Request ability to [increment the authorization](https://docs.stripe.com/payments/incremental-authorization) for this PaymentIntent. """ request_multicapture: NotRequired[Literal["if_available", "never"]] """ - Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent. + Request ability to make [multiple captures](https://docs.stripe.com/payments/multicapture) for this PaymentIntent. """ request_overcapture: NotRequired[Literal["if_available", "never"]] """ - Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent. + Request ability to [overcapture](https://docs.stripe.com/payments/overcapture) for this PaymentIntent. """ request_three_d_secure: NotRequired[ 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. + 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://docs.stripe.com/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://docs.stripe.com/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] """ @@ -2021,11 +2056,11 @@ class PaymentIntentUpdateParamsPaymentMethodOptionsCardPresent(TypedDict): """ 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 ability to capture this payment beyond the standard [authorization validity window](https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity) """ 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 ability to [increment](https://docs.stripe.com/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://docs.stripe.com/api/payment_intents/confirm) response to verify support. """ routing: NotRequired[ "PaymentIntentUpdateParamsPaymentMethodOptionsCardPresentRouting" @@ -2687,7 +2722,7 @@ class PaymentIntentUpdateParamsPaymentMethodOptionsPaypal(TypedDict): ] ] """ - [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. + [Preferred locale](https://docs.stripe.com/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ reference: NotRequired[str] """ @@ -2713,6 +2748,62 @@ class PaymentIntentUpdateParamsPaymentMethodOptionsPaypal(TypedDict): """ +class PaymentIntentUpdateParamsPaymentMethodOptionsPayto(TypedDict): + mandate_options: NotRequired[ + "PaymentIntentUpdateParamsPaymentMethodOptionsPaytoMandateOptions" + ] + """ + Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session` + """ + setup_future_usage: NotRequired[ + "Literal['']|Literal['none', 'off_session']" + ] + """ + Indicates that you intend to make future payments with this PaymentIntent's payment method. + + If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes. + + If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. + + When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication). + + If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. + """ + + +class PaymentIntentUpdateParamsPaymentMethodOptionsPaytoMandateOptions( + TypedDict, +): + amount: NotRequired["Literal['']|int"] + """ + Amount that will be collected. It is required when `amount_type` is `fixed`. + """ + amount_type: NotRequired["Literal['']|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. Defaults to `maximum`. + """ + end_date: NotRequired["Literal['']|str"] + """ + Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. + """ + payment_schedule: NotRequired[ + "Literal['']|Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + ] + """ + The periodicity at which payments will be collected. Defaults to `adhoc`. + """ + payments_per_period: NotRequired["Literal['']|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['']|Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + + class PaymentIntentUpdateParamsPaymentMethodOptionsPix(TypedDict): amount_includes_iof: NotRequired[Literal["always", "never"]] """ @@ -3084,7 +3175,7 @@ class PaymentIntentUpdateParamsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_payment_link_create_params.py b/stripe/params/_payment_link_create_params.py index c24e472e9..9e70abc17 100644 --- a/stripe/params/_payment_link_create_params.py +++ b/stripe/params/_payment_link_create_params.py @@ -48,7 +48,7 @@ class PaymentLinkCreateParams(RequestOptions): """ 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). + Configures whether [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link create a [Customer](https://docs.stripe.com/api/customers). """ expand: NotRequired[List[str]] """ @@ -68,7 +68,7 @@ class PaymentLinkCreateParams(RequestOptions): """ 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link. """ name_collection: NotRequired["PaymentLinkCreateParamsNameCollection"] """ @@ -80,7 +80,7 @@ class PaymentLinkCreateParams(RequestOptions): """ optional_items: NotRequired[List["PaymentLinkCreateParamsOptionalItem"]] """ - A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). + A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices). There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items. There is a maximum of 20 combined line items and optional items. """ @@ -96,7 +96,7 @@ class PaymentLinkCreateParams(RequestOptions): Can only be set in `subscription` mode. Defaults to `always`. - 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). + 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://docs.stripe.com/payments/checkout/free-trials). """ payment_method_types: NotRequired[ List[ @@ -129,6 +129,7 @@ class PaymentLinkCreateParams(RequestOptions): "pay_by_bank", "paynow", "paypal", + "payto", "pix", "promptpay", "satispay", @@ -143,7 +144,7 @@ class PaymentLinkCreateParams(RequestOptions): ] ] """ - 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)). + 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://docs.stripe.com/payments/payment-methods/integration-options#payment-method-product-support)). """ phone_number_collection: NotRequired[ "PaymentLinkCreateParamsPhoneNumberCollection" @@ -167,13 +168,13 @@ class PaymentLinkCreateParams(RequestOptions): List["PaymentLinkCreateParamsShippingOption"] ] """ - The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. + The shipping rate options to apply to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link. """ submit_type: NotRequired[ Literal["auto", "book", "donate", "pay", "subscribe"] ] """ - 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`). + 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://docs.stripe.com/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`). """ subscription_data: NotRequired["PaymentLinkCreateParamsSubscriptionData"] """ @@ -216,7 +217,7 @@ class PaymentLinkCreateParamsAfterCompletionHostedConfirmation(TypedDict): class PaymentLinkCreateParamsAfterCompletionRedirect(TypedDict): url: str """ - The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-id) included. + The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-id) included. """ @@ -461,7 +462,7 @@ class PaymentLinkCreateParamsInvoiceCreationInvoiceData(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ rendering_options: NotRequired[ "Literal['']|PaymentLinkCreateParamsInvoiceCreationInvoiceDataRenderingOptions" @@ -517,11 +518,11 @@ class PaymentLinkCreateParamsLineItem(TypedDict): """ 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. + The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object. One of `price` or `price_data` is required. """ price_data: NotRequired["PaymentLinkCreateParamsLineItemPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: int """ @@ -565,7 +566,7 @@ class PaymentLinkCreateParamsLineItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -588,7 +589,7 @@ class PaymentLinkCreateParamsLineItemPriceDataProductData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: str """ @@ -596,7 +597,7 @@ class PaymentLinkCreateParamsLineItemPriceDataProductData(TypedDict): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ unit_label: NotRequired[str] """ @@ -657,7 +658,7 @@ class PaymentLinkCreateParamsOptionalItem(TypedDict): """ price: str """ - The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. + The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object. """ quantity: int """ @@ -693,11 +694,11 @@ class PaymentLinkCreateParamsPaymentIntentData(TypedDict): """ 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Payment Intents](https://docs.stripe.com/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"]] """ - 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. + Indicates that you intend to [make future payments](https://docs.stripe.com/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session. When setting this to `on_session`, Checkout will show a notice to the customer that their payment details will be saved. @@ -721,7 +722,7 @@ class PaymentLinkCreateParamsPaymentIntentData(TypedDict): """ 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. + A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. """ @@ -1015,7 +1016,7 @@ class PaymentLinkCreateParamsSubscriptionData(TypedDict): """ 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Subscriptions](https://docs.stripe.com/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] """ diff --git a/stripe/params/_payment_link_modify_params.py b/stripe/params/_payment_link_modify_params.py index 260c3a70b..498342578 100644 --- a/stripe/params/_payment_link_modify_params.py +++ b/stripe/params/_payment_link_modify_params.py @@ -38,7 +38,7 @@ class PaymentLinkModifyParams(RequestOptions): """ 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). + Configures whether [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link create a [Customer](https://docs.stripe.com/api/customers). """ expand: NotRequired[List[str]] """ @@ -58,7 +58,7 @@ class PaymentLinkModifyParams(RequestOptions): """ 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link. """ name_collection: NotRequired[ "Literal['']|PaymentLinkModifyParamsNameCollection" @@ -78,10 +78,10 @@ class PaymentLinkModifyParams(RequestOptions): Can only be set in `subscription` mode. Defaults to `always`. - 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). + 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://docs.stripe.com/payments/checkout/free-trials). """ payment_method_types: NotRequired[ - "Literal['']|List[Literal['affirm', 'afterpay_clearpay', 'alipay', 'alma', 'au_becs_debit', 'bacs_debit', 'bancontact', 'billie', 'blik', 'boleto', 'card', 'cashapp', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'konbini', 'link', 'mb_way', 'mobilepay', 'multibanco', 'oxxo', 'p24', 'pay_by_bank', 'paynow', 'paypal', 'pix', 'promptpay', 'satispay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" + "Literal['']|List[Literal['affirm', 'afterpay_clearpay', 'alipay', 'alma', 'au_becs_debit', 'bacs_debit', 'bancontact', 'billie', 'blik', 'boleto', 'card', 'cashapp', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'konbini', 'link', 'mb_way', 'mobilepay', 'multibanco', 'oxxo', 'p24', 'pay_by_bank', 'paynow', 'paypal', 'payto', 'pix', 'promptpay', 'satispay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" ] """ The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). @@ -110,7 +110,7 @@ class PaymentLinkModifyParams(RequestOptions): Literal["auto", "book", "donate", "pay", "subscribe"] ] """ - 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`). + 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://docs.stripe.com/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`). """ subscription_data: NotRequired["PaymentLinkModifyParamsSubscriptionData"] """ @@ -149,7 +149,7 @@ class PaymentLinkModifyParamsAfterCompletionHostedConfirmation(TypedDict): class PaymentLinkModifyParamsAfterCompletionRedirect(TypedDict): url: str """ - The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-id) included. + The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-id) included. """ @@ -364,7 +364,7 @@ class PaymentLinkModifyParamsInvoiceCreationInvoiceData(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ rendering_options: NotRequired[ "Literal['']|PaymentLinkModifyParamsInvoiceCreationInvoiceDataRenderingOptions" @@ -483,7 +483,7 @@ class PaymentLinkModifyParamsPaymentIntentData(TypedDict): """ metadata: NotRequired["Literal['']|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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values. """ statement_descriptor: NotRequired["Literal['']|str"] """ @@ -497,7 +497,7 @@ class PaymentLinkModifyParamsPaymentIntentData(TypedDict): """ transfer_group: NotRequired["Literal['']|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. + A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. """ @@ -780,7 +780,7 @@ class PaymentLinkModifyParamsSubscriptionData(TypedDict): """ metadata: NotRequired["Literal['']|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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values. """ trial_period_days: NotRequired["Literal['']|int"] """ diff --git a/stripe/params/_payment_link_update_params.py b/stripe/params/_payment_link_update_params.py index 7a0b0d314..afd9214f3 100644 --- a/stripe/params/_payment_link_update_params.py +++ b/stripe/params/_payment_link_update_params.py @@ -37,7 +37,7 @@ class PaymentLinkUpdateParams(TypedDict): """ 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). + Configures whether [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link create a [Customer](https://docs.stripe.com/api/customers). """ expand: NotRequired[List[str]] """ @@ -57,7 +57,7 @@ class PaymentLinkUpdateParams(TypedDict): """ 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link. """ name_collection: NotRequired[ "Literal['']|PaymentLinkUpdateParamsNameCollection" @@ -77,10 +77,10 @@ class PaymentLinkUpdateParams(TypedDict): Can only be set in `subscription` mode. Defaults to `always`. - 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). + 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://docs.stripe.com/payments/checkout/free-trials). """ payment_method_types: NotRequired[ - "Literal['']|List[Literal['affirm', 'afterpay_clearpay', 'alipay', 'alma', 'au_becs_debit', 'bacs_debit', 'bancontact', 'billie', 'blik', 'boleto', 'card', 'cashapp', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'konbini', 'link', 'mb_way', 'mobilepay', 'multibanco', 'oxxo', 'p24', 'pay_by_bank', 'paynow', 'paypal', 'pix', 'promptpay', 'satispay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" + "Literal['']|List[Literal['affirm', 'afterpay_clearpay', 'alipay', 'alma', 'au_becs_debit', 'bacs_debit', 'bancontact', 'billie', 'blik', 'boleto', 'card', 'cashapp', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'klarna', 'konbini', 'link', 'mb_way', 'mobilepay', 'multibanco', 'oxxo', 'p24', 'pay_by_bank', 'paynow', 'paypal', 'payto', 'pix', 'promptpay', 'satispay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" ] """ The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). @@ -109,7 +109,7 @@ class PaymentLinkUpdateParams(TypedDict): Literal["auto", "book", "donate", "pay", "subscribe"] ] """ - 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`). + 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://docs.stripe.com/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`). """ subscription_data: NotRequired["PaymentLinkUpdateParamsSubscriptionData"] """ @@ -148,7 +148,7 @@ class PaymentLinkUpdateParamsAfterCompletionHostedConfirmation(TypedDict): class PaymentLinkUpdateParamsAfterCompletionRedirect(TypedDict): url: str """ - The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-id) included. + The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-id) included. """ @@ -363,7 +363,7 @@ class PaymentLinkUpdateParamsInvoiceCreationInvoiceData(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ rendering_options: NotRequired[ "Literal['']|PaymentLinkUpdateParamsInvoiceCreationInvoiceDataRenderingOptions" @@ -482,7 +482,7 @@ class PaymentLinkUpdateParamsPaymentIntentData(TypedDict): """ metadata: NotRequired["Literal['']|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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values. """ statement_descriptor: NotRequired["Literal['']|str"] """ @@ -496,7 +496,7 @@ class PaymentLinkUpdateParamsPaymentIntentData(TypedDict): """ transfer_group: NotRequired["Literal['']|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. + A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. """ @@ -779,7 +779,7 @@ class PaymentLinkUpdateParamsSubscriptionData(TypedDict): """ metadata: NotRequired["Literal['']|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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values. """ trial_period_days: NotRequired["Literal['']|int"] """ diff --git a/stripe/params/_payment_method_attach_params.py b/stripe/params/_payment_method_attach_params.py index ea9ae2eb4..95dcf6bbb 100644 --- a/stripe/params/_payment_method_attach_params.py +++ b/stripe/params/_payment_method_attach_params.py @@ -6,10 +6,14 @@ class PaymentMethodAttachParams(RequestOptions): - customer: str + customer: NotRequired[str] """ The ID of the customer to which to attach the PaymentMethod. """ + customer_account: NotRequired[str] + """ + The ID of the Account representing the customer to which to attach the PaymentMethod. + """ expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. diff --git a/stripe/params/_payment_method_configuration_create_params.py b/stripe/params/_payment_method_configuration_create_params.py index af89a356b..cc7e3089b 100644 --- a/stripe/params/_payment_method_configuration_create_params.py +++ b/stripe/params/_payment_method_configuration_create_params.py @@ -8,21 +8,21 @@ class PaymentMethodConfigurationCreateParams(RequestOptions): acss_debit: NotRequired["PaymentMethodConfigurationCreateParamsAcssDebit"] """ - Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability. + Canadian pre-authorized debit payments, check this [page](https://docs.stripe.com/payments/acss-debit) for more details like country availability. """ affirm: NotRequired["PaymentMethodConfigurationCreateParamsAffirm"] """ - [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability. + [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://docs.stripe.com/payments/affirm) for more details like country availability. """ afterpay_clearpay: NotRequired[ "PaymentMethodConfigurationCreateParamsAfterpayClearpay" ] """ - Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. + Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://docs.stripe.com/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. """ alipay: NotRequired["PaymentMethodConfigurationCreateParamsAlipay"] """ - Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details. + Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://docs.stripe.com/payments/alipay) for more details. """ alma: NotRequired["PaymentMethodConfigurationCreateParamsAlma"] """ @@ -34,7 +34,7 @@ class PaymentMethodConfigurationCreateParams(RequestOptions): """ apple_pay: NotRequired["PaymentMethodConfigurationCreateParamsApplePay"] """ - Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. + Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://docs.stripe.com/apple-pay) for more details. """ apple_pay_later: NotRequired[ "PaymentMethodConfigurationCreateParamsApplePayLater" @@ -46,15 +46,15 @@ class PaymentMethodConfigurationCreateParams(RequestOptions): "PaymentMethodConfigurationCreateParamsAuBecsDebit" ] """ - Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details. + Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://docs.stripe.com/payments/au-becs-debit) for more details. """ bacs_debit: NotRequired["PaymentMethodConfigurationCreateParamsBacsDebit"] """ - Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details. + Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://docs.stripe.com/payments/payment-methods/bacs-debit) for more details. """ bancontact: NotRequired["PaymentMethodConfigurationCreateParamsBancontact"] """ - Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details. + Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://docs.stripe.com/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://docs.stripe.com/payments/bancontact) for more details. """ billie: NotRequired["PaymentMethodConfigurationCreateParamsBillie"] """ @@ -62,11 +62,11 @@ class PaymentMethodConfigurationCreateParams(RequestOptions): """ blik: NotRequired["PaymentMethodConfigurationCreateParamsBlik"] """ - BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details. + BLIK is a [single use](https://docs.stripe.com/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://docs.stripe.com/payments/blik) for more details. """ boleto: NotRequired["PaymentMethodConfigurationCreateParamsBoleto"] """ - Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details. + Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://docs.stripe.com/payments/boleto) for more details. """ card: NotRequired["PaymentMethodConfigurationCreateParamsCard"] """ @@ -76,25 +76,25 @@ class PaymentMethodConfigurationCreateParams(RequestOptions): "PaymentMethodConfigurationCreateParamsCartesBancaires" ] """ - Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details. + Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://docs.stripe.com/payments/cartes-bancaires) for more details. """ cashapp: NotRequired["PaymentMethodConfigurationCreateParamsCashapp"] """ - Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details. + Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://docs.stripe.com/payments/cash-app-pay) for more details. """ crypto: NotRequired["PaymentMethodConfigurationCreateParamsCrypto"] """ - [Stablecoin payments](https://stripe.com/docs/payments/stablecoin-payments) enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask. + [Stablecoin payments](https://docs.stripe.com/payments/stablecoin-payments) enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask. """ customer_balance: NotRequired[ "PaymentMethodConfigurationCreateParamsCustomerBalance" ] """ - Uses a customer's [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details. + Uses a customer's [cash balance](https://docs.stripe.com/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://docs.stripe.com/payments/bank-transfers) for more details. """ eps: NotRequired["PaymentMethodConfigurationCreateParamsEps"] """ - 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. + 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://docs.stripe.com/payments/eps) for more details. """ expand: NotRequired[List[str]] """ @@ -102,29 +102,29 @@ class PaymentMethodConfigurationCreateParams(RequestOptions): """ fpx: NotRequired["PaymentMethodConfigurationCreateParamsFpx"] """ - Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details. + Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://docs.stripe.com/payments/fpx) for more details. """ fr_meal_voucher_conecs: NotRequired[ "PaymentMethodConfigurationCreateParamsFrMealVoucherConecs" ] """ - Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://stripe.com/docs/payments/benefits/fr-meal-vouchers) for more details. + Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://docs.stripe.com/payments/benefits/fr-meal-vouchers) for more details. """ giropay: NotRequired["PaymentMethodConfigurationCreateParamsGiropay"] """ - giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details. + giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://docs.stripe.com/payments/giropay) for more details. """ google_pay: NotRequired["PaymentMethodConfigurationCreateParamsGooglePay"] """ - Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details. + Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://docs.stripe.com/google-pay) for more details. """ grabpay: NotRequired["PaymentMethodConfigurationCreateParamsGrabpay"] """ - GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details. + GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://docs.stripe.com/payments/grabpay) for more details. """ ideal: NotRequired["PaymentMethodConfigurationCreateParamsIdeal"] """ - iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details. + iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://docs.stripe.com/payments/ideal) for more details. """ jcb: NotRequired["PaymentMethodConfigurationCreateParamsJcb"] """ @@ -136,11 +136,11 @@ class PaymentMethodConfigurationCreateParams(RequestOptions): """ klarna: NotRequired["PaymentMethodConfigurationCreateParamsKlarna"] """ - Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. + Klarna gives customers a range of [payment options](https://docs.stripe.com/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://docs.stripe.com/payments/klarna) for more details. """ konbini: NotRequired["PaymentMethodConfigurationCreateParamsKonbini"] """ - Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. + Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://docs.stripe.com/payments/konbini) for more details. """ kr_card: NotRequired["PaymentMethodConfigurationCreateParamsKrCard"] """ @@ -148,15 +148,15 @@ class PaymentMethodConfigurationCreateParams(RequestOptions): """ link: NotRequired["PaymentMethodConfigurationCreateParamsLink"] """ - [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. + [Link](https://docs.stripe.com/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. """ mb_way: NotRequired["PaymentMethodConfigurationCreateParamsMbWay"] """ - MB WAY is the most popular wallet in Portugal. After entering their phone number in your checkout, customers approve the payment directly in their MB WAY app. Check this [page](https://stripe.com/docs/payments/mb-way) for more details. + MB WAY is the most popular wallet in Portugal. After entering their phone number in your checkout, customers approve the payment directly in their MB WAY app. Check this [page](https://docs.stripe.com/payments/mb-way) for more details. """ mobilepay: NotRequired["PaymentMethodConfigurationCreateParamsMobilepay"] """ - MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details. + MobilePay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://docs.stripe.com/payments/mobilepay) for more details. """ multibanco: NotRequired["PaymentMethodConfigurationCreateParamsMultibanco"] """ @@ -174,15 +174,15 @@ class PaymentMethodConfigurationCreateParams(RequestOptions): "PaymentMethodConfigurationCreateParamsNzBankAccount" ] """ - Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details. + Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://docs.stripe.com/payments/nz-bank-account) for more details. """ oxxo: NotRequired["PaymentMethodConfigurationCreateParamsOxxo"] """ - OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details. + OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://docs.stripe.com/payments/oxxo) for more details. """ p24: NotRequired["PaymentMethodConfigurationCreateParamsP24"] """ - 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. + 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://docs.stripe.com/payments/p24) for more details. """ parent: NotRequired[str] """ @@ -198,11 +198,15 @@ class PaymentMethodConfigurationCreateParams(RequestOptions): """ paynow: NotRequired["PaymentMethodConfigurationCreateParamsPaynow"] """ - PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. + PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://docs.stripe.com/payments/paynow) for more details. """ paypal: NotRequired["PaymentMethodConfigurationCreateParamsPaypal"] """ - PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details. + PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://docs.stripe.com/payments/paypal) for more details. + """ + payto: NotRequired["PaymentMethodConfigurationCreateParamsPayto"] + """ + PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details. """ pix: NotRequired["PaymentMethodConfigurationCreateParamsPix"] """ @@ -210,7 +214,7 @@ class PaymentMethodConfigurationCreateParams(RequestOptions): """ promptpay: NotRequired["PaymentMethodConfigurationCreateParamsPromptpay"] """ - PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details. + PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://docs.stripe.com/payments/promptpay) for more details. """ revolut_pay: NotRequired[ "PaymentMethodConfigurationCreateParamsRevolutPay" @@ -230,15 +234,15 @@ class PaymentMethodConfigurationCreateParams(RequestOptions): """ sepa_debit: NotRequired["PaymentMethodConfigurationCreateParamsSepaDebit"] """ - The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details. + The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://docs.stripe.com/payments/sepa-debit) for more details. """ sofort: NotRequired["PaymentMethodConfigurationCreateParamsSofort"] """ - Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details. + Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://docs.stripe.com/payments/sofort) for more details. """ swish: NotRequired["PaymentMethodConfigurationCreateParamsSwish"] """ - Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details. + Swish is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://docs.stripe.com/payments/swish) for more details. """ twint: NotRequired["PaymentMethodConfigurationCreateParamsTwint"] """ @@ -248,15 +252,15 @@ class PaymentMethodConfigurationCreateParams(RequestOptions): "PaymentMethodConfigurationCreateParamsUsBankAccount" ] """ - Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-direct-debit) for more details. + Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://docs.stripe.com/payments/ach-direct-debit) for more details. """ wechat_pay: NotRequired["PaymentMethodConfigurationCreateParamsWechatPay"] """ - WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details. + WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://docs.stripe.com/payments/wechat-pay) for more details. """ zip: NotRequired["PaymentMethodConfigurationCreateParamsZip"] """ - Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability. + Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://docs.stripe.com/payments/zip) for more details like country availability. """ @@ -992,6 +996,22 @@ class PaymentMethodConfigurationCreateParamsPaypalDisplayPreference(TypedDict): """ +class PaymentMethodConfigurationCreateParamsPayto(TypedDict): + display_preference: NotRequired[ + "PaymentMethodConfigurationCreateParamsPaytoDisplayPreference" + ] + """ + Whether or not the payment method should be displayed. + """ + + +class PaymentMethodConfigurationCreateParamsPaytoDisplayPreference(TypedDict): + preference: NotRequired[Literal["none", "off", "on"]] + """ + The account's preference for whether or not to display this payment method. + """ + + class PaymentMethodConfigurationCreateParamsPix(TypedDict): display_preference: NotRequired[ "PaymentMethodConfigurationCreateParamsPixDisplayPreference" diff --git a/stripe/params/_payment_method_configuration_modify_params.py b/stripe/params/_payment_method_configuration_modify_params.py index 64ef4051f..75633a65e 100644 --- a/stripe/params/_payment_method_configuration_modify_params.py +++ b/stripe/params/_payment_method_configuration_modify_params.py @@ -8,7 +8,7 @@ class PaymentMethodConfigurationModifyParams(RequestOptions): acss_debit: NotRequired["PaymentMethodConfigurationModifyParamsAcssDebit"] """ - Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability. + Canadian pre-authorized debit payments, check this [page](https://docs.stripe.com/payments/acss-debit) for more details like country availability. """ active: NotRequired[bool] """ @@ -16,17 +16,17 @@ class PaymentMethodConfigurationModifyParams(RequestOptions): """ affirm: NotRequired["PaymentMethodConfigurationModifyParamsAffirm"] """ - [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability. + [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://docs.stripe.com/payments/affirm) for more details like country availability. """ afterpay_clearpay: NotRequired[ "PaymentMethodConfigurationModifyParamsAfterpayClearpay" ] """ - Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. + Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://docs.stripe.com/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. """ alipay: NotRequired["PaymentMethodConfigurationModifyParamsAlipay"] """ - Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details. + Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://docs.stripe.com/payments/alipay) for more details. """ alma: NotRequired["PaymentMethodConfigurationModifyParamsAlma"] """ @@ -38,7 +38,7 @@ class PaymentMethodConfigurationModifyParams(RequestOptions): """ apple_pay: NotRequired["PaymentMethodConfigurationModifyParamsApplePay"] """ - Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. + Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://docs.stripe.com/apple-pay) for more details. """ apple_pay_later: NotRequired[ "PaymentMethodConfigurationModifyParamsApplePayLater" @@ -50,15 +50,15 @@ class PaymentMethodConfigurationModifyParams(RequestOptions): "PaymentMethodConfigurationModifyParamsAuBecsDebit" ] """ - Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details. + Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://docs.stripe.com/payments/au-becs-debit) for more details. """ bacs_debit: NotRequired["PaymentMethodConfigurationModifyParamsBacsDebit"] """ - Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details. + Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://docs.stripe.com/payments/payment-methods/bacs-debit) for more details. """ bancontact: NotRequired["PaymentMethodConfigurationModifyParamsBancontact"] """ - Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details. + Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://docs.stripe.com/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://docs.stripe.com/payments/bancontact) for more details. """ billie: NotRequired["PaymentMethodConfigurationModifyParamsBillie"] """ @@ -66,11 +66,11 @@ class PaymentMethodConfigurationModifyParams(RequestOptions): """ blik: NotRequired["PaymentMethodConfigurationModifyParamsBlik"] """ - BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details. + BLIK is a [single use](https://docs.stripe.com/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://docs.stripe.com/payments/blik) for more details. """ boleto: NotRequired["PaymentMethodConfigurationModifyParamsBoleto"] """ - Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details. + Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://docs.stripe.com/payments/boleto) for more details. """ card: NotRequired["PaymentMethodConfigurationModifyParamsCard"] """ @@ -80,25 +80,25 @@ class PaymentMethodConfigurationModifyParams(RequestOptions): "PaymentMethodConfigurationModifyParamsCartesBancaires" ] """ - Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details. + Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://docs.stripe.com/payments/cartes-bancaires) for more details. """ cashapp: NotRequired["PaymentMethodConfigurationModifyParamsCashapp"] """ - Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details. + Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://docs.stripe.com/payments/cash-app-pay) for more details. """ crypto: NotRequired["PaymentMethodConfigurationModifyParamsCrypto"] """ - [Stablecoin payments](https://stripe.com/docs/payments/stablecoin-payments) enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask. + [Stablecoin payments](https://docs.stripe.com/payments/stablecoin-payments) enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask. """ customer_balance: NotRequired[ "PaymentMethodConfigurationModifyParamsCustomerBalance" ] """ - Uses a customer's [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details. + Uses a customer's [cash balance](https://docs.stripe.com/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://docs.stripe.com/payments/bank-transfers) for more details. """ eps: NotRequired["PaymentMethodConfigurationModifyParamsEps"] """ - 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. + 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://docs.stripe.com/payments/eps) for more details. """ expand: NotRequired[List[str]] """ @@ -106,29 +106,29 @@ class PaymentMethodConfigurationModifyParams(RequestOptions): """ fpx: NotRequired["PaymentMethodConfigurationModifyParamsFpx"] """ - Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details. + Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://docs.stripe.com/payments/fpx) for more details. """ fr_meal_voucher_conecs: NotRequired[ "PaymentMethodConfigurationModifyParamsFrMealVoucherConecs" ] """ - Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://stripe.com/docs/payments/benefits/fr-meal-vouchers) for more details. + Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://docs.stripe.com/payments/benefits/fr-meal-vouchers) for more details. """ giropay: NotRequired["PaymentMethodConfigurationModifyParamsGiropay"] """ - giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details. + giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://docs.stripe.com/payments/giropay) for more details. """ google_pay: NotRequired["PaymentMethodConfigurationModifyParamsGooglePay"] """ - Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details. + Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://docs.stripe.com/google-pay) for more details. """ grabpay: NotRequired["PaymentMethodConfigurationModifyParamsGrabpay"] """ - GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details. + GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://docs.stripe.com/payments/grabpay) for more details. """ ideal: NotRequired["PaymentMethodConfigurationModifyParamsIdeal"] """ - iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details. + iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://docs.stripe.com/payments/ideal) for more details. """ jcb: NotRequired["PaymentMethodConfigurationModifyParamsJcb"] """ @@ -140,11 +140,11 @@ class PaymentMethodConfigurationModifyParams(RequestOptions): """ klarna: NotRequired["PaymentMethodConfigurationModifyParamsKlarna"] """ - Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. + Klarna gives customers a range of [payment options](https://docs.stripe.com/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://docs.stripe.com/payments/klarna) for more details. """ konbini: NotRequired["PaymentMethodConfigurationModifyParamsKonbini"] """ - Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. + Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://docs.stripe.com/payments/konbini) for more details. """ kr_card: NotRequired["PaymentMethodConfigurationModifyParamsKrCard"] """ @@ -152,15 +152,15 @@ class PaymentMethodConfigurationModifyParams(RequestOptions): """ link: NotRequired["PaymentMethodConfigurationModifyParamsLink"] """ - [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. + [Link](https://docs.stripe.com/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. """ mb_way: NotRequired["PaymentMethodConfigurationModifyParamsMbWay"] """ - MB WAY is the most popular wallet in Portugal. After entering their phone number in your checkout, customers approve the payment directly in their MB WAY app. Check this [page](https://stripe.com/docs/payments/mb-way) for more details. + MB WAY is the most popular wallet in Portugal. After entering their phone number in your checkout, customers approve the payment directly in their MB WAY app. Check this [page](https://docs.stripe.com/payments/mb-way) for more details. """ mobilepay: NotRequired["PaymentMethodConfigurationModifyParamsMobilepay"] """ - MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details. + MobilePay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://docs.stripe.com/payments/mobilepay) for more details. """ multibanco: NotRequired["PaymentMethodConfigurationModifyParamsMultibanco"] """ @@ -178,15 +178,15 @@ class PaymentMethodConfigurationModifyParams(RequestOptions): "PaymentMethodConfigurationModifyParamsNzBankAccount" ] """ - Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details. + Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://docs.stripe.com/payments/nz-bank-account) for more details. """ oxxo: NotRequired["PaymentMethodConfigurationModifyParamsOxxo"] """ - OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details. + OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://docs.stripe.com/payments/oxxo) for more details. """ p24: NotRequired["PaymentMethodConfigurationModifyParamsP24"] """ - 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. + 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://docs.stripe.com/payments/p24) for more details. """ pay_by_bank: NotRequired["PaymentMethodConfigurationModifyParamsPayByBank"] """ @@ -198,11 +198,15 @@ class PaymentMethodConfigurationModifyParams(RequestOptions): """ paynow: NotRequired["PaymentMethodConfigurationModifyParamsPaynow"] """ - PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. + PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://docs.stripe.com/payments/paynow) for more details. """ paypal: NotRequired["PaymentMethodConfigurationModifyParamsPaypal"] """ - PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details. + PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://docs.stripe.com/payments/paypal) for more details. + """ + payto: NotRequired["PaymentMethodConfigurationModifyParamsPayto"] + """ + PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details. """ pix: NotRequired["PaymentMethodConfigurationModifyParamsPix"] """ @@ -210,7 +214,7 @@ class PaymentMethodConfigurationModifyParams(RequestOptions): """ promptpay: NotRequired["PaymentMethodConfigurationModifyParamsPromptpay"] """ - PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details. + PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://docs.stripe.com/payments/promptpay) for more details. """ revolut_pay: NotRequired[ "PaymentMethodConfigurationModifyParamsRevolutPay" @@ -230,15 +234,15 @@ class PaymentMethodConfigurationModifyParams(RequestOptions): """ sepa_debit: NotRequired["PaymentMethodConfigurationModifyParamsSepaDebit"] """ - The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details. + The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://docs.stripe.com/payments/sepa-debit) for more details. """ sofort: NotRequired["PaymentMethodConfigurationModifyParamsSofort"] """ - Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details. + Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://docs.stripe.com/payments/sofort) for more details. """ swish: NotRequired["PaymentMethodConfigurationModifyParamsSwish"] """ - Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details. + Swish is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://docs.stripe.com/payments/swish) for more details. """ twint: NotRequired["PaymentMethodConfigurationModifyParamsTwint"] """ @@ -248,15 +252,15 @@ class PaymentMethodConfigurationModifyParams(RequestOptions): "PaymentMethodConfigurationModifyParamsUsBankAccount" ] """ - Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-direct-debit) for more details. + Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://docs.stripe.com/payments/ach-direct-debit) for more details. """ wechat_pay: NotRequired["PaymentMethodConfigurationModifyParamsWechatPay"] """ - WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details. + WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://docs.stripe.com/payments/wechat-pay) for more details. """ zip: NotRequired["PaymentMethodConfigurationModifyParamsZip"] """ - Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability. + Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://docs.stripe.com/payments/zip) for more details like country availability. """ @@ -992,6 +996,22 @@ class PaymentMethodConfigurationModifyParamsPaypalDisplayPreference(TypedDict): """ +class PaymentMethodConfigurationModifyParamsPayto(TypedDict): + display_preference: NotRequired[ + "PaymentMethodConfigurationModifyParamsPaytoDisplayPreference" + ] + """ + Whether or not the payment method should be displayed. + """ + + +class PaymentMethodConfigurationModifyParamsPaytoDisplayPreference(TypedDict): + preference: NotRequired[Literal["none", "off", "on"]] + """ + The account's preference for whether or not to display this payment method. + """ + + class PaymentMethodConfigurationModifyParamsPix(TypedDict): display_preference: NotRequired[ "PaymentMethodConfigurationModifyParamsPixDisplayPreference" diff --git a/stripe/params/_payment_method_configuration_update_params.py b/stripe/params/_payment_method_configuration_update_params.py index 6a4a41c84..bd66aa964 100644 --- a/stripe/params/_payment_method_configuration_update_params.py +++ b/stripe/params/_payment_method_configuration_update_params.py @@ -7,7 +7,7 @@ class PaymentMethodConfigurationUpdateParams(TypedDict): acss_debit: NotRequired["PaymentMethodConfigurationUpdateParamsAcssDebit"] """ - Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability. + Canadian pre-authorized debit payments, check this [page](https://docs.stripe.com/payments/acss-debit) for more details like country availability. """ active: NotRequired[bool] """ @@ -15,17 +15,17 @@ class PaymentMethodConfigurationUpdateParams(TypedDict): """ affirm: NotRequired["PaymentMethodConfigurationUpdateParamsAffirm"] """ - [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability. + [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://docs.stripe.com/payments/affirm) for more details like country availability. """ afterpay_clearpay: NotRequired[ "PaymentMethodConfigurationUpdateParamsAfterpayClearpay" ] """ - Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. + Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://docs.stripe.com/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. """ alipay: NotRequired["PaymentMethodConfigurationUpdateParamsAlipay"] """ - Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details. + Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://docs.stripe.com/payments/alipay) for more details. """ alma: NotRequired["PaymentMethodConfigurationUpdateParamsAlma"] """ @@ -37,7 +37,7 @@ class PaymentMethodConfigurationUpdateParams(TypedDict): """ apple_pay: NotRequired["PaymentMethodConfigurationUpdateParamsApplePay"] """ - Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. + Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://docs.stripe.com/apple-pay) for more details. """ apple_pay_later: NotRequired[ "PaymentMethodConfigurationUpdateParamsApplePayLater" @@ -49,15 +49,15 @@ class PaymentMethodConfigurationUpdateParams(TypedDict): "PaymentMethodConfigurationUpdateParamsAuBecsDebit" ] """ - Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details. + Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://docs.stripe.com/payments/au-becs-debit) for more details. """ bacs_debit: NotRequired["PaymentMethodConfigurationUpdateParamsBacsDebit"] """ - Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details. + Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://docs.stripe.com/payments/payment-methods/bacs-debit) for more details. """ bancontact: NotRequired["PaymentMethodConfigurationUpdateParamsBancontact"] """ - Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details. + Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://docs.stripe.com/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://docs.stripe.com/payments/bancontact) for more details. """ billie: NotRequired["PaymentMethodConfigurationUpdateParamsBillie"] """ @@ -65,11 +65,11 @@ class PaymentMethodConfigurationUpdateParams(TypedDict): """ blik: NotRequired["PaymentMethodConfigurationUpdateParamsBlik"] """ - BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details. + BLIK is a [single use](https://docs.stripe.com/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://docs.stripe.com/payments/blik) for more details. """ boleto: NotRequired["PaymentMethodConfigurationUpdateParamsBoleto"] """ - Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details. + Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://docs.stripe.com/payments/boleto) for more details. """ card: NotRequired["PaymentMethodConfigurationUpdateParamsCard"] """ @@ -79,25 +79,25 @@ class PaymentMethodConfigurationUpdateParams(TypedDict): "PaymentMethodConfigurationUpdateParamsCartesBancaires" ] """ - Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details. + Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://docs.stripe.com/payments/cartes-bancaires) for more details. """ cashapp: NotRequired["PaymentMethodConfigurationUpdateParamsCashapp"] """ - Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details. + Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://docs.stripe.com/payments/cash-app-pay) for more details. """ crypto: NotRequired["PaymentMethodConfigurationUpdateParamsCrypto"] """ - [Stablecoin payments](https://stripe.com/docs/payments/stablecoin-payments) enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask. + [Stablecoin payments](https://docs.stripe.com/payments/stablecoin-payments) enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask. """ customer_balance: NotRequired[ "PaymentMethodConfigurationUpdateParamsCustomerBalance" ] """ - Uses a customer's [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details. + Uses a customer's [cash balance](https://docs.stripe.com/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://docs.stripe.com/payments/bank-transfers) for more details. """ eps: NotRequired["PaymentMethodConfigurationUpdateParamsEps"] """ - 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. + 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://docs.stripe.com/payments/eps) for more details. """ expand: NotRequired[List[str]] """ @@ -105,29 +105,29 @@ class PaymentMethodConfigurationUpdateParams(TypedDict): """ fpx: NotRequired["PaymentMethodConfigurationUpdateParamsFpx"] """ - Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details. + Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://docs.stripe.com/payments/fpx) for more details. """ fr_meal_voucher_conecs: NotRequired[ "PaymentMethodConfigurationUpdateParamsFrMealVoucherConecs" ] """ - Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://stripe.com/docs/payments/benefits/fr-meal-vouchers) for more details. + Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://docs.stripe.com/payments/benefits/fr-meal-vouchers) for more details. """ giropay: NotRequired["PaymentMethodConfigurationUpdateParamsGiropay"] """ - giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details. + giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://docs.stripe.com/payments/giropay) for more details. """ google_pay: NotRequired["PaymentMethodConfigurationUpdateParamsGooglePay"] """ - Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details. + Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://docs.stripe.com/google-pay) for more details. """ grabpay: NotRequired["PaymentMethodConfigurationUpdateParamsGrabpay"] """ - GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details. + GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://docs.stripe.com/payments/grabpay) for more details. """ ideal: NotRequired["PaymentMethodConfigurationUpdateParamsIdeal"] """ - iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details. + iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://docs.stripe.com/payments/ideal) for more details. """ jcb: NotRequired["PaymentMethodConfigurationUpdateParamsJcb"] """ @@ -139,11 +139,11 @@ class PaymentMethodConfigurationUpdateParams(TypedDict): """ klarna: NotRequired["PaymentMethodConfigurationUpdateParamsKlarna"] """ - Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. + Klarna gives customers a range of [payment options](https://docs.stripe.com/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://docs.stripe.com/payments/klarna) for more details. """ konbini: NotRequired["PaymentMethodConfigurationUpdateParamsKonbini"] """ - Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. + Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://docs.stripe.com/payments/konbini) for more details. """ kr_card: NotRequired["PaymentMethodConfigurationUpdateParamsKrCard"] """ @@ -151,15 +151,15 @@ class PaymentMethodConfigurationUpdateParams(TypedDict): """ link: NotRequired["PaymentMethodConfigurationUpdateParamsLink"] """ - [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. + [Link](https://docs.stripe.com/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. """ mb_way: NotRequired["PaymentMethodConfigurationUpdateParamsMbWay"] """ - MB WAY is the most popular wallet in Portugal. After entering their phone number in your checkout, customers approve the payment directly in their MB WAY app. Check this [page](https://stripe.com/docs/payments/mb-way) for more details. + MB WAY is the most popular wallet in Portugal. After entering their phone number in your checkout, customers approve the payment directly in their MB WAY app. Check this [page](https://docs.stripe.com/payments/mb-way) for more details. """ mobilepay: NotRequired["PaymentMethodConfigurationUpdateParamsMobilepay"] """ - MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details. + MobilePay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://docs.stripe.com/payments/mobilepay) for more details. """ multibanco: NotRequired["PaymentMethodConfigurationUpdateParamsMultibanco"] """ @@ -177,15 +177,15 @@ class PaymentMethodConfigurationUpdateParams(TypedDict): "PaymentMethodConfigurationUpdateParamsNzBankAccount" ] """ - Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details. + Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://docs.stripe.com/payments/nz-bank-account) for more details. """ oxxo: NotRequired["PaymentMethodConfigurationUpdateParamsOxxo"] """ - OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details. + OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://docs.stripe.com/payments/oxxo) for more details. """ p24: NotRequired["PaymentMethodConfigurationUpdateParamsP24"] """ - 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. + 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://docs.stripe.com/payments/p24) for more details. """ pay_by_bank: NotRequired["PaymentMethodConfigurationUpdateParamsPayByBank"] """ @@ -197,11 +197,15 @@ class PaymentMethodConfigurationUpdateParams(TypedDict): """ paynow: NotRequired["PaymentMethodConfigurationUpdateParamsPaynow"] """ - PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. + PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://docs.stripe.com/payments/paynow) for more details. """ paypal: NotRequired["PaymentMethodConfigurationUpdateParamsPaypal"] """ - PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details. + PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://docs.stripe.com/payments/paypal) for more details. + """ + payto: NotRequired["PaymentMethodConfigurationUpdateParamsPayto"] + """ + PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details. """ pix: NotRequired["PaymentMethodConfigurationUpdateParamsPix"] """ @@ -209,7 +213,7 @@ class PaymentMethodConfigurationUpdateParams(TypedDict): """ promptpay: NotRequired["PaymentMethodConfigurationUpdateParamsPromptpay"] """ - PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details. + PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://docs.stripe.com/payments/promptpay) for more details. """ revolut_pay: NotRequired[ "PaymentMethodConfigurationUpdateParamsRevolutPay" @@ -229,15 +233,15 @@ class PaymentMethodConfigurationUpdateParams(TypedDict): """ sepa_debit: NotRequired["PaymentMethodConfigurationUpdateParamsSepaDebit"] """ - The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details. + The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://docs.stripe.com/payments/sepa-debit) for more details. """ sofort: NotRequired["PaymentMethodConfigurationUpdateParamsSofort"] """ - Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details. + Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://docs.stripe.com/payments/sofort) for more details. """ swish: NotRequired["PaymentMethodConfigurationUpdateParamsSwish"] """ - Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details. + Swish is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://docs.stripe.com/payments/swish) for more details. """ twint: NotRequired["PaymentMethodConfigurationUpdateParamsTwint"] """ @@ -247,15 +251,15 @@ class PaymentMethodConfigurationUpdateParams(TypedDict): "PaymentMethodConfigurationUpdateParamsUsBankAccount" ] """ - Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-direct-debit) for more details. + Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://docs.stripe.com/payments/ach-direct-debit) for more details. """ wechat_pay: NotRequired["PaymentMethodConfigurationUpdateParamsWechatPay"] """ - WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details. + WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://docs.stripe.com/payments/wechat-pay) for more details. """ zip: NotRequired["PaymentMethodConfigurationUpdateParamsZip"] """ - Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability. + Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://docs.stripe.com/payments/zip) for more details like country availability. """ @@ -991,6 +995,22 @@ class PaymentMethodConfigurationUpdateParamsPaypalDisplayPreference(TypedDict): """ +class PaymentMethodConfigurationUpdateParamsPayto(TypedDict): + display_preference: NotRequired[ + "PaymentMethodConfigurationUpdateParamsPaytoDisplayPreference" + ] + """ + Whether or not the payment method should be displayed. + """ + + +class PaymentMethodConfigurationUpdateParamsPaytoDisplayPreference(TypedDict): + preference: NotRequired[Literal["none", "off", "on"]] + """ + The account's preference for whether or not to display this payment method. + """ + + class PaymentMethodConfigurationUpdateParamsPix(TypedDict): display_preference: NotRequired[ "PaymentMethodConfigurationUpdateParamsPixDisplayPreference" diff --git a/stripe/params/_payment_method_create_params.py b/stripe/params/_payment_method_create_params.py index 775472253..925422485 100644 --- a/stripe/params/_payment_method_create_params.py +++ b/stripe/params/_payment_method_create_params.py @@ -140,7 +140,7 @@ class PaymentMethodCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ mobilepay: NotRequired["PaymentMethodCreateParamsMobilepay"] """ @@ -186,6 +186,10 @@ class PaymentMethodCreateParams(RequestOptions): """ If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. """ + payto: NotRequired["PaymentMethodCreateParamsPayto"] + """ + If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. + """ pix: NotRequired["PaymentMethodCreateParamsPix"] """ If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. @@ -196,7 +200,7 @@ class PaymentMethodCreateParams(RequestOptions): """ radar_options: NotRequired["PaymentMethodCreateParamsRadarOptions"] """ - Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. """ revolut_pay: NotRequired["PaymentMethodCreateParamsRevolutPay"] """ @@ -266,6 +270,7 @@ class PaymentMethodCreateParams(RequestOptions): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -410,7 +415,7 @@ class PaymentMethodCreateParamsBillingDetailsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -569,6 +574,7 @@ class PaymentMethodCreateParamsIdeal(TypedDict): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -727,6 +733,21 @@ class PaymentMethodCreateParamsPaypal(TypedDict): pass +class PaymentMethodCreateParamsPayto(TypedDict): + account_number: NotRequired[str] + """ + The account number for the bank account. + """ + bsb_number: NotRequired[str] + """ + Bank-State-Branch number of the bank account. + """ + pay_id: NotRequired[str] + """ + The PayID alias for the bank account. + """ + + class PaymentMethodCreateParamsPix(TypedDict): pass @@ -738,7 +759,7 @@ class PaymentMethodCreateParamsPromptpay(TypedDict): class PaymentMethodCreateParamsRadarOptions(TypedDict): 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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ diff --git a/stripe/params/_payment_method_list_params.py b/stripe/params/_payment_method_list_params.py index e5f023c35..a7e69d1f3 100644 --- a/stripe/params/_payment_method_list_params.py +++ b/stripe/params/_payment_method_list_params.py @@ -6,10 +6,18 @@ class PaymentMethodListParams(RequestOptions): + allow_redisplay: NotRequired[Literal["always", "limited", "unspecified"]] + """ + This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. + """ customer: NotRequired[str] """ The ID of the customer whose PaymentMethods will be retrieved. """ + customer_account: NotRequired[str] + """ + The ID of the Account whose PaymentMethods will be retrieved. + """ 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. @@ -66,6 +74,7 @@ class PaymentMethodListParams(RequestOptions): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", diff --git a/stripe/params/_payment_method_modify_params.py b/stripe/params/_payment_method_modify_params.py index b1132da37..c0424e71f 100644 --- a/stripe/params/_payment_method_modify_params.py +++ b/stripe/params/_payment_method_modify_params.py @@ -24,7 +24,11 @@ class PaymentMethodModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + """ + payto: NotRequired["PaymentMethodModifyParamsPayto"] + """ + If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. """ us_bank_account: NotRequired["PaymentMethodModifyParamsUsBankAccount"] """ @@ -80,7 +84,7 @@ class PaymentMethodModifyParamsBillingDetailsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -108,6 +112,21 @@ class PaymentMethodModifyParamsCardNetworks(TypedDict): """ +class PaymentMethodModifyParamsPayto(TypedDict): + account_number: NotRequired[str] + """ + The account number for the bank account. + """ + bsb_number: NotRequired[str] + """ + Bank-State-Branch number of the bank account. + """ + pay_id: NotRequired[str] + """ + The PayID alias for the bank account. + """ + + class PaymentMethodModifyParamsUsBankAccount(TypedDict): account_holder_type: NotRequired[Literal["company", "individual"]] """ diff --git a/stripe/params/_payment_method_update_params.py b/stripe/params/_payment_method_update_params.py index 1c73b4027..b32ed0f0e 100644 --- a/stripe/params/_payment_method_update_params.py +++ b/stripe/params/_payment_method_update_params.py @@ -23,7 +23,11 @@ class PaymentMethodUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + """ + payto: NotRequired["PaymentMethodUpdateParamsPayto"] + """ + If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. """ us_bank_account: NotRequired["PaymentMethodUpdateParamsUsBankAccount"] """ @@ -79,7 +83,7 @@ class PaymentMethodUpdateParamsBillingDetailsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -107,6 +111,21 @@ class PaymentMethodUpdateParamsCardNetworks(TypedDict): """ +class PaymentMethodUpdateParamsPayto(TypedDict): + account_number: NotRequired[str] + """ + The account number for the bank account. + """ + bsb_number: NotRequired[str] + """ + Bank-State-Branch number of the bank account. + """ + pay_id: NotRequired[str] + """ + The PayID alias for the bank account. + """ + + class PaymentMethodUpdateParamsUsBankAccount(TypedDict): account_holder_type: NotRequired[Literal["company", "individual"]] """ diff --git a/stripe/params/_payment_record_report_payment_attempt_informational_params.py b/stripe/params/_payment_record_report_payment_attempt_informational_params.py index 462f2e145..8af88e076 100644 --- a/stripe/params/_payment_record_report_payment_attempt_informational_params.py +++ b/stripe/params/_payment_record_report_payment_attempt_informational_params.py @@ -22,7 +22,7 @@ class PaymentRecordReportPaymentAttemptInformationalParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ shipping_details: NotRequired[ "Literal['']|PaymentRecordReportPaymentAttemptInformationalParamsShippingDetails" @@ -97,5 +97,5 @@ class PaymentRecordReportPaymentAttemptInformationalParamsShippingDetailsAddress """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_payment_record_report_payment_attempt_params.py b/stripe/params/_payment_record_report_payment_attempt_params.py index e4eca9b5c..41f456230 100644 --- a/stripe/params/_payment_record_report_payment_attempt_params.py +++ b/stripe/params/_payment_record_report_payment_attempt_params.py @@ -30,7 +30,7 @@ class PaymentRecordReportPaymentAttemptParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ outcome: NotRequired[Literal["failed", "guaranteed"]] """ @@ -135,7 +135,7 @@ class PaymentRecordReportPaymentAttemptParamsPaymentMethodDetailsBillingDetailsA """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -192,5 +192,5 @@ class PaymentRecordReportPaymentAttemptParamsShippingDetailsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_payment_record_report_payment_params.py b/stripe/params/_payment_record_report_payment_params.py index bccfe8745..1ccea295e 100644 --- a/stripe/params/_payment_record_report_payment_params.py +++ b/stripe/params/_payment_record_report_payment_params.py @@ -42,7 +42,7 @@ class PaymentRecordReportPaymentParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ outcome: NotRequired[Literal["failed", "guaranteed"]] """ @@ -75,7 +75,7 @@ class PaymentRecordReportPaymentParamsAmountRequested(TypedDict): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ @@ -183,7 +183,7 @@ class PaymentRecordReportPaymentParamsPaymentMethodDetailsBillingDetailsAddress( """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -258,5 +258,5 @@ class PaymentRecordReportPaymentParamsShippingDetailsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_payment_record_report_refund_params.py b/stripe/params/_payment_record_report_refund_params.py index f79bf5bb3..e7756f0e6 100644 --- a/stripe/params/_payment_record_report_refund_params.py +++ b/stripe/params/_payment_record_report_refund_params.py @@ -8,7 +8,7 @@ class PaymentRecordReportRefundParams(RequestOptions): amount: NotRequired["PaymentRecordReportRefundParamsAmount"] """ - A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing how much of this payment to refund. Can refund only up to the remaining, unrefunded amount of the payment. + A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) representing how much of this payment to refund. Can refund only up to the remaining, unrefunded amount of the payment. """ expand: NotRequired[List[str]] """ @@ -20,7 +20,7 @@ class PaymentRecordReportRefundParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ outcome: Literal["refunded"] """ @@ -43,7 +43,7 @@ class PaymentRecordReportRefundParamsAmount(TypedDict): """ value: int """ - A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. + A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. """ diff --git a/stripe/params/_payout_create_params.py b/stripe/params/_payout_create_params.py index 9df088fda..3611f6284 100644 --- a/stripe/params/_payout_create_params.py +++ b/stripe/params/_payout_create_params.py @@ -28,7 +28,7 @@ class PayoutCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ method: NotRequired[Literal["instant", "standard"]] """ diff --git a/stripe/params/_payout_modify_params.py b/stripe/params/_payout_modify_params.py index 732d10bd7..aed1d9d76 100644 --- a/stripe/params/_payout_modify_params.py +++ b/stripe/params/_payout_modify_params.py @@ -12,5 +12,5 @@ class PayoutModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_payout_reverse_params.py b/stripe/params/_payout_reverse_params.py index 2e95e113a..ddb78fe21 100644 --- a/stripe/params/_payout_reverse_params.py +++ b/stripe/params/_payout_reverse_params.py @@ -12,5 +12,5 @@ class PayoutReverseParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_payout_update_params.py b/stripe/params/_payout_update_params.py index 04a99d7da..7c494f28a 100644 --- a/stripe/params/_payout_update_params.py +++ b/stripe/params/_payout_update_params.py @@ -11,5 +11,5 @@ class PayoutUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_plan_create_params.py b/stripe/params/_plan_create_params.py index 43c20a246..d3cdabcdf 100644 --- a/stripe/params/_plan_create_params.py +++ b/stripe/params/_plan_create_params.py @@ -44,7 +44,7 @@ class PlanCreateParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ meter: NotRequired[str] """ @@ -69,7 +69,7 @@ class PlanCreateParams(RequestOptions): """ 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). + Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan). """ usage_type: NotRequired[Literal["licensed", "metered"]] """ @@ -88,7 +88,7 @@ class PlanCreateParamsProduct(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: str """ @@ -102,7 +102,7 @@ class PlanCreateParamsProduct(TypedDict): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ unit_label: NotRequired[str] """ diff --git a/stripe/params/_plan_modify_params.py b/stripe/params/_plan_modify_params.py index c9efc214b..c491c4195 100644 --- a/stripe/params/_plan_modify_params.py +++ b/stripe/params/_plan_modify_params.py @@ -16,7 +16,7 @@ class PlanModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ nickname: NotRequired[str] """ @@ -28,5 +28,5 @@ class PlanModifyParams(RequestOptions): """ 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). + Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan). """ diff --git a/stripe/params/_plan_update_params.py b/stripe/params/_plan_update_params.py index 7c2ef5cf2..09ac77c26 100644 --- a/stripe/params/_plan_update_params.py +++ b/stripe/params/_plan_update_params.py @@ -15,7 +15,7 @@ class PlanUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ nickname: NotRequired[str] """ @@ -27,5 +27,5 @@ class PlanUpdateParams(TypedDict): """ 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). + Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan). """ diff --git a/stripe/params/_price_create_params.py b/stripe/params/_price_create_params.py index decaa2d7e..b584425ca 100644 --- a/stripe/params/_price_create_params.py +++ b/stripe/params/_price_create_params.py @@ -38,7 +38,7 @@ class PriceCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ nickname: NotRequired[str] """ @@ -58,7 +58,7 @@ class PriceCreateParams(RequestOptions): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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["PriceCreateParamsTier"]] """ @@ -95,7 +95,7 @@ class PriceCreateParamsCurrencyOptions(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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["PriceCreateParamsCurrencyOptionsTier"]] """ @@ -183,7 +183,7 @@ class PriceCreateParamsProductData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: str """ @@ -197,7 +197,7 @@ class PriceCreateParamsProductData(TypedDict): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ unit_label: NotRequired[str] """ @@ -220,7 +220,7 @@ class PriceCreateParamsRecurring(TypedDict): """ 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). + Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan). """ usage_type: NotRequired[Literal["licensed", "metered"]] """ diff --git a/stripe/params/_price_modify_params.py b/stripe/params/_price_modify_params.py index 1f8983ae8..6a5310928 100644 --- a/stripe/params/_price_modify_params.py +++ b/stripe/params/_price_modify_params.py @@ -26,7 +26,7 @@ class PriceModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ nickname: NotRequired[str] """ @@ -34,7 +34,7 @@ class PriceModifyParams(RequestOptions): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -51,7 +51,7 @@ class PriceModifyParamsCurrencyOptions(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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["PriceModifyParamsCurrencyOptionsTier"]] """ diff --git a/stripe/params/_price_search_params.py b/stripe/params/_price_search_params.py index f10b84c39..d2ab15fed 100644 --- a/stripe/params/_price_search_params.py +++ b/stripe/params/_price_search_params.py @@ -20,5 +20,5 @@ class PriceSearchParams(RequestOptions): """ query: str """ - The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for prices](https://stripe.com/docs/search#query-fields-for-prices). + The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for prices](https://docs.stripe.com/search#query-fields-for-prices). """ diff --git a/stripe/params/_price_update_params.py b/stripe/params/_price_update_params.py index 35b483618..3176bfc00 100644 --- a/stripe/params/_price_update_params.py +++ b/stripe/params/_price_update_params.py @@ -25,7 +25,7 @@ class PriceUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ nickname: NotRequired[str] """ @@ -33,7 +33,7 @@ class PriceUpdateParams(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -50,7 +50,7 @@ class PriceUpdateParamsCurrencyOptions(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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["PriceUpdateParamsCurrencyOptionsTier"]] """ diff --git a/stripe/params/_product_create_feature_params.py b/stripe/params/_product_create_feature_params.py index 4ec04f542..a04d9df41 100644 --- a/stripe/params/_product_create_feature_params.py +++ b/stripe/params/_product_create_feature_params.py @@ -8,7 +8,7 @@ class ProductCreateFeatureParams(RequestOptions): entitlement_feature: str """ - The ID of the [Feature](https://stripe.com/docs/api/entitlements/feature) object attached to this product. + The ID of the [Feature](https://docs.stripe.com/api/entitlements/feature) object attached to this product. """ expand: NotRequired[List[str]] """ diff --git a/stripe/params/_product_create_params.py b/stripe/params/_product_create_params.py index 761f0fd6a..d8fb6cbb1 100644 --- a/stripe/params/_product_create_params.py +++ b/stripe/params/_product_create_params.py @@ -12,7 +12,7 @@ class ProductCreateParams(RequestOptions): """ default_price_data: NotRequired["ProductCreateParamsDefaultPriceData"] """ - 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. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object. This Price will be set as the default price for this product. """ description: NotRequired[str] """ @@ -34,11 +34,11 @@ class ProductCreateParams(RequestOptions): List["ProductCreateParamsMarketingFeature"] ] """ - 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). + A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table). """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: str """ @@ -61,7 +61,7 @@ class ProductCreateParams(RequestOptions): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ type: NotRequired[Literal["good", "service"]] """ @@ -96,7 +96,7 @@ class ProductCreateParamsDefaultPriceData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ recurring: NotRequired["ProductCreateParamsDefaultPriceDataRecurring"] """ @@ -104,7 +104,7 @@ class ProductCreateParamsDefaultPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -125,7 +125,7 @@ class ProductCreateParamsDefaultPriceDataCurrencyOptions(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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["ProductCreateParamsDefaultPriceDataCurrencyOptionsTier"] diff --git a/stripe/params/_product_feature_create_params.py b/stripe/params/_product_feature_create_params.py index b52580ed9..04c1b2e04 100644 --- a/stripe/params/_product_feature_create_params.py +++ b/stripe/params/_product_feature_create_params.py @@ -7,7 +7,7 @@ class ProductFeatureCreateParams(TypedDict): entitlement_feature: str """ - The ID of the [Feature](https://stripe.com/docs/api/entitlements/feature) object attached to this product. + The ID of the [Feature](https://docs.stripe.com/api/entitlements/feature) object attached to this product. """ expand: NotRequired[List[str]] """ diff --git a/stripe/params/_product_list_params.py b/stripe/params/_product_list_params.py index c52f65b89..40347b633 100644 --- a/stripe/params/_product_list_params.py +++ b/stripe/params/_product_list_params.py @@ -24,7 +24,7 @@ class ProductListParams(RequestOptions): """ 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). + Only return products with the given IDs. Cannot be used with [starting_after](https://api.stripe.com#list_products-starting_after) or [ending_before](https://api.stripe.com#list_products-ending_before). """ limit: NotRequired[int] """ diff --git a/stripe/params/_product_modify_params.py b/stripe/params/_product_modify_params.py index 1a7381951..7db18ce7d 100644 --- a/stripe/params/_product_modify_params.py +++ b/stripe/params/_product_modify_params.py @@ -12,7 +12,7 @@ class ProductModifyParams(RequestOptions): """ default_price: NotRequired[str] """ - The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product. + The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product. """ description: NotRequired["Literal['']|str"] """ @@ -30,11 +30,11 @@ class ProductModifyParams(RequestOptions): "Literal['']|List[ProductModifyParamsMarketingFeature]" ] """ - 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). + A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table). """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired[str] """ @@ -59,7 +59,7 @@ class ProductModifyParams(RequestOptions): """ tax_code: NotRequired["Literal['']|str"] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ unit_label: NotRequired["Literal['']|str"] """ diff --git a/stripe/params/_product_search_params.py b/stripe/params/_product_search_params.py index e9ac3e56b..ca74fd7c3 100644 --- a/stripe/params/_product_search_params.py +++ b/stripe/params/_product_search_params.py @@ -20,5 +20,5 @@ class ProductSearchParams(RequestOptions): """ query: str """ - The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for products](https://stripe.com/docs/search#query-fields-for-products). + The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for products](https://docs.stripe.com/search#query-fields-for-products). """ diff --git a/stripe/params/_product_update_params.py b/stripe/params/_product_update_params.py index 685966a0e..dbda248a2 100644 --- a/stripe/params/_product_update_params.py +++ b/stripe/params/_product_update_params.py @@ -11,7 +11,7 @@ class ProductUpdateParams(TypedDict): """ default_price: NotRequired[str] """ - The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product. + The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product. """ description: NotRequired["Literal['']|str"] """ @@ -29,11 +29,11 @@ class ProductUpdateParams(TypedDict): "Literal['']|List[ProductUpdateParamsMarketingFeature]" ] """ - 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). + A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table). """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired[str] """ @@ -58,7 +58,7 @@ class ProductUpdateParams(TypedDict): """ tax_code: NotRequired["Literal['']|str"] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ unit_label: NotRequired["Literal['']|str"] """ diff --git a/stripe/params/_promotion_code_create_params.py b/stripe/params/_promotion_code_create_params.py index 684750d87..e63c0566a 100644 --- a/stripe/params/_promotion_code_create_params.py +++ b/stripe/params/_promotion_code_create_params.py @@ -18,7 +18,11 @@ class PromotionCodeCreateParams(RequestOptions): """ 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. + The customer who can use this promotion code. If not set, all customers can use the promotion code. + """ + customer_account: NotRequired[str] + """ + The account representing the customer who can use this promotion code. If not set, all customers can use the promotion code. """ expand: NotRequired[List[str]] """ @@ -34,7 +38,7 @@ class PromotionCodeCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ promotion: "PromotionCodeCreateParamsPromotion" """ diff --git a/stripe/params/_promotion_code_list_params.py b/stripe/params/_promotion_code_list_params.py index 693f319af..5393d8e5b 100644 --- a/stripe/params/_promotion_code_list_params.py +++ b/stripe/params/_promotion_code_list_params.py @@ -26,6 +26,10 @@ class PromotionCodeListParams(RequestOptions): """ Only return promotion codes that are restricted to this customer. """ + customer_account: NotRequired[str] + """ + Only return promotion codes that are restricted to this account representing the customer. + """ ending_before: NotRequired[str] """ A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. diff --git a/stripe/params/_promotion_code_modify_params.py b/stripe/params/_promotion_code_modify_params.py index 671f7047d..5f0763a17 100644 --- a/stripe/params/_promotion_code_modify_params.py +++ b/stripe/params/_promotion_code_modify_params.py @@ -16,7 +16,7 @@ class PromotionCodeModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ restrictions: NotRequired["PromotionCodeModifyParamsRestrictions"] """ diff --git a/stripe/params/_promotion_code_update_params.py b/stripe/params/_promotion_code_update_params.py index 9f05b1a79..626d60482 100644 --- a/stripe/params/_promotion_code_update_params.py +++ b/stripe/params/_promotion_code_update_params.py @@ -15,7 +15,7 @@ class PromotionCodeUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ restrictions: NotRequired["PromotionCodeUpdateParamsRestrictions"] """ diff --git a/stripe/params/_quote_create_params.py b/stripe/params/_quote_create_params.py index 13b910faa..9b0cd5db6 100644 --- a/stripe/params/_quote_create_params.py +++ b/stripe/params/_quote_create_params.py @@ -28,6 +28,10 @@ class QuoteCreateParams(RequestOptions): """ The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. """ + customer_account: NotRequired[str] + """ + The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed. + """ default_tax_rates: NotRequired["Literal['']|List[str]"] """ The tax rates that will apply to any line item that does not have `tax_rates` set. @@ -70,7 +74,7 @@ class QuoteCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ on_behalf_of: NotRequired["Literal['']|str"] """ @@ -173,7 +177,7 @@ class QuoteCreateParamsLineItem(TypedDict): """ price_data: NotRequired["QuoteCreateParamsLineItemPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: NotRequired[int] """ @@ -215,7 +219,7 @@ class QuoteCreateParamsLineItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -255,7 +259,7 @@ class QuoteCreateParamsSubscriptionData(TypedDict): """ 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. + Set of [key-value pairs](https://docs.stripe.com/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. """ trial_period_days: NotRequired["Literal['']|int"] """ diff --git a/stripe/params/_quote_list_params.py b/stripe/params/_quote_list_params.py index cb888202d..af6197037 100644 --- a/stripe/params/_quote_list_params.py +++ b/stripe/params/_quote_list_params.py @@ -8,7 +8,11 @@ class QuoteListParams(RequestOptions): customer: NotRequired[str] """ - The ID of the customer whose quotes will be retrieved. + The ID of the customer whose quotes you're retrieving. + """ + customer_account: NotRequired[str] + """ + The ID of the account representing the customer whose quotes you're retrieving. """ ending_before: NotRequired[str] """ diff --git a/stripe/params/_quote_modify_params.py b/stripe/params/_quote_modify_params.py index 9a66752a9..734b030d4 100644 --- a/stripe/params/_quote_modify_params.py +++ b/stripe/params/_quote_modify_params.py @@ -28,6 +28,10 @@ class QuoteModifyParams(RequestOptions): """ The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. """ + customer_account: NotRequired[str] + """ + The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed. + """ default_tax_rates: NotRequired["Literal['']|List[str]"] """ The tax rates that will apply to any line item that does not have `tax_rates` set. @@ -66,7 +70,7 @@ class QuoteModifyParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ on_behalf_of: NotRequired["Literal['']|str"] """ @@ -158,7 +162,7 @@ class QuoteModifyParamsLineItem(TypedDict): """ price_data: NotRequired["QuoteModifyParamsLineItemPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: NotRequired[int] """ @@ -200,7 +204,7 @@ class QuoteModifyParamsLineItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -236,7 +240,7 @@ class QuoteModifyParamsSubscriptionData(TypedDict): """ 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. + Set of [key-value pairs](https://docs.stripe.com/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. """ trial_period_days: NotRequired["Literal['']|int"] """ diff --git a/stripe/params/_quote_update_params.py b/stripe/params/_quote_update_params.py index 630d474e3..71481477a 100644 --- a/stripe/params/_quote_update_params.py +++ b/stripe/params/_quote_update_params.py @@ -27,6 +27,10 @@ class QuoteUpdateParams(TypedDict): """ The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. """ + customer_account: NotRequired[str] + """ + The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed. + """ default_tax_rates: NotRequired["Literal['']|List[str]"] """ The tax rates that will apply to any line item that does not have `tax_rates` set. @@ -65,7 +69,7 @@ class QuoteUpdateParams(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ on_behalf_of: NotRequired["Literal['']|str"] """ @@ -157,7 +161,7 @@ class QuoteUpdateParamsLineItem(TypedDict): """ price_data: NotRequired["QuoteUpdateParamsLineItemPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: NotRequired[int] """ @@ -199,7 +203,7 @@ class QuoteUpdateParamsLineItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -235,7 +239,7 @@ class QuoteUpdateParamsSubscriptionData(TypedDict): """ 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. + Set of [key-value pairs](https://docs.stripe.com/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. """ trial_period_days: NotRequired["Literal['']|int"] """ diff --git a/stripe/params/_refund_create_params.py b/stripe/params/_refund_create_params.py index c8d7eac1b..3643e9fc0 100644 --- a/stripe/params/_refund_create_params.py +++ b/stripe/params/_refund_create_params.py @@ -29,7 +29,7 @@ class RefundCreateParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ origin: NotRequired[Literal["customer_balance"]] """ @@ -43,7 +43,7 @@ class RefundCreateParams(RequestOptions): 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. + 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://docs.stripe.com/radar/lists), and will also help us improve our fraud detection algorithms. """ refund_application_fee: NotRequired[bool] """ diff --git a/stripe/params/_refund_modify_params.py b/stripe/params/_refund_modify_params.py index 86df6e4ff..137744551 100644 --- a/stripe/params/_refund_modify_params.py +++ b/stripe/params/_refund_modify_params.py @@ -12,5 +12,5 @@ class RefundModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_refund_update_params.py b/stripe/params/_refund_update_params.py index 615d175a3..2de319688 100644 --- a/stripe/params/_refund_update_params.py +++ b/stripe/params/_refund_update_params.py @@ -11,5 +11,5 @@ class RefundUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_setup_intent_confirm_params.py b/stripe/params/_setup_intent_confirm_params.py index d812f3e2f..9f48da351 100644 --- a/stripe/params/_setup_intent_confirm_params.py +++ b/stripe/params/_setup_intent_confirm_params.py @@ -27,7 +27,7 @@ class SetupIntentConfirmParams(RequestOptions): "SetupIntentConfirmParamsPaymentMethodData" ] """ - When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) + When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent. """ payment_method_options: NotRequired[ @@ -232,7 +232,7 @@ class SetupIntentConfirmParamsPaymentMethodData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ mobilepay: NotRequired[ "SetupIntentConfirmParamsPaymentMethodDataMobilepay" @@ -282,6 +282,10 @@ class SetupIntentConfirmParamsPaymentMethodData(TypedDict): """ If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. """ + payto: NotRequired["SetupIntentConfirmParamsPaymentMethodDataPayto"] + """ + If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. + """ pix: NotRequired["SetupIntentConfirmParamsPaymentMethodDataPix"] """ If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. @@ -296,7 +300,7 @@ class SetupIntentConfirmParamsPaymentMethodData(TypedDict): "SetupIntentConfirmParamsPaymentMethodDataRadarOptions" ] """ - Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. """ revolut_pay: NotRequired[ "SetupIntentConfirmParamsPaymentMethodDataRevolutPay" @@ -369,6 +373,7 @@ class SetupIntentConfirmParamsPaymentMethodData(TypedDict): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -518,7 +523,7 @@ class SetupIntentConfirmParamsPaymentMethodDataBillingDetailsAddress( """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -636,6 +641,7 @@ class SetupIntentConfirmParamsPaymentMethodDataIdeal(TypedDict): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -794,6 +800,21 @@ class SetupIntentConfirmParamsPaymentMethodDataPaypal(TypedDict): pass +class SetupIntentConfirmParamsPaymentMethodDataPayto(TypedDict): + account_number: NotRequired[str] + """ + The account number for the bank account. + """ + bsb_number: NotRequired[str] + """ + Bank-State-Branch number of the bank account. + """ + pay_id: NotRequired[str] + """ + The PayID alias for the bank account. + """ + + class SetupIntentConfirmParamsPaymentMethodDataPix(TypedDict): pass @@ -805,7 +826,7 @@ class SetupIntentConfirmParamsPaymentMethodDataPromptpay(TypedDict): class SetupIntentConfirmParamsPaymentMethodDataRadarOptions(TypedDict): 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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -915,6 +936,10 @@ class SetupIntentConfirmParamsPaymentMethodOptions(TypedDict): """ If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options. """ + payto: NotRequired["SetupIntentConfirmParamsPaymentMethodOptionsPayto"] + """ + If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options. + """ sepa_debit: NotRequired[ "SetupIntentConfirmParamsPaymentMethodOptionsSepaDebit" ] @@ -1034,7 +1059,7 @@ class SetupIntentConfirmParamsPaymentMethodOptionsCard(TypedDict): 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. + 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ three_d_secure: NotRequired[ "SetupIntentConfirmParamsPaymentMethodOptionsCardThreeDSecure" @@ -1318,6 +1343,52 @@ class SetupIntentConfirmParamsPaymentMethodOptionsPaypal(TypedDict): """ +class SetupIntentConfirmParamsPaymentMethodOptionsPayto(TypedDict): + mandate_options: NotRequired[ + "SetupIntentConfirmParamsPaymentMethodOptionsPaytoMandateOptions" + ] + """ + Additional fields for Mandate creation. + """ + + +class SetupIntentConfirmParamsPaymentMethodOptionsPaytoMandateOptions( + TypedDict, +): + amount: NotRequired["Literal['']|int"] + """ + Amount that will be collected. It is required when `amount_type` is `fixed`. + """ + amount_type: NotRequired["Literal['']|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. Defaults to `maximum`. + """ + end_date: NotRequired["Literal['']|str"] + """ + Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. + """ + payment_schedule: NotRequired[ + "Literal['']|Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + ] + """ + The periodicity at which payments will be collected. Defaults to `adhoc`. + """ + payments_per_period: NotRequired["Literal['']|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['']|Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + start_date: NotRequired["Literal['']|str"] + """ + Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. + """ + + class SetupIntentConfirmParamsPaymentMethodOptionsSepaDebit(TypedDict): mandate_options: NotRequired[ "SetupIntentConfirmParamsPaymentMethodOptionsSepaDebitMandateOptions" diff --git a/stripe/params/_setup_intent_create_params.py b/stripe/params/_setup_intent_create_params.py index ca4bfd430..4e73a8557 100644 --- a/stripe/params/_setup_intent_create_params.py +++ b/stripe/params/_setup_intent_create_params.py @@ -34,6 +34,12 @@ class SetupIntentCreateParams(RequestOptions): 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. """ + customer_account: NotRequired[str] + """ + ID of the Account this SetupIntent belongs to, if one exists. + + If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent. + """ description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. @@ -77,6 +83,7 @@ class SetupIntentCreateParams(RequestOptions): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -107,11 +114,11 @@ class SetupIntentCreateParams(RequestOptions): """ mandate_data: NotRequired["Literal['']|SetupIntentCreateParamsMandateData"] """ - 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). + This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://docs.stripe.com/api/setup_intents/create#create_setup_intent-confirm). """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ on_behalf_of: NotRequired[str] """ @@ -123,13 +130,13 @@ class SetupIntentCreateParams(RequestOptions): """ payment_method_configuration: NotRequired[str] """ - The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent. + The ID of the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this SetupIntent. """ payment_method_data: NotRequired[ "SetupIntentCreateParamsPaymentMethodData" ] """ - When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) + When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent. """ payment_method_options: NotRequired[ @@ -144,7 +151,7 @@ class SetupIntentCreateParams(RequestOptions): """ 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). + 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://docs.stripe.com/api/setup_intents/create#create_setup_intent-confirm). """ single_use: NotRequired["SetupIntentCreateParamsSingleUse"] """ @@ -167,7 +174,7 @@ class SetupIntentCreateParamsAutomaticPaymentMethods(TypedDict): """ Controls whether this SetupIntent will accept redirect-based payment methods. - Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup. + Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://docs.stripe.com/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup. """ enabled: bool """ @@ -357,7 +364,7 @@ class SetupIntentCreateParamsPaymentMethodData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ mobilepay: NotRequired["SetupIntentCreateParamsPaymentMethodDataMobilepay"] """ @@ -405,6 +412,10 @@ class SetupIntentCreateParamsPaymentMethodData(TypedDict): """ If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. """ + payto: NotRequired["SetupIntentCreateParamsPaymentMethodDataPayto"] + """ + If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. + """ pix: NotRequired["SetupIntentCreateParamsPaymentMethodDataPix"] """ If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. @@ -417,7 +428,7 @@ class SetupIntentCreateParamsPaymentMethodData(TypedDict): "SetupIntentCreateParamsPaymentMethodDataRadarOptions" ] """ - Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. """ revolut_pay: NotRequired[ "SetupIntentCreateParamsPaymentMethodDataRevolutPay" @@ -490,6 +501,7 @@ class SetupIntentCreateParamsPaymentMethodData(TypedDict): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -637,7 +649,7 @@ class SetupIntentCreateParamsPaymentMethodDataBillingDetailsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -755,6 +767,7 @@ class SetupIntentCreateParamsPaymentMethodDataIdeal(TypedDict): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -913,6 +926,21 @@ class SetupIntentCreateParamsPaymentMethodDataPaypal(TypedDict): pass +class SetupIntentCreateParamsPaymentMethodDataPayto(TypedDict): + account_number: NotRequired[str] + """ + The account number for the bank account. + """ + bsb_number: NotRequired[str] + """ + Bank-State-Branch number of the bank account. + """ + pay_id: NotRequired[str] + """ + The PayID alias for the bank account. + """ + + class SetupIntentCreateParamsPaymentMethodDataPix(TypedDict): pass @@ -924,7 +952,7 @@ class SetupIntentCreateParamsPaymentMethodDataPromptpay(TypedDict): class SetupIntentCreateParamsPaymentMethodDataRadarOptions(TypedDict): 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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -1034,6 +1062,10 @@ class SetupIntentCreateParamsPaymentMethodOptions(TypedDict): """ If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options. """ + payto: NotRequired["SetupIntentCreateParamsPaymentMethodOptionsPayto"] + """ + If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options. + """ sepa_debit: NotRequired[ "SetupIntentCreateParamsPaymentMethodOptionsSepaDebit" ] @@ -1153,7 +1185,7 @@ class SetupIntentCreateParamsPaymentMethodOptionsCard(TypedDict): 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. + 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ three_d_secure: NotRequired[ "SetupIntentCreateParamsPaymentMethodOptionsCardThreeDSecure" @@ -1433,6 +1465,52 @@ class SetupIntentCreateParamsPaymentMethodOptionsPaypal(TypedDict): """ +class SetupIntentCreateParamsPaymentMethodOptionsPayto(TypedDict): + mandate_options: NotRequired[ + "SetupIntentCreateParamsPaymentMethodOptionsPaytoMandateOptions" + ] + """ + Additional fields for Mandate creation. + """ + + +class SetupIntentCreateParamsPaymentMethodOptionsPaytoMandateOptions( + TypedDict +): + amount: NotRequired["Literal['']|int"] + """ + Amount that will be collected. It is required when `amount_type` is `fixed`. + """ + amount_type: NotRequired["Literal['']|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. Defaults to `maximum`. + """ + end_date: NotRequired["Literal['']|str"] + """ + Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. + """ + payment_schedule: NotRequired[ + "Literal['']|Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + ] + """ + The periodicity at which payments will be collected. Defaults to `adhoc`. + """ + payments_per_period: NotRequired["Literal['']|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['']|Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + start_date: NotRequired["Literal['']|str"] + """ + Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. + """ + + class SetupIntentCreateParamsPaymentMethodOptionsSepaDebit(TypedDict): mandate_options: NotRequired[ "SetupIntentCreateParamsPaymentMethodOptionsSepaDebitMandateOptions" @@ -1537,7 +1615,7 @@ class SetupIntentCreateParamsPaymentMethodOptionsUsBankAccountNetworks( class SetupIntentCreateParamsSingleUse(TypedDict): amount: int """ - Amount the customer is granting permission to collect later. 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). + Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/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://docs.stripe.com/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). """ currency: str """ diff --git a/stripe/params/_setup_intent_list_params.py b/stripe/params/_setup_intent_list_params.py index 4363dd605..bb7a87ede 100644 --- a/stripe/params/_setup_intent_list_params.py +++ b/stripe/params/_setup_intent_list_params.py @@ -20,6 +20,10 @@ class SetupIntentListParams(RequestOptions): """ Only return SetupIntents for the customer specified by this customer ID. """ + customer_account: NotRequired[str] + """ + Only return SetupIntents for the account specified by this customer ID. + """ 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. diff --git a/stripe/params/_setup_intent_modify_params.py b/stripe/params/_setup_intent_modify_params.py index d5460ba42..878cb4137 100644 --- a/stripe/params/_setup_intent_modify_params.py +++ b/stripe/params/_setup_intent_modify_params.py @@ -18,12 +18,18 @@ class SetupIntentModifyParams(RequestOptions): 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. """ + customer_account: NotRequired[str] + """ + ID of the Account this SetupIntent belongs to, if one exists. + + If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent. + """ description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ excluded_payment_method_types: NotRequired[ - "Literal['']|List[Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'alma', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'billie', 'blik', 'boleto', 'card', 'cashapp', 'crypto', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'mb_way', 'mobilepay', 'multibanco', 'naver_pay', 'nz_bank_account', 'oxxo', 'p24', 'pay_by_bank', 'payco', 'paynow', 'paypal', 'pix', 'promptpay', 'revolut_pay', 'samsung_pay', 'satispay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" + "Literal['']|List[Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'alma', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'billie', 'blik', 'boleto', 'card', 'cashapp', 'crypto', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'mb_way', 'mobilepay', 'multibanco', 'naver_pay', 'nz_bank_account', 'oxxo', 'p24', 'pay_by_bank', 'payco', 'paynow', 'paypal', 'payto', 'pix', 'promptpay', 'revolut_pay', 'samsung_pay', 'satispay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" ] """ The list of payment method types to exclude from use with this SetupIntent. @@ -40,7 +46,7 @@ class SetupIntentModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ payment_method: NotRequired[str] """ @@ -48,13 +54,13 @@ class SetupIntentModifyParams(RequestOptions): """ payment_method_configuration: NotRequired[str] """ - The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent. + The ID of the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this SetupIntent. """ payment_method_data: NotRequired[ "SetupIntentModifyParamsPaymentMethodData" ] """ - When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) + When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent. """ payment_method_options: NotRequired[ @@ -206,7 +212,7 @@ class SetupIntentModifyParamsPaymentMethodData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ mobilepay: NotRequired["SetupIntentModifyParamsPaymentMethodDataMobilepay"] """ @@ -254,6 +260,10 @@ class SetupIntentModifyParamsPaymentMethodData(TypedDict): """ If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. """ + payto: NotRequired["SetupIntentModifyParamsPaymentMethodDataPayto"] + """ + If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. + """ pix: NotRequired["SetupIntentModifyParamsPaymentMethodDataPix"] """ If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. @@ -266,7 +276,7 @@ class SetupIntentModifyParamsPaymentMethodData(TypedDict): "SetupIntentModifyParamsPaymentMethodDataRadarOptions" ] """ - Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. """ revolut_pay: NotRequired[ "SetupIntentModifyParamsPaymentMethodDataRevolutPay" @@ -339,6 +349,7 @@ class SetupIntentModifyParamsPaymentMethodData(TypedDict): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -486,7 +497,7 @@ class SetupIntentModifyParamsPaymentMethodDataBillingDetailsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -604,6 +615,7 @@ class SetupIntentModifyParamsPaymentMethodDataIdeal(TypedDict): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -762,6 +774,21 @@ class SetupIntentModifyParamsPaymentMethodDataPaypal(TypedDict): pass +class SetupIntentModifyParamsPaymentMethodDataPayto(TypedDict): + account_number: NotRequired[str] + """ + The account number for the bank account. + """ + bsb_number: NotRequired[str] + """ + Bank-State-Branch number of the bank account. + """ + pay_id: NotRequired[str] + """ + The PayID alias for the bank account. + """ + + class SetupIntentModifyParamsPaymentMethodDataPix(TypedDict): pass @@ -773,7 +800,7 @@ class SetupIntentModifyParamsPaymentMethodDataPromptpay(TypedDict): class SetupIntentModifyParamsPaymentMethodDataRadarOptions(TypedDict): 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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -883,6 +910,10 @@ class SetupIntentModifyParamsPaymentMethodOptions(TypedDict): """ If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options. """ + payto: NotRequired["SetupIntentModifyParamsPaymentMethodOptionsPayto"] + """ + If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options. + """ sepa_debit: NotRequired[ "SetupIntentModifyParamsPaymentMethodOptionsSepaDebit" ] @@ -1002,7 +1033,7 @@ class SetupIntentModifyParamsPaymentMethodOptionsCard(TypedDict): 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. + 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ three_d_secure: NotRequired[ "SetupIntentModifyParamsPaymentMethodOptionsCardThreeDSecure" @@ -1282,6 +1313,52 @@ class SetupIntentModifyParamsPaymentMethodOptionsPaypal(TypedDict): """ +class SetupIntentModifyParamsPaymentMethodOptionsPayto(TypedDict): + mandate_options: NotRequired[ + "SetupIntentModifyParamsPaymentMethodOptionsPaytoMandateOptions" + ] + """ + Additional fields for Mandate creation. + """ + + +class SetupIntentModifyParamsPaymentMethodOptionsPaytoMandateOptions( + TypedDict +): + amount: NotRequired["Literal['']|int"] + """ + Amount that will be collected. It is required when `amount_type` is `fixed`. + """ + amount_type: NotRequired["Literal['']|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. Defaults to `maximum`. + """ + end_date: NotRequired["Literal['']|str"] + """ + Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. + """ + payment_schedule: NotRequired[ + "Literal['']|Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + ] + """ + The periodicity at which payments will be collected. Defaults to `adhoc`. + """ + payments_per_period: NotRequired["Literal['']|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['']|Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + start_date: NotRequired["Literal['']|str"] + """ + Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. + """ + + class SetupIntentModifyParamsPaymentMethodOptionsSepaDebit(TypedDict): mandate_options: NotRequired[ "SetupIntentModifyParamsPaymentMethodOptionsSepaDebitMandateOptions" diff --git a/stripe/params/_setup_intent_update_params.py b/stripe/params/_setup_intent_update_params.py index a3c539ba4..91a0531c1 100644 --- a/stripe/params/_setup_intent_update_params.py +++ b/stripe/params/_setup_intent_update_params.py @@ -17,12 +17,18 @@ class SetupIntentUpdateParams(TypedDict): 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. """ + customer_account: NotRequired[str] + """ + ID of the Account this SetupIntent belongs to, if one exists. + + If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent. + """ description: NotRequired[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ excluded_payment_method_types: NotRequired[ - "Literal['']|List[Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'alma', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'billie', 'blik', 'boleto', 'card', 'cashapp', 'crypto', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'mb_way', 'mobilepay', 'multibanco', 'naver_pay', 'nz_bank_account', 'oxxo', 'p24', 'pay_by_bank', 'payco', 'paynow', 'paypal', 'pix', 'promptpay', 'revolut_pay', 'samsung_pay', 'satispay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" + "Literal['']|List[Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'alma', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'billie', 'blik', 'boleto', 'card', 'cashapp', 'crypto', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'mb_way', 'mobilepay', 'multibanco', 'naver_pay', 'nz_bank_account', 'oxxo', 'p24', 'pay_by_bank', 'payco', 'paynow', 'paypal', 'payto', 'pix', 'promptpay', 'revolut_pay', 'samsung_pay', 'satispay', 'sepa_debit', 'sofort', 'swish', 'twint', 'us_bank_account', 'wechat_pay', 'zip']]" ] """ The list of payment method types to exclude from use with this SetupIntent. @@ -39,7 +45,7 @@ class SetupIntentUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ payment_method: NotRequired[str] """ @@ -47,13 +53,13 @@ class SetupIntentUpdateParams(TypedDict): """ payment_method_configuration: NotRequired[str] """ - The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent. + The ID of the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this SetupIntent. """ payment_method_data: NotRequired[ "SetupIntentUpdateParamsPaymentMethodData" ] """ - When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) + When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent. """ payment_method_options: NotRequired[ @@ -205,7 +211,7 @@ class SetupIntentUpdateParamsPaymentMethodData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ mobilepay: NotRequired["SetupIntentUpdateParamsPaymentMethodDataMobilepay"] """ @@ -253,6 +259,10 @@ class SetupIntentUpdateParamsPaymentMethodData(TypedDict): """ If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. """ + payto: NotRequired["SetupIntentUpdateParamsPaymentMethodDataPayto"] + """ + If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. + """ pix: NotRequired["SetupIntentUpdateParamsPaymentMethodDataPix"] """ If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. @@ -265,7 +275,7 @@ class SetupIntentUpdateParamsPaymentMethodData(TypedDict): "SetupIntentUpdateParamsPaymentMethodDataRadarOptions" ] """ - Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. """ revolut_pay: NotRequired[ "SetupIntentUpdateParamsPaymentMethodDataRevolutPay" @@ -338,6 +348,7 @@ class SetupIntentUpdateParamsPaymentMethodData(TypedDict): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -485,7 +496,7 @@ class SetupIntentUpdateParamsPaymentMethodDataBillingDetailsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -603,6 +614,7 @@ class SetupIntentUpdateParamsPaymentMethodDataIdeal(TypedDict): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -761,6 +773,21 @@ class SetupIntentUpdateParamsPaymentMethodDataPaypal(TypedDict): pass +class SetupIntentUpdateParamsPaymentMethodDataPayto(TypedDict): + account_number: NotRequired[str] + """ + The account number for the bank account. + """ + bsb_number: NotRequired[str] + """ + Bank-State-Branch number of the bank account. + """ + pay_id: NotRequired[str] + """ + The PayID alias for the bank account. + """ + + class SetupIntentUpdateParamsPaymentMethodDataPix(TypedDict): pass @@ -772,7 +799,7 @@ class SetupIntentUpdateParamsPaymentMethodDataPromptpay(TypedDict): class SetupIntentUpdateParamsPaymentMethodDataRadarOptions(TypedDict): 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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -882,6 +909,10 @@ class SetupIntentUpdateParamsPaymentMethodOptions(TypedDict): """ If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options. """ + payto: NotRequired["SetupIntentUpdateParamsPaymentMethodOptionsPayto"] + """ + If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options. + """ sepa_debit: NotRequired[ "SetupIntentUpdateParamsPaymentMethodOptionsSepaDebit" ] @@ -1001,7 +1032,7 @@ class SetupIntentUpdateParamsPaymentMethodOptionsCard(TypedDict): 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. + 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ three_d_secure: NotRequired[ "SetupIntentUpdateParamsPaymentMethodOptionsCardThreeDSecure" @@ -1281,6 +1312,52 @@ class SetupIntentUpdateParamsPaymentMethodOptionsPaypal(TypedDict): """ +class SetupIntentUpdateParamsPaymentMethodOptionsPayto(TypedDict): + mandate_options: NotRequired[ + "SetupIntentUpdateParamsPaymentMethodOptionsPaytoMandateOptions" + ] + """ + Additional fields for Mandate creation. + """ + + +class SetupIntentUpdateParamsPaymentMethodOptionsPaytoMandateOptions( + TypedDict +): + amount: NotRequired["Literal['']|int"] + """ + Amount that will be collected. It is required when `amount_type` is `fixed`. + """ + amount_type: NotRequired["Literal['']|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. Defaults to `maximum`. + """ + end_date: NotRequired["Literal['']|str"] + """ + Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. + """ + payment_schedule: NotRequired[ + "Literal['']|Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + ] + """ + The periodicity at which payments will be collected. Defaults to `adhoc`. + """ + payments_per_period: NotRequired["Literal['']|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['']|Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + start_date: NotRequired["Literal['']|str"] + """ + Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. + """ + + class SetupIntentUpdateParamsPaymentMethodOptionsSepaDebit(TypedDict): mandate_options: NotRequired[ "SetupIntentUpdateParamsPaymentMethodOptionsSepaDebitMandateOptions" diff --git a/stripe/params/_shipping_rate_create_params.py b/stripe/params/_shipping_rate_create_params.py index 8697e7138..3e8bad043 100644 --- a/stripe/params/_shipping_rate_create_params.py +++ b/stripe/params/_shipping_rate_create_params.py @@ -24,7 +24,7 @@ class ShippingRateCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ tax_behavior: NotRequired[Literal["exclusive", "inclusive", "unspecified"]] """ @@ -32,7 +32,7 @@ class ShippingRateCreateParams(RequestOptions): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ type: NotRequired[Literal["fixed_amount"]] """ diff --git a/stripe/params/_shipping_rate_modify_params.py b/stripe/params/_shipping_rate_modify_params.py index 85f84f4bb..bae5280a8 100644 --- a/stripe/params/_shipping_rate_modify_params.py +++ b/stripe/params/_shipping_rate_modify_params.py @@ -20,7 +20,7 @@ class ShippingRateModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ tax_behavior: NotRequired[Literal["exclusive", "inclusive", "unspecified"]] """ diff --git a/stripe/params/_shipping_rate_update_params.py b/stripe/params/_shipping_rate_update_params.py index bdfb36dc7..8008e0291 100644 --- a/stripe/params/_shipping_rate_update_params.py +++ b/stripe/params/_shipping_rate_update_params.py @@ -19,7 +19,7 @@ class ShippingRateUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ tax_behavior: NotRequired[Literal["exclusive", "inclusive", "unspecified"]] """ diff --git a/stripe/params/_source_create_params.py b/stripe/params/_source_create_params.py index 013849e76..da9714921 100644 --- a/stripe/params/_source_create_params.py +++ b/stripe/params/_source_create_params.py @@ -63,7 +63,7 @@ class SourceCreateParams(RequestOptions): """ 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) + The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://docs.stripe.com/sources/connect#cloning-card-sources) guide) """ usage: NotRequired[Literal["reusable", "single_use"]] @@ -188,7 +188,7 @@ class SourceCreateParamsOwnerAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -278,5 +278,5 @@ class SourceCreateParamsSourceOrderShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_source_modify_params.py b/stripe/params/_source_modify_params.py index f57584e1d..7e2b77e4f 100644 --- a/stripe/params/_source_modify_params.py +++ b/stripe/params/_source_modify_params.py @@ -20,7 +20,7 @@ class SourceModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ owner: NotRequired["SourceModifyParamsOwner"] """ @@ -152,7 +152,7 @@ class SourceModifyParamsOwnerAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -228,5 +228,5 @@ class SourceModifyParamsSourceOrderShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_source_update_params.py b/stripe/params/_source_update_params.py index ff800484c..25ca98953 100644 --- a/stripe/params/_source_update_params.py +++ b/stripe/params/_source_update_params.py @@ -19,7 +19,7 @@ class SourceUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ owner: NotRequired["SourceUpdateParamsOwner"] """ @@ -151,7 +151,7 @@ class SourceUpdateParamsOwnerAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -227,5 +227,5 @@ class SourceUpdateParamsSourceOrderShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/_subscription_create_params.py b/stripe/params/_subscription_create_params.py index 13101cb3b..35c75cfe2 100644 --- a/stripe/params/_subscription_create_params.py +++ b/stripe/params/_subscription_create_params.py @@ -26,7 +26,7 @@ class SubscriptionCreateParams(RequestOptions): """ 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. + A future timestamp in UTC format to anchor the subscription's [billing cycle](https://docs.stripe.com/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. """ billing_cycle_anchor_config: NotRequired[ "SubscriptionCreateParamsBillingCycleAnchorConfig" @@ -62,21 +62,25 @@ class SubscriptionCreateParams(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: str + customer: NotRequired[str] """ The identifier of the customer to subscribe. """ + customer_account: NotRequired[str] + """ + The identifier of the account representing the customer to subscribe. + """ 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] """ - 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). + 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://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). """ 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). + 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://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). """ default_tax_rates: NotRequired["Literal['']|List[str]"] """ @@ -106,7 +110,7 @@ class SubscriptionCreateParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ off_session: NotRequired[bool] """ @@ -127,11 +131,11 @@ class SubscriptionCreateParams(RequestOptions): """ Only applies to subscriptions with `collection_method=charge_automatically`. - Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer 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. + Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer 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://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. - Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription's invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state. + Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription's invoice, such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state. - Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a 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. + Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/upgrades#2019-03-14) to learn more. `pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription. @@ -145,13 +149,13 @@ class SubscriptionCreateParams(RequestOptions): "Literal['']|SubscriptionCreateParamsPendingInvoiceItemInterval" ] """ - Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. + Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval. """ proration_behavior: NotRequired[ 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`. + Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. """ transfer_data: NotRequired["SubscriptionCreateParamsTransferData"] """ @@ -159,15 +163,15 @@ class SubscriptionCreateParams(RequestOptions): """ trial_end: NotRequired["Literal['now']|int"] """ - 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. + 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://docs.stripe.com/billing/subscriptions/trials) to learn more. """ 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. + 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://docs.stripe.com/billing/subscriptions/trials) to learn more. """ 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. + 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://docs.stripe.com/billing/subscriptions/trials) to learn more. """ trial_settings: NotRequired["SubscriptionCreateParamsTrialSettings"] """ @@ -184,7 +188,7 @@ class SubscriptionCreateParamsAddInvoiceItem(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ period: NotRequired["SubscriptionCreateParamsAddInvoiceItemPeriod"] """ @@ -196,7 +200,7 @@ class SubscriptionCreateParamsAddInvoiceItem(TypedDict): """ price_data: NotRequired["SubscriptionCreateParamsAddInvoiceItemPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: NotRequired[int] """ @@ -267,7 +271,7 @@ class SubscriptionCreateParamsAddInvoiceItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -405,7 +409,7 @@ class SubscriptionCreateParamsItem(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ plan: NotRequired[str] """ @@ -417,7 +421,7 @@ class SubscriptionCreateParamsItem(TypedDict): """ price_data: NotRequired["SubscriptionCreateParamsItemPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. """ quantity: NotRequired[int] """ @@ -425,14 +429,14 @@ class SubscriptionCreateParamsItem(TypedDict): """ tax_rates: NotRequired["Literal['']|List[str]"] """ - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. """ class SubscriptionCreateParamsItemBillingThresholds(TypedDict): usage_gte: int """ - Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) """ @@ -466,7 +470,7 @@ class SubscriptionCreateParamsItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -497,7 +501,7 @@ class SubscriptionCreateParamsPaymentSettings(TypedDict): Payment-method-specific configuration to provide to invoices created by the subscription. """ payment_method_types: NotRequired[ - "Literal['']|List[Literal['ach_credit_transfer', 'ach_debit', 'acss_debit', 'affirm', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'boleto', 'card', 'cashapp', 'crypto', 'custom', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'jp_credit_transfer', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'link', 'multibanco', 'naver_pay', 'nz_bank_account', 'p24', 'payco', 'paynow', 'paypal', 'promptpay', 'revolut_pay', 'sepa_credit_transfer', 'sepa_debit', 'sofort', 'swish', 'us_bank_account', 'wechat_pay']]" + "Literal['']|List[Literal['ach_credit_transfer', 'ach_debit', 'acss_debit', 'affirm', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'boleto', 'card', 'cashapp', 'crypto', 'custom', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'jp_credit_transfer', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'link', 'multibanco', 'naver_pay', 'nz_bank_account', 'p24', 'payco', 'paynow', 'paypal', 'payto', 'promptpay', 'revolut_pay', 'sepa_credit_transfer', 'sepa_debit', 'sofort', 'swish', 'us_bank_account', 'wechat_pay']]" ] """ 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). Should not be specified with payment_method_configuration @@ -539,6 +543,12 @@ class SubscriptionCreateParamsPaymentSettingsPaymentMethodOptions(TypedDict): """ This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent. """ + payto: NotRequired[ + "Literal['']|SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsPayto" + ] + """ + This sub-hash contains details about the PayTo payment method options to pass to the invoice's PaymentIntent. + """ sepa_debit: NotRequired[ "Literal['']|SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsSepaDebit" ] @@ -621,7 +631,7 @@ class SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsCard( 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. + 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ @@ -687,6 +697,44 @@ class SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsKonbini( pass +class SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsPayto( + TypedDict, +): + mandate_options: NotRequired[ + "SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions" + ] + """ + Additional fields for Mandate creation. + """ + + +class SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions( + TypedDict, +): + amount: NotRequired[int] + """ + The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit. + """ + purpose: NotRequired[ + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + + class SubscriptionCreateParamsPaymentSettingsPaymentMethodOptionsSepaDebit( TypedDict, ): diff --git a/stripe/params/_subscription_item_create_params.py b/stripe/params/_subscription_item_create_params.py index 7b139d102..952d15004 100644 --- a/stripe/params/_subscription_item_create_params.py +++ b/stripe/params/_subscription_item_create_params.py @@ -24,7 +24,7 @@ class SubscriptionItemCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ payment_behavior: NotRequired[ Literal[ @@ -35,11 +35,11 @@ class SubscriptionItemCreateParams(RequestOptions): ] ] """ - 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. + 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://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. - Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. + Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. - Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). + Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). 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://docs.stripe.com/changelog/2019-03-14) to learn more. """ @@ -53,17 +53,17 @@ class SubscriptionItemCreateParams(RequestOptions): """ price_data: NotRequired["SubscriptionItemCreateParamsPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. """ proration_behavior: NotRequired[ 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`. + Determines how to handle [prorations](https://docs.stripe.com/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] """ - 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. + 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://api.stripe.com#retrieve_customer_invoice) endpoint. """ quantity: NotRequired[int] """ @@ -75,14 +75,14 @@ class SubscriptionItemCreateParams(RequestOptions): """ tax_rates: NotRequired["Literal['']|List[str]"] """ - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. """ class SubscriptionItemCreateParamsBillingThresholds(TypedDict): usage_gte: int """ - Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) """ @@ -116,7 +116,7 @@ class SubscriptionItemCreateParamsPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ diff --git a/stripe/params/_subscription_item_delete_params.py b/stripe/params/_subscription_item_delete_params.py index 2355bfe58..b03385454 100644 --- a/stripe/params/_subscription_item_delete_params.py +++ b/stripe/params/_subscription_item_delete_params.py @@ -13,9 +13,9 @@ class SubscriptionItemDeleteParams(RequestOptions): 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`. + Determines how to handle [prorations](https://docs.stripe.com/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] """ - 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. + 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://api.stripe.com#retrieve_customer_invoice) endpoint. """ diff --git a/stripe/params/_subscription_item_modify_params.py b/stripe/params/_subscription_item_modify_params.py index 9759b7211..01546a6c0 100644 --- a/stripe/params/_subscription_item_modify_params.py +++ b/stripe/params/_subscription_item_modify_params.py @@ -24,7 +24,7 @@ class SubscriptionItemModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ off_session: NotRequired[bool] """ @@ -39,11 +39,11 @@ class SubscriptionItemModifyParams(RequestOptions): ] ] """ - 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. + 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://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. - Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. + Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. - Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). + Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). 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://docs.stripe.com/changelog/2019-03-14) to learn more. """ @@ -57,17 +57,17 @@ class SubscriptionItemModifyParams(RequestOptions): """ price_data: NotRequired["SubscriptionItemModifyParamsPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ proration_behavior: NotRequired[ 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`. + Determines how to handle [prorations](https://docs.stripe.com/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] """ - 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. + 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://api.stripe.com#retrieve_customer_invoice) endpoint. """ quantity: NotRequired[int] """ @@ -75,14 +75,14 @@ class SubscriptionItemModifyParams(RequestOptions): """ tax_rates: NotRequired["Literal['']|List[str]"] """ - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. """ class SubscriptionItemModifyParamsBillingThresholds(TypedDict): usage_gte: int """ - Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) """ @@ -116,7 +116,7 @@ class SubscriptionItemModifyParamsPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ diff --git a/stripe/params/_subscription_item_update_params.py b/stripe/params/_subscription_item_update_params.py index bd6e0d45a..3261b558d 100644 --- a/stripe/params/_subscription_item_update_params.py +++ b/stripe/params/_subscription_item_update_params.py @@ -23,7 +23,7 @@ class SubscriptionItemUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ off_session: NotRequired[bool] """ @@ -38,11 +38,11 @@ class SubscriptionItemUpdateParams(TypedDict): ] ] """ - 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. + 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://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. - Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. + Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. - Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). + Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). 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://docs.stripe.com/changelog/2019-03-14) to learn more. """ @@ -56,17 +56,17 @@ class SubscriptionItemUpdateParams(TypedDict): """ price_data: NotRequired["SubscriptionItemUpdateParamsPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ proration_behavior: NotRequired[ 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`. + Determines how to handle [prorations](https://docs.stripe.com/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] """ - 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. + 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://api.stripe.com#retrieve_customer_invoice) endpoint. """ quantity: NotRequired[int] """ @@ -74,14 +74,14 @@ class SubscriptionItemUpdateParams(TypedDict): """ tax_rates: NotRequired["Literal['']|List[str]"] """ - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. """ class SubscriptionItemUpdateParamsBillingThresholds(TypedDict): usage_gte: int """ - Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) """ @@ -115,7 +115,7 @@ class SubscriptionItemUpdateParamsPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ diff --git a/stripe/params/_subscription_list_params.py b/stripe/params/_subscription_list_params.py index d51baa76b..efbcb83ab 100644 --- a/stripe/params/_subscription_list_params.py +++ b/stripe/params/_subscription_list_params.py @@ -34,7 +34,11 @@ class SubscriptionListParams(RequestOptions): """ customer: NotRequired[str] """ - The ID of the customer whose subscriptions will be retrieved. + The ID of the customer whose subscriptions you're retrieving. + """ + customer_account: NotRequired[str] + """ + The ID of the account representing the customer whose subscriptions you're retrieving. """ ending_before: NotRequired[str] """ @@ -75,7 +79,7 @@ class SubscriptionListParams(RequestOptions): ] ] """ - 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. + 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://docs.stripe.com/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] """ diff --git a/stripe/params/_subscription_modify_params.py b/stripe/params/_subscription_modify_params.py index c4696a1cb..0891345b0 100644 --- a/stripe/params/_subscription_modify_params.py +++ b/stripe/params/_subscription_modify_params.py @@ -22,7 +22,7 @@ class SubscriptionModifyParams(RequestOptions): """ 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). + 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://docs.stripe.com/billing/subscriptions/billing-cycle). """ billing_thresholds: NotRequired[ "Literal['']|SubscriptionModifyParamsBillingThresholds" @@ -58,11 +58,11 @@ class SubscriptionModifyParams(RequestOptions): """ 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). + 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://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). """ default_source: NotRequired["Literal['']|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). + 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://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). """ default_tax_rates: NotRequired["Literal['']|List[str]"] """ @@ -92,7 +92,7 @@ class SubscriptionModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ off_session: NotRequired[bool] """ @@ -106,7 +106,7 @@ class SubscriptionModifyParams(RequestOptions): "Literal['']|SubscriptionModifyParamsPauseCollection" ] """ - 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/docs/billing/subscriptions/pause-payment). + 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://docs.stripe.com/billing/subscriptions/pause-payment). """ payment_behavior: NotRequired[ Literal[ @@ -117,11 +117,11 @@ class SubscriptionModifyParams(RequestOptions): ] ] """ - 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. + 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://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. - Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. + Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. - Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). + Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). 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://docs.stripe.com/changelog/2019-03-14) to learn more. """ @@ -133,13 +133,13 @@ class SubscriptionModifyParams(RequestOptions): "Literal['']|SubscriptionModifyParamsPendingInvoiceItemInterval" ] """ - Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. + Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval. """ proration_behavior: NotRequired[ 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`. + Determines how to handle [prorations](https://docs.stripe.com/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] """ @@ -157,7 +157,7 @@ class SubscriptionModifyParams(RequestOptions): """ 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. + 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://docs.stripe.com/billing/subscriptions/trials) to learn more. """ trial_settings: NotRequired["SubscriptionModifyParamsTrialSettings"] """ @@ -174,7 +174,7 @@ class SubscriptionModifyParamsAddInvoiceItem(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ period: NotRequired["SubscriptionModifyParamsAddInvoiceItemPeriod"] """ @@ -186,7 +186,7 @@ class SubscriptionModifyParamsAddInvoiceItem(TypedDict): """ price_data: NotRequired["SubscriptionModifyParamsAddInvoiceItemPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: NotRequired[int] """ @@ -257,7 +257,7 @@ class SubscriptionModifyParamsAddInvoiceItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -379,7 +379,7 @@ class SubscriptionModifyParamsItem(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ plan: NotRequired[str] """ @@ -391,7 +391,7 @@ class SubscriptionModifyParamsItem(TypedDict): """ price_data: NotRequired["SubscriptionModifyParamsItemPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: NotRequired[int] """ @@ -399,14 +399,14 @@ class SubscriptionModifyParamsItem(TypedDict): """ tax_rates: NotRequired["Literal['']|List[str]"] """ - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. """ class SubscriptionModifyParamsItemBillingThresholds(TypedDict): usage_gte: int """ - Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) """ @@ -440,7 +440,7 @@ class SubscriptionModifyParamsItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -482,7 +482,7 @@ class SubscriptionModifyParamsPaymentSettings(TypedDict): Payment-method-specific configuration to provide to invoices created by the subscription. """ payment_method_types: NotRequired[ - "Literal['']|List[Literal['ach_credit_transfer', 'ach_debit', 'acss_debit', 'affirm', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'boleto', 'card', 'cashapp', 'crypto', 'custom', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'jp_credit_transfer', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'link', 'multibanco', 'naver_pay', 'nz_bank_account', 'p24', 'payco', 'paynow', 'paypal', 'promptpay', 'revolut_pay', 'sepa_credit_transfer', 'sepa_debit', 'sofort', 'swish', 'us_bank_account', 'wechat_pay']]" + "Literal['']|List[Literal['ach_credit_transfer', 'ach_debit', 'acss_debit', 'affirm', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'boleto', 'card', 'cashapp', 'crypto', 'custom', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'jp_credit_transfer', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'link', 'multibanco', 'naver_pay', 'nz_bank_account', 'p24', 'payco', 'paynow', 'paypal', 'payto', 'promptpay', 'revolut_pay', 'sepa_credit_transfer', 'sepa_debit', 'sofort', 'swish', 'us_bank_account', 'wechat_pay']]" ] """ 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). Should not be specified with payment_method_configuration @@ -524,6 +524,12 @@ class SubscriptionModifyParamsPaymentSettingsPaymentMethodOptions(TypedDict): """ This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent. """ + payto: NotRequired[ + "Literal['']|SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsPayto" + ] + """ + This sub-hash contains details about the PayTo payment method options to pass to the invoice's PaymentIntent. + """ sepa_debit: NotRequired[ "Literal['']|SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsSepaDebit" ] @@ -606,7 +612,7 @@ class SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsCard( 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. + 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ @@ -672,6 +678,44 @@ class SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsKonbini( pass +class SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsPayto( + TypedDict, +): + mandate_options: NotRequired[ + "SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions" + ] + """ + Additional fields for Mandate creation. + """ + + +class SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions( + TypedDict, +): + amount: NotRequired[int] + """ + The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit. + """ + purpose: NotRequired[ + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + + class SubscriptionModifyParamsPaymentSettingsPaymentMethodOptionsSepaDebit( TypedDict, ): diff --git a/stripe/params/_subscription_resume_params.py b/stripe/params/_subscription_resume_params.py index a74e3c7bb..e1ad4a625 100644 --- a/stripe/params/_subscription_resume_params.py +++ b/stripe/params/_subscription_resume_params.py @@ -8,7 +8,7 @@ class SubscriptionResumeParams(RequestOptions): billing_cycle_anchor: NotRequired[Literal["now", "unchanged"]] """ - The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). + The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle). """ expand: NotRequired[List[str]] """ @@ -18,7 +18,7 @@ class SubscriptionResumeParams(RequestOptions): Literal["always_invoice", "create_prorations", "none"] ] """ - Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`. + Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`. """ proration_date: NotRequired[int] """ diff --git a/stripe/params/_subscription_schedule_create_params.py b/stripe/params/_subscription_schedule_create_params.py index c27662147..48a8b9a5d 100644 --- a/stripe/params/_subscription_schedule_create_params.py +++ b/stripe/params/_subscription_schedule_create_params.py @@ -14,6 +14,10 @@ class SubscriptionScheduleCreateParams(RequestOptions): """ The identifier of the customer to create the subscription schedule for. """ + customer_account: NotRequired[str] + """ + The identifier of the account to create the subscription schedule for. + """ default_settings: NotRequired[ "SubscriptionScheduleCreateParamsDefaultSettings" ] @@ -34,7 +38,7 @@ class SubscriptionScheduleCreateParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ phases: NotRequired[List["SubscriptionScheduleCreateParamsPhase"]] """ @@ -79,7 +83,7 @@ class SubscriptionScheduleCreateParamsDefaultSettings(TypedDict): """ 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). + 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://docs.stripe.com/billing/subscriptions/billing-cycle). """ billing_thresholds: NotRequired[ "Literal['']|SubscriptionScheduleCreateParamsDefaultSettingsBillingThresholds" @@ -220,7 +224,7 @@ class SubscriptionScheduleCreateParamsPhase(TypedDict): """ 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). + 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://docs.stripe.com/billing/subscriptions/billing-cycle). """ billing_thresholds: NotRequired[ "Literal['']|SubscriptionScheduleCreateParamsPhaseBillingThresholds" @@ -244,7 +248,7 @@ class SubscriptionScheduleCreateParamsPhase(TypedDict): """ default_tax_rates: NotRequired["Literal['']|List[str]"] """ - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase. + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase. """ description: NotRequired["Literal['']|str"] """ @@ -262,7 +266,7 @@ class SubscriptionScheduleCreateParamsPhase(TypedDict): """ end_date: NotRequired[int] """ - The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set. + The date at which this phase of the subscription schedule ends. If set, `duration` must not be set. """ invoice_settings: NotRequired[ "SubscriptionScheduleCreateParamsPhaseInvoiceSettings" @@ -276,7 +280,7 @@ class SubscriptionScheduleCreateParamsPhase(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/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] """ @@ -286,7 +290,7 @@ class SubscriptionScheduleCreateParamsPhase(TypedDict): Literal["always_invoice", "create_prorations", "none"] ] """ - Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. 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 (item price, quantity, etc.) of the current phase. + Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. """ transfer_data: NotRequired[ "SubscriptionScheduleCreateParamsPhaseTransferData" @@ -313,7 +317,7 @@ class SubscriptionScheduleCreateParamsPhaseAddInvoiceItem(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ period: NotRequired[ "SubscriptionScheduleCreateParamsPhaseAddInvoiceItemPeriod" @@ -329,7 +333,7 @@ class SubscriptionScheduleCreateParamsPhaseAddInvoiceItem(TypedDict): "SubscriptionScheduleCreateParamsPhaseAddInvoiceItemPriceData" ] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: NotRequired[int] """ @@ -402,7 +406,7 @@ class SubscriptionScheduleCreateParamsPhaseAddInvoiceItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -518,7 +522,7 @@ class SubscriptionScheduleCreateParamsPhaseItem(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/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] """ @@ -532,7 +536,7 @@ class SubscriptionScheduleCreateParamsPhaseItem(TypedDict): "SubscriptionScheduleCreateParamsPhaseItemPriceData" ] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. """ quantity: NotRequired[int] """ @@ -540,14 +544,14 @@ class SubscriptionScheduleCreateParamsPhaseItem(TypedDict): """ tax_rates: NotRequired["Literal['']|List[str]"] """ - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. """ class SubscriptionScheduleCreateParamsPhaseItemBillingThresholds(TypedDict): usage_gte: int """ - Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) """ @@ -581,7 +585,7 @@ class SubscriptionScheduleCreateParamsPhaseItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ diff --git a/stripe/params/_subscription_schedule_list_params.py b/stripe/params/_subscription_schedule_list_params.py index 2f3b91e9f..b87767ab2 100644 --- a/stripe/params/_subscription_schedule_list_params.py +++ b/stripe/params/_subscription_schedule_list_params.py @@ -22,6 +22,10 @@ class SubscriptionScheduleListParams(RequestOptions): """ Only return subscription schedules for the given customer. """ + customer_account: NotRequired[str] + """ + Only return subscription schedules for the given account. + """ 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. diff --git a/stripe/params/_subscription_schedule_modify_params.py b/stripe/params/_subscription_schedule_modify_params.py index 04d91b096..e47484ff5 100644 --- a/stripe/params/_subscription_schedule_modify_params.py +++ b/stripe/params/_subscription_schedule_modify_params.py @@ -22,7 +22,7 @@ class SubscriptionScheduleModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ phases: NotRequired[List["SubscriptionScheduleModifyParamsPhase"]] """ @@ -49,7 +49,7 @@ class SubscriptionScheduleModifyParamsDefaultSettings(TypedDict): """ 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). + 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://docs.stripe.com/billing/subscriptions/billing-cycle). """ billing_thresholds: NotRequired[ "Literal['']|SubscriptionScheduleModifyParamsDefaultSettingsBillingThresholds" @@ -190,7 +190,7 @@ class SubscriptionScheduleModifyParamsPhase(TypedDict): """ 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). + 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://docs.stripe.com/billing/subscriptions/billing-cycle). """ billing_thresholds: NotRequired[ "Literal['']|SubscriptionScheduleModifyParamsPhaseBillingThresholds" @@ -214,7 +214,7 @@ class SubscriptionScheduleModifyParamsPhase(TypedDict): """ default_tax_rates: NotRequired["Literal['']|List[str]"] """ - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase. + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase. """ description: NotRequired["Literal['']|str"] """ @@ -232,7 +232,7 @@ class SubscriptionScheduleModifyParamsPhase(TypedDict): """ end_date: NotRequired["int|Literal['now']"] """ - The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set. + The date at which this phase of the subscription schedule ends. If set, `duration` must not be set. """ invoice_settings: NotRequired[ "SubscriptionScheduleModifyParamsPhaseInvoiceSettings" @@ -246,7 +246,7 @@ class SubscriptionScheduleModifyParamsPhase(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/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] """ @@ -256,7 +256,7 @@ class SubscriptionScheduleModifyParamsPhase(TypedDict): Literal["always_invoice", "create_prorations", "none"] ] """ - Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. 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 (item price, quantity, etc.) of the current phase. + Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. """ start_date: NotRequired["int|Literal['now']"] """ @@ -287,7 +287,7 @@ class SubscriptionScheduleModifyParamsPhaseAddInvoiceItem(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ period: NotRequired[ "SubscriptionScheduleModifyParamsPhaseAddInvoiceItemPeriod" @@ -303,7 +303,7 @@ class SubscriptionScheduleModifyParamsPhaseAddInvoiceItem(TypedDict): "SubscriptionScheduleModifyParamsPhaseAddInvoiceItemPriceData" ] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: NotRequired[int] """ @@ -376,7 +376,7 @@ class SubscriptionScheduleModifyParamsPhaseAddInvoiceItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -492,7 +492,7 @@ class SubscriptionScheduleModifyParamsPhaseItem(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/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] """ @@ -506,7 +506,7 @@ class SubscriptionScheduleModifyParamsPhaseItem(TypedDict): "SubscriptionScheduleModifyParamsPhaseItemPriceData" ] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. """ quantity: NotRequired[int] """ @@ -514,14 +514,14 @@ class SubscriptionScheduleModifyParamsPhaseItem(TypedDict): """ tax_rates: NotRequired["Literal['']|List[str]"] """ - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. """ class SubscriptionScheduleModifyParamsPhaseItemBillingThresholds(TypedDict): usage_gte: int """ - Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) """ @@ -555,7 +555,7 @@ class SubscriptionScheduleModifyParamsPhaseItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ diff --git a/stripe/params/_subscription_schedule_update_params.py b/stripe/params/_subscription_schedule_update_params.py index 165534710..4427a0bbf 100644 --- a/stripe/params/_subscription_schedule_update_params.py +++ b/stripe/params/_subscription_schedule_update_params.py @@ -21,7 +21,7 @@ class SubscriptionScheduleUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ phases: NotRequired[List["SubscriptionScheduleUpdateParamsPhase"]] """ @@ -48,7 +48,7 @@ class SubscriptionScheduleUpdateParamsDefaultSettings(TypedDict): """ 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). + 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://docs.stripe.com/billing/subscriptions/billing-cycle). """ billing_thresholds: NotRequired[ "Literal['']|SubscriptionScheduleUpdateParamsDefaultSettingsBillingThresholds" @@ -189,7 +189,7 @@ class SubscriptionScheduleUpdateParamsPhase(TypedDict): """ 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). + 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://docs.stripe.com/billing/subscriptions/billing-cycle). """ billing_thresholds: NotRequired[ "Literal['']|SubscriptionScheduleUpdateParamsPhaseBillingThresholds" @@ -213,7 +213,7 @@ class SubscriptionScheduleUpdateParamsPhase(TypedDict): """ default_tax_rates: NotRequired["Literal['']|List[str]"] """ - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase. + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase. """ description: NotRequired["Literal['']|str"] """ @@ -231,7 +231,7 @@ class SubscriptionScheduleUpdateParamsPhase(TypedDict): """ end_date: NotRequired["int|Literal['now']"] """ - The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set. + The date at which this phase of the subscription schedule ends. If set, `duration` must not be set. """ invoice_settings: NotRequired[ "SubscriptionScheduleUpdateParamsPhaseInvoiceSettings" @@ -245,7 +245,7 @@ class SubscriptionScheduleUpdateParamsPhase(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/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] """ @@ -255,7 +255,7 @@ class SubscriptionScheduleUpdateParamsPhase(TypedDict): Literal["always_invoice", "create_prorations", "none"] ] """ - Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. 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 (item price, quantity, etc.) of the current phase. + Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. """ start_date: NotRequired["int|Literal['now']"] """ @@ -286,7 +286,7 @@ class SubscriptionScheduleUpdateParamsPhaseAddInvoiceItem(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ period: NotRequired[ "SubscriptionScheduleUpdateParamsPhaseAddInvoiceItemPeriod" @@ -302,7 +302,7 @@ class SubscriptionScheduleUpdateParamsPhaseAddInvoiceItem(TypedDict): "SubscriptionScheduleUpdateParamsPhaseAddInvoiceItemPriceData" ] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: NotRequired[int] """ @@ -375,7 +375,7 @@ class SubscriptionScheduleUpdateParamsPhaseAddInvoiceItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -491,7 +491,7 @@ class SubscriptionScheduleUpdateParamsPhaseItem(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/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] """ @@ -505,7 +505,7 @@ class SubscriptionScheduleUpdateParamsPhaseItem(TypedDict): "SubscriptionScheduleUpdateParamsPhaseItemPriceData" ] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. """ quantity: NotRequired[int] """ @@ -513,14 +513,14 @@ class SubscriptionScheduleUpdateParamsPhaseItem(TypedDict): """ tax_rates: NotRequired["Literal['']|List[str]"] """ - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. """ class SubscriptionScheduleUpdateParamsPhaseItemBillingThresholds(TypedDict): usage_gte: int """ - Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) """ @@ -554,7 +554,7 @@ class SubscriptionScheduleUpdateParamsPhaseItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ diff --git a/stripe/params/_subscription_search_params.py b/stripe/params/_subscription_search_params.py index 7930e586c..7dcd112d4 100644 --- a/stripe/params/_subscription_search_params.py +++ b/stripe/params/_subscription_search_params.py @@ -20,5 +20,5 @@ class SubscriptionSearchParams(RequestOptions): """ query: str """ - The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions). + The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for subscriptions](https://docs.stripe.com/search#query-fields-for-subscriptions). """ diff --git a/stripe/params/_subscription_update_params.py b/stripe/params/_subscription_update_params.py index 66201f21a..3fe0aeecf 100644 --- a/stripe/params/_subscription_update_params.py +++ b/stripe/params/_subscription_update_params.py @@ -21,7 +21,7 @@ class SubscriptionUpdateParams(TypedDict): """ 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). + 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://docs.stripe.com/billing/subscriptions/billing-cycle). """ billing_thresholds: NotRequired[ "Literal['']|SubscriptionUpdateParamsBillingThresholds" @@ -57,11 +57,11 @@ class SubscriptionUpdateParams(TypedDict): """ 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). + 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://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). """ default_source: NotRequired["Literal['']|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). + 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://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). """ default_tax_rates: NotRequired["Literal['']|List[str]"] """ @@ -91,7 +91,7 @@ class SubscriptionUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ off_session: NotRequired[bool] """ @@ -105,7 +105,7 @@ class SubscriptionUpdateParams(TypedDict): "Literal['']|SubscriptionUpdateParamsPauseCollection" ] """ - 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/docs/billing/subscriptions/pause-payment). + 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://docs.stripe.com/billing/subscriptions/pause-payment). """ payment_behavior: NotRequired[ Literal[ @@ -116,11 +116,11 @@ class SubscriptionUpdateParams(TypedDict): ] ] """ - 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. + 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://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. - Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. + Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. - Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). + Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). 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://docs.stripe.com/changelog/2019-03-14) to learn more. """ @@ -132,13 +132,13 @@ class SubscriptionUpdateParams(TypedDict): "Literal['']|SubscriptionUpdateParamsPendingInvoiceItemInterval" ] """ - Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. + Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval. """ proration_behavior: NotRequired[ 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`. + Determines how to handle [prorations](https://docs.stripe.com/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] """ @@ -156,7 +156,7 @@ class SubscriptionUpdateParams(TypedDict): """ 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. + 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://docs.stripe.com/billing/subscriptions/trials) to learn more. """ trial_settings: NotRequired["SubscriptionUpdateParamsTrialSettings"] """ @@ -173,7 +173,7 @@ class SubscriptionUpdateParamsAddInvoiceItem(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ period: NotRequired["SubscriptionUpdateParamsAddInvoiceItemPeriod"] """ @@ -185,7 +185,7 @@ class SubscriptionUpdateParamsAddInvoiceItem(TypedDict): """ price_data: NotRequired["SubscriptionUpdateParamsAddInvoiceItemPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: NotRequired[int] """ @@ -256,7 +256,7 @@ class SubscriptionUpdateParamsAddInvoiceItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -378,7 +378,7 @@ class SubscriptionUpdateParamsItem(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ plan: NotRequired[str] """ @@ -390,7 +390,7 @@ class SubscriptionUpdateParamsItem(TypedDict): """ price_data: NotRequired["SubscriptionUpdateParamsItemPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: NotRequired[int] """ @@ -398,14 +398,14 @@ class SubscriptionUpdateParamsItem(TypedDict): """ tax_rates: NotRequired["Literal['']|List[str]"] """ - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. """ class SubscriptionUpdateParamsItemBillingThresholds(TypedDict): usage_gte: int """ - Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) """ @@ -439,7 +439,7 @@ class SubscriptionUpdateParamsItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -481,7 +481,7 @@ class SubscriptionUpdateParamsPaymentSettings(TypedDict): Payment-method-specific configuration to provide to invoices created by the subscription. """ payment_method_types: NotRequired[ - "Literal['']|List[Literal['ach_credit_transfer', 'ach_debit', 'acss_debit', 'affirm', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'boleto', 'card', 'cashapp', 'crypto', 'custom', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'jp_credit_transfer', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'link', 'multibanco', 'naver_pay', 'nz_bank_account', 'p24', 'payco', 'paynow', 'paypal', 'promptpay', 'revolut_pay', 'sepa_credit_transfer', 'sepa_debit', 'sofort', 'swish', 'us_bank_account', 'wechat_pay']]" + "Literal['']|List[Literal['ach_credit_transfer', 'ach_debit', 'acss_debit', 'affirm', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'boleto', 'card', 'cashapp', 'crypto', 'custom', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'jp_credit_transfer', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'link', 'multibanco', 'naver_pay', 'nz_bank_account', 'p24', 'payco', 'paynow', 'paypal', 'payto', 'promptpay', 'revolut_pay', 'sepa_credit_transfer', 'sepa_debit', 'sofort', 'swish', 'us_bank_account', 'wechat_pay']]" ] """ 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). Should not be specified with payment_method_configuration @@ -523,6 +523,12 @@ class SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptions(TypedDict): """ This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent. """ + payto: NotRequired[ + "Literal['']|SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsPayto" + ] + """ + This sub-hash contains details about the PayTo payment method options to pass to the invoice's PaymentIntent. + """ sepa_debit: NotRequired[ "Literal['']|SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsSepaDebit" ] @@ -605,7 +611,7 @@ class SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsCard( 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. + 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ @@ -671,6 +677,44 @@ class SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsKonbini( pass +class SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsPayto( + TypedDict, +): + mandate_options: NotRequired[ + "SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions" + ] + """ + Additional fields for Mandate creation. + """ + + +class SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsPaytoMandateOptions( + TypedDict, +): + amount: NotRequired[int] + """ + The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit. + """ + purpose: NotRequired[ + Literal[ + "dependant_support", + "government", + "loan", + "mortgage", + "other", + "pension", + "personal", + "retail", + "salary", + "tax", + "utility", + ] + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + + class SubscriptionUpdateParamsPaymentSettingsPaymentMethodOptionsSepaDebit( TypedDict, ): diff --git a/stripe/params/_tax_id_create_params.py b/stripe/params/_tax_id_create_params.py index 9cd1071d8..fffda28d7 100644 --- a/stripe/params/_tax_id_create_params.py +++ b/stripe/params/_tax_id_create_params.py @@ -138,12 +138,16 @@ class TaxIdCreateParams(RequestOptions): class TaxIdCreateParamsOwner(TypedDict): account: NotRequired[str] """ - Account the tax ID belongs to. Required when `type=account` + Connected Account the tax ID belongs to. Required when `type=account` """ customer: NotRequired[str] """ Customer the tax ID belongs to. Required when `type=customer` """ + customer_account: NotRequired[str] + """ + ID of the Account representing the customer that the tax ID belongs to. Can be used in place of `customer` when `type=customer` + """ type: Literal["account", "application", "customer", "self"] """ Type of owner referenced. diff --git a/stripe/params/_tax_id_list_params.py b/stripe/params/_tax_id_list_params.py index 9c841c25c..7c30b8178 100644 --- a/stripe/params/_tax_id_list_params.py +++ b/stripe/params/_tax_id_list_params.py @@ -31,12 +31,16 @@ class TaxIdListParams(RequestOptions): class TaxIdListParamsOwner(TypedDict): account: NotRequired[str] """ - Account the tax ID belongs to. Required when `type=account` + Connected Account the tax ID belongs to. Required when `type=account` """ customer: NotRequired[str] """ Customer the tax ID belongs to. Required when `type=customer` """ + customer_account: NotRequired[str] + """ + ID of the Account representing the customer that the tax ID belongs to. Can be used in place of `customer` when `type=customer` + """ type: Literal["account", "application", "customer", "self"] """ Type of owner referenced. diff --git a/stripe/params/_tax_rate_create_params.py b/stripe/params/_tax_rate_create_params.py index e92785e0c..d8ebf03af 100644 --- a/stripe/params/_tax_rate_create_params.py +++ b/stripe/params/_tax_rate_create_params.py @@ -36,7 +36,7 @@ class TaxRateCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ percentage: float """ diff --git a/stripe/params/_tax_rate_modify_params.py b/stripe/params/_tax_rate_modify_params.py index 04473b12d..571215003 100644 --- a/stripe/params/_tax_rate_modify_params.py +++ b/stripe/params/_tax_rate_modify_params.py @@ -32,7 +32,7 @@ class TaxRateModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ state: NotRequired[str] """ diff --git a/stripe/params/_tax_rate_update_params.py b/stripe/params/_tax_rate_update_params.py index c049176ad..0e887e9b7 100644 --- a/stripe/params/_tax_rate_update_params.py +++ b/stripe/params/_tax_rate_update_params.py @@ -31,7 +31,7 @@ class TaxRateUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ state: NotRequired[str] """ diff --git a/stripe/params/_token_create_params.py b/stripe/params/_token_create_params.py index 658dc00b0..e66b44517 100644 --- a/stripe/params/_token_create_params.py +++ b/stripe/params/_token_create_params.py @@ -20,7 +20,7 @@ class TokenCreateParams(RequestOptions): """ 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). + 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://docs.stripe.com/connect/standard-accounts) or [Stripe-Account header](https://docs.stripe.com/connect/authentication). Learn more about [cloning saved payment methods](https://docs.stripe.com/connect/cloning-saved-payment-methods). """ cvc_update: NotRequired["TokenCreateParamsCvcUpdate"] """ @@ -195,7 +195,7 @@ class TokenCreateParamsAccountCompanyAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -333,11 +333,11 @@ class TokenCreateParamsAccountCompanyVerification(TypedDict): class TokenCreateParamsAccountCompanyVerificationDocument(TypedDict): 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. + The back of a document returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of a document returned by a [file upload](https://api.stripe.com#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. """ @@ -410,7 +410,7 @@ class TokenCreateParamsAccountIndividual(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ phone: NotRequired[str] """ @@ -463,7 +463,7 @@ class TokenCreateParamsAccountIndividualAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -567,7 +567,7 @@ class TokenCreateParamsAccountIndividualRegisteredAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -614,22 +614,22 @@ class TokenCreateParamsAccountIndividualVerificationAdditionalDocument( ): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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 TokenCreateParamsAccountIndividualVerificationDocument(TypedDict): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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. """ @@ -656,7 +656,7 @@ class TokenCreateParamsBankAccount(TypedDict): """ 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) + The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](https://docs.stripe.com/payouts) """ payment_method: NotRequired[str] """ @@ -814,7 +814,7 @@ class TokenCreateParamsPerson(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ nationality: NotRequired[str] """ @@ -897,7 +897,7 @@ class TokenCreateParamsPersonAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -998,21 +998,21 @@ class TokenCreateParamsPersonDocuments(TypedDict): class TokenCreateParamsPersonDocumentsCompanyAuthorization(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class TokenCreateParamsPersonDocumentsPassport(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ class TokenCreateParamsPersonDocumentsVisa(TypedDict): 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`. + One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`. """ @@ -1039,7 +1039,7 @@ class TokenCreateParamsPersonRegisteredAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -1174,22 +1174,22 @@ class TokenCreateParamsPersonVerification(TypedDict): class TokenCreateParamsPersonVerificationAdditionalDocument(TypedDict): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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 TokenCreateParamsPersonVerificationDocument(TypedDict): 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. + The back of an ID returned by a [file upload](https://api.stripe.com#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] """ - 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. + The front of an ID returned by a [file upload](https://api.stripe.com#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/params/_topup_create_params.py b/stripe/params/_topup_create_params.py index e7d682ace..69eea27ce 100644 --- a/stripe/params/_topup_create_params.py +++ b/stripe/params/_topup_create_params.py @@ -24,11 +24,11 @@ class TopupCreateParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ 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)). + 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://docs.stripe.com/connect/testing#testing-top-ups)). """ statement_descriptor: NotRequired[str] """ diff --git a/stripe/params/_topup_modify_params.py b/stripe/params/_topup_modify_params.py index 1886a84fc..66e5b1473 100644 --- a/stripe/params/_topup_modify_params.py +++ b/stripe/params/_topup_modify_params.py @@ -16,5 +16,5 @@ class TopupModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_topup_update_params.py b/stripe/params/_topup_update_params.py index e4f803fda..66e2b8dfe 100644 --- a/stripe/params/_topup_update_params.py +++ b/stripe/params/_topup_update_params.py @@ -15,5 +15,5 @@ class TopupUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_transfer_create_params.py b/stripe/params/_transfer_create_params.py index b2fb8d596..95dea8f91 100644 --- a/stripe/params/_transfer_create_params.py +++ b/stripe/params/_transfer_create_params.py @@ -28,11 +28,11 @@ class TransferCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ 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. + 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://docs.stripe.com/connect/separate-charges-and-transfers#transfer-availability) for details. """ source_type: NotRequired[Literal["bank_account", "card", "fpx"]] """ @@ -40,5 +40,5 @@ class TransferCreateParams(RequestOptions): """ 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. + A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. """ diff --git a/stripe/params/_transfer_create_reversal_params.py b/stripe/params/_transfer_create_reversal_params.py index e59069fd1..3bed8eed3 100644 --- a/stripe/params/_transfer_create_reversal_params.py +++ b/stripe/params/_transfer_create_reversal_params.py @@ -20,7 +20,7 @@ class TransferCreateReversalParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ refund_application_fee: NotRequired[bool] """ diff --git a/stripe/params/_transfer_modify_params.py b/stripe/params/_transfer_modify_params.py index bfee1cecb..a3aeb4c9f 100644 --- a/stripe/params/_transfer_modify_params.py +++ b/stripe/params/_transfer_modify_params.py @@ -16,5 +16,5 @@ class TransferModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_transfer_modify_reversal_params.py b/stripe/params/_transfer_modify_reversal_params.py index ab2b0d271..d7c223e5b 100644 --- a/stripe/params/_transfer_modify_reversal_params.py +++ b/stripe/params/_transfer_modify_reversal_params.py @@ -12,5 +12,5 @@ class TransferModifyReversalParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_transfer_reversal_create_params.py b/stripe/params/_transfer_reversal_create_params.py index 50268c857..17e623dd1 100644 --- a/stripe/params/_transfer_reversal_create_params.py +++ b/stripe/params/_transfer_reversal_create_params.py @@ -19,7 +19,7 @@ class TransferReversalCreateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ refund_application_fee: NotRequired[bool] """ diff --git a/stripe/params/_transfer_reversal_update_params.py b/stripe/params/_transfer_reversal_update_params.py index aebe79cc1..503053b6c 100644 --- a/stripe/params/_transfer_reversal_update_params.py +++ b/stripe/params/_transfer_reversal_update_params.py @@ -11,5 +11,5 @@ class TransferReversalUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_transfer_update_params.py b/stripe/params/_transfer_update_params.py index 4d0452546..7363dcab7 100644 --- a/stripe/params/_transfer_update_params.py +++ b/stripe/params/_transfer_update_params.py @@ -15,5 +15,5 @@ class TransferUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/_webhook_endpoint_create_params.py b/stripe/params/_webhook_endpoint_create_params.py index a5a2d51a6..2b49034a0 100644 --- a/stripe/params/_webhook_endpoint_create_params.py +++ b/stripe/params/_webhook_endpoint_create_params.py @@ -126,6 +126,8 @@ class WebhookEndpointCreateParams(RequestOptions): "2025-09-30.clover", "2025-10-29.clover", "2025-11-17.clover", + "2025-12-15.clover", + "2026-01-28.clover", ] ] """ @@ -406,7 +408,7 @@ class WebhookEndpointCreateParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ url: str """ diff --git a/stripe/params/_webhook_endpoint_modify_params.py b/stripe/params/_webhook_endpoint_modify_params.py index 7562179e3..66fa34971 100644 --- a/stripe/params/_webhook_endpoint_modify_params.py +++ b/stripe/params/_webhook_endpoint_modify_params.py @@ -283,7 +283,7 @@ class WebhookEndpointModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ url: NotRequired[str] """ diff --git a/stripe/params/_webhook_endpoint_update_params.py b/stripe/params/_webhook_endpoint_update_params.py index a784019ea..ce676a54a 100644 --- a/stripe/params/_webhook_endpoint_update_params.py +++ b/stripe/params/_webhook_endpoint_update_params.py @@ -282,7 +282,7 @@ class WebhookEndpointUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ url: NotRequired[str] """ diff --git a/stripe/params/billing/_credit_balance_summary_retrieve_params.py b/stripe/params/billing/_credit_balance_summary_retrieve_params.py index 83568bdef..a5ea1a65a 100644 --- a/stripe/params/billing/_credit_balance_summary_retrieve_params.py +++ b/stripe/params/billing/_credit_balance_summary_retrieve_params.py @@ -6,9 +6,13 @@ class CreditBalanceSummaryRetrieveParams(RequestOptions): - customer: str + customer: NotRequired[str] """ - The customer for which to fetch credit balance summary. + The customer whose credit balance summary you're retrieving. + """ + customer_account: NotRequired[str] + """ + The account representing the customer whose credit balance summary you're retrieving. """ expand: NotRequired[List[str]] """ diff --git a/stripe/params/billing/_credit_balance_transaction_list_params.py b/stripe/params/billing/_credit_balance_transaction_list_params.py index 2a61839ef..9550b2860 100644 --- a/stripe/params/billing/_credit_balance_transaction_list_params.py +++ b/stripe/params/billing/_credit_balance_transaction_list_params.py @@ -10,9 +10,13 @@ class CreditBalanceTransactionListParams(RequestOptions): """ The credit grant for which to fetch credit balance transactions. """ - customer: str + customer: NotRequired[str] """ - The customer for which to fetch credit balance transactions. + The customer whose credit balance transactions you're retrieving. + """ + customer_account: NotRequired[str] + """ + The account representing the customer whose credit balance transactions you're retrieving. """ ending_before: NotRequired[str] """ diff --git a/stripe/params/billing/_credit_grant_create_params.py b/stripe/params/billing/_credit_grant_create_params.py index 2b30b24b4..bab9f9ff4 100644 --- a/stripe/params/billing/_credit_grant_create_params.py +++ b/stripe/params/billing/_credit_grant_create_params.py @@ -18,9 +18,13 @@ class CreditGrantCreateParams(RequestOptions): """ The category of this credit grant. It defaults to `paid` if not specified. """ - customer: str + customer: NotRequired[str] """ - ID of the customer to receive the billing credits. + ID of the customer receiving the billing credits. + """ + customer_account: NotRequired[str] + """ + ID of the account representing the customer receiving the billing credits. """ effective_at: NotRequired[int] """ diff --git a/stripe/params/billing/_credit_grant_list_params.py b/stripe/params/billing/_credit_grant_list_params.py index bf8ab6d0c..fc2a1cbba 100644 --- a/stripe/params/billing/_credit_grant_list_params.py +++ b/stripe/params/billing/_credit_grant_list_params.py @@ -10,6 +10,10 @@ class CreditGrantListParams(RequestOptions): """ Only return credit grants for this customer. """ + customer_account: NotRequired[str] + """ + Only return credit grants for this account representing the customer. + """ ending_before: NotRequired[str] """ A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. diff --git a/stripe/params/billing/_meter_event_create_params.py b/stripe/params/billing/_meter_event_create_params.py index 6a65963e3..98bfec24d 100644 --- a/stripe/params/billing/_meter_event_create_params.py +++ b/stripe/params/billing/_meter_event_create_params.py @@ -20,7 +20,7 @@ class MeterEventCreateParams(RequestOptions): """ payload: Dict[str, str] """ - The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). + The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/meters/configure#meter-configuration-attributes). """ timestamp: NotRequired[int] """ diff --git a/stripe/params/billing_portal/_configuration_create_params.py b/stripe/params/billing_portal/_configuration_create_params.py index 1265f59ac..6c68c9c7b 100644 --- a/stripe/params/billing_portal/_configuration_create_params.py +++ b/stripe/params/billing_portal/_configuration_create_params.py @@ -12,7 +12,7 @@ class ConfigurationCreateParams(RequestOptions): """ default_return_url: NotRequired["Literal['']|str"] """ - 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. + 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://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. """ expand: NotRequired[List[str]] """ @@ -28,7 +28,7 @@ class ConfigurationCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired["Literal['']|str"] """ @@ -166,6 +166,10 @@ class ConfigurationCreateParamsFeaturesSubscriptionCancelCancellationReason( class ConfigurationCreateParamsFeaturesSubscriptionUpdate(TypedDict): + billing_cycle_anchor: NotRequired[Literal["now", "unchanged"]] + """ + Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `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://docs.stripe.com/billing/subscriptions/billing-cycle). + """ default_allowed_updates: NotRequired[ "Literal['']|List[Literal['price', 'promotion_code', 'quantity']]" ] @@ -259,5 +263,5 @@ class ConfigurationCreateParamsFeaturesSubscriptionUpdateScheduleAtPeriodEndCond class ConfigurationCreateParamsLoginPage(TypedDict): enabled: bool """ - Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal. + Set to `true` to generate a shareable URL [`login_page.url`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal. """ diff --git a/stripe/params/billing_portal/_configuration_modify_params.py b/stripe/params/billing_portal/_configuration_modify_params.py index 72cbf435c..7f2f3439c 100644 --- a/stripe/params/billing_portal/_configuration_modify_params.py +++ b/stripe/params/billing_portal/_configuration_modify_params.py @@ -16,7 +16,7 @@ class ConfigurationModifyParams(RequestOptions): """ default_return_url: NotRequired["Literal['']|str"] """ - 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. + 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://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. """ expand: NotRequired[List[str]] """ @@ -32,7 +32,7 @@ class ConfigurationModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired["Literal['']|str"] """ @@ -158,6 +158,10 @@ class ConfigurationModifyParamsFeaturesSubscriptionCancelCancellationReason( class ConfigurationModifyParamsFeaturesSubscriptionUpdate(TypedDict): + billing_cycle_anchor: NotRequired[Literal["now", "unchanged"]] + """ + Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `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://docs.stripe.com/billing/subscriptions/billing-cycle). + """ default_allowed_updates: NotRequired[ "Literal['']|List[Literal['price', 'promotion_code', 'quantity']]" ] @@ -249,7 +253,7 @@ class ConfigurationModifyParamsFeaturesSubscriptionUpdateScheduleAtPeriodEndCond class ConfigurationModifyParamsLoginPage(TypedDict): enabled: bool """ - Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal. + Set to `true` to generate a shareable URL [`login_page.url`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal. Set to `false` to deactivate the `login_page.url`. """ diff --git a/stripe/params/billing_portal/_configuration_update_params.py b/stripe/params/billing_portal/_configuration_update_params.py index 084ad54b6..7e605f1ec 100644 --- a/stripe/params/billing_portal/_configuration_update_params.py +++ b/stripe/params/billing_portal/_configuration_update_params.py @@ -15,7 +15,7 @@ class ConfigurationUpdateParams(TypedDict): """ default_return_url: NotRequired["Literal['']|str"] """ - 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. + 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://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. """ expand: NotRequired[List[str]] """ @@ -31,7 +31,7 @@ class ConfigurationUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired["Literal['']|str"] """ @@ -157,6 +157,10 @@ class ConfigurationUpdateParamsFeaturesSubscriptionCancelCancellationReason( class ConfigurationUpdateParamsFeaturesSubscriptionUpdate(TypedDict): + billing_cycle_anchor: NotRequired[Literal["now", "unchanged"]] + """ + Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `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://docs.stripe.com/billing/subscriptions/billing-cycle). + """ default_allowed_updates: NotRequired[ "Literal['']|List[Literal['price', 'promotion_code', 'quantity']]" ] @@ -248,7 +252,7 @@ class ConfigurationUpdateParamsFeaturesSubscriptionUpdateScheduleAtPeriodEndCond class ConfigurationUpdateParamsLoginPage(TypedDict): enabled: bool """ - Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal. + Set to `true` to generate a shareable URL [`login_page.url`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal. Set to `false` to deactivate the `login_page.url`. """ diff --git a/stripe/params/billing_portal/_session_create_params.py b/stripe/params/billing_portal/_session_create_params.py index f16942ae6..be54d2a44 100644 --- a/stripe/params/billing_portal/_session_create_params.py +++ b/stripe/params/billing_portal/_session_create_params.py @@ -8,19 +8,23 @@ class SessionCreateParams(RequestOptions): 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. + The ID of an existing [configuration](https://docs.stripe.com/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. """ - customer: str + customer: NotRequired[str] """ The ID of an existing customer. """ + customer_account: NotRequired[str] + """ + The ID of an existing account. + """ expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. """ flow_data: NotRequired["SessionCreateParamsFlowData"] """ - 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. + Information about a specific flow for the customer to go through. See the [docs](https://docs.stripe.com/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. """ locale: NotRequired[ Literal[ @@ -78,7 +82,7 @@ class SessionCreateParams(RequestOptions): """ 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#settlement-merchant). 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. + 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://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://docs.stripe.com/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] """ @@ -202,7 +206,7 @@ class SessionCreateParamsFlowDataSubscriptionUpdateConfirm(TypedDict): """ items: List["SessionCreateParamsFlowDataSubscriptionUpdateConfirmItem"] """ - The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable. + The [subscription item](https://docs.stripe.com/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable. """ subscription: str """ @@ -224,13 +228,13 @@ class SessionCreateParamsFlowDataSubscriptionUpdateConfirmDiscount(TypedDict): class SessionCreateParamsFlowDataSubscriptionUpdateConfirmItem(TypedDict): id: str """ - The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated. + The ID of the [subscription item](https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id) to be updated. """ 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). + 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://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). """ quantity: NotRequired[int] """ - [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow. + [Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow. """ diff --git a/stripe/params/checkout/__init__.py b/stripe/params/checkout/__init__.py index 678e8a29e..7a0905661 100644 --- a/stripe/params/checkout/__init__.py +++ b/stripe/params/checkout/__init__.py @@ -92,6 +92,8 @@ SessionCreateParamsPaymentMethodOptionsPayco as SessionCreateParamsPaymentMethodOptionsPayco, SessionCreateParamsPaymentMethodOptionsPaynow as SessionCreateParamsPaymentMethodOptionsPaynow, SessionCreateParamsPaymentMethodOptionsPaypal as SessionCreateParamsPaymentMethodOptionsPaypal, + SessionCreateParamsPaymentMethodOptionsPayto as SessionCreateParamsPaymentMethodOptionsPayto, + SessionCreateParamsPaymentMethodOptionsPaytoMandateOptions as SessionCreateParamsPaymentMethodOptionsPaytoMandateOptions, SessionCreateParamsPaymentMethodOptionsPix as SessionCreateParamsPaymentMethodOptionsPix, SessionCreateParamsPaymentMethodOptionsRevolutPay as SessionCreateParamsPaymentMethodOptionsRevolutPay, SessionCreateParamsPaymentMethodOptionsSamsungPay as SessionCreateParamsPaymentMethodOptionsSamsungPay, @@ -147,6 +149,11 @@ SessionModifyParamsCollectedInformation as SessionModifyParamsCollectedInformation, SessionModifyParamsCollectedInformationShippingDetails as SessionModifyParamsCollectedInformationShippingDetails, SessionModifyParamsCollectedInformationShippingDetailsAddress as SessionModifyParamsCollectedInformationShippingDetailsAddress, + SessionModifyParamsLineItem as SessionModifyParamsLineItem, + SessionModifyParamsLineItemAdjustableQuantity as SessionModifyParamsLineItemAdjustableQuantity, + SessionModifyParamsLineItemPriceData as SessionModifyParamsLineItemPriceData, + SessionModifyParamsLineItemPriceDataProductData as SessionModifyParamsLineItemPriceDataProductData, + SessionModifyParamsLineItemPriceDataRecurring as SessionModifyParamsLineItemPriceDataRecurring, SessionModifyParamsShippingOption as SessionModifyParamsShippingOption, SessionModifyParamsShippingOptionShippingRateData as SessionModifyParamsShippingOptionShippingRateData, SessionModifyParamsShippingOptionShippingRateDataDeliveryEstimate as SessionModifyParamsShippingOptionShippingRateDataDeliveryEstimate, @@ -163,6 +170,11 @@ SessionUpdateParamsCollectedInformation as SessionUpdateParamsCollectedInformation, SessionUpdateParamsCollectedInformationShippingDetails as SessionUpdateParamsCollectedInformationShippingDetails, SessionUpdateParamsCollectedInformationShippingDetailsAddress as SessionUpdateParamsCollectedInformationShippingDetailsAddress, + SessionUpdateParamsLineItem as SessionUpdateParamsLineItem, + SessionUpdateParamsLineItemAdjustableQuantity as SessionUpdateParamsLineItemAdjustableQuantity, + SessionUpdateParamsLineItemPriceData as SessionUpdateParamsLineItemPriceData, + SessionUpdateParamsLineItemPriceDataProductData as SessionUpdateParamsLineItemPriceDataProductData, + SessionUpdateParamsLineItemPriceDataRecurring as SessionUpdateParamsLineItemPriceDataRecurring, SessionUpdateParamsShippingOption as SessionUpdateParamsShippingOption, SessionUpdateParamsShippingOptionShippingRateData as SessionUpdateParamsShippingOptionShippingRateData, SessionUpdateParamsShippingOptionShippingRateDataDeliveryEstimate as SessionUpdateParamsShippingOptionShippingRateDataDeliveryEstimate, @@ -522,6 +534,14 @@ "stripe.params.checkout._session_create_params", False, ), + "SessionCreateParamsPaymentMethodOptionsPayto": ( + "stripe.params.checkout._session_create_params", + False, + ), + "SessionCreateParamsPaymentMethodOptionsPaytoMandateOptions": ( + "stripe.params.checkout._session_create_params", + False, + ), "SessionCreateParamsPaymentMethodOptionsPix": ( "stripe.params.checkout._session_create_params", False, @@ -702,6 +722,26 @@ "stripe.params.checkout._session_modify_params", False, ), + "SessionModifyParamsLineItem": ( + "stripe.params.checkout._session_modify_params", + False, + ), + "SessionModifyParamsLineItemAdjustableQuantity": ( + "stripe.params.checkout._session_modify_params", + False, + ), + "SessionModifyParamsLineItemPriceData": ( + "stripe.params.checkout._session_modify_params", + False, + ), + "SessionModifyParamsLineItemPriceDataProductData": ( + "stripe.params.checkout._session_modify_params", + False, + ), + "SessionModifyParamsLineItemPriceDataRecurring": ( + "stripe.params.checkout._session_modify_params", + False, + ), "SessionModifyParamsShippingOption": ( "stripe.params.checkout._session_modify_params", False, @@ -750,6 +790,26 @@ "stripe.params.checkout._session_update_params", False, ), + "SessionUpdateParamsLineItem": ( + "stripe.params.checkout._session_update_params", + False, + ), + "SessionUpdateParamsLineItemAdjustableQuantity": ( + "stripe.params.checkout._session_update_params", + False, + ), + "SessionUpdateParamsLineItemPriceData": ( + "stripe.params.checkout._session_update_params", + False, + ), + "SessionUpdateParamsLineItemPriceDataProductData": ( + "stripe.params.checkout._session_update_params", + False, + ), + "SessionUpdateParamsLineItemPriceDataRecurring": ( + "stripe.params.checkout._session_update_params", + False, + ), "SessionUpdateParamsShippingOption": ( "stripe.params.checkout._session_update_params", False, diff --git a/stripe/params/checkout/_session_create_params.py b/stripe/params/checkout/_session_create_params.py index 73bd78a29..5598d804f 100644 --- a/stripe/params/checkout/_session_create_params.py +++ b/stripe/params/checkout/_session_create_params.py @@ -60,24 +60,28 @@ class SessionCreateParams(RequestOptions): """ 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 - on the Checkout page. In `subscription` mode, the customer's [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) + on the Checkout page. In `subscription` mode, the customer's [default payment method](https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method) will be used if it's a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details. - If the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout. + If the Customer already has a valid [email](https://docs.stripe.com/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout. If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer. If blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow. - 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. + You can set [`payment_intent_data.setup_future_usage`](https://docs.stripe.com/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_account: NotRequired[str] + """ + ID of an existing Account, if one exists. Has the same behavior as `customer`. """ customer_creation: NotRequired[Literal["always", "if_required"]] """ - Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation. + Configure whether a Checkout Session creates a [Customer](https://docs.stripe.com/api/customers) during Session confirmation. When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout - with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details). + with [customer_details](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-customer_details). - Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers) + Sessions that don't create Customers instead are grouped by [guest customers](https://docs.stripe.com/payments/checkout/guest-customers) in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions. Can only be set in `payment` and `setup` mode. @@ -137,6 +141,7 @@ class SessionCreateParams(RequestOptions): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -169,7 +174,7 @@ class SessionCreateParams(RequestOptions): """ line_items: NotRequired[List["SessionCreateParamsLineItem"]] """ - A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). The parameter is required for `payment` and `subscription` mode. + A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices). The parameter is required for `payment` and `subscription` mode. For `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen. @@ -225,7 +230,7 @@ class SessionCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ mode: NotRequired[Literal["payment", "setup", "subscription"]] """ @@ -237,11 +242,11 @@ class SessionCreateParams(RequestOptions): You can configure Checkout to collect your customers' business names, individual names, or both. Each name field can be either required or optional. - If a [Customer](https://stripe.com/docs/api/customers) is created or provided, the names can be saved to the Customer object as well. + If a [Customer](https://docs.stripe.com/api/customers) is created or provided, the names can be saved to the Customer object as well. """ optional_items: NotRequired[List["SessionCreateParamsOptionalItem"]] """ - A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). + A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices). There is a maximum of 10 optional items allowed on a Checkout Session, and the existing limits on the number of line items allowed on a Checkout Session apply to the combined number of line items and optional items. @@ -264,7 +269,7 @@ class SessionCreateParams(RequestOptions): Can only be set in `subscription` mode. Defaults to `always`. - 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). + 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://docs.stripe.com/payments/checkout/free-trials). """ payment_method_configuration: NotRequired[str] """ @@ -320,6 +325,7 @@ class SessionCreateParams(RequestOptions): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -339,7 +345,7 @@ class SessionCreateParams(RequestOptions): A list of the types of payment methods (e.g., `card`) this Checkout Session can accept. You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). - See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details. + See [Dynamic Payment Methods](https://docs.stripe.com/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details. Read more about the supported payment methods and their requirements in our [payment method details guide](https://docs.stripe.com/docs/payments/checkout/payment-methods). @@ -361,13 +367,13 @@ class SessionCreateParams(RequestOptions): Controls phone number collection settings for the session. We recommend that you review your privacy policy and check with your legal contacts - before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers). + before using this feature. Learn more about [collecting phone numbers with Checkout](https://docs.stripe.com/payments/checkout/phone-numbers). """ redirect_on_completion: NotRequired[ 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-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. + This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. """ return_url: NotRequired[str] """ @@ -414,7 +420,7 @@ class SessionCreateParams(RequestOptions): is complete. This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use information from the successful Checkout Session on your page, read the - guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page). + guide on [customizing your success page](https://docs.stripe.com/payments/checkout/custom-success-page). """ tax_id_collection: NotRequired["SessionCreateParamsTaxIdCollection"] """ @@ -787,7 +793,7 @@ class SessionCreateParamsInvoiceCreationInvoiceData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ rendering_options: NotRequired[ "Literal['']|SessionCreateParamsInvoiceCreationInvoiceDataRenderingOptions" @@ -841,15 +847,19 @@ class SessionCreateParamsLineItem(TypedDict): """ 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. + The [tax rates](https://docs.stripe.com/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. + """ + metadata: NotRequired[Dict[str, str]] + """ + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ 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. + The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object. One of `price` or `price_data` is required. """ price_data: NotRequired["SessionCreateParamsLineItemPriceData"] """ - Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. """ quantity: NotRequired[int] """ @@ -857,7 +867,7 @@ class SessionCreateParamsLineItem(TypedDict): """ tax_rates: NotRequired[List[str]] """ - The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item. + The [tax rates](https://docs.stripe.com/api/tax_rates) which apply to this line item. """ @@ -897,7 +907,7 @@ class SessionCreateParamsLineItemPriceData(TypedDict): """ tax_behavior: NotRequired[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. + Only required if a [default tax behavior](https://docs.stripe.com/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] """ @@ -920,7 +930,7 @@ class SessionCreateParamsLineItemPriceDataProductData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: str """ @@ -928,7 +938,7 @@ class SessionCreateParamsLineItemPriceDataProductData(TypedDict): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ unit_label: NotRequired[str] """ @@ -989,7 +999,7 @@ class SessionCreateParamsOptionalItem(TypedDict): """ price: str """ - The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. + The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object. """ quantity: int """ @@ -1015,7 +1025,7 @@ class SessionCreateParamsOptionalItemAdjustableQuantity(TypedDict): class SessionCreateParamsPaymentIntentData(TypedDict): 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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + 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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). """ capture_method: NotRequired[ Literal["automatic", "automatic_async", "manual"] @@ -1029,7 +1039,7 @@ class SessionCreateParamsPaymentIntentData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ on_behalf_of: NotRequired[str] """ @@ -1043,7 +1053,7 @@ class SessionCreateParamsPaymentIntentData(TypedDict): """ 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 + Indicates that you intend to [make future payments](https://docs.stripe.com/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session. When setting this to `on_session`, Checkout will show a notice to the @@ -1083,11 +1093,11 @@ class SessionCreateParamsPaymentIntentData(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). + For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). """ 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. + A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. """ @@ -1137,7 +1147,7 @@ class SessionCreateParamsPaymentIntentDataShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -1311,6 +1321,10 @@ class SessionCreateParamsPaymentMethodOptions(TypedDict): """ contains details about the PayPal payment method options. """ + payto: NotRequired["SessionCreateParamsPaymentMethodOptionsPayto"] + """ + contains details about the PayTo payment method options. + """ pix: NotRequired["SessionCreateParamsPaymentMethodOptionsPix"] """ contains details about the Pix payment method options. @@ -1617,7 +1631,7 @@ class SessionCreateParamsPaymentMethodOptionsCard(TypedDict): 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. + 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ restrictions: NotRequired[ "SessionCreateParamsPaymentMethodOptionsCardRestrictions" @@ -2096,7 +2110,7 @@ class SessionCreateParamsPaymentMethodOptionsPaypal(TypedDict): ] ] """ - [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. + [Preferred locale](https://docs.stripe.com/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to. """ reference: NotRequired[str] """ @@ -2122,6 +2136,60 @@ class SessionCreateParamsPaymentMethodOptionsPaypal(TypedDict): """ +class SessionCreateParamsPaymentMethodOptionsPayto(TypedDict): + mandate_options: NotRequired[ + "SessionCreateParamsPaymentMethodOptionsPaytoMandateOptions" + ] + """ + Additional fields for Mandate creation + """ + setup_future_usage: NotRequired[Literal["none", "off_session"]] + """ + Indicates that you intend to make future payments with this PaymentIntent's payment method. + + If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes. + + If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. + + When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication). + """ + + +class SessionCreateParamsPaymentMethodOptionsPaytoMandateOptions(TypedDict): + amount: NotRequired["Literal['']|int"] + """ + Amount that will be collected. It is required when `amount_type` is `fixed`. + """ + amount_type: NotRequired["Literal['']|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. Defaults to `maximum`. + """ + end_date: NotRequired["Literal['']|str"] + """ + Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. + """ + payment_schedule: NotRequired[ + "Literal['']|Literal['adhoc', 'annual', 'daily', 'fortnightly', 'monthly', 'quarterly', 'semi_annual', 'weekly']" + ] + """ + The periodicity at which payments will be collected. Defaults to `adhoc`. + """ + payments_per_period: NotRequired["Literal['']|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['']|Literal['dependant_support', 'government', 'loan', 'mortgage', 'other', 'pension', 'personal', 'retail', 'salary', 'tax', 'utility']" + ] + """ + The purpose for which payments are made. Has a default value based on your merchant category code. + """ + start_date: NotRequired["Literal['']|str"] + """ + Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. + """ + + class SessionCreateParamsPaymentMethodOptionsPix(TypedDict): amount_includes_iof: NotRequired[Literal["always", "never"]] """ @@ -2354,7 +2422,7 @@ class SessionCreateParamsSetupIntentData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ on_behalf_of: NotRequired[str] """ @@ -2643,7 +2711,7 @@ class SessionCreateParamsShippingOptionShippingRateData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ tax_behavior: NotRequired[Literal["exclusive", "inclusive", "unspecified"]] """ @@ -2651,7 +2719,7 @@ class SessionCreateParamsShippingOptionShippingRateData(TypedDict): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ type: NotRequired[Literal["fixed_amount"]] """ @@ -2758,7 +2826,7 @@ class SessionCreateParamsSubscriptionData(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 the [customer portal](https://stripe.com/docs/customer-management). + for rendering in the [customer portal](https://docs.stripe.com/customer-management). """ invoice_settings: NotRequired[ "SessionCreateParamsSubscriptionDataInvoiceSettings" @@ -2768,7 +2836,7 @@ class SessionCreateParamsSubscriptionData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ on_behalf_of: NotRequired[str] """ diff --git a/stripe/params/checkout/_session_list_params.py b/stripe/params/checkout/_session_list_params.py index cf2a77104..1bd82256d 100644 --- a/stripe/params/checkout/_session_list_params.py +++ b/stripe/params/checkout/_session_list_params.py @@ -14,6 +14,10 @@ class SessionListParams(RequestOptions): """ Only return the Checkout Sessions for the Customer specified. """ + customer_account: NotRequired[str] + """ + Only return the Checkout Sessions for the Account specified. + """ customer_details: NotRequired["SessionListParamsCustomerDetails"] """ Only return the Checkout Sessions for the Customer details specified. diff --git a/stripe/params/checkout/_session_modify_params.py b/stripe/params/checkout/_session_modify_params.py index 8a9fd9036..ee3989f1b 100644 --- a/stripe/params/checkout/_session_modify_params.py +++ b/stripe/params/checkout/_session_modify_params.py @@ -16,9 +16,25 @@ class SessionModifyParams(RequestOptions): """ Specifies which fields in the response should be expanded. """ + line_items: NotRequired[List["SessionModifyParamsLineItem"]] + """ + A list of items the customer is purchasing. + + When updating line items, you must retransmit the entire array of line items. + + To retain an existing line item, specify its `id`. + + To update an existing line item, specify its `id` along with the new values of the fields to update. + + To add a new line item, specify one of `price` or `price_data` and `quantity`. + + To remove an existing line item, omit the line item's ID from the retransmitted array. + + To reorder a line item, specify it at the desired position in the retransmitted array. + """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ shipping_options: NotRequired[ "Literal['']|List[SessionModifyParamsShippingOption]" @@ -71,7 +87,126 @@ class SessionModifyParamsCollectedInformationShippingDetailsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). + """ + + +class SessionModifyParamsLineItem(TypedDict): + adjustable_quantity: NotRequired[ + "SessionModifyParamsLineItemAdjustableQuantity" + ] + """ + When set, provides configuration for this item's quantity to be adjusted by the customer during Checkout. + """ + id: NotRequired[str] + """ + ID of an existing line item. + """ + metadata: NotRequired["Literal['']|Dict[str, str]"] + """ + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + """ + price: NotRequired[str] + """ + The ID of the [Price](https://docs.stripe.com/api/prices). One of `price` or `price_data` is required when creating a new line item. + """ + price_data: NotRequired["SessionModifyParamsLineItemPriceData"] + """ + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required when creating a new line item. + """ + quantity: NotRequired[int] + """ + The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`. + """ + tax_rates: NotRequired["Literal['']|List[str]"] + """ + The [tax rates](https://docs.stripe.com/api/tax_rates) which apply to this line item. + """ + + +class SessionModifyParamsLineItemAdjustableQuantity(TypedDict): + enabled: bool + """ + Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity. + """ + 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] + """ + The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0. + """ + + +class SessionModifyParamsLineItemPriceData(TypedDict): + currency: 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] + """ + The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required. + """ + product_data: NotRequired[ + "SessionModifyParamsLineItemPriceDataProductData" + ] + """ + Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required. + """ + recurring: NotRequired["SessionModifyParamsLineItemPriceDataRecurring"] + """ + The recurring components of a price such as `interval` and `interval_count`. + """ + tax_behavior: NotRequired[Literal["exclusive", "inclusive", "unspecified"]] + """ + Only required if a [default tax behavior](https://docs.stripe.com/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] + """ + 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] + """ + 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 SessionModifyParamsLineItemPriceDataProductData(TypedDict): + 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]] + """ + A list of up to 8 URLs of images for this product, meant to be displayable to the customer. + """ + metadata: NotRequired[Dict[str, str]] + """ + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + """ + name: str + """ + The product's name, meant to be displayable to the customer. + """ + tax_code: NotRequired[str] + """ + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. + """ + 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 SessionModifyParamsLineItemPriceDataRecurring(TypedDict): + interval: Literal["day", "month", "week", "year"] + """ + Specifies billing frequency. Either `day`, `week`, `month` or `year`. + """ + 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). """ @@ -107,7 +242,7 @@ class SessionModifyParamsShippingOptionShippingRateData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ tax_behavior: NotRequired[Literal["exclusive", "inclusive", "unspecified"]] """ @@ -115,7 +250,7 @@ class SessionModifyParamsShippingOptionShippingRateData(TypedDict): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ type: NotRequired[Literal["fixed_amount"]] """ diff --git a/stripe/params/checkout/_session_update_params.py b/stripe/params/checkout/_session_update_params.py index 2b7109590..f0ac3ed7d 100644 --- a/stripe/params/checkout/_session_update_params.py +++ b/stripe/params/checkout/_session_update_params.py @@ -15,9 +15,25 @@ class SessionUpdateParams(TypedDict): """ Specifies which fields in the response should be expanded. """ + line_items: NotRequired[List["SessionUpdateParamsLineItem"]] + """ + A list of items the customer is purchasing. + + When updating line items, you must retransmit the entire array of line items. + + To retain an existing line item, specify its `id`. + + To update an existing line item, specify its `id` along with the new values of the fields to update. + + To add a new line item, specify one of `price` or `price_data` and `quantity`. + + To remove an existing line item, omit the line item's ID from the retransmitted array. + + To reorder a line item, specify it at the desired position in the retransmitted array. + """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ shipping_options: NotRequired[ "Literal['']|List[SessionUpdateParamsShippingOption]" @@ -70,7 +86,126 @@ class SessionUpdateParamsCollectedInformationShippingDetailsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). + """ + + +class SessionUpdateParamsLineItem(TypedDict): + adjustable_quantity: NotRequired[ + "SessionUpdateParamsLineItemAdjustableQuantity" + ] + """ + When set, provides configuration for this item's quantity to be adjusted by the customer during Checkout. + """ + id: NotRequired[str] + """ + ID of an existing line item. + """ + metadata: NotRequired["Literal['']|Dict[str, str]"] + """ + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + """ + price: NotRequired[str] + """ + The ID of the [Price](https://docs.stripe.com/api/prices). One of `price` or `price_data` is required when creating a new line item. + """ + price_data: NotRequired["SessionUpdateParamsLineItemPriceData"] + """ + Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required when creating a new line item. + """ + quantity: NotRequired[int] + """ + The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`. + """ + tax_rates: NotRequired["Literal['']|List[str]"] + """ + The [tax rates](https://docs.stripe.com/api/tax_rates) which apply to this line item. + """ + + +class SessionUpdateParamsLineItemAdjustableQuantity(TypedDict): + enabled: bool + """ + Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity. + """ + 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] + """ + The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0. + """ + + +class SessionUpdateParamsLineItemPriceData(TypedDict): + currency: 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] + """ + The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required. + """ + product_data: NotRequired[ + "SessionUpdateParamsLineItemPriceDataProductData" + ] + """ + Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required. + """ + recurring: NotRequired["SessionUpdateParamsLineItemPriceDataRecurring"] + """ + The recurring components of a price such as `interval` and `interval_count`. + """ + tax_behavior: NotRequired[Literal["exclusive", "inclusive", "unspecified"]] + """ + Only required if a [default tax behavior](https://docs.stripe.com/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] + """ + 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] + """ + 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 SessionUpdateParamsLineItemPriceDataProductData(TypedDict): + 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]] + """ + A list of up to 8 URLs of images for this product, meant to be displayable to the customer. + """ + metadata: NotRequired[Dict[str, str]] + """ + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + """ + name: str + """ + The product's name, meant to be displayable to the customer. + """ + tax_code: NotRequired[str] + """ + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. + """ + 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 SessionUpdateParamsLineItemPriceDataRecurring(TypedDict): + interval: Literal["day", "month", "week", "year"] + """ + Specifies billing frequency. Either `day`, `week`, `month` or `year`. + """ + 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). """ @@ -106,7 +241,7 @@ class SessionUpdateParamsShippingOptionShippingRateData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ tax_behavior: NotRequired[Literal["exclusive", "inclusive", "unspecified"]] """ @@ -114,7 +249,7 @@ class SessionUpdateParamsShippingOptionShippingRateData(TypedDict): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. """ type: NotRequired[Literal["fixed_amount"]] """ diff --git a/stripe/params/climate/_order_create_params.py b/stripe/params/climate/_order_create_params.py index 45ca42955..7f0785799 100644 --- a/stripe/params/climate/_order_create_params.py +++ b/stripe/params/climate/_order_create_params.py @@ -24,7 +24,7 @@ class OrderCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ metric_tons: NotRequired[str] """ diff --git a/stripe/params/climate/_order_modify_params.py b/stripe/params/climate/_order_modify_params.py index af4371473..42b7b43a5 100644 --- a/stripe/params/climate/_order_modify_params.py +++ b/stripe/params/climate/_order_modify_params.py @@ -16,7 +16,7 @@ class OrderModifyParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/climate/_order_update_params.py b/stripe/params/climate/_order_update_params.py index 05a947f03..5776507cf 100644 --- a/stripe/params/climate/_order_update_params.py +++ b/stripe/params/climate/_order_update_params.py @@ -15,7 +15,7 @@ class OrderUpdateParams(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/financial_connections/_account_list_params.py b/stripe/params/financial_connections/_account_list_params.py index d87f6b106..fba9b746c 100644 --- a/stripe/params/financial_connections/_account_list_params.py +++ b/stripe/params/financial_connections/_account_list_params.py @@ -35,9 +35,13 @@ class AccountListParams(RequestOptions): class AccountListParamsAccountHolder(TypedDict): account: NotRequired[str] """ - The ID of the Stripe account whose accounts will be retrieved. + The ID of the Stripe account whose accounts you will retrieve. """ customer: NotRequired[str] """ - The ID of the Stripe customer whose accounts will be retrieved. + The ID of the Stripe customer whose accounts you will retrieve. + """ + customer_account: NotRequired[str] + """ + The ID of the Account representing a customer whose accounts you will retrieve. """ diff --git a/stripe/params/financial_connections/_session_create_params.py b/stripe/params/financial_connections/_session_create_params.py index e1dfd3660..4150e379b 100644 --- a/stripe/params/financial_connections/_session_create_params.py +++ b/stripe/params/financial_connections/_session_create_params.py @@ -41,11 +41,15 @@ class SessionCreateParams(RequestOptions): class SessionCreateParamsAccountHolder(TypedDict): account: NotRequired[str] """ - The ID of the Stripe account whose accounts will be retrieved. Should only be present if `type` is `account`. + The ID of the Stripe account whose accounts you will retrieve. Only available when `type` is `account`. """ customer: NotRequired[str] """ - The ID of the Stripe customer whose accounts will be retrieved. Should only be present if `type` is `customer`. + The ID of the Stripe customer whose accounts you will retrieve. Only available when `type` is `customer`. + """ + customer_account: NotRequired[str] + """ + The ID of Account representing a customer whose accounts you will retrieve. Only available when `type` is `customer`. """ type: Literal["account", "customer"] """ diff --git a/stripe/params/forwarding/_request_create_params.py b/stripe/params/forwarding/_request_create_params.py index e35ebfc51..d507e97ca 100644 --- a/stripe/params/forwarding/_request_create_params.py +++ b/stripe/params/forwarding/_request_create_params.py @@ -12,7 +12,7 @@ class RequestCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ payment_method: str """ diff --git a/stripe/params/identity/_verification_session_create_params.py b/stripe/params/identity/_verification_session_create_params.py index 2c7cc20af..09d7f81be 100644 --- a/stripe/params/identity/_verification_session_create_params.py +++ b/stripe/params/identity/_verification_session_create_params.py @@ -16,7 +16,7 @@ class VerificationSessionCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ options: NotRequired["VerificationSessionCreateParamsOptions"] """ @@ -32,6 +32,10 @@ class VerificationSessionCreateParams(RequestOptions): """ Customer ID """ + related_customer_account: NotRequired[str] + """ + The ID of the Account representing a customer. + """ related_person: NotRequired["VerificationSessionCreateParamsRelatedPerson"] """ Tokens referencing a Person resource and it's associated account. @@ -42,7 +46,7 @@ class VerificationSessionCreateParams(RequestOptions): """ type: NotRequired[Literal["document", "id_number"]] """ - The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`. + The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`. """ verification_flow: NotRequired[str] """ @@ -55,7 +59,7 @@ class VerificationSessionCreateParamsOptions(TypedDict): "Literal['']|VerificationSessionCreateParamsOptionsDocument" ] """ - Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document). + Options that apply to the [document check](https://docs.stripe.com/identity/verification-checks?type=document). """ @@ -68,7 +72,7 @@ class VerificationSessionCreateParamsOptionsDocument(TypedDict): """ 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. + Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document's extracted name and date of birth. """ require_live_capture: NotRequired[bool] """ @@ -76,7 +80,7 @@ class VerificationSessionCreateParamsOptionsDocument(TypedDict): """ 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). + Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://docs.stripe.com/identity/selfie). """ diff --git a/stripe/params/identity/_verification_session_list_params.py b/stripe/params/identity/_verification_session_list_params.py index 6bd462214..3ca5ee030 100644 --- a/stripe/params/identity/_verification_session_list_params.py +++ b/stripe/params/identity/_verification_session_list_params.py @@ -27,6 +27,13 @@ class VerificationSessionListParams(RequestOptions): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. """ related_customer: NotRequired[str] + """ + Customer ID + """ + related_customer_account: NotRequired[str] + """ + The ID of the Account representing a customer. + """ 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. @@ -35,7 +42,7 @@ class VerificationSessionListParams(RequestOptions): 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). + Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work). """ diff --git a/stripe/params/identity/_verification_session_modify_params.py b/stripe/params/identity/_verification_session_modify_params.py index ec4fb2c11..e306a8dd7 100644 --- a/stripe/params/identity/_verification_session_modify_params.py +++ b/stripe/params/identity/_verification_session_modify_params.py @@ -12,7 +12,7 @@ class VerificationSessionModifyParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ options: NotRequired["VerificationSessionModifyParamsOptions"] """ @@ -26,7 +26,7 @@ class VerificationSessionModifyParams(RequestOptions): """ type: NotRequired[Literal["document", "id_number"]] """ - The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. + The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed. """ @@ -35,7 +35,7 @@ class VerificationSessionModifyParamsOptions(TypedDict): "Literal['']|VerificationSessionModifyParamsOptionsDocument" ] """ - Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document). + Options that apply to the [document check](https://docs.stripe.com/identity/verification-checks?type=document). """ @@ -48,7 +48,7 @@ class VerificationSessionModifyParamsOptionsDocument(TypedDict): """ 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. + Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document's extracted name and date of birth. """ require_live_capture: NotRequired[bool] """ @@ -56,7 +56,7 @@ class VerificationSessionModifyParamsOptionsDocument(TypedDict): """ 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). + Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://docs.stripe.com/identity/selfie). """ diff --git a/stripe/params/identity/_verification_session_update_params.py b/stripe/params/identity/_verification_session_update_params.py index 6fe2b7271..67b8788c9 100644 --- a/stripe/params/identity/_verification_session_update_params.py +++ b/stripe/params/identity/_verification_session_update_params.py @@ -11,7 +11,7 @@ class VerificationSessionUpdateParams(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ options: NotRequired["VerificationSessionUpdateParamsOptions"] """ @@ -25,7 +25,7 @@ class VerificationSessionUpdateParams(TypedDict): """ type: NotRequired[Literal["document", "id_number"]] """ - The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. + The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed. """ @@ -34,7 +34,7 @@ class VerificationSessionUpdateParamsOptions(TypedDict): "Literal['']|VerificationSessionUpdateParamsOptionsDocument" ] """ - Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document). + Options that apply to the [document check](https://docs.stripe.com/identity/verification-checks?type=document). """ @@ -47,7 +47,7 @@ class VerificationSessionUpdateParamsOptionsDocument(TypedDict): """ 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. + Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document's extracted name and date of birth. """ require_live_capture: NotRequired[bool] """ @@ -55,7 +55,7 @@ class VerificationSessionUpdateParamsOptionsDocument(TypedDict): """ 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). + Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://docs.stripe.com/identity/selfie). """ diff --git a/stripe/params/issuing/_authorization_approve_params.py b/stripe/params/issuing/_authorization_approve_params.py index f21d353f1..0f7655163 100644 --- a/stripe/params/issuing/_authorization_approve_params.py +++ b/stripe/params/issuing/_authorization_approve_params.py @@ -8,7 +8,7 @@ class AuthorizationApproveParams(RequestOptions): 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). + 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://docs.stripe.com/api/issuing/authorizations/decline) to decline an authorization request). """ expand: NotRequired[List[str]] """ @@ -16,5 +16,5 @@ class AuthorizationApproveParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/issuing/_authorization_capture_params.py b/stripe/params/issuing/_authorization_capture_params.py index 79049f779..ceb709ffc 100644 --- a/stripe/params/issuing/_authorization_capture_params.py +++ b/stripe/params/issuing/_authorization_capture_params.py @@ -8,7 +8,7 @@ class AuthorizationCaptureParams(RequestOptions): 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). + 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://docs.stripe.com/currencies#zero-decimal). """ close_authorization: NotRequired[bool] """ diff --git a/stripe/params/issuing/_authorization_create_params.py b/stripe/params/issuing/_authorization_create_params.py index 606a10552..c20825cd5 100644 --- a/stripe/params/issuing/_authorization_create_params.py +++ b/stripe/params/issuing/_authorization_create_params.py @@ -8,11 +8,11 @@ class AuthorizationCreateParams(RequestOptions): amount: NotRequired[int] """ - The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ amount_details: NotRequired["AuthorizationCreateParamsAmountDetails"] """ - Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ authorization_method: NotRequired[ Literal["chip", "contactless", "keyed_in", "online", "swipe"] @@ -48,11 +48,11 @@ class AuthorizationCreateParams(RequestOptions): """ 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. + If set `true`, you may provide [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. """ merchant_amount: NotRequired[int] """ - The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ merchant_currency: NotRequired[str] """ @@ -527,7 +527,7 @@ class AuthorizationCreateParamsMerchantData(TypedDict): ] ] """ - 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. + A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values. """ city: NotRequired[str] """ diff --git a/stripe/params/issuing/_authorization_decline_params.py b/stripe/params/issuing/_authorization_decline_params.py index d746a8a1c..39e8881fe 100644 --- a/stripe/params/issuing/_authorization_decline_params.py +++ b/stripe/params/issuing/_authorization_decline_params.py @@ -12,5 +12,5 @@ class AuthorizationDeclineParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/issuing/_authorization_finalize_amount_params.py b/stripe/params/issuing/_authorization_finalize_amount_params.py index a15604fa9..64b9053a9 100644 --- a/stripe/params/issuing/_authorization_finalize_amount_params.py +++ b/stripe/params/issuing/_authorization_finalize_amount_params.py @@ -12,7 +12,7 @@ class AuthorizationFinalizeAmountParams(RequestOptions): """ final_amount: int """ - The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ fleet: NotRequired["AuthorizationFinalizeAmountParamsFleet"] """ diff --git a/stripe/params/issuing/_authorization_increment_params.py b/stripe/params/issuing/_authorization_increment_params.py index 30fe7ede7..176e543f8 100644 --- a/stripe/params/issuing/_authorization_increment_params.py +++ b/stripe/params/issuing/_authorization_increment_params.py @@ -12,9 +12,9 @@ class AuthorizationIncrementParams(RequestOptions): """ increment_amount: int """ - 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). + The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ 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. + If set `true`, you may provide [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. """ diff --git a/stripe/params/issuing/_authorization_modify_params.py b/stripe/params/issuing/_authorization_modify_params.py index af0629823..070ecb9a5 100644 --- a/stripe/params/issuing/_authorization_modify_params.py +++ b/stripe/params/issuing/_authorization_modify_params.py @@ -12,5 +12,5 @@ class AuthorizationModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/issuing/_authorization_reverse_params.py b/stripe/params/issuing/_authorization_reverse_params.py index 5788d84fd..7ca44d5f5 100644 --- a/stripe/params/issuing/_authorization_reverse_params.py +++ b/stripe/params/issuing/_authorization_reverse_params.py @@ -12,5 +12,5 @@ class AuthorizationReverseParams(RequestOptions): """ 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). + 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://docs.stripe.com/currencies#zero-decimal). """ diff --git a/stripe/params/issuing/_authorization_update_params.py b/stripe/params/issuing/_authorization_update_params.py index 6734372bf..09d270108 100644 --- a/stripe/params/issuing/_authorization_update_params.py +++ b/stripe/params/issuing/_authorization_update_params.py @@ -11,5 +11,5 @@ class AuthorizationUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/issuing/_card_create_params.py b/stripe/params/issuing/_card_create_params.py index 6b5059c9a..ed8b0c5b1 100644 --- a/stripe/params/issuing/_card_create_params.py +++ b/stripe/params/issuing/_card_create_params.py @@ -8,7 +8,7 @@ class CardCreateParams(RequestOptions): cardholder: NotRequired[str] """ - The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated. + The [Cardholder](https://docs.stripe.com/api#issuing_cardholder_object) object with which the card will be associated. """ currency: str """ @@ -32,7 +32,7 @@ class CardCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ personalization_design: NotRequired[str] """ @@ -62,7 +62,7 @@ class CardCreateParams(RequestOptions): """ spending_controls: NotRequired["CardCreateParamsSpendingControls"] """ - Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. + Rules that control spending for this card. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. """ status: NotRequired[Literal["active", "inactive"]] """ @@ -141,7 +141,7 @@ class CardCreateParamsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -464,7 +464,7 @@ class CardCreateParamsSpendingControls(TypedDict): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ allowed_merchant_countries: NotRequired[List[str]] """ @@ -772,7 +772,7 @@ class CardCreateParamsSpendingControls(TypedDict): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ blocked_merchant_countries: NotRequired[List[str]] """ @@ -1093,7 +1093,7 @@ class CardCreateParamsSpendingControlsSpendingLimit(TypedDict): ] ] """ - 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. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. """ interval: Literal[ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" diff --git a/stripe/params/issuing/_card_modify_params.py b/stripe/params/issuing/_card_modify_params.py index f635f349d..0cd14eaab 100644 --- a/stripe/params/issuing/_card_modify_params.py +++ b/stripe/params/issuing/_card_modify_params.py @@ -16,7 +16,7 @@ class CardModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ personalization_design: NotRequired[str] pin: NotRequired["CardModifyParamsPin"] @@ -29,7 +29,7 @@ class CardModifyParams(RequestOptions): """ spending_controls: NotRequired["CardModifyParamsSpendingControls"] """ - Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. + Rules that control spending for this card. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. """ status: NotRequired[Literal["active", "canceled", "inactive"]] """ @@ -104,7 +104,7 @@ class CardModifyParamsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -427,7 +427,7 @@ class CardModifyParamsSpendingControls(TypedDict): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ allowed_merchant_countries: NotRequired[List[str]] """ @@ -735,7 +735,7 @@ class CardModifyParamsSpendingControls(TypedDict): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ blocked_merchant_countries: NotRequired[List[str]] """ @@ -1056,7 +1056,7 @@ class CardModifyParamsSpendingControlsSpendingLimit(TypedDict): ] ] """ - 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. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. """ interval: Literal[ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" diff --git a/stripe/params/issuing/_card_update_params.py b/stripe/params/issuing/_card_update_params.py index 74a6a9d98..9bb5bef56 100644 --- a/stripe/params/issuing/_card_update_params.py +++ b/stripe/params/issuing/_card_update_params.py @@ -15,7 +15,7 @@ class CardUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ personalization_design: NotRequired[str] pin: NotRequired["CardUpdateParamsPin"] @@ -28,7 +28,7 @@ class CardUpdateParams(TypedDict): """ spending_controls: NotRequired["CardUpdateParamsSpendingControls"] """ - Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. + Rules that control spending for this card. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. """ status: NotRequired[Literal["active", "canceled", "inactive"]] """ @@ -103,7 +103,7 @@ class CardUpdateParamsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -426,7 +426,7 @@ class CardUpdateParamsSpendingControls(TypedDict): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ allowed_merchant_countries: NotRequired[List[str]] """ @@ -734,7 +734,7 @@ class CardUpdateParamsSpendingControls(TypedDict): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ blocked_merchant_countries: NotRequired[List[str]] """ @@ -1055,7 +1055,7 @@ class CardUpdateParamsSpendingControlsSpendingLimit(TypedDict): ] ] """ - 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. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. """ interval: Literal[ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" diff --git a/stripe/params/issuing/_cardholder_create_params.py b/stripe/params/issuing/_cardholder_create_params.py index a5caa9e09..83fa12c91 100644 --- a/stripe/params/issuing/_cardholder_create_params.py +++ b/stripe/params/issuing/_cardholder_create_params.py @@ -28,7 +28,7 @@ class CardholderCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: str """ @@ -36,16 +36,16 @@ class CardholderCreateParams(RequestOptions): """ 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. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details. + 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. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details. """ preferred_locales: NotRequired[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`. - This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. + This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder. """ spending_controls: NotRequired["CardholderCreateParamsSpendingControls"] """ - Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. + Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. """ status: NotRequired[Literal["active", "inactive"]] """ @@ -53,7 +53,7 @@ class CardholderCreateParams(RequestOptions): """ 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. + One of `individual` or `company`. See [Choose a cardholder type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details. """ @@ -87,7 +87,7 @@ class CardholderCreateParamsBillingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -174,11 +174,11 @@ class CardholderCreateParamsIndividualVerification(TypedDict): class CardholderCreateParamsIndividualVerificationDocument(TypedDict): 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 back of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. """ 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 front of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. """ @@ -485,7 +485,7 @@ class CardholderCreateParamsSpendingControls(TypedDict): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ allowed_merchant_countries: NotRequired[List[str]] """ @@ -793,7 +793,7 @@ class CardholderCreateParamsSpendingControls(TypedDict): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ blocked_merchant_countries: NotRequired[List[str]] """ @@ -1118,7 +1118,7 @@ class CardholderCreateParamsSpendingControlsSpendingLimit(TypedDict): ] ] """ - 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. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. """ interval: Literal[ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" diff --git a/stripe/params/issuing/_cardholder_modify_params.py b/stripe/params/issuing/_cardholder_modify_params.py index 74bfc8406..d3b0361bb 100644 --- a/stripe/params/issuing/_cardholder_modify_params.py +++ b/stripe/params/issuing/_cardholder_modify_params.py @@ -28,20 +28,20 @@ class CardholderModifyParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ 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. + The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure) for more details. """ preferred_locales: NotRequired[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`. - This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. + This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder. """ spending_controls: NotRequired["CardholderModifyParamsSpendingControls"] """ - Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. + Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. """ status: NotRequired[Literal["active", "inactive"]] """ @@ -79,7 +79,7 @@ class CardholderModifyParamsBillingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -166,11 +166,11 @@ class CardholderModifyParamsIndividualVerification(TypedDict): class CardholderModifyParamsIndividualVerificationDocument(TypedDict): 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 back of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. """ 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 front of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. """ @@ -477,7 +477,7 @@ class CardholderModifyParamsSpendingControls(TypedDict): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ allowed_merchant_countries: NotRequired[List[str]] """ @@ -785,7 +785,7 @@ class CardholderModifyParamsSpendingControls(TypedDict): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ blocked_merchant_countries: NotRequired[List[str]] """ @@ -1110,7 +1110,7 @@ class CardholderModifyParamsSpendingControlsSpendingLimit(TypedDict): ] ] """ - 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. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. """ interval: Literal[ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" diff --git a/stripe/params/issuing/_cardholder_update_params.py b/stripe/params/issuing/_cardholder_update_params.py index ffc9c2898..9e1d6ceae 100644 --- a/stripe/params/issuing/_cardholder_update_params.py +++ b/stripe/params/issuing/_cardholder_update_params.py @@ -27,20 +27,20 @@ class CardholderUpdateParams(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ 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. + The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure) for more details. """ preferred_locales: NotRequired[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`. - This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. + This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder. """ spending_controls: NotRequired["CardholderUpdateParamsSpendingControls"] """ - Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. + Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. """ status: NotRequired[Literal["active", "inactive"]] """ @@ -78,7 +78,7 @@ class CardholderUpdateParamsBillingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -165,11 +165,11 @@ class CardholderUpdateParamsIndividualVerification(TypedDict): class CardholderUpdateParamsIndividualVerificationDocument(TypedDict): 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 back of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. """ 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 front of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. """ @@ -476,7 +476,7 @@ class CardholderUpdateParamsSpendingControls(TypedDict): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. """ allowed_merchant_countries: NotRequired[List[str]] """ @@ -784,7 +784,7 @@ class CardholderUpdateParamsSpendingControls(TypedDict): ] ] """ - 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`. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. """ blocked_merchant_countries: NotRequired[List[str]] """ @@ -1109,7 +1109,7 @@ class CardholderUpdateParamsSpendingControlsSpendingLimit(TypedDict): ] ] """ - 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. + Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. """ interval: Literal[ "all_time", "daily", "monthly", "per_authorization", "weekly", "yearly" diff --git a/stripe/params/issuing/_dispute_create_params.py b/stripe/params/issuing/_dispute_create_params.py index 4fdc92093..c87fa31ed 100644 --- a/stripe/params/issuing/_dispute_create_params.py +++ b/stripe/params/issuing/_dispute_create_params.py @@ -8,7 +8,7 @@ class DisputeCreateParams(RequestOptions): 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. + The dispute amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If not set, defaults to the full transaction amount. """ evidence: NotRequired["DisputeCreateParamsEvidence"] """ @@ -20,7 +20,7 @@ class DisputeCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ transaction: NotRequired[str] """ diff --git a/stripe/params/issuing/_dispute_modify_params.py b/stripe/params/issuing/_dispute_modify_params.py index 2843be9cd..18d947990 100644 --- a/stripe/params/issuing/_dispute_modify_params.py +++ b/stripe/params/issuing/_dispute_modify_params.py @@ -8,7 +8,7 @@ class DisputeModifyParams(RequestOptions): amount: NotRequired[int] """ - The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The dispute amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ evidence: NotRequired["DisputeModifyParamsEvidence"] """ @@ -20,7 +20,7 @@ class DisputeModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/issuing/_dispute_submit_params.py b/stripe/params/issuing/_dispute_submit_params.py index 3f504f2dc..b0484081e 100644 --- a/stripe/params/issuing/_dispute_submit_params.py +++ b/stripe/params/issuing/_dispute_submit_params.py @@ -12,5 +12,5 @@ class DisputeSubmitParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/issuing/_dispute_update_params.py b/stripe/params/issuing/_dispute_update_params.py index 3a7d33188..b9e51d546 100644 --- a/stripe/params/issuing/_dispute_update_params.py +++ b/stripe/params/issuing/_dispute_update_params.py @@ -7,7 +7,7 @@ class DisputeUpdateParams(TypedDict): amount: NotRequired[int] """ - The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The dispute amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ evidence: NotRequired["DisputeUpdateParamsEvidence"] """ @@ -19,7 +19,7 @@ class DisputeUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/issuing/_personalization_design_create_params.py b/stripe/params/issuing/_personalization_design_create_params.py index 39fd71913..235c54aad 100644 --- a/stripe/params/issuing/_personalization_design_create_params.py +++ b/stripe/params/issuing/_personalization_design_create_params.py @@ -24,7 +24,7 @@ class PersonalizationDesignCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired[str] """ diff --git a/stripe/params/issuing/_personalization_design_modify_params.py b/stripe/params/issuing/_personalization_design_modify_params.py index 1c57a9dfc..e2307719e 100644 --- a/stripe/params/issuing/_personalization_design_modify_params.py +++ b/stripe/params/issuing/_personalization_design_modify_params.py @@ -26,7 +26,7 @@ class PersonalizationDesignModifyParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired["Literal['']|str"] """ diff --git a/stripe/params/issuing/_personalization_design_update_params.py b/stripe/params/issuing/_personalization_design_update_params.py index d5f3f57b5..6b18ec7b2 100644 --- a/stripe/params/issuing/_personalization_design_update_params.py +++ b/stripe/params/issuing/_personalization_design_update_params.py @@ -25,7 +25,7 @@ class PersonalizationDesignUpdateParams(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired["Literal['']|str"] """ diff --git a/stripe/params/issuing/_transaction_create_force_capture_params.py b/stripe/params/issuing/_transaction_create_force_capture_params.py index d9f6709a9..c71bcfca7 100644 --- a/stripe/params/issuing/_transaction_create_force_capture_params.py +++ b/stripe/params/issuing/_transaction_create_force_capture_params.py @@ -8,7 +8,7 @@ class TransactionCreateForceCaptureParams(RequestOptions): amount: int """ - The total amount to attempt to capture. 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). + The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ card: str """ @@ -336,7 +336,7 @@ class TransactionCreateForceCaptureParamsMerchantData(TypedDict): ] ] """ - 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. + A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values. """ city: NotRequired[str] """ diff --git a/stripe/params/issuing/_transaction_create_unlinked_refund_params.py b/stripe/params/issuing/_transaction_create_unlinked_refund_params.py index 8a0d378f9..d8d6ef226 100644 --- a/stripe/params/issuing/_transaction_create_unlinked_refund_params.py +++ b/stripe/params/issuing/_transaction_create_unlinked_refund_params.py @@ -8,7 +8,7 @@ class TransactionCreateUnlinkedRefundParams(RequestOptions): amount: 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). + 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://docs.stripe.com/currencies#zero-decimal). """ card: str """ @@ -336,7 +336,7 @@ class TransactionCreateUnlinkedRefundParamsMerchantData(TypedDict): ] ] """ - 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. + A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values. """ city: NotRequired[str] """ diff --git a/stripe/params/issuing/_transaction_modify_params.py b/stripe/params/issuing/_transaction_modify_params.py index ba255b790..bfc9305fb 100644 --- a/stripe/params/issuing/_transaction_modify_params.py +++ b/stripe/params/issuing/_transaction_modify_params.py @@ -12,5 +12,5 @@ class TransactionModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/issuing/_transaction_refund_params.py b/stripe/params/issuing/_transaction_refund_params.py index 0953e1baa..135ec6b26 100644 --- a/stripe/params/issuing/_transaction_refund_params.py +++ b/stripe/params/issuing/_transaction_refund_params.py @@ -12,5 +12,5 @@ class TransactionRefundParams(RequestOptions): """ 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). + 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://docs.stripe.com/currencies#zero-decimal). """ diff --git a/stripe/params/issuing/_transaction_update_params.py b/stripe/params/issuing/_transaction_update_params.py index 8cb955c53..bf4fa27c9 100644 --- a/stripe/params/issuing/_transaction_update_params.py +++ b/stripe/params/issuing/_transaction_update_params.py @@ -11,5 +11,5 @@ class TransactionUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/radar/_value_list_create_params.py b/stripe/params/radar/_value_list_create_params.py index 1299e35db..a91570312 100644 --- a/stripe/params/radar/_value_list_create_params.py +++ b/stripe/params/radar/_value_list_create_params.py @@ -33,7 +33,7 @@ class ValueListCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: str """ diff --git a/stripe/params/radar/_value_list_modify_params.py b/stripe/params/radar/_value_list_modify_params.py index 31a60cbc3..f5b55fffc 100644 --- a/stripe/params/radar/_value_list_modify_params.py +++ b/stripe/params/radar/_value_list_modify_params.py @@ -16,7 +16,7 @@ class ValueListModifyParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired[str] """ diff --git a/stripe/params/radar/_value_list_update_params.py b/stripe/params/radar/_value_list_update_params.py index e8cbd9f18..0cb95a76f 100644 --- a/stripe/params/radar/_value_list_update_params.py +++ b/stripe/params/radar/_value_list_update_params.py @@ -15,7 +15,7 @@ class ValueListUpdateParams(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ name: NotRequired[str] """ diff --git a/stripe/params/reporting/_report_run_create_params.py b/stripe/params/reporting/_report_run_create_params.py index d3f0dabb3..2cbc5af43 100644 --- a/stripe/params/reporting/_report_run_create_params.py +++ b/stripe/params/reporting/_report_run_create_params.py @@ -12,11 +12,11 @@ class ReportRunCreateParams(RequestOptions): """ parameters: NotRequired["ReportRunCreateParamsParameters"] """ - Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/docs/reporting/statements/api) documentation. + Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://docs.stripe.com/reporting/statements/api) documentation. """ report_type: str """ - The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. + The ID of the [report type](https://docs.stripe.com/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. """ diff --git a/stripe/params/tax/_association_find_params.py b/stripe/params/tax/_association_find_params.py index 8da73d00f..8bef40e1e 100644 --- a/stripe/params/tax/_association_find_params.py +++ b/stripe/params/tax/_association_find_params.py @@ -12,5 +12,5 @@ class AssociationFindParams(RequestOptions): """ payment_intent: str """ - Valid [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) id + Valid [PaymentIntent](https://docs.stripe.com/api/payment_intents/object) id """ diff --git a/stripe/params/tax/_calculation_create_params.py b/stripe/params/tax/_calculation_create_params.py index f1815268a..5f6f71166 100644 --- a/stripe/params/tax/_calculation_create_params.py +++ b/stripe/params/tax/_calculation_create_params.py @@ -217,12 +217,12 @@ class CalculationCreateParamsCustomerDetailsTaxId(TypedDict): class CalculationCreateParamsLineItem(TypedDict): amount: int """ - A positive integer representing the line item's total price in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + A positive integer representing the line item's total price in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount. """ 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ product: NotRequired[str] """ @@ -234,7 +234,7 @@ class CalculationCreateParamsLineItem(TypedDict): """ 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). + 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://docs.stripe.com/tax/reports). """ tax_behavior: NotRequired[Literal["exclusive", "inclusive"]] """ @@ -242,7 +242,7 @@ class CalculationCreateParamsLineItem(TypedDict): """ 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. + A [tax code](https://docs.stripe.com/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. """ @@ -283,11 +283,11 @@ class CalculationCreateParamsShipFromDetailsAddress(TypedDict): class CalculationCreateParamsShippingCost(TypedDict): 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. + A positive integer in the [smallest currency unit](https://docs.stripe.com/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] """ - 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. + If provided, the [shipping rate](https://docs.stripe.com/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"]] """ @@ -295,5 +295,5 @@ class CalculationCreateParamsShippingCost(TypedDict): """ 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://dashboard.stripe.com/settings/tax) is used. + The [tax code](https://docs.stripe.com/tax/tax-categories) used to calculate tax on shipping. If not provided, the default shipping tax code from your [Tax Settings](https://dashboard.stripe.com/settings/tax) is used. """ diff --git a/stripe/params/tax/_settings_modify_params.py b/stripe/params/tax/_settings_modify_params.py index 52f9780f1..29f661810 100644 --- a/stripe/params/tax/_settings_modify_params.py +++ b/stripe/params/tax/_settings_modify_params.py @@ -29,7 +29,7 @@ class SettingsModifyParamsDefaults(TypedDict): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ diff --git a/stripe/params/tax/_settings_update_params.py b/stripe/params/tax/_settings_update_params.py index 1d0bb94a1..af11f83fb 100644 --- a/stripe/params/tax/_settings_update_params.py +++ b/stripe/params/tax/_settings_update_params.py @@ -28,7 +28,7 @@ class SettingsUpdateParamsDefaults(TypedDict): """ tax_code: NotRequired[str] """ - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. """ diff --git a/stripe/params/tax/_transaction_create_from_calculation_params.py b/stripe/params/tax/_transaction_create_from_calculation_params.py index 233bb0f08..1600113d3 100644 --- a/stripe/params/tax/_transaction_create_from_calculation_params.py +++ b/stripe/params/tax/_transaction_create_from_calculation_params.py @@ -16,7 +16,7 @@ class TransactionCreateFromCalculationParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ posted_at: NotRequired[int] """ diff --git a/stripe/params/tax/_transaction_create_reversal_params.py b/stripe/params/tax/_transaction_create_reversal_params.py index a86a4b2cd..48764a84a 100644 --- a/stripe/params/tax/_transaction_create_reversal_params.py +++ b/stripe/params/tax/_transaction_create_reversal_params.py @@ -12,7 +12,7 @@ class TransactionCreateReversalParams(RequestOptions): """ 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. + A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes. """ line_items: NotRequired[List["TransactionCreateReversalParamsLineItem"]] """ @@ -20,7 +20,7 @@ class TransactionCreateReversalParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ mode: Literal["full", "partial"] """ @@ -32,7 +32,7 @@ class TransactionCreateReversalParams(RequestOptions): """ reference: str """ - A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://stripe.com/docs/tax/reports). + A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://docs.stripe.com/tax/reports). """ shipping_cost: NotRequired["TransactionCreateReversalParamsShippingCost"] """ @@ -43,15 +43,15 @@ class TransactionCreateReversalParams(RequestOptions): class TransactionCreateReversalParamsLineItem(TypedDict): amount: int """ - The amount to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. + The amount to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative. """ amount_tax: int """ - The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. + The amount of tax to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative. """ 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ original_line_item: str """ @@ -59,7 +59,7 @@ class TransactionCreateReversalParamsLineItem(TypedDict): """ 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. + The quantity reversed. Appears in [tax exports](https://docs.stripe.com/tax/reports), but does not affect the amount of tax reversed. """ reference: str """ @@ -70,9 +70,9 @@ class TransactionCreateReversalParamsLineItem(TypedDict): class TransactionCreateReversalParamsShippingCost(TypedDict): amount: int """ - The amount to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. + The amount to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative. """ amount_tax: int """ - The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. + The amount of tax to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative. """ diff --git a/stripe/params/terminal/_location_create_params.py b/stripe/params/terminal/_location_create_params.py index 72a484005..31ead0dd5 100644 --- a/stripe/params/terminal/_location_create_params.py +++ b/stripe/params/terminal/_location_create_params.py @@ -40,7 +40,7 @@ class LocationCreateParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ phone: NotRequired[str] """ @@ -71,7 +71,7 @@ class LocationCreateParamsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/terminal/_location_modify_params.py b/stripe/params/terminal/_location_modify_params.py index f4c76e275..c3777b860 100644 --- a/stripe/params/terminal/_location_modify_params.py +++ b/stripe/params/terminal/_location_modify_params.py @@ -40,7 +40,7 @@ class LocationModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ phone: NotRequired["Literal['']|str"] """ @@ -71,7 +71,7 @@ class LocationModifyParamsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/terminal/_location_update_params.py b/stripe/params/terminal/_location_update_params.py index bd0083cbb..07152294c 100644 --- a/stripe/params/terminal/_location_update_params.py +++ b/stripe/params/terminal/_location_update_params.py @@ -39,7 +39,7 @@ class LocationUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ phone: NotRequired["Literal['']|str"] """ @@ -70,7 +70,7 @@ class LocationUpdateParamsAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/terminal/_reader_collect_inputs_params.py b/stripe/params/terminal/_reader_collect_inputs_params.py index e66b3c064..6c2d41c0b 100644 --- a/stripe/params/terminal/_reader_collect_inputs_params.py +++ b/stripe/params/terminal/_reader_collect_inputs_params.py @@ -16,7 +16,7 @@ class ReaderCollectInputsParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/terminal/_reader_create_params.py b/stripe/params/terminal/_reader_create_params.py index 6e6d550d7..d23e8cde1 100644 --- a/stripe/params/terminal/_reader_create_params.py +++ b/stripe/params/terminal/_reader_create_params.py @@ -20,7 +20,7 @@ class ReaderCreateParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ registration_code: str """ diff --git a/stripe/params/terminal/_reader_modify_params.py b/stripe/params/terminal/_reader_modify_params.py index da2d79c97..cd646f7de 100644 --- a/stripe/params/terminal/_reader_modify_params.py +++ b/stripe/params/terminal/_reader_modify_params.py @@ -16,5 +16,5 @@ class ReaderModifyParams(RequestOptions): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/terminal/_reader_refund_payment_params.py b/stripe/params/terminal/_reader_refund_payment_params.py index 9d1a0297c..885659a7e 100644 --- a/stripe/params/terminal/_reader_refund_payment_params.py +++ b/stripe/params/terminal/_reader_refund_payment_params.py @@ -20,7 +20,7 @@ class ReaderRefundPaymentParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ payment_intent: NotRequired[str] """ diff --git a/stripe/params/terminal/_reader_set_reader_display_params.py b/stripe/params/terminal/_reader_set_reader_display_params.py index 448aa8917..6a2f4b0b8 100644 --- a/stripe/params/terminal/_reader_set_reader_display_params.py +++ b/stripe/params/terminal/_reader_set_reader_display_params.py @@ -31,18 +31,18 @@ class ReaderSetReaderDisplayParamsCart(TypedDict): """ tax: NotRequired[int] """ - The amount of tax in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The amount of tax in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ total: int """ - Total balance of cart due in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + Total balance of cart due in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ class ReaderSetReaderDisplayParamsCartLineItem(TypedDict): amount: int """ - The price of the item in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The price of the item in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ description: str """ diff --git a/stripe/params/terminal/_reader_update_params.py b/stripe/params/terminal/_reader_update_params.py index 25b94dc25..fec59172d 100644 --- a/stripe/params/terminal/_reader_update_params.py +++ b/stripe/params/terminal/_reader_update_params.py @@ -15,5 +15,5 @@ class ReaderUpdateParams(TypedDict): """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ diff --git a/stripe/params/test_helpers/__init__.py b/stripe/params/test_helpers/__init__.py index 475021d18..39dc6913e 100644 --- a/stripe/params/test_helpers/__init__.py +++ b/stripe/params/test_helpers/__init__.py @@ -52,6 +52,7 @@ ConfirmationTokenCreateParamsPaymentMethodDataPayco as ConfirmationTokenCreateParamsPaymentMethodDataPayco, ConfirmationTokenCreateParamsPaymentMethodDataPaynow as ConfirmationTokenCreateParamsPaymentMethodDataPaynow, ConfirmationTokenCreateParamsPaymentMethodDataPaypal as ConfirmationTokenCreateParamsPaymentMethodDataPaypal, + ConfirmationTokenCreateParamsPaymentMethodDataPayto as ConfirmationTokenCreateParamsPaymentMethodDataPayto, ConfirmationTokenCreateParamsPaymentMethodDataPix as ConfirmationTokenCreateParamsPaymentMethodDataPix, ConfirmationTokenCreateParamsPaymentMethodDataPromptpay as ConfirmationTokenCreateParamsPaymentMethodDataPromptpay, ConfirmationTokenCreateParamsPaymentMethodDataRadarOptions as ConfirmationTokenCreateParamsPaymentMethodDataRadarOptions, @@ -267,6 +268,10 @@ "stripe.params.test_helpers._confirmation_token_create_params", False, ), + "ConfirmationTokenCreateParamsPaymentMethodDataPayto": ( + "stripe.params.test_helpers._confirmation_token_create_params", + False, + ), "ConfirmationTokenCreateParamsPaymentMethodDataPix": ( "stripe.params.test_helpers._confirmation_token_create_params", False, diff --git a/stripe/params/test_helpers/_confirmation_token_create_params.py b/stripe/params/test_helpers/_confirmation_token_create_params.py index d0a32b6a8..8ea274194 100644 --- a/stripe/params/test_helpers/_confirmation_token_create_params.py +++ b/stripe/params/test_helpers/_confirmation_token_create_params.py @@ -33,7 +33,7 @@ class ConfirmationTokenCreateParams(TypedDict): """ Indicates that you intend to make future payments with this ConfirmationToken's payment method. - The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. + The presence of this property will [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. """ shipping: NotRequired["ConfirmationTokenCreateParamsShipping"] """ @@ -190,7 +190,7 @@ class ConfirmationTokenCreateParamsPaymentMethodData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ mobilepay: NotRequired[ "ConfirmationTokenCreateParamsPaymentMethodDataMobilepay" @@ -242,6 +242,10 @@ class ConfirmationTokenCreateParamsPaymentMethodData(TypedDict): """ If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. """ + payto: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataPayto"] + """ + If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. + """ pix: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataPix"] """ If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. @@ -256,7 +260,7 @@ class ConfirmationTokenCreateParamsPaymentMethodData(TypedDict): "ConfirmationTokenCreateParamsPaymentMethodDataRadarOptions" ] """ - Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. """ revolut_pay: NotRequired[ "ConfirmationTokenCreateParamsPaymentMethodDataRevolutPay" @@ -331,6 +335,7 @@ class ConfirmationTokenCreateParamsPaymentMethodData(TypedDict): "payco", "paynow", "paypal", + "payto", "pix", "promptpay", "revolut_pay", @@ -482,7 +487,7 @@ class ConfirmationTokenCreateParamsPaymentMethodDataBillingDetailsAddress( """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -600,6 +605,7 @@ class ConfirmationTokenCreateParamsPaymentMethodDataIdeal(TypedDict): "handelsbanken", "ing", "knab", + "mollie", "moneyou", "n26", "nn", @@ -758,6 +764,21 @@ class ConfirmationTokenCreateParamsPaymentMethodDataPaypal(TypedDict): pass +class ConfirmationTokenCreateParamsPaymentMethodDataPayto(TypedDict): + account_number: NotRequired[str] + """ + The account number for the bank account. + """ + bsb_number: NotRequired[str] + """ + Bank-State-Branch number of the bank account. + """ + pay_id: NotRequired[str] + """ + The PayID alias for the bank account. + """ + + class ConfirmationTokenCreateParamsPaymentMethodDataPix(TypedDict): pass @@ -769,7 +790,7 @@ class ConfirmationTokenCreateParamsPaymentMethodDataPromptpay(TypedDict): class ConfirmationTokenCreateParamsPaymentMethodDataRadarOptions(TypedDict): 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. + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ @@ -922,5 +943,5 @@ class ConfirmationTokenCreateParamsShippingAddress(TypedDict): """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ diff --git a/stripe/params/test_helpers/_customer_fund_cash_balance_params.py b/stripe/params/test_helpers/_customer_fund_cash_balance_params.py index dde8f3e4a..6ac4948e8 100644 --- a/stripe/params/test_helpers/_customer_fund_cash_balance_params.py +++ b/stripe/params/test_helpers/_customer_fund_cash_balance_params.py @@ -7,7 +7,7 @@ class CustomerFundCashBalanceParams(TypedDict): amount: int """ - Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency). + Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency). """ currency: str """ @@ -19,5 +19,5 @@ class CustomerFundCashBalanceParams(TypedDict): """ 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. + 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://docs.stripe.com/payments/customer-balance/reconciliation) applies to different user inputs. """ diff --git a/stripe/params/test_helpers/issuing/_authorization_capture_params.py b/stripe/params/test_helpers/issuing/_authorization_capture_params.py index a18365064..8902e15aa 100644 --- a/stripe/params/test_helpers/issuing/_authorization_capture_params.py +++ b/stripe/params/test_helpers/issuing/_authorization_capture_params.py @@ -7,7 +7,7 @@ class AuthorizationCaptureParams(TypedDict): 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). + 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://docs.stripe.com/currencies#zero-decimal). """ close_authorization: NotRequired[bool] """ diff --git a/stripe/params/test_helpers/issuing/_authorization_create_params.py b/stripe/params/test_helpers/issuing/_authorization_create_params.py index af7c512c9..92a39a655 100644 --- a/stripe/params/test_helpers/issuing/_authorization_create_params.py +++ b/stripe/params/test_helpers/issuing/_authorization_create_params.py @@ -7,11 +7,11 @@ class AuthorizationCreateParams(TypedDict): amount: NotRequired[int] """ - The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ amount_details: NotRequired["AuthorizationCreateParamsAmountDetails"] """ - Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ authorization_method: NotRequired[ Literal["chip", "contactless", "keyed_in", "online", "swipe"] @@ -47,11 +47,11 @@ class AuthorizationCreateParams(TypedDict): """ 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. + If set `true`, you may provide [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. """ merchant_amount: NotRequired[int] """ - The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ merchant_currency: NotRequired[str] """ @@ -526,7 +526,7 @@ class AuthorizationCreateParamsMerchantData(TypedDict): ] ] """ - 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. + A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values. """ city: NotRequired[str] """ diff --git a/stripe/params/test_helpers/issuing/_authorization_finalize_amount_params.py b/stripe/params/test_helpers/issuing/_authorization_finalize_amount_params.py index 233ee6b26..af6fd8df6 100644 --- a/stripe/params/test_helpers/issuing/_authorization_finalize_amount_params.py +++ b/stripe/params/test_helpers/issuing/_authorization_finalize_amount_params.py @@ -11,7 +11,7 @@ class AuthorizationFinalizeAmountParams(TypedDict): """ final_amount: int """ - The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ fleet: NotRequired["AuthorizationFinalizeAmountParamsFleet"] """ diff --git a/stripe/params/test_helpers/issuing/_authorization_increment_params.py b/stripe/params/test_helpers/issuing/_authorization_increment_params.py index 6190a1399..76c2591aa 100644 --- a/stripe/params/test_helpers/issuing/_authorization_increment_params.py +++ b/stripe/params/test_helpers/issuing/_authorization_increment_params.py @@ -11,9 +11,9 @@ class AuthorizationIncrementParams(TypedDict): """ increment_amount: int """ - 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). + The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ 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. + If set `true`, you may provide [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. """ diff --git a/stripe/params/test_helpers/issuing/_authorization_reverse_params.py b/stripe/params/test_helpers/issuing/_authorization_reverse_params.py index 34241359a..015835de3 100644 --- a/stripe/params/test_helpers/issuing/_authorization_reverse_params.py +++ b/stripe/params/test_helpers/issuing/_authorization_reverse_params.py @@ -11,5 +11,5 @@ class AuthorizationReverseParams(TypedDict): """ 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). + 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://docs.stripe.com/currencies#zero-decimal). """ diff --git a/stripe/params/test_helpers/issuing/_transaction_create_force_capture_params.py b/stripe/params/test_helpers/issuing/_transaction_create_force_capture_params.py index e2818f727..193a40e0a 100644 --- a/stripe/params/test_helpers/issuing/_transaction_create_force_capture_params.py +++ b/stripe/params/test_helpers/issuing/_transaction_create_force_capture_params.py @@ -7,7 +7,7 @@ class TransactionCreateForceCaptureParams(TypedDict): amount: int """ - The total amount to attempt to capture. 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). + The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ card: str """ @@ -335,7 +335,7 @@ class TransactionCreateForceCaptureParamsMerchantData(TypedDict): ] ] """ - 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. + A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values. """ city: NotRequired[str] """ diff --git a/stripe/params/test_helpers/issuing/_transaction_create_unlinked_refund_params.py b/stripe/params/test_helpers/issuing/_transaction_create_unlinked_refund_params.py index 1fa13fae8..4ab81df69 100644 --- a/stripe/params/test_helpers/issuing/_transaction_create_unlinked_refund_params.py +++ b/stripe/params/test_helpers/issuing/_transaction_create_unlinked_refund_params.py @@ -7,7 +7,7 @@ class TransactionCreateUnlinkedRefundParams(TypedDict): amount: 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). + 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://docs.stripe.com/currencies#zero-decimal). """ card: str """ @@ -335,7 +335,7 @@ class TransactionCreateUnlinkedRefundParamsMerchantData(TypedDict): ] ] """ - 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. + A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values. """ city: NotRequired[str] """ diff --git a/stripe/params/test_helpers/issuing/_transaction_refund_params.py b/stripe/params/test_helpers/issuing/_transaction_refund_params.py index d488f1d6a..05ab847e9 100644 --- a/stripe/params/test_helpers/issuing/_transaction_refund_params.py +++ b/stripe/params/test_helpers/issuing/_transaction_refund_params.py @@ -11,5 +11,5 @@ class TransactionRefundParams(TypedDict): """ 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). + 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://docs.stripe.com/currencies#zero-decimal). """ diff --git a/stripe/params/test_helpers/treasury/_received_credit_create_params.py b/stripe/params/test_helpers/treasury/_received_credit_create_params.py index 674ef687d..ebb70060d 100644 --- a/stripe/params/test_helpers/treasury/_received_credit_create_params.py +++ b/stripe/params/test_helpers/treasury/_received_credit_create_params.py @@ -33,7 +33,7 @@ class ReceivedCreditCreateParams(TypedDict): """ network: 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. + Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. """ diff --git a/stripe/params/test_helpers/treasury/_received_debit_create_params.py b/stripe/params/test_helpers/treasury/_received_debit_create_params.py index c7b138238..3ba648706 100644 --- a/stripe/params/test_helpers/treasury/_received_debit_create_params.py +++ b/stripe/params/test_helpers/treasury/_received_debit_create_params.py @@ -33,7 +33,7 @@ class ReceivedDebitCreateParams(TypedDict): """ network: Literal["ach"] """ - 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. + Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. """ diff --git a/stripe/params/treasury/_credit_reversal_create_params.py b/stripe/params/treasury/_credit_reversal_create_params.py index 96ad037e2..1326b34da 100644 --- a/stripe/params/treasury/_credit_reversal_create_params.py +++ b/stripe/params/treasury/_credit_reversal_create_params.py @@ -12,7 +12,7 @@ class CreditReversalCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ received_credit: str """ diff --git a/stripe/params/treasury/_debit_reversal_create_params.py b/stripe/params/treasury/_debit_reversal_create_params.py index aa873103c..c3a7e803c 100644 --- a/stripe/params/treasury/_debit_reversal_create_params.py +++ b/stripe/params/treasury/_debit_reversal_create_params.py @@ -12,7 +12,7 @@ class DebitReversalCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ received_debit: str """ diff --git a/stripe/params/treasury/_financial_account_create_params.py b/stripe/params/treasury/_financial_account_create_params.py index f89af2865..db19b90c2 100644 --- a/stripe/params/treasury/_financial_account_create_params.py +++ b/stripe/params/treasury/_financial_account_create_params.py @@ -16,7 +16,7 @@ class FinancialAccountCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ nickname: NotRequired["Literal['']|str"] """ diff --git a/stripe/params/treasury/_financial_account_modify_params.py b/stripe/params/treasury/_financial_account_modify_params.py index 292576858..65d86794c 100644 --- a/stripe/params/treasury/_financial_account_modify_params.py +++ b/stripe/params/treasury/_financial_account_modify_params.py @@ -22,7 +22,7 @@ class FinancialAccountModifyParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ nickname: NotRequired["Literal['']|str"] """ diff --git a/stripe/params/treasury/_financial_account_update_params.py b/stripe/params/treasury/_financial_account_update_params.py index 49fa4276b..fa25425d0 100644 --- a/stripe/params/treasury/_financial_account_update_params.py +++ b/stripe/params/treasury/_financial_account_update_params.py @@ -21,7 +21,7 @@ class FinancialAccountUpdateParams(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ nickname: NotRequired["Literal['']|str"] """ diff --git a/stripe/params/treasury/_inbound_transfer_create_params.py b/stripe/params/treasury/_inbound_transfer_create_params.py index efc92248e..c5bbcd14d 100644 --- a/stripe/params/treasury/_inbound_transfer_create_params.py +++ b/stripe/params/treasury/_inbound_transfer_create_params.py @@ -28,7 +28,7 @@ class InboundTransferCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ origin_payment_method: str """ @@ -36,5 +36,5 @@ class InboundTransferCreateParams(RequestOptions): """ statement_descriptor: NotRequired[str] """ - The complete description that appears on your customers' statements. Maximum 10 characters. + The complete description that appears on your customers' statements. Maximum 10 characters. Can only include -#.$&*, spaces, and alphanumeric characters. """ diff --git a/stripe/params/treasury/_outbound_payment_create_params.py b/stripe/params/treasury/_outbound_payment_create_params.py index 89cdf5685..565364948 100644 --- a/stripe/params/treasury/_outbound_payment_create_params.py +++ b/stripe/params/treasury/_outbound_payment_create_params.py @@ -52,11 +52,11 @@ class OutboundPaymentCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ 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". + 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. Can only include -#.$&*, spaces, and alphanumeric characters. The default value is "payment". """ @@ -73,7 +73,7 @@ class OutboundPaymentCreateParamsDestinationPaymentMethodData(TypedDict): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ type: Literal["financial_account", "us_bank_account"] """ @@ -135,7 +135,7 @@ class OutboundPaymentCreateParamsDestinationPaymentMethodDataBillingDetailsAddre """ state: NotRequired[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ @@ -178,7 +178,7 @@ class OutboundPaymentCreateParamsDestinationPaymentMethodOptionsUsBankAccount( ): 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. + Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. """ diff --git a/stripe/params/treasury/_outbound_transfer_create_params.py b/stripe/params/treasury/_outbound_transfer_create_params.py index 9a4728fa4..6e732e69e 100644 --- a/stripe/params/treasury/_outbound_transfer_create_params.py +++ b/stripe/params/treasury/_outbound_transfer_create_params.py @@ -44,11 +44,11 @@ class OutboundTransferCreateParams(RequestOptions): """ 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`. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ 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". + 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". Can only include -#.$&*, spaces, and alphanumeric characters. """ @@ -77,5 +77,5 @@ class OutboundTransferCreateParamsDestinationPaymentMethodOptionsUsBankAccount( ): 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. + Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. """ diff --git a/stripe/params/treasury/_received_credit_create_params.py b/stripe/params/treasury/_received_credit_create_params.py index 42911f15e..988331248 100644 --- a/stripe/params/treasury/_received_credit_create_params.py +++ b/stripe/params/treasury/_received_credit_create_params.py @@ -34,7 +34,7 @@ class ReceivedCreditCreateParams(RequestOptions): """ network: 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. + Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. """ diff --git a/stripe/params/treasury/_received_debit_create_params.py b/stripe/params/treasury/_received_debit_create_params.py index e5aad3393..a1d8e82d0 100644 --- a/stripe/params/treasury/_received_debit_create_params.py +++ b/stripe/params/treasury/_received_debit_create_params.py @@ -34,7 +34,7 @@ class ReceivedDebitCreateParams(RequestOptions): """ network: Literal["ach"] """ - 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. + Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. """ diff --git a/stripe/params/v2/core/__init__.py b/stripe/params/v2/core/__init__.py index b7c384aa4..9888a38e7 100644 --- a/stripe/params/v2/core/__init__.py +++ b/stripe/params/v2/core/__init__.py @@ -4,6 +4,354 @@ from typing_extensions import TYPE_CHECKING if TYPE_CHECKING: + from stripe.params.v2.core import accounts as accounts + from stripe.params.v2.core._account_close_params import ( + AccountCloseParams as AccountCloseParams, + ) + from stripe.params.v2.core._account_create_params import ( + AccountCreateParams as AccountCreateParams, + AccountCreateParamsConfiguration as AccountCreateParamsConfiguration, + AccountCreateParamsConfigurationCustomer as AccountCreateParamsConfigurationCustomer, + AccountCreateParamsConfigurationCustomerAutomaticIndirectTax as AccountCreateParamsConfigurationCustomerAutomaticIndirectTax, + AccountCreateParamsConfigurationCustomerBilling as AccountCreateParamsConfigurationCustomerBilling, + AccountCreateParamsConfigurationCustomerBillingInvoice as AccountCreateParamsConfigurationCustomerBillingInvoice, + AccountCreateParamsConfigurationCustomerBillingInvoiceCustomField as AccountCreateParamsConfigurationCustomerBillingInvoiceCustomField, + AccountCreateParamsConfigurationCustomerBillingInvoiceRendering as AccountCreateParamsConfigurationCustomerBillingInvoiceRendering, + AccountCreateParamsConfigurationCustomerCapabilities as AccountCreateParamsConfigurationCustomerCapabilities, + AccountCreateParamsConfigurationCustomerCapabilitiesAutomaticIndirectTax as AccountCreateParamsConfigurationCustomerCapabilitiesAutomaticIndirectTax, + AccountCreateParamsConfigurationCustomerShipping as AccountCreateParamsConfigurationCustomerShipping, + AccountCreateParamsConfigurationCustomerShippingAddress as AccountCreateParamsConfigurationCustomerShippingAddress, + AccountCreateParamsConfigurationMerchant as AccountCreateParamsConfigurationMerchant, + AccountCreateParamsConfigurationMerchantBacsDebitPayments as AccountCreateParamsConfigurationMerchantBacsDebitPayments, + AccountCreateParamsConfigurationMerchantBranding as AccountCreateParamsConfigurationMerchantBranding, + AccountCreateParamsConfigurationMerchantCapabilities as AccountCreateParamsConfigurationMerchantCapabilities, + AccountCreateParamsConfigurationMerchantCapabilitiesAchDebitPayments as AccountCreateParamsConfigurationMerchantCapabilitiesAchDebitPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesAcssDebitPayments as AccountCreateParamsConfigurationMerchantCapabilitiesAcssDebitPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesAffirmPayments as AccountCreateParamsConfigurationMerchantCapabilitiesAffirmPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesAfterpayClearpayPayments as AccountCreateParamsConfigurationMerchantCapabilitiesAfterpayClearpayPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesAlmaPayments as AccountCreateParamsConfigurationMerchantCapabilitiesAlmaPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesAmazonPayPayments as AccountCreateParamsConfigurationMerchantCapabilitiesAmazonPayPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesAuBecsDebitPayments as AccountCreateParamsConfigurationMerchantCapabilitiesAuBecsDebitPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesBacsDebitPayments as AccountCreateParamsConfigurationMerchantCapabilitiesBacsDebitPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesBancontactPayments as AccountCreateParamsConfigurationMerchantCapabilitiesBancontactPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesBlikPayments as AccountCreateParamsConfigurationMerchantCapabilitiesBlikPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesBoletoPayments as AccountCreateParamsConfigurationMerchantCapabilitiesBoletoPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesCardPayments as AccountCreateParamsConfigurationMerchantCapabilitiesCardPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesCartesBancairesPayments as AccountCreateParamsConfigurationMerchantCapabilitiesCartesBancairesPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesCashappPayments as AccountCreateParamsConfigurationMerchantCapabilitiesCashappPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesEpsPayments as AccountCreateParamsConfigurationMerchantCapabilitiesEpsPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesFpxPayments as AccountCreateParamsConfigurationMerchantCapabilitiesFpxPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesGbBankTransferPayments as AccountCreateParamsConfigurationMerchantCapabilitiesGbBankTransferPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesGrabpayPayments as AccountCreateParamsConfigurationMerchantCapabilitiesGrabpayPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesIdealPayments as AccountCreateParamsConfigurationMerchantCapabilitiesIdealPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesJcbPayments as AccountCreateParamsConfigurationMerchantCapabilitiesJcbPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesJpBankTransferPayments as AccountCreateParamsConfigurationMerchantCapabilitiesJpBankTransferPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesKakaoPayPayments as AccountCreateParamsConfigurationMerchantCapabilitiesKakaoPayPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesKlarnaPayments as AccountCreateParamsConfigurationMerchantCapabilitiesKlarnaPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesKonbiniPayments as AccountCreateParamsConfigurationMerchantCapabilitiesKonbiniPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesKrCardPayments as AccountCreateParamsConfigurationMerchantCapabilitiesKrCardPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesLinkPayments as AccountCreateParamsConfigurationMerchantCapabilitiesLinkPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesMobilepayPayments as AccountCreateParamsConfigurationMerchantCapabilitiesMobilepayPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesMultibancoPayments as AccountCreateParamsConfigurationMerchantCapabilitiesMultibancoPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesMxBankTransferPayments as AccountCreateParamsConfigurationMerchantCapabilitiesMxBankTransferPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesNaverPayPayments as AccountCreateParamsConfigurationMerchantCapabilitiesNaverPayPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesOxxoPayments as AccountCreateParamsConfigurationMerchantCapabilitiesOxxoPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesP24Payments as AccountCreateParamsConfigurationMerchantCapabilitiesP24Payments, + AccountCreateParamsConfigurationMerchantCapabilitiesPayByBankPayments as AccountCreateParamsConfigurationMerchantCapabilitiesPayByBankPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesPaycoPayments as AccountCreateParamsConfigurationMerchantCapabilitiesPaycoPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesPaynowPayments as AccountCreateParamsConfigurationMerchantCapabilitiesPaynowPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesPromptpayPayments as AccountCreateParamsConfigurationMerchantCapabilitiesPromptpayPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesRevolutPayPayments as AccountCreateParamsConfigurationMerchantCapabilitiesRevolutPayPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesSamsungPayPayments as AccountCreateParamsConfigurationMerchantCapabilitiesSamsungPayPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesSepaBankTransferPayments as AccountCreateParamsConfigurationMerchantCapabilitiesSepaBankTransferPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesSepaDebitPayments as AccountCreateParamsConfigurationMerchantCapabilitiesSepaDebitPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesSwishPayments as AccountCreateParamsConfigurationMerchantCapabilitiesSwishPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesTwintPayments as AccountCreateParamsConfigurationMerchantCapabilitiesTwintPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesUsBankTransferPayments as AccountCreateParamsConfigurationMerchantCapabilitiesUsBankTransferPayments, + AccountCreateParamsConfigurationMerchantCapabilitiesZipPayments as AccountCreateParamsConfigurationMerchantCapabilitiesZipPayments, + AccountCreateParamsConfigurationMerchantCardPayments as AccountCreateParamsConfigurationMerchantCardPayments, + AccountCreateParamsConfigurationMerchantCardPaymentsDeclineOn as AccountCreateParamsConfigurationMerchantCardPaymentsDeclineOn, + AccountCreateParamsConfigurationMerchantKonbiniPayments as AccountCreateParamsConfigurationMerchantKonbiniPayments, + AccountCreateParamsConfigurationMerchantKonbiniPaymentsSupport as AccountCreateParamsConfigurationMerchantKonbiniPaymentsSupport, + AccountCreateParamsConfigurationMerchantKonbiniPaymentsSupportHours as AccountCreateParamsConfigurationMerchantKonbiniPaymentsSupportHours, + AccountCreateParamsConfigurationMerchantScriptStatementDescriptor as AccountCreateParamsConfigurationMerchantScriptStatementDescriptor, + AccountCreateParamsConfigurationMerchantScriptStatementDescriptorKana as AccountCreateParamsConfigurationMerchantScriptStatementDescriptorKana, + AccountCreateParamsConfigurationMerchantScriptStatementDescriptorKanji as AccountCreateParamsConfigurationMerchantScriptStatementDescriptorKanji, + AccountCreateParamsConfigurationMerchantStatementDescriptor as AccountCreateParamsConfigurationMerchantStatementDescriptor, + AccountCreateParamsConfigurationMerchantSupport as AccountCreateParamsConfigurationMerchantSupport, + AccountCreateParamsConfigurationMerchantSupportAddress as AccountCreateParamsConfigurationMerchantSupportAddress, + AccountCreateParamsConfigurationRecipient as AccountCreateParamsConfigurationRecipient, + AccountCreateParamsConfigurationRecipientCapabilities as AccountCreateParamsConfigurationRecipientCapabilities, + AccountCreateParamsConfigurationRecipientCapabilitiesStripeBalance as AccountCreateParamsConfigurationRecipientCapabilitiesStripeBalance, + AccountCreateParamsConfigurationRecipientCapabilitiesStripeBalanceStripeTransfers as AccountCreateParamsConfigurationRecipientCapabilitiesStripeBalanceStripeTransfers, + AccountCreateParamsDefaults as AccountCreateParamsDefaults, + AccountCreateParamsDefaultsProfile as AccountCreateParamsDefaultsProfile, + AccountCreateParamsDefaultsResponsibilities as AccountCreateParamsDefaultsResponsibilities, + AccountCreateParamsIdentity as AccountCreateParamsIdentity, + AccountCreateParamsIdentityAttestations as AccountCreateParamsIdentityAttestations, + AccountCreateParamsIdentityAttestationsDirectorshipDeclaration as AccountCreateParamsIdentityAttestationsDirectorshipDeclaration, + AccountCreateParamsIdentityAttestationsOwnershipDeclaration as AccountCreateParamsIdentityAttestationsOwnershipDeclaration, + AccountCreateParamsIdentityAttestationsPersonsProvided as AccountCreateParamsIdentityAttestationsPersonsProvided, + AccountCreateParamsIdentityAttestationsRepresentativeDeclaration as AccountCreateParamsIdentityAttestationsRepresentativeDeclaration, + AccountCreateParamsIdentityAttestationsTermsOfService as AccountCreateParamsIdentityAttestationsTermsOfService, + AccountCreateParamsIdentityAttestationsTermsOfServiceAccount as AccountCreateParamsIdentityAttestationsTermsOfServiceAccount, + AccountCreateParamsIdentityBusinessDetails as AccountCreateParamsIdentityBusinessDetails, + AccountCreateParamsIdentityBusinessDetailsAddress as AccountCreateParamsIdentityBusinessDetailsAddress, + AccountCreateParamsIdentityBusinessDetailsAnnualRevenue as AccountCreateParamsIdentityBusinessDetailsAnnualRevenue, + AccountCreateParamsIdentityBusinessDetailsAnnualRevenueAmount as AccountCreateParamsIdentityBusinessDetailsAnnualRevenueAmount, + AccountCreateParamsIdentityBusinessDetailsDocuments as AccountCreateParamsIdentityBusinessDetailsDocuments, + AccountCreateParamsIdentityBusinessDetailsDocumentsBankAccountOwnershipVerification as AccountCreateParamsIdentityBusinessDetailsDocumentsBankAccountOwnershipVerification, + AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyLicense as AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyLicense, + AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyMemorandumOfAssociation as AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyMemorandumOfAssociation, + AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyMinisterialDecree as AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyMinisterialDecree, + AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyRegistrationVerification as AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyRegistrationVerification, + AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyTaxIdVerification as AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyTaxIdVerification, + AccountCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerification as AccountCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerification, + AccountCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerificationFrontBack as AccountCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerificationFrontBack, + AccountCreateParamsIdentityBusinessDetailsDocumentsProofOfAddress as AccountCreateParamsIdentityBusinessDetailsDocumentsProofOfAddress, + AccountCreateParamsIdentityBusinessDetailsDocumentsProofOfRegistration as AccountCreateParamsIdentityBusinessDetailsDocumentsProofOfRegistration, + AccountCreateParamsIdentityBusinessDetailsDocumentsProofOfUltimateBeneficialOwnership as AccountCreateParamsIdentityBusinessDetailsDocumentsProofOfUltimateBeneficialOwnership, + AccountCreateParamsIdentityBusinessDetailsIdNumber as AccountCreateParamsIdentityBusinessDetailsIdNumber, + AccountCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenue as AccountCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenue, + AccountCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenueAmount as AccountCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenueAmount, + AccountCreateParamsIdentityBusinessDetailsScriptAddresses as AccountCreateParamsIdentityBusinessDetailsScriptAddresses, + AccountCreateParamsIdentityBusinessDetailsScriptAddressesKana as AccountCreateParamsIdentityBusinessDetailsScriptAddressesKana, + AccountCreateParamsIdentityBusinessDetailsScriptAddressesKanji as AccountCreateParamsIdentityBusinessDetailsScriptAddressesKanji, + AccountCreateParamsIdentityBusinessDetailsScriptNames as AccountCreateParamsIdentityBusinessDetailsScriptNames, + AccountCreateParamsIdentityBusinessDetailsScriptNamesKana as AccountCreateParamsIdentityBusinessDetailsScriptNamesKana, + AccountCreateParamsIdentityBusinessDetailsScriptNamesKanji as AccountCreateParamsIdentityBusinessDetailsScriptNamesKanji, + AccountCreateParamsIdentityIndividual as AccountCreateParamsIdentityIndividual, + AccountCreateParamsIdentityIndividualAdditionalAddress as AccountCreateParamsIdentityIndividualAdditionalAddress, + AccountCreateParamsIdentityIndividualAdditionalName as AccountCreateParamsIdentityIndividualAdditionalName, + AccountCreateParamsIdentityIndividualAddress as AccountCreateParamsIdentityIndividualAddress, + AccountCreateParamsIdentityIndividualDateOfBirth as AccountCreateParamsIdentityIndividualDateOfBirth, + AccountCreateParamsIdentityIndividualDocuments as AccountCreateParamsIdentityIndividualDocuments, + AccountCreateParamsIdentityIndividualDocumentsCompanyAuthorization as AccountCreateParamsIdentityIndividualDocumentsCompanyAuthorization, + AccountCreateParamsIdentityIndividualDocumentsPassport as AccountCreateParamsIdentityIndividualDocumentsPassport, + AccountCreateParamsIdentityIndividualDocumentsPrimaryVerification as AccountCreateParamsIdentityIndividualDocumentsPrimaryVerification, + AccountCreateParamsIdentityIndividualDocumentsPrimaryVerificationFrontBack as AccountCreateParamsIdentityIndividualDocumentsPrimaryVerificationFrontBack, + AccountCreateParamsIdentityIndividualDocumentsSecondaryVerification as AccountCreateParamsIdentityIndividualDocumentsSecondaryVerification, + AccountCreateParamsIdentityIndividualDocumentsSecondaryVerificationFrontBack as AccountCreateParamsIdentityIndividualDocumentsSecondaryVerificationFrontBack, + AccountCreateParamsIdentityIndividualDocumentsVisa as AccountCreateParamsIdentityIndividualDocumentsVisa, + AccountCreateParamsIdentityIndividualIdNumber as AccountCreateParamsIdentityIndividualIdNumber, + AccountCreateParamsIdentityIndividualRelationship as AccountCreateParamsIdentityIndividualRelationship, + AccountCreateParamsIdentityIndividualScriptAddresses as AccountCreateParamsIdentityIndividualScriptAddresses, + AccountCreateParamsIdentityIndividualScriptAddressesKana as AccountCreateParamsIdentityIndividualScriptAddressesKana, + AccountCreateParamsIdentityIndividualScriptAddressesKanji as AccountCreateParamsIdentityIndividualScriptAddressesKanji, + AccountCreateParamsIdentityIndividualScriptNames as AccountCreateParamsIdentityIndividualScriptNames, + AccountCreateParamsIdentityIndividualScriptNamesKana as AccountCreateParamsIdentityIndividualScriptNamesKana, + AccountCreateParamsIdentityIndividualScriptNamesKanji as AccountCreateParamsIdentityIndividualScriptNamesKanji, + ) + from stripe.params.v2.core._account_link_create_params import ( + AccountLinkCreateParams as AccountLinkCreateParams, + AccountLinkCreateParamsUseCase as AccountLinkCreateParamsUseCase, + AccountLinkCreateParamsUseCaseAccountOnboarding as AccountLinkCreateParamsUseCaseAccountOnboarding, + AccountLinkCreateParamsUseCaseAccountOnboardingCollectionOptions as AccountLinkCreateParamsUseCaseAccountOnboardingCollectionOptions, + AccountLinkCreateParamsUseCaseAccountUpdate as AccountLinkCreateParamsUseCaseAccountUpdate, + AccountLinkCreateParamsUseCaseAccountUpdateCollectionOptions as AccountLinkCreateParamsUseCaseAccountUpdateCollectionOptions, + ) + from stripe.params.v2.core._account_list_params import ( + AccountListParams as AccountListParams, + ) + from stripe.params.v2.core._account_retrieve_params import ( + AccountRetrieveParams as AccountRetrieveParams, + ) + from stripe.params.v2.core._account_token_create_params import ( + AccountTokenCreateParams as AccountTokenCreateParams, + AccountTokenCreateParamsIdentity as AccountTokenCreateParamsIdentity, + AccountTokenCreateParamsIdentityAttestations as AccountTokenCreateParamsIdentityAttestations, + AccountTokenCreateParamsIdentityAttestationsDirectorshipDeclaration as AccountTokenCreateParamsIdentityAttestationsDirectorshipDeclaration, + AccountTokenCreateParamsIdentityAttestationsOwnershipDeclaration as AccountTokenCreateParamsIdentityAttestationsOwnershipDeclaration, + AccountTokenCreateParamsIdentityAttestationsPersonsProvided as AccountTokenCreateParamsIdentityAttestationsPersonsProvided, + AccountTokenCreateParamsIdentityAttestationsRepresentativeDeclaration as AccountTokenCreateParamsIdentityAttestationsRepresentativeDeclaration, + AccountTokenCreateParamsIdentityAttestationsTermsOfService as AccountTokenCreateParamsIdentityAttestationsTermsOfService, + AccountTokenCreateParamsIdentityAttestationsTermsOfServiceAccount as AccountTokenCreateParamsIdentityAttestationsTermsOfServiceAccount, + AccountTokenCreateParamsIdentityBusinessDetails as AccountTokenCreateParamsIdentityBusinessDetails, + AccountTokenCreateParamsIdentityBusinessDetailsAddress as AccountTokenCreateParamsIdentityBusinessDetailsAddress, + AccountTokenCreateParamsIdentityBusinessDetailsAnnualRevenue as AccountTokenCreateParamsIdentityBusinessDetailsAnnualRevenue, + AccountTokenCreateParamsIdentityBusinessDetailsAnnualRevenueAmount as AccountTokenCreateParamsIdentityBusinessDetailsAnnualRevenueAmount, + AccountTokenCreateParamsIdentityBusinessDetailsDocuments as AccountTokenCreateParamsIdentityBusinessDetailsDocuments, + AccountTokenCreateParamsIdentityBusinessDetailsDocumentsBankAccountOwnershipVerification as AccountTokenCreateParamsIdentityBusinessDetailsDocumentsBankAccountOwnershipVerification, + AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyLicense as AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyLicense, + AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyMemorandumOfAssociation as AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyMemorandumOfAssociation, + AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyMinisterialDecree as AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyMinisterialDecree, + AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyRegistrationVerification as AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyRegistrationVerification, + AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyTaxIdVerification as AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyTaxIdVerification, + AccountTokenCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerification as AccountTokenCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerification, + AccountTokenCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerificationFrontBack as AccountTokenCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerificationFrontBack, + AccountTokenCreateParamsIdentityBusinessDetailsDocumentsProofOfAddress as AccountTokenCreateParamsIdentityBusinessDetailsDocumentsProofOfAddress, + AccountTokenCreateParamsIdentityBusinessDetailsDocumentsProofOfRegistration as AccountTokenCreateParamsIdentityBusinessDetailsDocumentsProofOfRegistration, + AccountTokenCreateParamsIdentityBusinessDetailsDocumentsProofOfUltimateBeneficialOwnership as AccountTokenCreateParamsIdentityBusinessDetailsDocumentsProofOfUltimateBeneficialOwnership, + AccountTokenCreateParamsIdentityBusinessDetailsIdNumber as AccountTokenCreateParamsIdentityBusinessDetailsIdNumber, + AccountTokenCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenue as AccountTokenCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenue, + AccountTokenCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenueAmount as AccountTokenCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenueAmount, + AccountTokenCreateParamsIdentityBusinessDetailsScriptAddresses as AccountTokenCreateParamsIdentityBusinessDetailsScriptAddresses, + AccountTokenCreateParamsIdentityBusinessDetailsScriptAddressesKana as AccountTokenCreateParamsIdentityBusinessDetailsScriptAddressesKana, + AccountTokenCreateParamsIdentityBusinessDetailsScriptAddressesKanji as AccountTokenCreateParamsIdentityBusinessDetailsScriptAddressesKanji, + AccountTokenCreateParamsIdentityBusinessDetailsScriptNames as AccountTokenCreateParamsIdentityBusinessDetailsScriptNames, + AccountTokenCreateParamsIdentityBusinessDetailsScriptNamesKana as AccountTokenCreateParamsIdentityBusinessDetailsScriptNamesKana, + AccountTokenCreateParamsIdentityBusinessDetailsScriptNamesKanji as AccountTokenCreateParamsIdentityBusinessDetailsScriptNamesKanji, + AccountTokenCreateParamsIdentityIndividual as AccountTokenCreateParamsIdentityIndividual, + AccountTokenCreateParamsIdentityIndividualAdditionalAddress as AccountTokenCreateParamsIdentityIndividualAdditionalAddress, + AccountTokenCreateParamsIdentityIndividualAdditionalName as AccountTokenCreateParamsIdentityIndividualAdditionalName, + AccountTokenCreateParamsIdentityIndividualAddress as AccountTokenCreateParamsIdentityIndividualAddress, + AccountTokenCreateParamsIdentityIndividualDateOfBirth as AccountTokenCreateParamsIdentityIndividualDateOfBirth, + AccountTokenCreateParamsIdentityIndividualDocuments as AccountTokenCreateParamsIdentityIndividualDocuments, + AccountTokenCreateParamsIdentityIndividualDocumentsCompanyAuthorization as AccountTokenCreateParamsIdentityIndividualDocumentsCompanyAuthorization, + AccountTokenCreateParamsIdentityIndividualDocumentsPassport as AccountTokenCreateParamsIdentityIndividualDocumentsPassport, + AccountTokenCreateParamsIdentityIndividualDocumentsPrimaryVerification as AccountTokenCreateParamsIdentityIndividualDocumentsPrimaryVerification, + AccountTokenCreateParamsIdentityIndividualDocumentsPrimaryVerificationFrontBack as AccountTokenCreateParamsIdentityIndividualDocumentsPrimaryVerificationFrontBack, + AccountTokenCreateParamsIdentityIndividualDocumentsSecondaryVerification as AccountTokenCreateParamsIdentityIndividualDocumentsSecondaryVerification, + AccountTokenCreateParamsIdentityIndividualDocumentsSecondaryVerificationFrontBack as AccountTokenCreateParamsIdentityIndividualDocumentsSecondaryVerificationFrontBack, + AccountTokenCreateParamsIdentityIndividualDocumentsVisa as AccountTokenCreateParamsIdentityIndividualDocumentsVisa, + AccountTokenCreateParamsIdentityIndividualIdNumber as AccountTokenCreateParamsIdentityIndividualIdNumber, + AccountTokenCreateParamsIdentityIndividualRelationship as AccountTokenCreateParamsIdentityIndividualRelationship, + AccountTokenCreateParamsIdentityIndividualScriptAddresses as AccountTokenCreateParamsIdentityIndividualScriptAddresses, + AccountTokenCreateParamsIdentityIndividualScriptAddressesKana as AccountTokenCreateParamsIdentityIndividualScriptAddressesKana, + AccountTokenCreateParamsIdentityIndividualScriptAddressesKanji as AccountTokenCreateParamsIdentityIndividualScriptAddressesKanji, + AccountTokenCreateParamsIdentityIndividualScriptNames as AccountTokenCreateParamsIdentityIndividualScriptNames, + AccountTokenCreateParamsIdentityIndividualScriptNamesKana as AccountTokenCreateParamsIdentityIndividualScriptNamesKana, + AccountTokenCreateParamsIdentityIndividualScriptNamesKanji as AccountTokenCreateParamsIdentityIndividualScriptNamesKanji, + ) + from stripe.params.v2.core._account_token_retrieve_params import ( + AccountTokenRetrieveParams as AccountTokenRetrieveParams, + ) + from stripe.params.v2.core._account_update_params import ( + AccountUpdateParams as AccountUpdateParams, + AccountUpdateParamsConfiguration as AccountUpdateParamsConfiguration, + AccountUpdateParamsConfigurationCustomer as AccountUpdateParamsConfigurationCustomer, + AccountUpdateParamsConfigurationCustomerAutomaticIndirectTax as AccountUpdateParamsConfigurationCustomerAutomaticIndirectTax, + AccountUpdateParamsConfigurationCustomerBilling as AccountUpdateParamsConfigurationCustomerBilling, + AccountUpdateParamsConfigurationCustomerBillingInvoice as AccountUpdateParamsConfigurationCustomerBillingInvoice, + AccountUpdateParamsConfigurationCustomerBillingInvoiceCustomField as AccountUpdateParamsConfigurationCustomerBillingInvoiceCustomField, + AccountUpdateParamsConfigurationCustomerBillingInvoiceRendering as AccountUpdateParamsConfigurationCustomerBillingInvoiceRendering, + AccountUpdateParamsConfigurationCustomerCapabilities as AccountUpdateParamsConfigurationCustomerCapabilities, + AccountUpdateParamsConfigurationCustomerCapabilitiesAutomaticIndirectTax as AccountUpdateParamsConfigurationCustomerCapabilitiesAutomaticIndirectTax, + AccountUpdateParamsConfigurationCustomerShipping as AccountUpdateParamsConfigurationCustomerShipping, + AccountUpdateParamsConfigurationCustomerShippingAddress as AccountUpdateParamsConfigurationCustomerShippingAddress, + AccountUpdateParamsConfigurationMerchant as AccountUpdateParamsConfigurationMerchant, + AccountUpdateParamsConfigurationMerchantBacsDebitPayments as AccountUpdateParamsConfigurationMerchantBacsDebitPayments, + AccountUpdateParamsConfigurationMerchantBranding as AccountUpdateParamsConfigurationMerchantBranding, + AccountUpdateParamsConfigurationMerchantCapabilities as AccountUpdateParamsConfigurationMerchantCapabilities, + AccountUpdateParamsConfigurationMerchantCapabilitiesAchDebitPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesAchDebitPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesAcssDebitPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesAcssDebitPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesAffirmPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesAffirmPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesAfterpayClearpayPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesAfterpayClearpayPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesAlmaPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesAlmaPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesAmazonPayPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesAmazonPayPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesAuBecsDebitPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesAuBecsDebitPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesBacsDebitPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesBacsDebitPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesBancontactPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesBancontactPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesBlikPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesBlikPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesBoletoPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesBoletoPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesCardPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesCardPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesCartesBancairesPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesCartesBancairesPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesCashappPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesCashappPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesEpsPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesEpsPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesFpxPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesFpxPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesGbBankTransferPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesGbBankTransferPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesGrabpayPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesGrabpayPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesIdealPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesIdealPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesJcbPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesJcbPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesJpBankTransferPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesJpBankTransferPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesKakaoPayPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesKakaoPayPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesKlarnaPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesKlarnaPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesKonbiniPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesKonbiniPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesKrCardPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesKrCardPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesLinkPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesLinkPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesMobilepayPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesMobilepayPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesMultibancoPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesMultibancoPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesMxBankTransferPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesMxBankTransferPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesNaverPayPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesNaverPayPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesOxxoPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesOxxoPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesP24Payments as AccountUpdateParamsConfigurationMerchantCapabilitiesP24Payments, + AccountUpdateParamsConfigurationMerchantCapabilitiesPayByBankPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesPayByBankPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesPaycoPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesPaycoPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesPaynowPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesPaynowPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesPromptpayPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesPromptpayPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesRevolutPayPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesRevolutPayPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesSamsungPayPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesSamsungPayPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesSepaBankTransferPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesSepaBankTransferPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesSepaDebitPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesSepaDebitPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesSwishPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesSwishPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesTwintPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesTwintPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesUsBankTransferPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesUsBankTransferPayments, + AccountUpdateParamsConfigurationMerchantCapabilitiesZipPayments as AccountUpdateParamsConfigurationMerchantCapabilitiesZipPayments, + AccountUpdateParamsConfigurationMerchantCardPayments as AccountUpdateParamsConfigurationMerchantCardPayments, + AccountUpdateParamsConfigurationMerchantCardPaymentsDeclineOn as AccountUpdateParamsConfigurationMerchantCardPaymentsDeclineOn, + AccountUpdateParamsConfigurationMerchantKonbiniPayments as AccountUpdateParamsConfigurationMerchantKonbiniPayments, + AccountUpdateParamsConfigurationMerchantKonbiniPaymentsSupport as AccountUpdateParamsConfigurationMerchantKonbiniPaymentsSupport, + AccountUpdateParamsConfigurationMerchantKonbiniPaymentsSupportHours as AccountUpdateParamsConfigurationMerchantKonbiniPaymentsSupportHours, + AccountUpdateParamsConfigurationMerchantScriptStatementDescriptor as AccountUpdateParamsConfigurationMerchantScriptStatementDescriptor, + AccountUpdateParamsConfigurationMerchantScriptStatementDescriptorKana as AccountUpdateParamsConfigurationMerchantScriptStatementDescriptorKana, + AccountUpdateParamsConfigurationMerchantScriptStatementDescriptorKanji as AccountUpdateParamsConfigurationMerchantScriptStatementDescriptorKanji, + AccountUpdateParamsConfigurationMerchantStatementDescriptor as AccountUpdateParamsConfigurationMerchantStatementDescriptor, + AccountUpdateParamsConfigurationMerchantSupport as AccountUpdateParamsConfigurationMerchantSupport, + AccountUpdateParamsConfigurationMerchantSupportAddress as AccountUpdateParamsConfigurationMerchantSupportAddress, + AccountUpdateParamsConfigurationRecipient as AccountUpdateParamsConfigurationRecipient, + AccountUpdateParamsConfigurationRecipientCapabilities as AccountUpdateParamsConfigurationRecipientCapabilities, + AccountUpdateParamsConfigurationRecipientCapabilitiesStripeBalance as AccountUpdateParamsConfigurationRecipientCapabilitiesStripeBalance, + AccountUpdateParamsConfigurationRecipientCapabilitiesStripeBalanceStripeTransfers as AccountUpdateParamsConfigurationRecipientCapabilitiesStripeBalanceStripeTransfers, + AccountUpdateParamsDefaults as AccountUpdateParamsDefaults, + AccountUpdateParamsDefaultsProfile as AccountUpdateParamsDefaultsProfile, + AccountUpdateParamsDefaultsResponsibilities as AccountUpdateParamsDefaultsResponsibilities, + AccountUpdateParamsIdentity as AccountUpdateParamsIdentity, + AccountUpdateParamsIdentityAttestations as AccountUpdateParamsIdentityAttestations, + AccountUpdateParamsIdentityAttestationsDirectorshipDeclaration as AccountUpdateParamsIdentityAttestationsDirectorshipDeclaration, + AccountUpdateParamsIdentityAttestationsOwnershipDeclaration as AccountUpdateParamsIdentityAttestationsOwnershipDeclaration, + AccountUpdateParamsIdentityAttestationsPersonsProvided as AccountUpdateParamsIdentityAttestationsPersonsProvided, + AccountUpdateParamsIdentityAttestationsRepresentativeDeclaration as AccountUpdateParamsIdentityAttestationsRepresentativeDeclaration, + AccountUpdateParamsIdentityAttestationsTermsOfService as AccountUpdateParamsIdentityAttestationsTermsOfService, + AccountUpdateParamsIdentityAttestationsTermsOfServiceAccount as AccountUpdateParamsIdentityAttestationsTermsOfServiceAccount, + AccountUpdateParamsIdentityAttestationsTermsOfServiceCryptoStorer as AccountUpdateParamsIdentityAttestationsTermsOfServiceCryptoStorer, + AccountUpdateParamsIdentityAttestationsTermsOfServiceStorer as AccountUpdateParamsIdentityAttestationsTermsOfServiceStorer, + AccountUpdateParamsIdentityBusinessDetails as AccountUpdateParamsIdentityBusinessDetails, + AccountUpdateParamsIdentityBusinessDetailsAddress as AccountUpdateParamsIdentityBusinessDetailsAddress, + AccountUpdateParamsIdentityBusinessDetailsAnnualRevenue as AccountUpdateParamsIdentityBusinessDetailsAnnualRevenue, + AccountUpdateParamsIdentityBusinessDetailsAnnualRevenueAmount as AccountUpdateParamsIdentityBusinessDetailsAnnualRevenueAmount, + AccountUpdateParamsIdentityBusinessDetailsDocuments as AccountUpdateParamsIdentityBusinessDetailsDocuments, + AccountUpdateParamsIdentityBusinessDetailsDocumentsBankAccountOwnershipVerification as AccountUpdateParamsIdentityBusinessDetailsDocumentsBankAccountOwnershipVerification, + AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyLicense as AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyLicense, + AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyMemorandumOfAssociation as AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyMemorandumOfAssociation, + AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyMinisterialDecree as AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyMinisterialDecree, + AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyRegistrationVerification as AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyRegistrationVerification, + AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyTaxIdVerification as AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyTaxIdVerification, + AccountUpdateParamsIdentityBusinessDetailsDocumentsPrimaryVerification as AccountUpdateParamsIdentityBusinessDetailsDocumentsPrimaryVerification, + AccountUpdateParamsIdentityBusinessDetailsDocumentsPrimaryVerificationFrontBack as AccountUpdateParamsIdentityBusinessDetailsDocumentsPrimaryVerificationFrontBack, + AccountUpdateParamsIdentityBusinessDetailsDocumentsProofOfAddress as AccountUpdateParamsIdentityBusinessDetailsDocumentsProofOfAddress, + AccountUpdateParamsIdentityBusinessDetailsDocumentsProofOfRegistration as AccountUpdateParamsIdentityBusinessDetailsDocumentsProofOfRegistration, + AccountUpdateParamsIdentityBusinessDetailsDocumentsProofOfUltimateBeneficialOwnership as AccountUpdateParamsIdentityBusinessDetailsDocumentsProofOfUltimateBeneficialOwnership, + AccountUpdateParamsIdentityBusinessDetailsIdNumber as AccountUpdateParamsIdentityBusinessDetailsIdNumber, + AccountUpdateParamsIdentityBusinessDetailsMonthlyEstimatedRevenue as AccountUpdateParamsIdentityBusinessDetailsMonthlyEstimatedRevenue, + AccountUpdateParamsIdentityBusinessDetailsMonthlyEstimatedRevenueAmount as AccountUpdateParamsIdentityBusinessDetailsMonthlyEstimatedRevenueAmount, + AccountUpdateParamsIdentityBusinessDetailsScriptAddresses as AccountUpdateParamsIdentityBusinessDetailsScriptAddresses, + AccountUpdateParamsIdentityBusinessDetailsScriptAddressesKana as AccountUpdateParamsIdentityBusinessDetailsScriptAddressesKana, + AccountUpdateParamsIdentityBusinessDetailsScriptAddressesKanji as AccountUpdateParamsIdentityBusinessDetailsScriptAddressesKanji, + AccountUpdateParamsIdentityBusinessDetailsScriptNames as AccountUpdateParamsIdentityBusinessDetailsScriptNames, + AccountUpdateParamsIdentityBusinessDetailsScriptNamesKana as AccountUpdateParamsIdentityBusinessDetailsScriptNamesKana, + AccountUpdateParamsIdentityBusinessDetailsScriptNamesKanji as AccountUpdateParamsIdentityBusinessDetailsScriptNamesKanji, + AccountUpdateParamsIdentityIndividual as AccountUpdateParamsIdentityIndividual, + AccountUpdateParamsIdentityIndividualAdditionalAddress as AccountUpdateParamsIdentityIndividualAdditionalAddress, + AccountUpdateParamsIdentityIndividualAdditionalName as AccountUpdateParamsIdentityIndividualAdditionalName, + AccountUpdateParamsIdentityIndividualAddress as AccountUpdateParamsIdentityIndividualAddress, + AccountUpdateParamsIdentityIndividualDateOfBirth as AccountUpdateParamsIdentityIndividualDateOfBirth, + AccountUpdateParamsIdentityIndividualDocuments as AccountUpdateParamsIdentityIndividualDocuments, + AccountUpdateParamsIdentityIndividualDocumentsCompanyAuthorization as AccountUpdateParamsIdentityIndividualDocumentsCompanyAuthorization, + AccountUpdateParamsIdentityIndividualDocumentsPassport as AccountUpdateParamsIdentityIndividualDocumentsPassport, + AccountUpdateParamsIdentityIndividualDocumentsPrimaryVerification as AccountUpdateParamsIdentityIndividualDocumentsPrimaryVerification, + AccountUpdateParamsIdentityIndividualDocumentsPrimaryVerificationFrontBack as AccountUpdateParamsIdentityIndividualDocumentsPrimaryVerificationFrontBack, + AccountUpdateParamsIdentityIndividualDocumentsSecondaryVerification as AccountUpdateParamsIdentityIndividualDocumentsSecondaryVerification, + AccountUpdateParamsIdentityIndividualDocumentsSecondaryVerificationFrontBack as AccountUpdateParamsIdentityIndividualDocumentsSecondaryVerificationFrontBack, + AccountUpdateParamsIdentityIndividualDocumentsVisa as AccountUpdateParamsIdentityIndividualDocumentsVisa, + AccountUpdateParamsIdentityIndividualIdNumber as AccountUpdateParamsIdentityIndividualIdNumber, + AccountUpdateParamsIdentityIndividualRelationship as AccountUpdateParamsIdentityIndividualRelationship, + AccountUpdateParamsIdentityIndividualScriptAddresses as AccountUpdateParamsIdentityIndividualScriptAddresses, + AccountUpdateParamsIdentityIndividualScriptAddressesKana as AccountUpdateParamsIdentityIndividualScriptAddressesKana, + AccountUpdateParamsIdentityIndividualScriptAddressesKanji as AccountUpdateParamsIdentityIndividualScriptAddressesKanji, + AccountUpdateParamsIdentityIndividualScriptNames as AccountUpdateParamsIdentityIndividualScriptNames, + AccountUpdateParamsIdentityIndividualScriptNamesKana as AccountUpdateParamsIdentityIndividualScriptNamesKana, + AccountUpdateParamsIdentityIndividualScriptNamesKanji as AccountUpdateParamsIdentityIndividualScriptNamesKanji, + ) from stripe.params.v2.core._event_destination_create_params import ( EventDestinationCreateParams as EventDestinationCreateParams, EventDestinationCreateParamsAmazonEventbridge as EventDestinationCreateParamsAmazonEventbridge, @@ -41,6 +389,1328 @@ # name -> (import_target, is_submodule) _import_map = { + "accounts": ("stripe.params.v2.core.accounts", True), + "AccountCloseParams": ( + "stripe.params.v2.core._account_close_params", + False, + ), + "AccountCreateParams": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfiguration": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationCustomer": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationCustomerAutomaticIndirectTax": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationCustomerBilling": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationCustomerBillingInvoice": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationCustomerBillingInvoiceCustomField": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationCustomerBillingInvoiceRendering": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationCustomerCapabilities": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationCustomerCapabilitiesAutomaticIndirectTax": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationCustomerShipping": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationCustomerShippingAddress": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchant": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantBacsDebitPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantBranding": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilities": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesAchDebitPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesAcssDebitPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesAffirmPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesAfterpayClearpayPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesAlmaPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesAmazonPayPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesAuBecsDebitPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesBacsDebitPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesBancontactPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesBlikPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesBoletoPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesCardPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesCartesBancairesPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesCashappPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesEpsPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesFpxPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesGbBankTransferPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesGrabpayPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesIdealPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesJcbPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesJpBankTransferPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesKakaoPayPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesKlarnaPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesKonbiniPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesKrCardPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesLinkPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesMobilepayPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesMultibancoPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesMxBankTransferPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesNaverPayPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesOxxoPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesP24Payments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesPayByBankPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesPaycoPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesPaynowPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesPromptpayPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesRevolutPayPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesSamsungPayPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesSepaBankTransferPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesSepaDebitPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesSwishPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesTwintPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesUsBankTransferPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCapabilitiesZipPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCardPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantCardPaymentsDeclineOn": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantKonbiniPayments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantKonbiniPaymentsSupport": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantKonbiniPaymentsSupportHours": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantScriptStatementDescriptor": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantScriptStatementDescriptorKana": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantScriptStatementDescriptorKanji": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantStatementDescriptor": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantSupport": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationMerchantSupportAddress": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationRecipient": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationRecipientCapabilities": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationRecipientCapabilitiesStripeBalance": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsConfigurationRecipientCapabilitiesStripeBalanceStripeTransfers": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsDefaults": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsDefaultsProfile": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsDefaultsResponsibilities": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentity": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityAttestations": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityAttestationsDirectorshipDeclaration": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityAttestationsOwnershipDeclaration": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityAttestationsPersonsProvided": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityAttestationsRepresentativeDeclaration": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityAttestationsTermsOfService": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityAttestationsTermsOfServiceAccount": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetails": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsAddress": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsAnnualRevenue": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsAnnualRevenueAmount": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsDocuments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsDocumentsBankAccountOwnershipVerification": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyLicense": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyMemorandumOfAssociation": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyMinisterialDecree": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyRegistrationVerification": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyTaxIdVerification": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerification": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerificationFrontBack": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsDocumentsProofOfAddress": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsDocumentsProofOfRegistration": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsDocumentsProofOfUltimateBeneficialOwnership": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsIdNumber": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenue": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenueAmount": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsScriptAddresses": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsScriptAddressesKana": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsScriptAddressesKanji": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsScriptNames": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsScriptNamesKana": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityBusinessDetailsScriptNamesKanji": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividual": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualAdditionalAddress": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualAdditionalName": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualAddress": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualDateOfBirth": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualDocuments": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualDocumentsCompanyAuthorization": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualDocumentsPassport": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualDocumentsPrimaryVerification": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualDocumentsPrimaryVerificationFrontBack": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualDocumentsSecondaryVerification": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualDocumentsSecondaryVerificationFrontBack": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualDocumentsVisa": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualIdNumber": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualRelationship": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualScriptAddresses": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualScriptAddressesKana": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualScriptAddressesKanji": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualScriptNames": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualScriptNamesKana": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountCreateParamsIdentityIndividualScriptNamesKanji": ( + "stripe.params.v2.core._account_create_params", + False, + ), + "AccountLinkCreateParams": ( + "stripe.params.v2.core._account_link_create_params", + False, + ), + "AccountLinkCreateParamsUseCase": ( + "stripe.params.v2.core._account_link_create_params", + False, + ), + "AccountLinkCreateParamsUseCaseAccountOnboarding": ( + "stripe.params.v2.core._account_link_create_params", + False, + ), + "AccountLinkCreateParamsUseCaseAccountOnboardingCollectionOptions": ( + "stripe.params.v2.core._account_link_create_params", + False, + ), + "AccountLinkCreateParamsUseCaseAccountUpdate": ( + "stripe.params.v2.core._account_link_create_params", + False, + ), + "AccountLinkCreateParamsUseCaseAccountUpdateCollectionOptions": ( + "stripe.params.v2.core._account_link_create_params", + False, + ), + "AccountListParams": ("stripe.params.v2.core._account_list_params", False), + "AccountRetrieveParams": ( + "stripe.params.v2.core._account_retrieve_params", + False, + ), + "AccountTokenCreateParams": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentity": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityAttestations": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityAttestationsDirectorshipDeclaration": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityAttestationsOwnershipDeclaration": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityAttestationsPersonsProvided": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityAttestationsRepresentativeDeclaration": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityAttestationsTermsOfService": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityAttestationsTermsOfServiceAccount": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetails": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsAddress": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsAnnualRevenue": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsAnnualRevenueAmount": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsDocuments": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsBankAccountOwnershipVerification": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyLicense": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyMemorandumOfAssociation": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyMinisterialDecree": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyRegistrationVerification": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyTaxIdVerification": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerification": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerificationFrontBack": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsProofOfAddress": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsProofOfRegistration": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsProofOfUltimateBeneficialOwnership": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsIdNumber": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenue": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenueAmount": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsScriptAddresses": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsScriptAddressesKana": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsScriptAddressesKanji": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsScriptNames": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsScriptNamesKana": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityBusinessDetailsScriptNamesKanji": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividual": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualAdditionalAddress": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualAdditionalName": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualAddress": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualDateOfBirth": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualDocuments": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualDocumentsCompanyAuthorization": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualDocumentsPassport": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualDocumentsPrimaryVerification": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualDocumentsPrimaryVerificationFrontBack": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualDocumentsSecondaryVerification": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualDocumentsSecondaryVerificationFrontBack": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualDocumentsVisa": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualIdNumber": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualRelationship": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualScriptAddresses": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualScriptAddressesKana": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualScriptAddressesKanji": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualScriptNames": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualScriptNamesKana": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenCreateParamsIdentityIndividualScriptNamesKanji": ( + "stripe.params.v2.core._account_token_create_params", + False, + ), + "AccountTokenRetrieveParams": ( + "stripe.params.v2.core._account_token_retrieve_params", + False, + ), + "AccountUpdateParams": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfiguration": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationCustomer": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationCustomerAutomaticIndirectTax": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationCustomerBilling": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationCustomerBillingInvoice": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationCustomerBillingInvoiceCustomField": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationCustomerBillingInvoiceRendering": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationCustomerCapabilities": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationCustomerCapabilitiesAutomaticIndirectTax": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationCustomerShipping": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationCustomerShippingAddress": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchant": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantBacsDebitPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantBranding": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilities": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesAchDebitPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesAcssDebitPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesAffirmPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesAfterpayClearpayPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesAlmaPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesAmazonPayPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesAuBecsDebitPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesBacsDebitPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesBancontactPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesBlikPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesBoletoPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesCardPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesCartesBancairesPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesCashappPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesEpsPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesFpxPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesGbBankTransferPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesGrabpayPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesIdealPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesJcbPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesJpBankTransferPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesKakaoPayPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesKlarnaPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesKonbiniPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesKrCardPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesLinkPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesMobilepayPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesMultibancoPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesMxBankTransferPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesNaverPayPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesOxxoPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesP24Payments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesPayByBankPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesPaycoPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesPaynowPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesPromptpayPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesRevolutPayPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesSamsungPayPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesSepaBankTransferPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesSepaDebitPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesSwishPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesTwintPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesUsBankTransferPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCapabilitiesZipPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCardPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantCardPaymentsDeclineOn": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantKonbiniPayments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantKonbiniPaymentsSupport": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantKonbiniPaymentsSupportHours": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantScriptStatementDescriptor": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantScriptStatementDescriptorKana": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantScriptStatementDescriptorKanji": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantStatementDescriptor": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantSupport": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationMerchantSupportAddress": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationRecipient": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationRecipientCapabilities": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationRecipientCapabilitiesStripeBalance": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsConfigurationRecipientCapabilitiesStripeBalanceStripeTransfers": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsDefaults": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsDefaultsProfile": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsDefaultsResponsibilities": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentity": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityAttestations": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityAttestationsDirectorshipDeclaration": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityAttestationsOwnershipDeclaration": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityAttestationsPersonsProvided": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityAttestationsRepresentativeDeclaration": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityAttestationsTermsOfService": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityAttestationsTermsOfServiceAccount": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityAttestationsTermsOfServiceCryptoStorer": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityAttestationsTermsOfServiceStorer": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetails": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsAddress": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsAnnualRevenue": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsAnnualRevenueAmount": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsDocuments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsDocumentsBankAccountOwnershipVerification": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyLicense": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyMemorandumOfAssociation": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyMinisterialDecree": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyRegistrationVerification": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyTaxIdVerification": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsDocumentsPrimaryVerification": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsDocumentsPrimaryVerificationFrontBack": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsDocumentsProofOfAddress": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsDocumentsProofOfRegistration": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsDocumentsProofOfUltimateBeneficialOwnership": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsIdNumber": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsMonthlyEstimatedRevenue": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsMonthlyEstimatedRevenueAmount": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsScriptAddresses": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsScriptAddressesKana": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsScriptAddressesKanji": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsScriptNames": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsScriptNamesKana": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityBusinessDetailsScriptNamesKanji": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividual": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualAdditionalAddress": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualAdditionalName": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualAddress": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualDateOfBirth": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualDocuments": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualDocumentsCompanyAuthorization": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualDocumentsPassport": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualDocumentsPrimaryVerification": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualDocumentsPrimaryVerificationFrontBack": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualDocumentsSecondaryVerification": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualDocumentsSecondaryVerificationFrontBack": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualDocumentsVisa": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualIdNumber": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualRelationship": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualScriptAddresses": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualScriptAddressesKana": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualScriptAddressesKanji": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualScriptNames": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualScriptNamesKana": ( + "stripe.params.v2.core._account_update_params", + False, + ), + "AccountUpdateParamsIdentityIndividualScriptNamesKanji": ( + "stripe.params.v2.core._account_update_params", + False, + ), "EventDestinationCreateParams": ( "stripe.params.v2.core._event_destination_create_params", False, diff --git a/stripe/params/v2/core/_account_close_params.py b/stripe/params/v2/core/_account_close_params.py new file mode 100644 index 000000000..9c52aff1c --- /dev/null +++ b/stripe/params/v2/core/_account_close_params.py @@ -0,0 +1,13 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from typing import List +from typing_extensions import Literal, NotRequired, TypedDict + + +class AccountCloseParams(TypedDict): + applied_configurations: NotRequired[ + List[Literal["customer", "merchant", "recipient"]] + ] + """ + Configurations on the Account to be closed. All configurations on the Account must be passed in for this request to succeed. + """ diff --git a/stripe/params/v2/core/_account_create_params.py b/stripe/params/v2/core/_account_create_params.py new file mode 100644 index 000000000..79dbcabea --- /dev/null +++ b/stripe/params/v2/core/_account_create_params.py @@ -0,0 +1,2611 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from typing import Dict, List +from typing_extensions import Literal, NotRequired, TypedDict + + +class AccountCreateParams(TypedDict): + account_token: NotRequired[str] + """ + The account token generated by the account token api. + """ + configuration: NotRequired["AccountCreateParamsConfiguration"] + """ + An Account Configuration which allows the Account to take on a key persona across Stripe products. + """ + contact_email: NotRequired[str] + """ + The default contact email address for the Account. Required when configuring the account as a merchant or recipient. + """ + dashboard: NotRequired[Literal["express", "full", "none"]] + """ + A value indicating the Stripe dashboard this Account has access to. This will depend on which configurations are enabled for this account. + """ + defaults: NotRequired["AccountCreateParamsDefaults"] + """ + Default values to be used on Account Configurations. + """ + display_name: NotRequired[str] + """ + A descriptive name for the Account. This name will be surfaced in the Stripe Dashboard and on any invoices sent to the Account. + """ + identity: NotRequired["AccountCreateParamsIdentity"] + """ + Information about the company, individual, and business represented by the Account. + """ + include: NotRequired[ + List[ + Literal[ + "configuration.customer", + "configuration.merchant", + "configuration.recipient", + "defaults", + "future_requirements", + "identity", + "requirements", + ] + ] + ] + """ + Additional fields to include in the response. + """ + 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. + """ + + +class AccountCreateParamsConfiguration(TypedDict): + customer: NotRequired["AccountCreateParamsConfigurationCustomer"] + """ + The Customer Configuration allows the Account to be used in inbound payment flows. + """ + merchant: NotRequired["AccountCreateParamsConfigurationMerchant"] + """ + Enables the Account to act as a connected account and collect payments facilitated by a Connect platform. You must onboard your platform to Connect before you can add this configuration to your connected accounts. Utilize this configuration when the Account will be the Merchant of Record, like with Direct charges or Destination Charges with on_behalf_of set. + """ + recipient: NotRequired["AccountCreateParamsConfigurationRecipient"] + """ + The Recipient Configuration allows the Account to receive funds. Utilize this configuration if the Account will not be the Merchant of Record, like with Separate Charges & Transfers, or Destination Charges without on_behalf_of set. + """ + + +class AccountCreateParamsConfigurationCustomer(TypedDict): + automatic_indirect_tax: NotRequired[ + "AccountCreateParamsConfigurationCustomerAutomaticIndirectTax" + ] + """ + Automatic indirect tax settings to be used when automatic tax calculation is enabled on the customer's invoices, subscriptions, checkout sessions, or payment links. Surfaces if automatic tax calculation is possible given the current customer location information. + """ + billing: NotRequired["AccountCreateParamsConfigurationCustomerBilling"] + """ + Billing settings - default settings used for this customer in Billing flows such as Invoices and Subscriptions. + """ + capabilities: NotRequired[ + "AccountCreateParamsConfigurationCustomerCapabilities" + ] + """ + Capabilities that have been requested on the Customer Configuration. + """ + shipping: NotRequired["AccountCreateParamsConfigurationCustomerShipping"] + """ + The customer's shipping information. Appears on invoices emailed to this customer. + """ + test_clock: NotRequired[str] + """ + ID of the test clock to attach to the customer. Can only be set on testmode Accounts, and when the Customer Configuration is first set on an Account. + """ + + +class AccountCreateParamsConfigurationCustomerAutomaticIndirectTax(TypedDict): + exempt: NotRequired[Literal["exempt", "none", "reverse"]] + """ + Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to reverse, invoice and receipt PDFs include the following text: “Reverse charge”. + """ + ip_address: NotRequired[str] + """ + A recent IP address of the customer used for tax reporting and tax location inference. + """ + + +class AccountCreateParamsConfigurationCustomerBilling(TypedDict): + invoice: NotRequired[ + "AccountCreateParamsConfigurationCustomerBillingInvoice" + ] + """ + Default invoice settings for the customer account. + """ + + +class AccountCreateParamsConfigurationCustomerBillingInvoice(TypedDict): + custom_fields: NotRequired[ + List[ + "AccountCreateParamsConfigurationCustomerBillingInvoiceCustomField" + ] + ] + """ + The list of up to 4 default custom fields to be displayed on invoices for this customer. + """ + footer: NotRequired[str] + """ + Default invoice footer. + """ + next_sequence: NotRequired[int] + """ + Sequence number to use on the customer account's next invoice. Defaults to 1. + """ + prefix: NotRequired[str] + """ + Prefix used to generate unique invoice numbers. Must be 3-12 uppercase letters or numbers. + """ + rendering: NotRequired[ + "AccountCreateParamsConfigurationCustomerBillingInvoiceRendering" + ] + """ + Default invoice PDF rendering options. + """ + + +class AccountCreateParamsConfigurationCustomerBillingInvoiceCustomField( + TypedDict, +): + name: str + """ + The name of the custom field. This may be up to 40 characters. + """ + value: str + """ + The value of the custom field. This may be up to 140 characters. When updating, pass an empty string to remove previously-defined values. + """ + + +class AccountCreateParamsConfigurationCustomerBillingInvoiceRendering( + TypedDict, +): + amount_tax_display: NotRequired[ + Literal["exclude_tax", "include_inclusive_tax"] + ] + """ + Indicates whether displayed line item prices and amounts on invoice PDFs include inclusive tax amounts. Must be either `include_inclusive_tax` or `exclude_tax`. + """ + template: NotRequired[str] + """ + ID of the invoice rendering template to use for future invoices. + """ + + +class AccountCreateParamsConfigurationCustomerCapabilities(TypedDict): + automatic_indirect_tax: NotRequired[ + "AccountCreateParamsConfigurationCustomerCapabilitiesAutomaticIndirectTax" + ] + """ + Generates requirements for enabling automatic indirect tax calculation on this customer's invoices or subscriptions. Recommended to request this capability if planning to enable automatic tax calculation on this customer's invoices or subscriptions. + """ + + +class AccountCreateParamsConfigurationCustomerCapabilitiesAutomaticIndirectTax( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationCustomerShipping(TypedDict): + address: NotRequired[ + "AccountCreateParamsConfigurationCustomerShippingAddress" + ] + """ + Customer shipping address. + """ + name: NotRequired[str] + """ + Customer name. + """ + phone: NotRequired[str] + """ + Customer phone (including extension). + """ + + +class AccountCreateParamsConfigurationCustomerShippingAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + + +class AccountCreateParamsConfigurationMerchant(TypedDict): + bacs_debit_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantBacsDebitPayments" + ] + """ + Settings used for Bacs debit payments. + """ + branding: NotRequired["AccountCreateParamsConfigurationMerchantBranding"] + """ + Settings used to apply the merchant's branding to email receipts, invoices, Checkout, and other products. + """ + capabilities: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilities" + ] + """ + Capabilities to request on the Merchant Configuration. + """ + card_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCardPayments" + ] + """ + Card payments settings. + """ + konbini_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantKonbiniPayments" + ] + """ + Settings specific to Konbini payments on the account. + """ + mcc: NotRequired[str] + """ + The Merchant Category Code (MCC) for the Merchant Configuration. MCCs classify businesses based on the goods or services they provide. + """ + script_statement_descriptor: NotRequired[ + "AccountCreateParamsConfigurationMerchantScriptStatementDescriptor" + ] + """ + Settings for the default text that appears on statements for language variations. + """ + statement_descriptor: NotRequired[ + "AccountCreateParamsConfigurationMerchantStatementDescriptor" + ] + """ + Statement descriptor. + """ + support: NotRequired["AccountCreateParamsConfigurationMerchantSupport"] + """ + Publicly available contact information for sending support issues to. + """ + + +class AccountCreateParamsConfigurationMerchantBacsDebitPayments(TypedDict): + display_name: NotRequired[str] + """ + Display name for Bacs Direct Debit payments. + """ + + +class AccountCreateParamsConfigurationMerchantBranding(TypedDict): + icon: NotRequired[str] + """ + ID of a [file upload](https://docs.stripe.com/api/persons/update#create_file): An icon for the merchant. Must be square and at least 128px x 128px. + """ + logo: NotRequired[str] + """ + ID of a [file upload](https://docs.stripe.com/api/persons/update#create_file): A logo for the merchant that will be used in Checkout instead of the icon and without the merchant's name next to it if provided. Must be at least 128px x 128px. + """ + primary_color: NotRequired[str] + """ + A CSS hex color value representing the primary branding color for the merchant. + """ + secondary_color: NotRequired[str] + """ + A CSS hex color value representing the secondary branding color for the merchant. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilities(TypedDict): + ach_debit_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesAchDebitPayments" + ] + """ + Allow the merchant to process ACH debit payments. + """ + acss_debit_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesAcssDebitPayments" + ] + """ + Allow the merchant to process ACSS debit payments. + """ + affirm_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesAffirmPayments" + ] + """ + Allow the merchant to process Affirm payments. + """ + afterpay_clearpay_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesAfterpayClearpayPayments" + ] + """ + Allow the merchant to process Afterpay/Clearpay payments. + """ + alma_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesAlmaPayments" + ] + """ + Allow the merchant to process Alma payments. + """ + amazon_pay_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesAmazonPayPayments" + ] + """ + Allow the merchant to process Amazon Pay payments. + """ + au_becs_debit_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesAuBecsDebitPayments" + ] + """ + Allow the merchant to process Australian BECS Direct Debit payments. + """ + bacs_debit_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesBacsDebitPayments" + ] + """ + Allow the merchant to process BACS Direct Debit payments. + """ + bancontact_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesBancontactPayments" + ] + """ + Allow the merchant to process Bancontact payments. + """ + blik_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesBlikPayments" + ] + """ + Allow the merchant to process BLIK payments. + """ + boleto_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesBoletoPayments" + ] + """ + Allow the merchant to process Boleto payments. + """ + card_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesCardPayments" + ] + """ + Allow the merchant to collect card payments. + """ + cartes_bancaires_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesCartesBancairesPayments" + ] + """ + Allow the merchant to process Cartes Bancaires payments. + """ + cashapp_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesCashappPayments" + ] + """ + Allow the merchant to process Cash App payments. + """ + eps_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesEpsPayments" + ] + """ + Allow the merchant to process EPS payments. + """ + fpx_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesFpxPayments" + ] + """ + Allow the merchant to process FPX payments. + """ + gb_bank_transfer_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesGbBankTransferPayments" + ] + """ + Allow the merchant to process UK bank transfer payments. + """ + grabpay_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesGrabpayPayments" + ] + """ + Allow the merchant to process GrabPay payments. + """ + ideal_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesIdealPayments" + ] + """ + Allow the merchant to process iDEAL payments. + """ + jcb_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesJcbPayments" + ] + """ + Allow the merchant to process JCB card payments. + """ + jp_bank_transfer_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesJpBankTransferPayments" + ] + """ + Allow the merchant to process Japanese bank transfer payments. + """ + kakao_pay_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesKakaoPayPayments" + ] + """ + Allow the merchant to process Kakao Pay payments. + """ + klarna_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesKlarnaPayments" + ] + """ + Allow the merchant to process Klarna payments. + """ + konbini_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesKonbiniPayments" + ] + """ + Allow the merchant to process Konbini convenience store payments. + """ + kr_card_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesKrCardPayments" + ] + """ + Allow the merchant to process Korean card payments. + """ + link_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesLinkPayments" + ] + """ + Allow the merchant to process Link payments. + """ + mobilepay_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesMobilepayPayments" + ] + """ + Allow the merchant to process MobilePay payments. + """ + multibanco_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesMultibancoPayments" + ] + """ + Allow the merchant to process Multibanco payments. + """ + mx_bank_transfer_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesMxBankTransferPayments" + ] + """ + Allow the merchant to process Mexican bank transfer payments. + """ + naver_pay_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesNaverPayPayments" + ] + """ + Allow the merchant to process Naver Pay payments. + """ + oxxo_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesOxxoPayments" + ] + """ + Allow the merchant to process OXXO payments. + """ + p24_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesP24Payments" + ] + """ + Allow the merchant to process Przelewy24 (P24) payments. + """ + pay_by_bank_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesPayByBankPayments" + ] + """ + Allow the merchant to process Pay by Bank payments. + """ + payco_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesPaycoPayments" + ] + """ + Allow the merchant to process PAYCO payments. + """ + paynow_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesPaynowPayments" + ] + """ + Allow the merchant to process PayNow payments. + """ + promptpay_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesPromptpayPayments" + ] + """ + Allow the merchant to process PromptPay payments. + """ + revolut_pay_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesRevolutPayPayments" + ] + """ + Allow the merchant to process Revolut Pay payments. + """ + samsung_pay_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesSamsungPayPayments" + ] + """ + Allow the merchant to process Samsung Pay payments. + """ + sepa_bank_transfer_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesSepaBankTransferPayments" + ] + """ + Allow the merchant to process SEPA bank transfer payments. + """ + sepa_debit_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesSepaDebitPayments" + ] + """ + Allow the merchant to process SEPA Direct Debit payments. + """ + swish_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesSwishPayments" + ] + """ + Allow the merchant to process Swish payments. + """ + twint_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesTwintPayments" + ] + """ + Allow the merchant to process TWINT payments. + """ + us_bank_transfer_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesUsBankTransferPayments" + ] + """ + Allow the merchant to process US bank transfer payments. + """ + zip_payments: NotRequired[ + "AccountCreateParamsConfigurationMerchantCapabilitiesZipPayments" + ] + """ + Allow the merchant to process Zip payments. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesAchDebitPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesAcssDebitPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesAffirmPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesAfterpayClearpayPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesAlmaPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesAmazonPayPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesAuBecsDebitPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesBacsDebitPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesBancontactPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesBlikPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesBoletoPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesCardPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesCartesBancairesPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesCashappPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesEpsPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesFpxPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesGbBankTransferPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesGrabpayPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesIdealPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesJcbPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesJpBankTransferPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesKakaoPayPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesKlarnaPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesKonbiniPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesKrCardPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesLinkPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesMobilepayPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesMultibancoPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesMxBankTransferPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesNaverPayPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesOxxoPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesP24Payments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesPayByBankPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesPaycoPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesPaynowPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesPromptpayPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesRevolutPayPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesSamsungPayPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesSepaBankTransferPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesSepaDebitPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesSwishPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesTwintPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesUsBankTransferPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCapabilitiesZipPayments( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsConfigurationMerchantCardPayments(TypedDict): + decline_on: NotRequired[ + "AccountCreateParamsConfigurationMerchantCardPaymentsDeclineOn" + ] + """ + Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge. + """ + + +class AccountCreateParamsConfigurationMerchantCardPaymentsDeclineOn(TypedDict): + 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] + """ + Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification. + """ + + +class AccountCreateParamsConfigurationMerchantKonbiniPayments(TypedDict): + support: NotRequired[ + "AccountCreateParamsConfigurationMerchantKonbiniPaymentsSupport" + ] + """ + Support for Konbini payments. + """ + + +class AccountCreateParamsConfigurationMerchantKonbiniPaymentsSupport( + TypedDict +): + email: NotRequired[str] + """ + Support email address for Konbini payments. + """ + hours: NotRequired[ + "AccountCreateParamsConfigurationMerchantKonbiniPaymentsSupportHours" + ] + """ + Support hours for Konbini payments. + """ + phone: NotRequired[str] + """ + Support phone number for Konbini payments. + """ + + +class AccountCreateParamsConfigurationMerchantKonbiniPaymentsSupportHours( + TypedDict, +): + end_time: NotRequired[str] + """ + Support hours end time (JST time of day) for in `HH:MM` format. + """ + start_time: NotRequired[str] + """ + Support hours start time (JST time of day) for in `HH:MM` format. + """ + + +class AccountCreateParamsConfigurationMerchantScriptStatementDescriptor( + TypedDict, +): + kana: NotRequired[ + "AccountCreateParamsConfigurationMerchantScriptStatementDescriptorKana" + ] + """ + The Kana variation of statement_descriptor used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). + """ + kanji: NotRequired[ + "AccountCreateParamsConfigurationMerchantScriptStatementDescriptorKanji" + ] + """ + The Kanji variation of statement_descriptor used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). + """ + + +class AccountCreateParamsConfigurationMerchantScriptStatementDescriptorKana( + TypedDict, +): + descriptor: NotRequired[str] + """ + The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a statement_descriptor_prefix, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + prefix: NotRequired[str] + """ + Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don't specify this value, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + + +class AccountCreateParamsConfigurationMerchantScriptStatementDescriptorKanji( + TypedDict, +): + descriptor: NotRequired[str] + """ + The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a statement_descriptor_prefix, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + prefix: NotRequired[str] + """ + Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don't specify this value, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + + +class AccountCreateParamsConfigurationMerchantStatementDescriptor(TypedDict): + descriptor: NotRequired[str] + """ + The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a statement_descriptor_prefix, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + prefix: NotRequired[str] + """ + Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don't specify this value, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + + +class AccountCreateParamsConfigurationMerchantSupport(TypedDict): + address: NotRequired[ + "AccountCreateParamsConfigurationMerchantSupportAddress" + ] + """ + A publicly available mailing address for sending support issues to. + """ + email: NotRequired[str] + """ + A publicly available email address for sending support issues to. + """ + phone: NotRequired[str] + """ + A publicly available phone number to call with support issues. + """ + url: NotRequired[str] + """ + A publicly available website for handling support issues. + """ + + +class AccountCreateParamsConfigurationMerchantSupportAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: str + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountCreateParamsConfigurationRecipient(TypedDict): + capabilities: NotRequired[ + "AccountCreateParamsConfigurationRecipientCapabilities" + ] + """ + Capabilities to be requested on the Recipient Configuration. + """ + + +class AccountCreateParamsConfigurationRecipientCapabilities(TypedDict): + stripe_balance: NotRequired[ + "AccountCreateParamsConfigurationRecipientCapabilitiesStripeBalance" + ] + """ + Capabilities that enable the recipient to manage their Stripe Balance (/v1/balance). + """ + + +class AccountCreateParamsConfigurationRecipientCapabilitiesStripeBalance( + TypedDict, +): + stripe_transfers: NotRequired[ + "AccountCreateParamsConfigurationRecipientCapabilitiesStripeBalanceStripeTransfers" + ] + """ + Enables this Account to receive /v1/transfers into their Stripe Balance (/v1/balance). + """ + + +class AccountCreateParamsConfigurationRecipientCapabilitiesStripeBalanceStripeTransfers( + TypedDict, +): + requested: bool + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountCreateParamsDefaults(TypedDict): + 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). + """ + locales: NotRequired[ + List[ + Literal[ + "ar-SA", + "bg", + "bg-BG", + "cs", + "cs-CZ", + "da", + "da-DK", + "de", + "de-DE", + "el", + "el-GR", + "en", + "en-AU", + "en-CA", + "en-GB", + "en-IE", + "en-IN", + "en-NZ", + "en-SG", + "en-US", + "es", + "es-419", + "es-ES", + "et", + "et-EE", + "fi", + "fil", + "fil-PH", + "fi-FI", + "fr", + "fr-CA", + "fr-FR", + "he-IL", + "hr", + "hr-HR", + "hu", + "hu-HU", + "id", + "id-ID", + "it", + "it-IT", + "ja", + "ja-JP", + "ko", + "ko-KR", + "lt", + "lt-LT", + "lv", + "lv-LV", + "ms", + "ms-MY", + "mt", + "mt-MT", + "nb", + "nb-NO", + "nl", + "nl-NL", + "pl", + "pl-PL", + "pt", + "pt-BR", + "pt-PT", + "ro", + "ro-RO", + "ru", + "ru-RU", + "sk", + "sk-SK", + "sl", + "sl-SI", + "sv", + "sv-SE", + "th", + "th-TH", + "tr", + "tr-TR", + "vi", + "vi-VN", + "zh", + "zh-Hans", + "zh-Hant-HK", + "zh-Hant-TW", + "zh-HK", + "zh-TW", + ] + ] + ] + """ + The Account's preferred locales (languages), ordered by preference. + """ + profile: NotRequired["AccountCreateParamsDefaultsProfile"] + """ + Account profile information. + """ + responsibilities: NotRequired[ + "AccountCreateParamsDefaultsResponsibilities" + ] + """ + Default responsibilities held by either Stripe or the platform. + """ + + +class AccountCreateParamsDefaultsProfile(TypedDict): + business_url: NotRequired[str] + """ + The business's publicly-available website. + """ + doing_business_as: NotRequired[str] + """ + The name which is used by the business. + """ + product_description: NotRequired[str] + """ + Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. + """ + + +class AccountCreateParamsDefaultsResponsibilities(TypedDict): + fees_collector: Literal[ + "application", "application_custom", "application_express", "stripe" + ] + """ + A value indicating the party responsible for collecting fees from this account. + """ + losses_collector: Literal["application", "stripe"] + """ + A value indicating who is responsible for losses when this Account can't pay back negative balances from payments. + """ + + +class AccountCreateParamsIdentity(TypedDict): + attestations: NotRequired["AccountCreateParamsIdentityAttestations"] + """ + Attestations from the identity's key people, e.g. owners, executives, directors, representatives. + """ + business_details: NotRequired["AccountCreateParamsIdentityBusinessDetails"] + """ + Information about the company or business. + """ + 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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. + """ + entity_type: NotRequired[ + Literal["company", "government_entity", "individual", "non_profit"] + ] + """ + The entity type. + """ + individual: NotRequired["AccountCreateParamsIdentityIndividual"] + """ + Information about the person represented by the account. + """ + + +class AccountCreateParamsIdentityAttestations(TypedDict): + directorship_declaration: NotRequired[ + "AccountCreateParamsIdentityAttestationsDirectorshipDeclaration" + ] + """ + This hash is used to attest that the directors information provided to Stripe is both current and correct. + """ + ownership_declaration: NotRequired[ + "AccountCreateParamsIdentityAttestationsOwnershipDeclaration" + ] + """ + This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. + """ + persons_provided: NotRequired[ + "AccountCreateParamsIdentityAttestationsPersonsProvided" + ] + """ + Attestation that all Persons with a specific Relationship value have been provided. + """ + representative_declaration: NotRequired[ + "AccountCreateParamsIdentityAttestationsRepresentativeDeclaration" + ] + """ + This hash is used to attest that the representative is authorized to act as the representative of their legal entity. + """ + terms_of_service: NotRequired[ + "AccountCreateParamsIdentityAttestationsTermsOfService" + ] + """ + Attestations of accepted terms of service agreements. + """ + + +class AccountCreateParamsIdentityAttestationsDirectorshipDeclaration( + TypedDict +): + date: NotRequired[str] + """ + The time marking when the director attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: NotRequired[str] + """ + The IP address from which the director attestation was made. + """ + user_agent: NotRequired[str] + """ + The user agent of the browser from which the director attestation was made. + """ + + +class AccountCreateParamsIdentityAttestationsOwnershipDeclaration(TypedDict): + date: NotRequired[str] + """ + The time marking when the beneficial owner attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: NotRequired[str] + """ + The IP address from which the beneficial owner attestation was made. + """ + user_agent: NotRequired[str] + """ + The user agent of the browser from which the beneficial owner attestation was made. + """ + + +class AccountCreateParamsIdentityAttestationsPersonsProvided(TypedDict): + directors: 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://docs.stripe.com/api/v2/core/accounts/createperson). + """ + executives: 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://docs.stripe.com/api/v2/core/accounts/createperson). + """ + owners: 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://docs.stripe.com/api/v2/core/accounts/createperson). + """ + ownership_exemption_reason: NotRequired[ + Literal[ + "qualified_entity_exceeds_ownership_threshold", + "qualifies_as_financial_institution", + ] + ] + """ + Reason for why the company is exempt from providing ownership information. + """ + + +class AccountCreateParamsIdentityAttestationsRepresentativeDeclaration( + TypedDict, +): + date: NotRequired[str] + """ + The time marking when the representative attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: NotRequired[str] + """ + The IP address from which the representative attestation was made. + """ + user_agent: NotRequired[str] + """ + The user agent of the browser from which the representative attestation was made. + """ + + +class AccountCreateParamsIdentityAttestationsTermsOfService(TypedDict): + account: NotRequired[ + "AccountCreateParamsIdentityAttestationsTermsOfServiceAccount" + ] + """ + Details on the Account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance). + """ + + +class AccountCreateParamsIdentityAttestationsTermsOfServiceAccount(TypedDict): + date: str + """ + The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: str + """ + The IP address from which the Account's representative accepted the terms of service. + """ + user_agent: NotRequired[str] + """ + The user agent of the browser from which the Account's representative accepted the terms of service. + """ + + +class AccountCreateParamsIdentityBusinessDetails(TypedDict): + address: NotRequired["AccountCreateParamsIdentityBusinessDetailsAddress"] + """ + The business registration address of the business entity. + """ + annual_revenue: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsAnnualRevenue" + ] + """ + The business gross annual revenue for its preceding fiscal year. + """ + documents: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsDocuments" + ] + """ + A document verifying the business. + """ + estimated_worker_count: NotRequired[int] + """ + Estimated maximum number of workers currently engaged by the business (including employees, contractors, and vendors). + """ + id_numbers: NotRequired[ + List["AccountCreateParamsIdentityBusinessDetailsIdNumber"] + ] + """ + The ID numbers of a business entity. + """ + monthly_estimated_revenue: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenue" + ] + """ + An estimate of the monthly revenue of the business. + """ + phone: NotRequired[str] + """ + The phone number of the Business Entity. + """ + registered_name: NotRequired[str] + """ + The business legal name. + """ + script_addresses: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsScriptAddresses" + ] + """ + The business registration address of the business entity in non latin script. + """ + script_names: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsScriptNames" + ] + """ + The business legal name in non latin script. + """ + structure: NotRequired[ + Literal[ + "cooperative", + "free_zone_establishment", + "free_zone_llc", + "governmental_unit", + "government_instrumentality", + "incorporated_association", + "incorporated_non_profit", + "incorporated_partnership", + "limited_liability_partnership", + "llc", + "multi_member_llc", + "private_company", + "private_corporation", + "private_partnership", + "public_company", + "public_corporation", + "public_listed_corporation", + "public_partnership", + "registered_charity", + "single_member_llc", + "sole_establishment", + "sole_proprietorship", + "tax_exempt_government_instrumentality", + "trust", + "unincorporated_association", + "unincorporated_non_profit", + "unincorporated_partnership", + ] + ] + """ + The category identifying the legal structure of the business. + """ + + +class AccountCreateParamsIdentityBusinessDetailsAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: str + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountCreateParamsIdentityBusinessDetailsAnnualRevenue(TypedDict): + amount: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsAnnualRevenueAmount" + ] + """ + A non-negative integer representing the amount in the smallest currency unit. + """ + fiscal_year_end: NotRequired[str] + """ + The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. + """ + + +class AccountCreateParamsIdentityBusinessDetailsAnnualRevenueAmount(TypedDict): + value: NotRequired[int] + """ + A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). + """ + 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). + """ + + +class AccountCreateParamsIdentityBusinessDetailsDocuments(TypedDict): + bank_account_ownership_verification: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsDocumentsBankAccountOwnershipVerification" + ] + """ + One or more documents that support the bank account ownership verification requirement. Must be a document associated with the account's primary active bank account that displays the last 4 digits of the account number, either a statement or a check. + """ + company_license: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyLicense" + ] + """ + One or more documents that demonstrate proof of a company's license to operate. + """ + company_memorandum_of_association: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyMemorandumOfAssociation" + ] + """ + One or more documents showing the company's Memorandum of Association. + """ + company_ministerial_decree: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyMinisterialDecree" + ] + """ + Certain countries only: One or more documents showing the ministerial decree legalizing the company's establishment. + """ + company_registration_verification: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyRegistrationVerification" + ] + """ + One or more documents that demonstrate proof of a company's registration with the appropriate local authorities. + """ + company_tax_id_verification: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyTaxIdVerification" + ] + """ + One or more documents that demonstrate proof of a company's tax ID. + """ + primary_verification: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerification" + ] + """ + A document verifying the business. + """ + proof_of_address: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsDocumentsProofOfAddress" + ] + """ + One or more documents that demonstrate proof of address. + """ + proof_of_registration: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsDocumentsProofOfRegistration" + ] + """ + One or more documents showing the company's proof of registration with the national business registry. + """ + proof_of_ultimate_beneficial_ownership: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsDocumentsProofOfUltimateBeneficialOwnership" + ] + """ + One or more documents that demonstrate proof of ultimate beneficial ownership. + """ + + +class AccountCreateParamsIdentityBusinessDetailsDocumentsBankAccountOwnershipVerification( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyLicense( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyMemorandumOfAssociation( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyMinisterialDecree( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyRegistrationVerification( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountCreateParamsIdentityBusinessDetailsDocumentsCompanyTaxIdVerification( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerification( + TypedDict, +): + front_back: "AccountCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerificationFrontBack" + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + + +class AccountCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerificationFrontBack( + TypedDict, +): + back: NotRequired[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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: str + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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 AccountCreateParamsIdentityBusinessDetailsDocumentsProofOfAddress( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountCreateParamsIdentityBusinessDetailsDocumentsProofOfRegistration( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountCreateParamsIdentityBusinessDetailsDocumentsProofOfUltimateBeneficialOwnership( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountCreateParamsIdentityBusinessDetailsIdNumber(TypedDict): + registrar: NotRequired[str] + """ + The registrar of the ID number (Only valid for DE ID number types). + """ + type: Literal[ + "ae_crn", + "ae_vat", + "ao_nif", + "ar_cuit", + "at_fn", + "at_stn", + "at_vat", + "au_abn", + "au_acn", + "au_in", + "az_tin", + "bd_etin", + "be_cbe", + "be_vat", + "bg_uic", + "bg_vat", + "br_cnpj", + "ca_cn", + "ca_crarr", + "ca_gst_hst", + "ca_neq", + "ca_rid", + "ch_chid", + "ch_uid", + "cr_cpj", + "cr_nite", + "cy_he", + "cy_tic", + "cy_vat", + "cz_ico", + "cz_vat", + "de_hrn", + "de_stn", + "de_vat", + "dk_cvr", + "dk_vat", + "do_rcn", + "ee_rk", + "ee_vat", + "es_cif", + "es_vat", + "fi_vat", + "fi_yt", + "fr_rna", + "fr_siren", + "fr_vat", + "gb_crn", + "gi_crn", + "gr_afm", + "gr_gemi", + "gr_vat", + "gt_nit", + "hk_br", + "hk_cr", + "hr_mbs", + "hr_oib", + "hr_vat", + "hu_cjs", + "hu_tin", + "hu_vat", + "ie_crn", + "ie_trn", + "ie_vat", + "it_rea", + "it_vat", + "jp_cn", + "kz_bin", + "li_uid", + "lt_ccrn", + "lt_vat", + "lu_nif", + "lu_rcs", + "lu_vat", + "lv_urn", + "lv_vat", + "mt_crn", + "mt_tin", + "mt_vat", + "mx_rfc", + "my_brn", + "my_coid", + "my_itn", + "my_sst", + "mz_nuit", + "nl_kvk", + "nl_rsin", + "nl_vat", + "no_orgnr", + "nz_bn", + "nz_ird", + "pe_ruc", + "pk_ntn", + "pl_nip", + "pl_regon", + "pl_vat", + "pt_vat", + "ro_cui", + "ro_orc", + "ro_vat", + "sa_crn", + "sa_tin", + "se_orgnr", + "se_vat", + "sg_uen", + "si_msp", + "si_tin", + "si_vat", + "sk_dic", + "sk_ico", + "sk_vat", + "th_crn", + "th_prn", + "th_tin", + "us_ein", + ] + """ + Open Enum. The ID number type of a business entity. + """ + value: str + """ + The value of the ID number. + """ + + +class AccountCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenue( + TypedDict, +): + amount: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenueAmount" + ] + """ + A non-negative integer representing the amount in the smallest currency unit. + """ + + +class AccountCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenueAmount( + TypedDict, +): + value: NotRequired[int] + """ + A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). + """ + 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). + """ + + +class AccountCreateParamsIdentityBusinessDetailsScriptAddresses(TypedDict): + kana: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsScriptAddressesKana" + ] + """ + Kana Address. + """ + kanji: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsScriptAddressesKanji" + ] + """ + Kanji Address. + """ + + +class AccountCreateParamsIdentityBusinessDetailsScriptAddressesKana(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: str + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountCreateParamsIdentityBusinessDetailsScriptAddressesKanji( + TypedDict +): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: str + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountCreateParamsIdentityBusinessDetailsScriptNames(TypedDict): + kana: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsScriptNamesKana" + ] + """ + Kana name. + """ + kanji: NotRequired[ + "AccountCreateParamsIdentityBusinessDetailsScriptNamesKanji" + ] + """ + Kanji name. + """ + + +class AccountCreateParamsIdentityBusinessDetailsScriptNamesKana(TypedDict): + registered_name: NotRequired[str] + """ + Registered name of the business. + """ + + +class AccountCreateParamsIdentityBusinessDetailsScriptNamesKanji(TypedDict): + registered_name: NotRequired[str] + """ + Registered name of the business. + """ + + +class AccountCreateParamsIdentityIndividual(TypedDict): + additional_addresses: NotRequired[ + List["AccountCreateParamsIdentityIndividualAdditionalAddress"] + ] + """ + Additional addresses associated with the individual. + """ + additional_names: NotRequired[ + List["AccountCreateParamsIdentityIndividualAdditionalName"] + ] + """ + Additional names (e.g. aliases) associated with the individual. + """ + address: NotRequired["AccountCreateParamsIdentityIndividualAddress"] + """ + The individual's residential address. + """ + date_of_birth: NotRequired[ + "AccountCreateParamsIdentityIndividualDateOfBirth" + ] + """ + The individual's date of birth. + """ + documents: NotRequired["AccountCreateParamsIdentityIndividualDocuments"] + """ + Documents that may be submitted to satisfy various informational requests. + """ + email: NotRequired[str] + """ + The individual's email address. + """ + given_name: NotRequired[str] + """ + The individual's first name. + """ + id_numbers: NotRequired[ + List["AccountCreateParamsIdentityIndividualIdNumber"] + ] + """ + The identification numbers (e.g., SSN) associated with the individual. + """ + legal_gender: NotRequired[Literal["female", "male"]] + """ + The individual's gender (International regulations require either "male" or "female"). + """ + 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. + """ + nationalities: NotRequired[List[str]] + """ + The countries where the individual is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + phone: NotRequired[str] + """ + The individual's phone number. + """ + political_exposure: NotRequired[Literal["existing", "none"]] + """ + The individual's political exposure. + """ + relationship: NotRequired[ + "AccountCreateParamsIdentityIndividualRelationship" + ] + """ + The relationship that this individual has with the account's identity. + """ + script_addresses: NotRequired[ + "AccountCreateParamsIdentityIndividualScriptAddresses" + ] + """ + The script addresses (e.g., non-Latin characters) associated with the individual. + """ + script_names: NotRequired[ + "AccountCreateParamsIdentityIndividualScriptNames" + ] + """ + The individuals primary name in non latin script. + """ + surname: NotRequired[str] + """ + The individual's last name. + """ + + +class AccountCreateParamsIdentityIndividualAdditionalAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: str + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + purpose: Literal["registered"] + """ + Purpose of additional address. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountCreateParamsIdentityIndividualAdditionalName(TypedDict): + full_name: NotRequired[str] + """ + The person's full name. + """ + given_name: NotRequired[str] + """ + The person's first or given name. + """ + purpose: Literal["alias", "maiden"] + """ + The purpose or type of the additional name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ + + +class AccountCreateParamsIdentityIndividualAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: str + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountCreateParamsIdentityIndividualDateOfBirth(TypedDict): + day: int + """ + The day of birth. + """ + month: int + """ + The month of birth. + """ + year: int + """ + The year of birth. + """ + + +class AccountCreateParamsIdentityIndividualDocuments(TypedDict): + company_authorization: NotRequired[ + "AccountCreateParamsIdentityIndividualDocumentsCompanyAuthorization" + ] + """ + One or more documents that demonstrate proof that this person is authorized to represent the company. + """ + passport: NotRequired[ + "AccountCreateParamsIdentityIndividualDocumentsPassport" + ] + """ + One or more documents showing the person's passport page with photo and personal data. + """ + primary_verification: NotRequired[ + "AccountCreateParamsIdentityIndividualDocumentsPrimaryVerification" + ] + """ + An identifying document showing the person's name, either a passport or local ID card. + """ + secondary_verification: NotRequired[ + "AccountCreateParamsIdentityIndividualDocumentsSecondaryVerification" + ] + """ + A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. + """ + visa: NotRequired["AccountCreateParamsIdentityIndividualDocumentsVisa"] + """ + One or more documents showing the person's visa required for living in the country where they are residing. + """ + + +class AccountCreateParamsIdentityIndividualDocumentsCompanyAuthorization( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountCreateParamsIdentityIndividualDocumentsPassport(TypedDict): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountCreateParamsIdentityIndividualDocumentsPrimaryVerification( + TypedDict, +): + front_back: "AccountCreateParamsIdentityIndividualDocumentsPrimaryVerificationFrontBack" + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + + +class AccountCreateParamsIdentityIndividualDocumentsPrimaryVerificationFrontBack( + TypedDict, +): + back: NotRequired[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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: str + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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 AccountCreateParamsIdentityIndividualDocumentsSecondaryVerification( + TypedDict, +): + front_back: "AccountCreateParamsIdentityIndividualDocumentsSecondaryVerificationFrontBack" + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + + +class AccountCreateParamsIdentityIndividualDocumentsSecondaryVerificationFrontBack( + TypedDict, +): + back: NotRequired[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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: str + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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 AccountCreateParamsIdentityIndividualDocumentsVisa(TypedDict): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountCreateParamsIdentityIndividualIdNumber(TypedDict): + type: Literal[ + "ae_eid", + "ao_nif", + "ar_cuil", + "ar_dni", + "at_stn", + "az_tin", + "bd_brc", + "bd_etin", + "bd_nid", + "be_nrn", + "bg_ucn", + "bn_nric", + "br_cpf", + "ca_sin", + "ch_oasi", + "cl_rut", + "cn_pp", + "co_nuip", + "cr_ci", + "cr_cpf", + "cr_dimex", + "cr_nite", + "cy_tic", + "cz_rc", + "de_stn", + "dk_cpr", + "do_cie", + "do_rcn", + "ec_ci", + "ee_ik", + "es_nif", + "fi_hetu", + "fr_nir", + "gb_nino", + "gr_afm", + "gt_nit", + "hk_id", + "hr_oib", + "hu_ad", + "id_nik", + "ie_ppsn", + "is_kt", + "it_cf", + "jp_inc", + "ke_pin", + "kz_iin", + "li_peid", + "lt_ak", + "lu_nif", + "lv_pk", + "mx_rfc", + "my_nric", + "mz_nuit", + "ng_nin", + "nl_bsn", + "no_nin", + "nz_ird", + "pe_dni", + "pk_cnic", + "pk_snic", + "pl_pesel", + "pt_nif", + "ro_cnp", + "sa_tin", + "se_pin", + "sg_fin", + "sg_nric", + "sk_dic", + "th_lc", + "th_pin", + "tr_tin", + "us_itin", + "us_itin_last_4", + "us_ssn", + "us_ssn_last_4", + "uy_dni", + "za_id", + ] + """ + The ID number type of an individual. + """ + value: str + """ + The value of the ID number. + """ + + +class AccountCreateParamsIdentityIndividualRelationship(TypedDict): + director: NotRequired[bool] + """ + Whether the person is a director of the account's identity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. + """ + executive: NotRequired[bool] + """ + Whether the person has significant responsibility to control, manage, or direct the organization. + """ + owner: NotRequired[bool] + """ + Whether the person is an owner of the account's identity. + """ + percent_ownership: NotRequired[str] + """ + The percent owned by the person of the account's legal entity. + """ + title: NotRequired[str] + """ + The person's title (e.g., CEO, Support Engineer). + """ + + +class AccountCreateParamsIdentityIndividualScriptAddresses(TypedDict): + kana: NotRequired[ + "AccountCreateParamsIdentityIndividualScriptAddressesKana" + ] + """ + Kana Address. + """ + kanji: NotRequired[ + "AccountCreateParamsIdentityIndividualScriptAddressesKanji" + ] + """ + Kanji Address. + """ + + +class AccountCreateParamsIdentityIndividualScriptAddressesKana(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: str + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountCreateParamsIdentityIndividualScriptAddressesKanji(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: str + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountCreateParamsIdentityIndividualScriptNames(TypedDict): + kana: NotRequired["AccountCreateParamsIdentityIndividualScriptNamesKana"] + """ + Persons name in kana script. + """ + kanji: NotRequired["AccountCreateParamsIdentityIndividualScriptNamesKanji"] + """ + Persons name in kanji script. + """ + + +class AccountCreateParamsIdentityIndividualScriptNamesKana(TypedDict): + given_name: NotRequired[str] + """ + The person's first or given name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ + + +class AccountCreateParamsIdentityIndividualScriptNamesKanji(TypedDict): + given_name: NotRequired[str] + """ + The person's first or given name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ diff --git a/stripe/params/v2/core/_account_link_create_params.py b/stripe/params/v2/core/_account_link_create_params.py new file mode 100644 index 000000000..f9446fe97 --- /dev/null +++ b/stripe/params/v2/core/_account_link_create_params.py @@ -0,0 +1,98 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from typing import List +from typing_extensions import Literal, NotRequired, TypedDict + + +class AccountLinkCreateParams(TypedDict): + account: str + """ + The ID of the Account to create link for. + """ + use_case: "AccountLinkCreateParamsUseCase" + """ + The use case of the AccountLink. + """ + + +class AccountLinkCreateParamsUseCase(TypedDict): + type: Literal["account_onboarding", "account_update"] + """ + Open Enum. The type of Account Link the user is requesting. + """ + account_onboarding: NotRequired[ + "AccountLinkCreateParamsUseCaseAccountOnboarding" + ] + """ + Hash containing configuration options for an Account Link object that onboards a new account. + """ + account_update: NotRequired["AccountLinkCreateParamsUseCaseAccountUpdate"] + """ + Hash containing configuration options for an Account Link that updates an existing account. + """ + + +class AccountLinkCreateParamsUseCaseAccountOnboarding(TypedDict): + collection_options: NotRequired[ + "AccountLinkCreateParamsUseCaseAccountOnboardingCollectionOptions" + ] + """ + Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow. + """ + configurations: List[Literal["customer", "merchant", "recipient"]] + """ + Open Enum. A v2/core/account can be configured to enable certain functionality. The configuration param targets the v2/core/account_link to collect information for the specified v2/core/account configuration/s. + """ + refresh_url: str + """ + The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party. + """ + return_url: NotRequired[str] + """ + The URL that the user will be redirected to upon completing the linked flow. + """ + + +class AccountLinkCreateParamsUseCaseAccountOnboardingCollectionOptions( + TypedDict, +): + fields: NotRequired[Literal["currently_due", "eventually_due"]] + """ + 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"]] + """ + Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`. + """ + + +class AccountLinkCreateParamsUseCaseAccountUpdate(TypedDict): + collection_options: NotRequired[ + "AccountLinkCreateParamsUseCaseAccountUpdateCollectionOptions" + ] + """ + Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow. + """ + configurations: List[Literal["customer", "merchant", "recipient"]] + """ + Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s. + """ + refresh_url: str + """ + The URL the user will be redirected to if the Account Link is expired, has been used, 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 URL so they can continue the flow. Make sure to authenticate the user before redirecting to the new Account Link, in case the URL leaks to a third party. If a new Account Link can't be generated, or if the redirect fails, you should display a useful error to the user. + """ + return_url: NotRequired[str] + """ + The URL that the user will be redirected to upon completing the linked flow. + """ + + +class AccountLinkCreateParamsUseCaseAccountUpdateCollectionOptions(TypedDict): + fields: NotRequired[Literal["currently_due", "eventually_due"]] + """ + Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). The default value is `currently_due`. + """ + 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/params/v2/core/_account_list_params.py b/stripe/params/v2/core/_account_list_params.py new file mode 100644 index 000000000..39ee29c71 --- /dev/null +++ b/stripe/params/v2/core/_account_list_params.py @@ -0,0 +1,21 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from typing import List +from typing_extensions import Literal, NotRequired, TypedDict + + +class AccountListParams(TypedDict): + applied_configurations: NotRequired[ + List[Literal["customer", "merchant", "recipient"]] + ] + """ + Filter only accounts that have all of the configurations specified. If omitted, returns all accounts regardless of which configurations they have. + """ + closed: NotRequired[bool] + """ + Filter by whether the account is closed. If omitted, returns only Accounts that are not closed. + """ + limit: NotRequired[int] + """ + The upper limit on the number of accounts returned by the List Account request. + """ diff --git a/stripe/params/v2/core/_account_retrieve_params.py b/stripe/params/v2/core/_account_retrieve_params.py new file mode 100644 index 000000000..d04a55d50 --- /dev/null +++ b/stripe/params/v2/core/_account_retrieve_params.py @@ -0,0 +1,23 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from typing import List +from typing_extensions import Literal, NotRequired, TypedDict + + +class AccountRetrieveParams(TypedDict): + include: NotRequired[ + List[ + Literal[ + "configuration.customer", + "configuration.merchant", + "configuration.recipient", + "defaults", + "future_requirements", + "identity", + "requirements", + ] + ] + ] + """ + Additional fields to include in the response. + """ diff --git a/stripe/params/v2/core/_account_token_create_params.py b/stripe/params/v2/core/_account_token_create_params.py new file mode 100644 index 000000000..eeb12ed82 --- /dev/null +++ b/stripe/params/v2/core/_account_token_create_params.py @@ -0,0 +1,1303 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from typing import Dict, List, Optional +from typing_extensions import Literal, NotRequired, TypedDict + + +class AccountTokenCreateParams(TypedDict): + contact_email: NotRequired[str] + """ + The default contact email address for the Account. Required when configuring the account as a merchant or recipient. + """ + display_name: NotRequired[str] + """ + A descriptive name for the Account. This name will be surfaced in the Stripe Dashboard and on any invoices sent to the Account. + """ + identity: NotRequired["AccountTokenCreateParamsIdentity"] + """ + Information about the company, individual, and business represented by the Account. + """ + + +class AccountTokenCreateParamsIdentity(TypedDict): + attestations: NotRequired["AccountTokenCreateParamsIdentityAttestations"] + """ + Attestations from the identity's key people, e.g. owners, executives, directors, representatives. + """ + business_details: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetails" + ] + """ + Information about the company or business. + """ + entity_type: NotRequired[ + Literal["company", "government_entity", "individual", "non_profit"] + ] + """ + The entity type. + """ + individual: NotRequired["AccountTokenCreateParamsIdentityIndividual"] + """ + Information about the person represented by the account. + """ + + +class AccountTokenCreateParamsIdentityAttestations(TypedDict): + directorship_declaration: NotRequired[ + "AccountTokenCreateParamsIdentityAttestationsDirectorshipDeclaration" + ] + """ + This hash is used to attest that the directors information provided to Stripe is both current and correct; IP, date, and User Agent are expanded by Stripe. + """ + ownership_declaration: NotRequired[ + "AccountTokenCreateParamsIdentityAttestationsOwnershipDeclaration" + ] + """ + This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct; IP, date, and User Agent are expanded by Stripe. + """ + persons_provided: NotRequired[ + "AccountTokenCreateParamsIdentityAttestationsPersonsProvided" + ] + """ + Attestation that all Persons with a specific Relationship value have been provided. + """ + representative_declaration: NotRequired[ + "AccountTokenCreateParamsIdentityAttestationsRepresentativeDeclaration" + ] + """ + This hash is used to attest that the representative is authorized to act as the representative of their legal entity; IP, date, and User Agent are expanded by Stripe. + """ + terms_of_service: NotRequired[ + "AccountTokenCreateParamsIdentityAttestationsTermsOfService" + ] + """ + Attestations of accepted terms of service agreements. + """ + + +class AccountTokenCreateParamsIdentityAttestationsDirectorshipDeclaration( + TypedDict, +): + attested: NotRequired[bool] + """ + A boolean indicating if the directors information has been attested. + """ + + +class AccountTokenCreateParamsIdentityAttestationsOwnershipDeclaration( + TypedDict, +): + attested: NotRequired[bool] + """ + A boolean indicating if the beneficial owner information has been attested. + """ + + +class AccountTokenCreateParamsIdentityAttestationsPersonsProvided(TypedDict): + directors: 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://docs.stripe.com/api/v2/core/accounts/createperson). + """ + executives: 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://docs.stripe.com/api/v2/core/accounts/createperson). + """ + owners: 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://docs.stripe.com/api/v2/core/accounts/createperson). + """ + ownership_exemption_reason: NotRequired[ + Literal[ + "qualified_entity_exceeds_ownership_threshold", + "qualifies_as_financial_institution", + ] + ] + """ + Reason for why the company is exempt from providing ownership information. + """ + + +class AccountTokenCreateParamsIdentityAttestationsRepresentativeDeclaration( + TypedDict, +): + attested: NotRequired[bool] + """ + A boolean indicating if the representative is authorized to act as the representative of their legal entity. + """ + + +class AccountTokenCreateParamsIdentityAttestationsTermsOfService(TypedDict): + account: NotRequired[ + "AccountTokenCreateParamsIdentityAttestationsTermsOfServiceAccount" + ] + """ + Details on the Account's acceptance of the [Stripe Services Agreement]; IP, date, and User Agent are expanded by Stripe. + """ + + +class AccountTokenCreateParamsIdentityAttestationsTermsOfServiceAccount( + TypedDict, +): + shown_and_accepted: NotRequired[bool] + """ + The boolean value indicating if the terms of service have been accepted. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetails(TypedDict): + address: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsAddress" + ] + """ + The business registration address of the business entity. + """ + annual_revenue: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsAnnualRevenue" + ] + """ + The business gross annual revenue for its preceding fiscal year. + """ + documents: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsDocuments" + ] + """ + A document verifying the business. + """ + estimated_worker_count: NotRequired[int] + """ + Estimated maximum number of workers currently engaged by the business (including employees, contractors, and vendors). + """ + id_numbers: NotRequired[ + List["AccountTokenCreateParamsIdentityBusinessDetailsIdNumber"] + ] + """ + The ID numbers of a business entity. + """ + monthly_estimated_revenue: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenue" + ] + """ + An estimate of the monthly revenue of the business. + """ + phone: NotRequired[str] + """ + The phone number of the Business Entity. + """ + registered_name: NotRequired[str] + """ + The business legal name. + """ + script_addresses: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsScriptAddresses" + ] + """ + The business registration address of the business entity in non latin script. + """ + script_names: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsScriptNames" + ] + """ + The business legal name in non latin script. + """ + structure: NotRequired[ + Literal[ + "cooperative", + "free_zone_establishment", + "free_zone_llc", + "governmental_unit", + "government_instrumentality", + "incorporated_association", + "incorporated_non_profit", + "incorporated_partnership", + "limited_liability_partnership", + "llc", + "multi_member_llc", + "private_company", + "private_corporation", + "private_partnership", + "public_company", + "public_corporation", + "public_listed_corporation", + "public_partnership", + "registered_charity", + "single_member_llc", + "sole_establishment", + "sole_proprietorship", + "tax_exempt_government_instrumentality", + "trust", + "unincorporated_association", + "unincorporated_non_profit", + "unincorporated_partnership", + ] + ] + """ + The category identifying the legal structure of the business. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsAnnualRevenue(TypedDict): + amount: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsAnnualRevenueAmount" + ] + """ + A non-negative integer representing the amount in the smallest currency unit. + """ + fiscal_year_end: NotRequired[str] + """ + The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsAnnualRevenueAmount( + TypedDict, +): + value: NotRequired[int] + """ + A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). + """ + 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). + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsDocuments(TypedDict): + bank_account_ownership_verification: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsBankAccountOwnershipVerification" + ] + """ + One or more documents that support the bank account ownership verification requirement. Must be a document associated with the account's primary active bank account that displays the last 4 digits of the account number, either a statement or a check. + """ + company_license: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyLicense" + ] + """ + One or more documents that demonstrate proof of a company's license to operate. + """ + company_memorandum_of_association: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyMemorandumOfAssociation" + ] + """ + One or more documents showing the company's Memorandum of Association. + """ + company_ministerial_decree: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyMinisterialDecree" + ] + """ + Certain countries only: One or more documents showing the ministerial decree legalizing the company's establishment. + """ + company_registration_verification: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyRegistrationVerification" + ] + """ + One or more documents that demonstrate proof of a company's registration with the appropriate local authorities. + """ + company_tax_id_verification: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyTaxIdVerification" + ] + """ + One or more documents that demonstrate proof of a company's tax ID. + """ + primary_verification: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerification" + ] + """ + A document verifying the business. + """ + proof_of_address: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsProofOfAddress" + ] + """ + One or more documents that demonstrate proof of address. + """ + proof_of_registration: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsProofOfRegistration" + ] + """ + One or more documents showing the company's proof of registration with the national business registry. + """ + proof_of_ultimate_beneficial_ownership: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsProofOfUltimateBeneficialOwnership" + ] + """ + One or more documents that demonstrate proof of ultimate beneficial ownership. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsDocumentsBankAccountOwnershipVerification( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyLicense( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyMemorandumOfAssociation( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyMinisterialDecree( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyRegistrationVerification( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsDocumentsCompanyTaxIdVerification( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerification( + TypedDict, +): + front_back: "AccountTokenCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerificationFrontBack" + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsDocumentsPrimaryVerificationFrontBack( + TypedDict, +): + back: NotRequired[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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 AccountTokenCreateParamsIdentityBusinessDetailsDocumentsProofOfAddress( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsDocumentsProofOfRegistration( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsDocumentsProofOfUltimateBeneficialOwnership( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsIdNumber(TypedDict): + registrar: NotRequired[str] + """ + The registrar of the ID number (Only valid for DE ID number types). + """ + type: Literal[ + "ae_crn", + "ae_vat", + "ao_nif", + "ar_cuit", + "at_fn", + "at_stn", + "at_vat", + "au_abn", + "au_acn", + "au_in", + "az_tin", + "bd_etin", + "be_cbe", + "be_vat", + "bg_uic", + "bg_vat", + "br_cnpj", + "ca_cn", + "ca_crarr", + "ca_gst_hst", + "ca_neq", + "ca_rid", + "ch_chid", + "ch_uid", + "cr_cpj", + "cr_nite", + "cy_he", + "cy_tic", + "cy_vat", + "cz_ico", + "cz_vat", + "de_hrn", + "de_stn", + "de_vat", + "dk_cvr", + "dk_vat", + "do_rcn", + "ee_rk", + "ee_vat", + "es_cif", + "es_vat", + "fi_vat", + "fi_yt", + "fr_rna", + "fr_siren", + "fr_vat", + "gb_crn", + "gi_crn", + "gr_afm", + "gr_gemi", + "gr_vat", + "gt_nit", + "hk_br", + "hk_cr", + "hr_mbs", + "hr_oib", + "hr_vat", + "hu_cjs", + "hu_tin", + "hu_vat", + "ie_crn", + "ie_trn", + "ie_vat", + "it_rea", + "it_vat", + "jp_cn", + "kz_bin", + "li_uid", + "lt_ccrn", + "lt_vat", + "lu_nif", + "lu_rcs", + "lu_vat", + "lv_urn", + "lv_vat", + "mt_crn", + "mt_tin", + "mt_vat", + "mx_rfc", + "my_brn", + "my_coid", + "my_itn", + "my_sst", + "mz_nuit", + "nl_kvk", + "nl_rsin", + "nl_vat", + "no_orgnr", + "nz_bn", + "nz_ird", + "pe_ruc", + "pk_ntn", + "pl_nip", + "pl_regon", + "pl_vat", + "pt_vat", + "ro_cui", + "ro_orc", + "ro_vat", + "sa_crn", + "sa_tin", + "se_orgnr", + "se_vat", + "sg_uen", + "si_msp", + "si_tin", + "si_vat", + "sk_dic", + "sk_ico", + "sk_vat", + "th_crn", + "th_prn", + "th_tin", + "us_ein", + ] + """ + Open Enum. The ID number type of a business entity. + """ + value: str + """ + The value of the ID number. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenue( + TypedDict, +): + amount: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenueAmount" + ] + """ + A non-negative integer representing the amount in the smallest currency unit. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsMonthlyEstimatedRevenueAmount( + TypedDict, +): + value: NotRequired[int] + """ + A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). + """ + 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). + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsScriptAddresses( + TypedDict +): + kana: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsScriptAddressesKana" + ] + """ + Kana Address. + """ + kanji: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsScriptAddressesKanji" + ] + """ + Kanji Address. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsScriptAddressesKana( + TypedDict, +): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsScriptAddressesKanji( + TypedDict, +): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsScriptNames(TypedDict): + kana: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsScriptNamesKana" + ] + """ + Kana name. + """ + kanji: NotRequired[ + "AccountTokenCreateParamsIdentityBusinessDetailsScriptNamesKanji" + ] + """ + Kanji name. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsScriptNamesKana( + TypedDict +): + registered_name: NotRequired[str] + """ + Registered name of the business. + """ + + +class AccountTokenCreateParamsIdentityBusinessDetailsScriptNamesKanji( + TypedDict, +): + registered_name: NotRequired[str] + """ + Registered name of the business. + """ + + +class AccountTokenCreateParamsIdentityIndividual(TypedDict): + additional_addresses: NotRequired[ + List["AccountTokenCreateParamsIdentityIndividualAdditionalAddress"] + ] + """ + Additional addresses associated with the individual. + """ + additional_names: NotRequired[ + List["AccountTokenCreateParamsIdentityIndividualAdditionalName"] + ] + """ + Additional names (e.g. aliases) associated with the individual. + """ + address: NotRequired["AccountTokenCreateParamsIdentityIndividualAddress"] + """ + The individual's residential address. + """ + date_of_birth: NotRequired[ + "AccountTokenCreateParamsIdentityIndividualDateOfBirth" + ] + """ + The individual's date of birth. + """ + documents: NotRequired[ + "AccountTokenCreateParamsIdentityIndividualDocuments" + ] + """ + Documents that may be submitted to satisfy various informational requests. + """ + email: NotRequired[str] + """ + The individual's email address. + """ + given_name: NotRequired[str] + """ + The individual's first name. + """ + id_numbers: NotRequired[ + List["AccountTokenCreateParamsIdentityIndividualIdNumber"] + ] + """ + The identification numbers (e.g., SSN) associated with the individual. + """ + legal_gender: NotRequired[Literal["female", "male"]] + """ + The individual's gender (International regulations require either "male" or "female"). + """ + metadata: NotRequired[Dict[str, Optional[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. + """ + nationalities: NotRequired[List[str]] + """ + The countries where the individual is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + phone: NotRequired[str] + """ + The individual's phone number. + """ + political_exposure: NotRequired[Literal["existing", "none"]] + """ + The individual's political exposure. + """ + relationship: NotRequired[ + "AccountTokenCreateParamsIdentityIndividualRelationship" + ] + """ + The relationship that this individual has with the account's identity. + """ + script_addresses: NotRequired[ + "AccountTokenCreateParamsIdentityIndividualScriptAddresses" + ] + """ + The script addresses (e.g., non-Latin characters) associated with the individual. + """ + script_names: NotRequired[ + "AccountTokenCreateParamsIdentityIndividualScriptNames" + ] + """ + The individuals primary name in non latin script. + """ + surname: NotRequired[str] + """ + The individual's last name. + """ + + +class AccountTokenCreateParamsIdentityIndividualAdditionalAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + purpose: Literal["registered"] + """ + Purpose of additional address. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountTokenCreateParamsIdentityIndividualAdditionalName(TypedDict): + full_name: NotRequired[str] + """ + The person's full name. + """ + given_name: NotRequired[str] + """ + The person's first or given name. + """ + purpose: Literal["alias", "maiden"] + """ + The purpose or type of the additional name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ + + +class AccountTokenCreateParamsIdentityIndividualAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountTokenCreateParamsIdentityIndividualDateOfBirth(TypedDict): + day: int + """ + The day of the birth. + """ + month: int + """ + The month of birth. + """ + year: int + """ + The year of birth. + """ + + +class AccountTokenCreateParamsIdentityIndividualDocuments(TypedDict): + company_authorization: NotRequired[ + "AccountTokenCreateParamsIdentityIndividualDocumentsCompanyAuthorization" + ] + """ + One or more documents that demonstrate proof that this person is authorized to represent the company. + """ + passport: NotRequired[ + "AccountTokenCreateParamsIdentityIndividualDocumentsPassport" + ] + """ + One or more documents showing the person's passport page with photo and personal data. + """ + primary_verification: NotRequired[ + "AccountTokenCreateParamsIdentityIndividualDocumentsPrimaryVerification" + ] + """ + An identifying document showing the person's name, either a passport or local ID card. + """ + secondary_verification: NotRequired[ + "AccountTokenCreateParamsIdentityIndividualDocumentsSecondaryVerification" + ] + """ + A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. + """ + visa: NotRequired[ + "AccountTokenCreateParamsIdentityIndividualDocumentsVisa" + ] + """ + One or more documents showing the person's visa required for living in the country where they are residing. + """ + + +class AccountTokenCreateParamsIdentityIndividualDocumentsCompanyAuthorization( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountTokenCreateParamsIdentityIndividualDocumentsPassport(TypedDict): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountTokenCreateParamsIdentityIndividualDocumentsPrimaryVerification( + TypedDict, +): + front_back: "AccountTokenCreateParamsIdentityIndividualDocumentsPrimaryVerificationFrontBack" + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + + +class AccountTokenCreateParamsIdentityIndividualDocumentsPrimaryVerificationFrontBack( + TypedDict, +): + back: NotRequired[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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 AccountTokenCreateParamsIdentityIndividualDocumentsSecondaryVerification( + TypedDict, +): + front_back: "AccountTokenCreateParamsIdentityIndividualDocumentsSecondaryVerificationFrontBack" + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + + +class AccountTokenCreateParamsIdentityIndividualDocumentsSecondaryVerificationFrontBack( + TypedDict, +): + back: NotRequired[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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 AccountTokenCreateParamsIdentityIndividualDocumentsVisa(TypedDict): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountTokenCreateParamsIdentityIndividualIdNumber(TypedDict): + type: Literal[ + "ae_eid", + "ao_nif", + "ar_cuil", + "ar_dni", + "at_stn", + "az_tin", + "bd_brc", + "bd_etin", + "bd_nid", + "be_nrn", + "bg_ucn", + "bn_nric", + "br_cpf", + "ca_sin", + "ch_oasi", + "cl_rut", + "cn_pp", + "co_nuip", + "cr_ci", + "cr_cpf", + "cr_dimex", + "cr_nite", + "cy_tic", + "cz_rc", + "de_stn", + "dk_cpr", + "do_cie", + "do_rcn", + "ec_ci", + "ee_ik", + "es_nif", + "fi_hetu", + "fr_nir", + "gb_nino", + "gr_afm", + "gt_nit", + "hk_id", + "hr_oib", + "hu_ad", + "id_nik", + "ie_ppsn", + "is_kt", + "it_cf", + "jp_inc", + "ke_pin", + "kz_iin", + "li_peid", + "lt_ak", + "lu_nif", + "lv_pk", + "mx_rfc", + "my_nric", + "mz_nuit", + "ng_nin", + "nl_bsn", + "no_nin", + "nz_ird", + "pe_dni", + "pk_cnic", + "pk_snic", + "pl_pesel", + "pt_nif", + "ro_cnp", + "sa_tin", + "se_pin", + "sg_fin", + "sg_nric", + "sk_dic", + "th_lc", + "th_pin", + "tr_tin", + "us_itin", + "us_itin_last_4", + "us_ssn", + "us_ssn_last_4", + "uy_dni", + "za_id", + ] + """ + The ID number type of an individual. + """ + value: str + """ + The value of the ID number. + """ + + +class AccountTokenCreateParamsIdentityIndividualRelationship(TypedDict): + director: NotRequired[bool] + """ + Whether the person is a director of the account's identity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. + """ + executive: NotRequired[bool] + """ + Whether the person has significant responsibility to control, manage, or direct the organization. + """ + owner: NotRequired[bool] + """ + Whether the person is an owner of the account's identity. + """ + percent_ownership: NotRequired[str] + """ + The percent owned by the person of the account's legal entity. + """ + title: NotRequired[str] + """ + The person's title (e.g., CEO, Support Engineer). + """ + + +class AccountTokenCreateParamsIdentityIndividualScriptAddresses(TypedDict): + kana: NotRequired[ + "AccountTokenCreateParamsIdentityIndividualScriptAddressesKana" + ] + """ + Kana Address. + """ + kanji: NotRequired[ + "AccountTokenCreateParamsIdentityIndividualScriptAddressesKanji" + ] + """ + Kanji Address. + """ + + +class AccountTokenCreateParamsIdentityIndividualScriptAddressesKana(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountTokenCreateParamsIdentityIndividualScriptAddressesKanji( + TypedDict +): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountTokenCreateParamsIdentityIndividualScriptNames(TypedDict): + kana: NotRequired[ + "AccountTokenCreateParamsIdentityIndividualScriptNamesKana" + ] + """ + Persons name in kana script. + """ + kanji: NotRequired[ + "AccountTokenCreateParamsIdentityIndividualScriptNamesKanji" + ] + """ + Persons name in kanji script. + """ + + +class AccountTokenCreateParamsIdentityIndividualScriptNamesKana(TypedDict): + given_name: NotRequired[str] + """ + The person's first or given name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ + + +class AccountTokenCreateParamsIdentityIndividualScriptNamesKanji(TypedDict): + given_name: NotRequired[str] + """ + The person's first or given name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ diff --git a/stripe/params/v2/core/_account_token_retrieve_params.py b/stripe/params/v2/core/_account_token_retrieve_params.py new file mode 100644 index 000000000..0fd39f322 --- /dev/null +++ b/stripe/params/v2/core/_account_token_retrieve_params.py @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from typing_extensions import TypedDict + + +class AccountTokenRetrieveParams(TypedDict): + pass diff --git a/stripe/params/v2/core/_account_update_params.py b/stripe/params/v2/core/_account_update_params.py new file mode 100644 index 000000000..38c0ff060 --- /dev/null +++ b/stripe/params/v2/core/_account_update_params.py @@ -0,0 +1,2675 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from typing import Dict, List, Optional +from typing_extensions import Literal, NotRequired, TypedDict + + +class AccountUpdateParams(TypedDict): + account_token: NotRequired[str] + """ + The account token generated by the account token api. + """ + configuration: NotRequired["AccountUpdateParamsConfiguration"] + """ + An Account Configuration which allows the Account to take on a key persona across Stripe products. + """ + contact_email: NotRequired[str] + """ + The default contact email address for the Account. Required when configuring the account as a merchant or recipient. + """ + dashboard: NotRequired[Literal["express", "full", "none"]] + """ + A value indicating the Stripe dashboard this Account has access to. This will depend on which configurations are enabled for this account. + """ + defaults: NotRequired["AccountUpdateParamsDefaults"] + """ + Default values to be used on Account Configurations. + """ + display_name: NotRequired[str] + """ + A descriptive name for the Account. This name will be surfaced in the Stripe Dashboard and on any invoices sent to the Account. + """ + identity: NotRequired["AccountUpdateParamsIdentity"] + """ + Information about the company, individual, and business represented by the Account. + """ + include: NotRequired[ + List[ + Literal[ + "configuration.customer", + "configuration.merchant", + "configuration.recipient", + "defaults", + "future_requirements", + "identity", + "requirements", + ] + ] + ] + """ + Additional fields to include in the response. + """ + metadata: NotRequired[Dict[str, Optional[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. + """ + + +class AccountUpdateParamsConfiguration(TypedDict): + customer: NotRequired["AccountUpdateParamsConfigurationCustomer"] + """ + The Customer Configuration allows the Account to be charged. + """ + merchant: NotRequired["AccountUpdateParamsConfigurationMerchant"] + """ + Enables the Account to act as a connected account and collect payments facilitated by a Connect platform. You must onboard your platform to Connect before you can add this configuration to your connected accounts. Utilize this configuration when the Account will be the Merchant of Record, like with Direct charges or Destination Charges with on_behalf_of set. + """ + recipient: NotRequired["AccountUpdateParamsConfigurationRecipient"] + """ + The Recipient Configuration allows the Account to receive funds. Utilize this configuration if the Account will not be the Merchant of Record, like with Separate Charges & Transfers, or Destination Charges without on_behalf_of set. + """ + + +class AccountUpdateParamsConfigurationCustomer(TypedDict): + applied: NotRequired[bool] + """ + Represents the state of the configuration, and can be updated to deactivate or re-apply a configuration. + """ + automatic_indirect_tax: NotRequired[ + "AccountUpdateParamsConfigurationCustomerAutomaticIndirectTax" + ] + """ + Automatic indirect tax settings to be used when automatic tax calculation is enabled on the customer's invoices, subscriptions, checkout sessions, or payment links. Surfaces if automatic tax calculation is possible given the current customer location information. + """ + billing: NotRequired["AccountUpdateParamsConfigurationCustomerBilling"] + """ + Billing settings - default settings used for this customer in Billing flows such as Invoices and Subscriptions. + """ + capabilities: NotRequired[ + "AccountUpdateParamsConfigurationCustomerCapabilities" + ] + """ + Capabilities that have been requested on the Customer Configuration. + """ + shipping: NotRequired["AccountUpdateParamsConfigurationCustomerShipping"] + """ + The customer's shipping information. Appears on invoices emailed to this customer. + """ + test_clock: NotRequired[str] + """ + ID of the test clock to attach to the customer. Can only be set on testmode Accounts, and when the Customer Configuration is first set on an Account. + """ + + +class AccountUpdateParamsConfigurationCustomerAutomaticIndirectTax(TypedDict): + exempt: NotRequired[Literal["exempt", "none", "reverse"]] + """ + The customer account's tax exemption status: `none`, `exempt`, or `reverse`. When `reverse`, invoice and receipt PDFs include "Reverse charge". + """ + ip_address: NotRequired[str] + """ + A recent IP address of the customer used for tax reporting and tax location inference. + """ + validate_location: NotRequired[Literal["auto", "deferred", "immediately"]] + """ + A per-request flag that indicates when Stripe should validate the customer tax location - defaults to `auto`. + """ + + +class AccountUpdateParamsConfigurationCustomerBilling(TypedDict): + default_payment_method: NotRequired[str] + """ + ID of a PaymentMethod attached to the customer account to use as the default for invoices and subscriptions. + """ + invoice: NotRequired[ + "AccountUpdateParamsConfigurationCustomerBillingInvoice" + ] + """ + Default invoice settings for the customer account. + """ + + +class AccountUpdateParamsConfigurationCustomerBillingInvoice(TypedDict): + custom_fields: NotRequired[ + List[ + "AccountUpdateParamsConfigurationCustomerBillingInvoiceCustomField" + ] + ] + """ + The list of up to 4 default custom fields to be displayed on invoices for this customer. + """ + footer: NotRequired[str] + """ + Default invoice footer. + """ + next_sequence: NotRequired[int] + """ + Sequence number to use on the customer account's next invoice. Defaults to 1. + """ + prefix: NotRequired[str] + """ + Prefix used to generate unique invoice numbers. Must be 3-12 uppercase letters or numbers. + """ + rendering: NotRequired[ + "AccountUpdateParamsConfigurationCustomerBillingInvoiceRendering" + ] + """ + Default invoice PDF rendering options. + """ + + +class AccountUpdateParamsConfigurationCustomerBillingInvoiceCustomField( + TypedDict, +): + name: str + """ + The name of the custom field. This may be up to 40 characters. + """ + value: str + """ + The value of the custom field. This may be up to 140 characters. When updating, pass an empty string to remove previously-defined values. + """ + + +class AccountUpdateParamsConfigurationCustomerBillingInvoiceRendering( + TypedDict, +): + amount_tax_display: NotRequired[ + Literal["exclude_tax", "include_inclusive_tax"] + ] + """ + Indicates whether displayed line item prices and amounts on invoice PDFs include inclusive tax amounts. Must be either `include_inclusive_tax` or `exclude_tax`. + """ + template: NotRequired[str] + """ + ID of the invoice rendering template to use for future invoices. + """ + + +class AccountUpdateParamsConfigurationCustomerCapabilities(TypedDict): + automatic_indirect_tax: NotRequired[ + "AccountUpdateParamsConfigurationCustomerCapabilitiesAutomaticIndirectTax" + ] + """ + Generates requirements for enabling automatic indirect tax calculation on this customer's invoices or subscriptions. Recommended to request this capability if planning to enable automatic tax calculation on this customer's invoices or subscriptions. + """ + + +class AccountUpdateParamsConfigurationCustomerCapabilitiesAutomaticIndirectTax( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationCustomerShipping(TypedDict): + address: NotRequired[ + "AccountUpdateParamsConfigurationCustomerShippingAddress" + ] + """ + Customer shipping address. + """ + name: NotRequired[str] + """ + Customer name. + """ + phone: NotRequired[str] + """ + Customer phone (including extension). + """ + + +class AccountUpdateParamsConfigurationCustomerShippingAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + + +class AccountUpdateParamsConfigurationMerchant(TypedDict): + applied: NotRequired[bool] + """ + Represents the state of the configuration, and can be updated to deactivate or re-apply a configuration. + """ + bacs_debit_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantBacsDebitPayments" + ] + """ + Settings for Bacs Direct Debit payments. + """ + branding: NotRequired["AccountUpdateParamsConfigurationMerchantBranding"] + """ + Settings used to apply the merchant's branding to email receipts, invoices, Checkout, and other products. + """ + capabilities: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilities" + ] + """ + Capabilities to request on the Merchant Configuration. + """ + card_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCardPayments" + ] + """ + Card payments settings. + """ + konbini_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantKonbiniPayments" + ] + """ + Settings specific to Konbini payments on the account. + """ + mcc: NotRequired[str] + """ + The Merchant Category Code (MCC) for the merchant. MCCs classify businesses based on the goods or services they provide. + """ + script_statement_descriptor: NotRequired[ + "AccountUpdateParamsConfigurationMerchantScriptStatementDescriptor" + ] + """ + Settings for the default text that appears on statements for language variations. + """ + statement_descriptor: NotRequired[ + "AccountUpdateParamsConfigurationMerchantStatementDescriptor" + ] + """ + Settings for the default [statement descriptor](https://docs.stripe.com/connect/statement-descriptors) text. + """ + support: NotRequired["AccountUpdateParamsConfigurationMerchantSupport"] + """ + Publicly available contact information for sending support issues to. + """ + + +class AccountUpdateParamsConfigurationMerchantBacsDebitPayments(TypedDict): + display_name: NotRequired[str] + """ + Display name for Bacs Direct Debit payments. + """ + + +class AccountUpdateParamsConfigurationMerchantBranding(TypedDict): + icon: NotRequired[str] + """ + ID of a [file upload](https://docs.stripe.com/api/persons/update#create_file): An icon for the merchant. Must be square and at least 128px x 128px. + """ + logo: NotRequired[str] + """ + ID of a [file upload](https://docs.stripe.com/api/persons/update#create_file): A logo for the merchant that will be used in Checkout instead of the icon and without the merchant's name next to it if provided. Must be at least 128px x 128px. + """ + primary_color: NotRequired[str] + """ + A CSS hex color value representing the primary branding color for the merchant. + """ + secondary_color: NotRequired[str] + """ + A CSS hex color value representing the secondary branding color for the merchant. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilities(TypedDict): + ach_debit_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesAchDebitPayments" + ] + """ + Allow the merchant to process ACH debit payments. + """ + acss_debit_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesAcssDebitPayments" + ] + """ + Allow the merchant to process ACSS debit payments. + """ + affirm_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesAffirmPayments" + ] + """ + Allow the merchant to process Affirm payments. + """ + afterpay_clearpay_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesAfterpayClearpayPayments" + ] + """ + Allow the merchant to process Afterpay/Clearpay payments. + """ + alma_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesAlmaPayments" + ] + """ + Allow the merchant to process Alma payments. + """ + amazon_pay_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesAmazonPayPayments" + ] + """ + Allow the merchant to process Amazon Pay payments. + """ + au_becs_debit_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesAuBecsDebitPayments" + ] + """ + Allow the merchant to process Australian BECS Direct Debit payments. + """ + bacs_debit_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesBacsDebitPayments" + ] + """ + Allow the merchant to process BACS Direct Debit payments. + """ + bancontact_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesBancontactPayments" + ] + """ + Allow the merchant to process Bancontact payments. + """ + blik_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesBlikPayments" + ] + """ + Allow the merchant to process BLIK payments. + """ + boleto_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesBoletoPayments" + ] + """ + Allow the merchant to process Boleto payments. + """ + card_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesCardPayments" + ] + """ + Allow the merchant to collect card payments. + """ + cartes_bancaires_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesCartesBancairesPayments" + ] + """ + Allow the merchant to process Cartes Bancaires payments. + """ + cashapp_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesCashappPayments" + ] + """ + Allow the merchant to process Cash App payments. + """ + eps_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesEpsPayments" + ] + """ + Allow the merchant to process EPS payments. + """ + fpx_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesFpxPayments" + ] + """ + Allow the merchant to process FPX payments. + """ + gb_bank_transfer_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesGbBankTransferPayments" + ] + """ + Allow the merchant to process UK bank transfer payments. + """ + grabpay_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesGrabpayPayments" + ] + """ + Allow the merchant to process GrabPay payments. + """ + ideal_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesIdealPayments" + ] + """ + Allow the merchant to process iDEAL payments. + """ + jcb_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesJcbPayments" + ] + """ + Allow the merchant to process JCB card payments. + """ + jp_bank_transfer_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesJpBankTransferPayments" + ] + """ + Allow the merchant to process Japanese bank transfer payments. + """ + kakao_pay_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesKakaoPayPayments" + ] + """ + Allow the merchant to process Kakao Pay payments. + """ + klarna_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesKlarnaPayments" + ] + """ + Allow the merchant to process Klarna payments. + """ + konbini_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesKonbiniPayments" + ] + """ + Allow the merchant to process Konbini convenience store payments. + """ + kr_card_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesKrCardPayments" + ] + """ + Allow the merchant to process Korean card payments. + """ + link_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesLinkPayments" + ] + """ + Allow the merchant to process Link payments. + """ + mobilepay_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesMobilepayPayments" + ] + """ + Allow the merchant to process MobilePay payments. + """ + multibanco_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesMultibancoPayments" + ] + """ + Allow the merchant to process Multibanco payments. + """ + mx_bank_transfer_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesMxBankTransferPayments" + ] + """ + Allow the merchant to process Mexican bank transfer payments. + """ + naver_pay_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesNaverPayPayments" + ] + """ + Allow the merchant to process Naver Pay payments. + """ + oxxo_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesOxxoPayments" + ] + """ + Allow the merchant to process OXXO payments. + """ + p24_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesP24Payments" + ] + """ + Allow the merchant to process Przelewy24 (P24) payments. + """ + pay_by_bank_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesPayByBankPayments" + ] + """ + Allow the merchant to process Pay by Bank payments. + """ + payco_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesPaycoPayments" + ] + """ + Allow the merchant to process PAYCO payments. + """ + paynow_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesPaynowPayments" + ] + """ + Allow the merchant to process PayNow payments. + """ + promptpay_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesPromptpayPayments" + ] + """ + Allow the merchant to process PromptPay payments. + """ + revolut_pay_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesRevolutPayPayments" + ] + """ + Allow the merchant to process Revolut Pay payments. + """ + samsung_pay_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesSamsungPayPayments" + ] + """ + Allow the merchant to process Samsung Pay payments. + """ + sepa_bank_transfer_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesSepaBankTransferPayments" + ] + """ + Allow the merchant to process SEPA bank transfer payments. + """ + sepa_debit_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesSepaDebitPayments" + ] + """ + Allow the merchant to process SEPA Direct Debit payments. + """ + swish_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesSwishPayments" + ] + """ + Allow the merchant to process Swish payments. + """ + twint_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesTwintPayments" + ] + """ + Allow the merchant to process TWINT payments. + """ + us_bank_transfer_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesUsBankTransferPayments" + ] + """ + Allow the merchant to process US bank transfer payments. + """ + zip_payments: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCapabilitiesZipPayments" + ] + """ + Allow the merchant to process Zip payments. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesAchDebitPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesAcssDebitPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesAffirmPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesAfterpayClearpayPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesAlmaPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesAmazonPayPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesAuBecsDebitPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesBacsDebitPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesBancontactPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesBlikPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesBoletoPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesCardPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesCartesBancairesPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesCashappPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesEpsPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesFpxPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesGbBankTransferPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesGrabpayPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesIdealPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesJcbPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesJpBankTransferPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesKakaoPayPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesKlarnaPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesKonbiniPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesKrCardPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesLinkPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesMobilepayPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesMultibancoPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesMxBankTransferPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesNaverPayPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesOxxoPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesP24Payments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesPayByBankPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesPaycoPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesPaynowPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesPromptpayPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesRevolutPayPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesSamsungPayPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesSepaBankTransferPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesSepaDebitPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesSwishPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesTwintPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesUsBankTransferPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCapabilitiesZipPayments( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsConfigurationMerchantCardPayments(TypedDict): + decline_on: NotRequired[ + "AccountUpdateParamsConfigurationMerchantCardPaymentsDeclineOn" + ] + """ + Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge. + """ + + +class AccountUpdateParamsConfigurationMerchantCardPaymentsDeclineOn(TypedDict): + 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] + """ + Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification. + """ + + +class AccountUpdateParamsConfigurationMerchantKonbiniPayments(TypedDict): + support: NotRequired[ + "AccountUpdateParamsConfigurationMerchantKonbiniPaymentsSupport" + ] + """ + Support for Konbini payments. + """ + + +class AccountUpdateParamsConfigurationMerchantKonbiniPaymentsSupport( + TypedDict +): + email: NotRequired[str] + """ + Support email address for Konbini payments. + """ + hours: NotRequired[ + "AccountUpdateParamsConfigurationMerchantKonbiniPaymentsSupportHours" + ] + """ + Support hours for Konbini payments. + """ + phone: NotRequired[str] + """ + Support phone number for Konbini payments. + """ + + +class AccountUpdateParamsConfigurationMerchantKonbiniPaymentsSupportHours( + TypedDict, +): + end_time: NotRequired[str] + """ + Support hours end time (JST time of day) for in `HH:MM` format. + """ + start_time: NotRequired[str] + """ + Support hours start time (JST time of day) for in `HH:MM` format. + """ + + +class AccountUpdateParamsConfigurationMerchantScriptStatementDescriptor( + TypedDict, +): + kana: NotRequired[ + "AccountUpdateParamsConfigurationMerchantScriptStatementDescriptorKana" + ] + """ + The Kana variation of statement_descriptor used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). + """ + kanji: NotRequired[ + "AccountUpdateParamsConfigurationMerchantScriptStatementDescriptorKanji" + ] + """ + The Kanji variation of statement_descriptor used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). + """ + + +class AccountUpdateParamsConfigurationMerchantScriptStatementDescriptorKana( + TypedDict, +): + descriptor: NotRequired[str] + """ + The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a statement_descriptor_prefix, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + prefix: NotRequired[str] + """ + Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don't specify this value, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + + +class AccountUpdateParamsConfigurationMerchantScriptStatementDescriptorKanji( + TypedDict, +): + descriptor: NotRequired[str] + """ + The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a statement_descriptor_prefix, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + prefix: NotRequired[str] + """ + Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don't specify this value, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + + +class AccountUpdateParamsConfigurationMerchantStatementDescriptor(TypedDict): + descriptor: NotRequired[str] + """ + The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a statement_descriptor_prefix, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + prefix: NotRequired[str] + """ + Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don't specify this value, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + + +class AccountUpdateParamsConfigurationMerchantSupport(TypedDict): + address: NotRequired[ + "AccountUpdateParamsConfigurationMerchantSupportAddress" + ] + """ + A publicly available mailing address for sending support issues to. + """ + email: NotRequired[str] + """ + A publicly available email address for sending support issues to. + """ + phone: NotRequired[str] + """ + A publicly available phone number to call with support issues. + """ + url: NotRequired[str] + """ + A publicly available website for handling support issues. + """ + + +class AccountUpdateParamsConfigurationMerchantSupportAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountUpdateParamsConfigurationRecipient(TypedDict): + applied: NotRequired[bool] + """ + Represents the state of the configuration, and can be updated to deactivate or re-apply a configuration. + """ + capabilities: NotRequired[ + "AccountUpdateParamsConfigurationRecipientCapabilities" + ] + """ + Capabilities to request on the Recipient Configuration. + """ + + +class AccountUpdateParamsConfigurationRecipientCapabilities(TypedDict): + stripe_balance: NotRequired[ + "AccountUpdateParamsConfigurationRecipientCapabilitiesStripeBalance" + ] + """ + Capabilities that enable the recipient to manage their Stripe Balance (/v1/balance). + """ + + +class AccountUpdateParamsConfigurationRecipientCapabilitiesStripeBalance( + TypedDict, +): + stripe_transfers: NotRequired[ + "AccountUpdateParamsConfigurationRecipientCapabilitiesStripeBalanceStripeTransfers" + ] + """ + Enables this Account to receive /v1/transfers into their Stripe Balance (/v1/balance). + """ + + +class AccountUpdateParamsConfigurationRecipientCapabilitiesStripeBalanceStripeTransfers( + TypedDict, +): + requested: NotRequired[bool] + """ + To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active. + """ + + +class AccountUpdateParamsDefaults(TypedDict): + 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). + """ + locales: NotRequired[ + List[ + Literal[ + "ar-SA", + "bg", + "bg-BG", + "cs", + "cs-CZ", + "da", + "da-DK", + "de", + "de-DE", + "el", + "el-GR", + "en", + "en-AU", + "en-CA", + "en-GB", + "en-IE", + "en-IN", + "en-NZ", + "en-SG", + "en-US", + "es", + "es-419", + "es-ES", + "et", + "et-EE", + "fi", + "fil", + "fil-PH", + "fi-FI", + "fr", + "fr-CA", + "fr-FR", + "he-IL", + "hr", + "hr-HR", + "hu", + "hu-HU", + "id", + "id-ID", + "it", + "it-IT", + "ja", + "ja-JP", + "ko", + "ko-KR", + "lt", + "lt-LT", + "lv", + "lv-LV", + "ms", + "ms-MY", + "mt", + "mt-MT", + "nb", + "nb-NO", + "nl", + "nl-NL", + "pl", + "pl-PL", + "pt", + "pt-BR", + "pt-PT", + "ro", + "ro-RO", + "ru", + "ru-RU", + "sk", + "sk-SK", + "sl", + "sl-SI", + "sv", + "sv-SE", + "th", + "th-TH", + "tr", + "tr-TR", + "vi", + "vi-VN", + "zh", + "zh-Hans", + "zh-Hant-HK", + "zh-Hant-TW", + "zh-HK", + "zh-TW", + ] + ] + ] + """ + The Account's preferred locales (languages), ordered by preference. + """ + profile: NotRequired["AccountUpdateParamsDefaultsProfile"] + """ + Account profile information. + """ + responsibilities: NotRequired[ + "AccountUpdateParamsDefaultsResponsibilities" + ] + """ + Default responsibilities held by either Stripe or the platform. + """ + + +class AccountUpdateParamsDefaultsProfile(TypedDict): + business_url: NotRequired[str] + """ + The business's publicly-available website. + """ + doing_business_as: NotRequired[str] + """ + The name which is used by the business. + """ + product_description: NotRequired[str] + """ + Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. + """ + + +class AccountUpdateParamsDefaultsResponsibilities(TypedDict): + fees_collector: Literal[ + "application", "application_custom", "application_express", "stripe" + ] + """ + A value indicating the party responsible for collecting fees from this account. + """ + losses_collector: Literal["application", "stripe"] + """ + A value indicating who is responsible for losses when this Account can't pay back negative balances from payments. + """ + + +class AccountUpdateParamsIdentity(TypedDict): + attestations: NotRequired["AccountUpdateParamsIdentityAttestations"] + """ + Attestations from the identity's key people, e.g. owners, executives, directors, representatives. + """ + business_details: NotRequired["AccountUpdateParamsIdentityBusinessDetails"] + """ + Information about the company or business. + """ + 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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. + """ + entity_type: NotRequired[ + Literal["company", "government_entity", "individual", "non_profit"] + ] + """ + The entity type. + """ + individual: NotRequired["AccountUpdateParamsIdentityIndividual"] + """ + Information about the individual represented by the Account. This property is `null` unless `entity_type` is set to `individual`. + """ + + +class AccountUpdateParamsIdentityAttestations(TypedDict): + directorship_declaration: NotRequired[ + "AccountUpdateParamsIdentityAttestationsDirectorshipDeclaration" + ] + """ + This hash is used to attest that the directors information provided to Stripe is both current and correct. + """ + ownership_declaration: NotRequired[ + "AccountUpdateParamsIdentityAttestationsOwnershipDeclaration" + ] + """ + This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. + """ + persons_provided: NotRequired[ + "AccountUpdateParamsIdentityAttestationsPersonsProvided" + ] + """ + Attestation that all Persons with a specific Relationship value have been provided. + """ + representative_declaration: NotRequired[ + "AccountUpdateParamsIdentityAttestationsRepresentativeDeclaration" + ] + """ + This hash is used to attest that the representative is authorized to act as the representative of their legal entity. + """ + terms_of_service: NotRequired[ + "AccountUpdateParamsIdentityAttestationsTermsOfService" + ] + """ + Attestations of accepted terms of service agreements. + """ + + +class AccountUpdateParamsIdentityAttestationsDirectorshipDeclaration( + TypedDict +): + date: NotRequired[str] + """ + The time marking when the director attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: NotRequired[str] + """ + The IP address from which the director attestation was made. + """ + user_agent: NotRequired[str] + """ + The user agent of the browser from which the director attestation was made. + """ + + +class AccountUpdateParamsIdentityAttestationsOwnershipDeclaration(TypedDict): + date: NotRequired[str] + """ + The time marking when the beneficial owner attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: NotRequired[str] + """ + The IP address from which the beneficial owner attestation was made. + """ + user_agent: NotRequired[str] + """ + The user agent of the browser from which the beneficial owner attestation was made. + """ + + +class AccountUpdateParamsIdentityAttestationsPersonsProvided(TypedDict): + directors: 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://docs.stripe.com/api/v2/core/accounts/createperson). + """ + executives: 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://docs.stripe.com/api/v2/core/accounts/createperson). + """ + owners: 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://docs.stripe.com/api/v2/core/accounts/createperson). + """ + ownership_exemption_reason: NotRequired[ + Literal[ + "qualified_entity_exceeds_ownership_threshold", + "qualifies_as_financial_institution", + ] + ] + """ + Reason for why the company is exempt from providing ownership information. + """ + + +class AccountUpdateParamsIdentityAttestationsRepresentativeDeclaration( + TypedDict, +): + date: NotRequired[str] + """ + The time marking when the representative attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: NotRequired[str] + """ + The IP address from which the representative attestation was made. + """ + user_agent: NotRequired[str] + """ + The user agent of the browser from which the representative attestation was made. + """ + + +class AccountUpdateParamsIdentityAttestationsTermsOfService(TypedDict): + account: NotRequired[ + "AccountUpdateParamsIdentityAttestationsTermsOfServiceAccount" + ] + """ + Details on the Account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance). + """ + crypto_storer: NotRequired[ + "AccountUpdateParamsIdentityAttestationsTermsOfServiceCryptoStorer" + ] + """ + Details on the Account's acceptance of Crypto-storer-specific terms of service. + """ + storer: NotRequired[ + "AccountUpdateParamsIdentityAttestationsTermsOfServiceStorer" + ] + """ + Details on the Account's acceptance of Treasury-specific terms of service. + """ + + +class AccountUpdateParamsIdentityAttestationsTermsOfServiceAccount(TypedDict): + date: NotRequired[str] + """ + The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: NotRequired[str] + """ + The IP address from which the Account's representative accepted the terms of service. + """ + user_agent: NotRequired[str] + """ + The user agent of the browser from which the Account's representative accepted the terms of service. + """ + + +class AccountUpdateParamsIdentityAttestationsTermsOfServiceCryptoStorer( + TypedDict, +): + date: NotRequired[str] + """ + The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: NotRequired[str] + """ + The IP address from which the Account's representative accepted the terms of service. + """ + user_agent: NotRequired[str] + """ + The user agent of the browser from which the Account's representative accepted the terms of service. + """ + + +class AccountUpdateParamsIdentityAttestationsTermsOfServiceStorer(TypedDict): + date: NotRequired[str] + """ + The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: NotRequired[str] + """ + The IP address from which the Account's representative accepted the terms of service. + """ + user_agent: NotRequired[str] + """ + The user agent of the browser from which the Account's representative accepted the terms of service. + """ + + +class AccountUpdateParamsIdentityBusinessDetails(TypedDict): + address: NotRequired["AccountUpdateParamsIdentityBusinessDetailsAddress"] + """ + The business registration address of the business entity. + """ + annual_revenue: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsAnnualRevenue" + ] + """ + The business gross annual revenue for its preceding fiscal year. + """ + documents: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsDocuments" + ] + """ + A document verifying the business. + """ + estimated_worker_count: NotRequired[int] + """ + Estimated maximum number of workers currently engaged by the business (including employees, contractors, and vendors). + """ + id_numbers: NotRequired[ + List["AccountUpdateParamsIdentityBusinessDetailsIdNumber"] + ] + """ + The ID numbers of a business entity. + """ + monthly_estimated_revenue: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsMonthlyEstimatedRevenue" + ] + """ + An estimate of the monthly revenue of the business. + """ + phone: NotRequired[str] + """ + The phone number of the Business Entity. + """ + registered_name: NotRequired[str] + """ + The business legal name. + """ + script_addresses: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsScriptAddresses" + ] + """ + The business registration address of the business entity in non latin script. + """ + script_names: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsScriptNames" + ] + """ + The business legal name in non latin script. + """ + structure: NotRequired[ + Literal[ + "cooperative", + "free_zone_establishment", + "free_zone_llc", + "governmental_unit", + "government_instrumentality", + "incorporated_association", + "incorporated_non_profit", + "incorporated_partnership", + "limited_liability_partnership", + "llc", + "multi_member_llc", + "private_company", + "private_corporation", + "private_partnership", + "public_company", + "public_corporation", + "public_listed_corporation", + "public_partnership", + "registered_charity", + "single_member_llc", + "sole_establishment", + "sole_proprietorship", + "tax_exempt_government_instrumentality", + "trust", + "unincorporated_association", + "unincorporated_non_profit", + "unincorporated_partnership", + ] + ] + """ + The category identifying the legal structure of the business. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsAnnualRevenue(TypedDict): + amount: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsAnnualRevenueAmount" + ] + """ + A non-negative integer representing the amount in the smallest currency unit. + """ + fiscal_year_end: NotRequired[str] + """ + The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsAnnualRevenueAmount(TypedDict): + value: NotRequired[int] + """ + A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). + """ + 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). + """ + + +class AccountUpdateParamsIdentityBusinessDetailsDocuments(TypedDict): + bank_account_ownership_verification: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsDocumentsBankAccountOwnershipVerification" + ] + """ + One or more documents that support the bank account ownership verification requirement. Must be a document associated with the account's primary active bank account that displays the last 4 digits of the account number, either a statement or a check. + """ + company_license: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyLicense" + ] + """ + One or more documents that demonstrate proof of a company's license to operate. + """ + company_memorandum_of_association: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyMemorandumOfAssociation" + ] + """ + One or more documents showing the company's Memorandum of Association. + """ + company_ministerial_decree: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyMinisterialDecree" + ] + """ + Certain countries only: One or more documents showing the ministerial decree legalizing the company's establishment. + """ + company_registration_verification: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyRegistrationVerification" + ] + """ + One or more documents that demonstrate proof of a company's registration with the appropriate local authorities. + """ + company_tax_id_verification: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyTaxIdVerification" + ] + """ + One or more documents that demonstrate proof of a company's tax ID. + """ + primary_verification: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsDocumentsPrimaryVerification" + ] + """ + A document verifying the business. + """ + proof_of_address: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsDocumentsProofOfAddress" + ] + """ + One or more documents that demonstrate proof of address. + """ + proof_of_registration: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsDocumentsProofOfRegistration" + ] + """ + One or more documents showing the company's proof of registration with the national business registry. + """ + proof_of_ultimate_beneficial_ownership: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsDocumentsProofOfUltimateBeneficialOwnership" + ] + """ + One or more documents that demonstrate proof of ultimate beneficial ownership. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsDocumentsBankAccountOwnershipVerification( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyLicense( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyMemorandumOfAssociation( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyMinisterialDecree( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyRegistrationVerification( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsDocumentsCompanyTaxIdVerification( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsDocumentsPrimaryVerification( + TypedDict, +): + front_back: "AccountUpdateParamsIdentityBusinessDetailsDocumentsPrimaryVerificationFrontBack" + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsDocumentsPrimaryVerificationFrontBack( + TypedDict, +): + back: NotRequired[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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 AccountUpdateParamsIdentityBusinessDetailsDocumentsProofOfAddress( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsDocumentsProofOfRegistration( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsDocumentsProofOfUltimateBeneficialOwnership( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsIdNumber(TypedDict): + registrar: NotRequired[str] + """ + The registrar of the ID number (Only valid for DE ID number types). + """ + type: Literal[ + "ae_crn", + "ae_vat", + "ao_nif", + "ar_cuit", + "at_fn", + "at_stn", + "at_vat", + "au_abn", + "au_acn", + "au_in", + "az_tin", + "bd_etin", + "be_cbe", + "be_vat", + "bg_uic", + "bg_vat", + "br_cnpj", + "ca_cn", + "ca_crarr", + "ca_gst_hst", + "ca_neq", + "ca_rid", + "ch_chid", + "ch_uid", + "cr_cpj", + "cr_nite", + "cy_he", + "cy_tic", + "cy_vat", + "cz_ico", + "cz_vat", + "de_hrn", + "de_stn", + "de_vat", + "dk_cvr", + "dk_vat", + "do_rcn", + "ee_rk", + "ee_vat", + "es_cif", + "es_vat", + "fi_vat", + "fi_yt", + "fr_rna", + "fr_siren", + "fr_vat", + "gb_crn", + "gi_crn", + "gr_afm", + "gr_gemi", + "gr_vat", + "gt_nit", + "hk_br", + "hk_cr", + "hr_mbs", + "hr_oib", + "hr_vat", + "hu_cjs", + "hu_tin", + "hu_vat", + "ie_crn", + "ie_trn", + "ie_vat", + "it_rea", + "it_vat", + "jp_cn", + "kz_bin", + "li_uid", + "lt_ccrn", + "lt_vat", + "lu_nif", + "lu_rcs", + "lu_vat", + "lv_urn", + "lv_vat", + "mt_crn", + "mt_tin", + "mt_vat", + "mx_rfc", + "my_brn", + "my_coid", + "my_itn", + "my_sst", + "mz_nuit", + "nl_kvk", + "nl_rsin", + "nl_vat", + "no_orgnr", + "nz_bn", + "nz_ird", + "pe_ruc", + "pk_ntn", + "pl_nip", + "pl_regon", + "pl_vat", + "pt_vat", + "ro_cui", + "ro_orc", + "ro_vat", + "sa_crn", + "sa_tin", + "se_orgnr", + "se_vat", + "sg_uen", + "si_msp", + "si_tin", + "si_vat", + "sk_dic", + "sk_ico", + "sk_vat", + "th_crn", + "th_prn", + "th_tin", + "us_ein", + ] + """ + Open Enum. The ID number type of a business entity. + """ + value: str + """ + The value of the ID number. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsMonthlyEstimatedRevenue( + TypedDict, +): + amount: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsMonthlyEstimatedRevenueAmount" + ] + """ + A non-negative integer representing the amount in the smallest currency unit. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsMonthlyEstimatedRevenueAmount( + TypedDict, +): + value: NotRequired[int] + """ + A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). + """ + 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). + """ + + +class AccountUpdateParamsIdentityBusinessDetailsScriptAddresses(TypedDict): + kana: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsScriptAddressesKana" + ] + """ + Kana Address. + """ + kanji: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsScriptAddressesKanji" + ] + """ + Kanji Address. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsScriptAddressesKana(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsScriptAddressesKanji( + TypedDict +): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsScriptNames(TypedDict): + kana: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsScriptNamesKana" + ] + """ + Kana name. + """ + kanji: NotRequired[ + "AccountUpdateParamsIdentityBusinessDetailsScriptNamesKanji" + ] + """ + Kanji name. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsScriptNamesKana(TypedDict): + registered_name: NotRequired[str] + """ + Registered name of the business. + """ + + +class AccountUpdateParamsIdentityBusinessDetailsScriptNamesKanji(TypedDict): + registered_name: NotRequired[str] + """ + Registered name of the business. + """ + + +class AccountUpdateParamsIdentityIndividual(TypedDict): + additional_addresses: NotRequired[ + List["AccountUpdateParamsIdentityIndividualAdditionalAddress"] + ] + """ + Additional addresses associated with the individual. + """ + additional_names: NotRequired[ + List["AccountUpdateParamsIdentityIndividualAdditionalName"] + ] + """ + Additional names (e.g. aliases) associated with the individual. + """ + address: NotRequired["AccountUpdateParamsIdentityIndividualAddress"] + """ + The individual's residential address. + """ + date_of_birth: NotRequired[ + "AccountUpdateParamsIdentityIndividualDateOfBirth" + ] + """ + The individual's date of birth. + """ + documents: NotRequired["AccountUpdateParamsIdentityIndividualDocuments"] + """ + Documents that may be submitted to satisfy various informational requests. + """ + email: NotRequired[str] + """ + The individual's email address. + """ + given_name: NotRequired[str] + """ + The individual's first name. + """ + id_numbers: NotRequired[ + List["AccountUpdateParamsIdentityIndividualIdNumber"] + ] + """ + The identification numbers (e.g., SSN) associated with the individual. + """ + legal_gender: NotRequired[Literal["female", "male"]] + """ + The individual's gender (International regulations require either "male" or "female"). + """ + metadata: NotRequired[Dict[str, Optional[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. + """ + nationalities: NotRequired[List[str]] + """ + The countries where the individual is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + phone: NotRequired[str] + """ + The individual's phone number. + """ + political_exposure: NotRequired[Literal["existing", "none"]] + """ + The individual's political exposure. + """ + relationship: NotRequired[ + "AccountUpdateParamsIdentityIndividualRelationship" + ] + """ + The relationship that this individual has with the account's identity. + """ + script_addresses: NotRequired[ + "AccountUpdateParamsIdentityIndividualScriptAddresses" + ] + """ + The script addresses (e.g., non-Latin characters) associated with the individual. + """ + script_names: NotRequired[ + "AccountUpdateParamsIdentityIndividualScriptNames" + ] + """ + The individuals primary name in non latin script. + """ + surname: NotRequired[str] + """ + The individual's last name. + """ + + +class AccountUpdateParamsIdentityIndividualAdditionalAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + purpose: Literal["registered"] + """ + Purpose of additional address. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountUpdateParamsIdentityIndividualAdditionalName(TypedDict): + full_name: NotRequired[str] + """ + The person's full name. + """ + given_name: NotRequired[str] + """ + The person's first or given name. + """ + purpose: Literal["alias", "maiden"] + """ + The purpose or type of the additional name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ + + +class AccountUpdateParamsIdentityIndividualAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountUpdateParamsIdentityIndividualDateOfBirth(TypedDict): + day: int + """ + The day of the birth. + """ + month: int + """ + The month of birth. + """ + year: int + """ + The year of birth. + """ + + +class AccountUpdateParamsIdentityIndividualDocuments(TypedDict): + company_authorization: NotRequired[ + "AccountUpdateParamsIdentityIndividualDocumentsCompanyAuthorization" + ] + """ + One or more documents that demonstrate proof that this person is authorized to represent the company. + """ + passport: NotRequired[ + "AccountUpdateParamsIdentityIndividualDocumentsPassport" + ] + """ + One or more documents showing the person's passport page with photo and personal data. + """ + primary_verification: NotRequired[ + "AccountUpdateParamsIdentityIndividualDocumentsPrimaryVerification" + ] + """ + An identifying document showing the person's name, either a passport or local ID card. + """ + secondary_verification: NotRequired[ + "AccountUpdateParamsIdentityIndividualDocumentsSecondaryVerification" + ] + """ + A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. + """ + visa: NotRequired["AccountUpdateParamsIdentityIndividualDocumentsVisa"] + """ + One or more documents showing the person's visa required for living in the country where they are residing. + """ + + +class AccountUpdateParamsIdentityIndividualDocumentsCompanyAuthorization( + TypedDict, +): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountUpdateParamsIdentityIndividualDocumentsPassport(TypedDict): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountUpdateParamsIdentityIndividualDocumentsPrimaryVerification( + TypedDict, +): + front_back: "AccountUpdateParamsIdentityIndividualDocumentsPrimaryVerificationFrontBack" + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + + +class AccountUpdateParamsIdentityIndividualDocumentsPrimaryVerificationFrontBack( + TypedDict, +): + back: NotRequired[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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 AccountUpdateParamsIdentityIndividualDocumentsSecondaryVerification( + TypedDict, +): + front_back: "AccountUpdateParamsIdentityIndividualDocumentsSecondaryVerificationFrontBack" + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + + +class AccountUpdateParamsIdentityIndividualDocumentsSecondaryVerificationFrontBack( + TypedDict, +): + back: NotRequired[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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 AccountUpdateParamsIdentityIndividualDocumentsVisa(TypedDict): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class AccountUpdateParamsIdentityIndividualIdNumber(TypedDict): + type: Literal[ + "ae_eid", + "ao_nif", + "ar_cuil", + "ar_dni", + "at_stn", + "az_tin", + "bd_brc", + "bd_etin", + "bd_nid", + "be_nrn", + "bg_ucn", + "bn_nric", + "br_cpf", + "ca_sin", + "ch_oasi", + "cl_rut", + "cn_pp", + "co_nuip", + "cr_ci", + "cr_cpf", + "cr_dimex", + "cr_nite", + "cy_tic", + "cz_rc", + "de_stn", + "dk_cpr", + "do_cie", + "do_rcn", + "ec_ci", + "ee_ik", + "es_nif", + "fi_hetu", + "fr_nir", + "gb_nino", + "gr_afm", + "gt_nit", + "hk_id", + "hr_oib", + "hu_ad", + "id_nik", + "ie_ppsn", + "is_kt", + "it_cf", + "jp_inc", + "ke_pin", + "kz_iin", + "li_peid", + "lt_ak", + "lu_nif", + "lv_pk", + "mx_rfc", + "my_nric", + "mz_nuit", + "ng_nin", + "nl_bsn", + "no_nin", + "nz_ird", + "pe_dni", + "pk_cnic", + "pk_snic", + "pl_pesel", + "pt_nif", + "ro_cnp", + "sa_tin", + "se_pin", + "sg_fin", + "sg_nric", + "sk_dic", + "th_lc", + "th_pin", + "tr_tin", + "us_itin", + "us_itin_last_4", + "us_ssn", + "us_ssn_last_4", + "uy_dni", + "za_id", + ] + """ + The ID number type of an individual. + """ + value: str + """ + The value of the ID number. + """ + + +class AccountUpdateParamsIdentityIndividualRelationship(TypedDict): + director: NotRequired[bool] + """ + Whether the person is a director of the account's identity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. + """ + executive: NotRequired[bool] + """ + Whether the person has significant responsibility to control, manage, or direct the organization. + """ + owner: NotRequired[bool] + """ + Whether the person is an owner of the account's identity. + """ + percent_ownership: NotRequired[str] + """ + The percent owned by the person of the account's legal entity. + """ + title: NotRequired[str] + """ + The person's title (e.g., CEO, Support Engineer). + """ + + +class AccountUpdateParamsIdentityIndividualScriptAddresses(TypedDict): + kana: NotRequired[ + "AccountUpdateParamsIdentityIndividualScriptAddressesKana" + ] + """ + Kana Address. + """ + kanji: NotRequired[ + "AccountUpdateParamsIdentityIndividualScriptAddressesKanji" + ] + """ + Kanji Address. + """ + + +class AccountUpdateParamsIdentityIndividualScriptAddressesKana(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountUpdateParamsIdentityIndividualScriptAddressesKanji(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class AccountUpdateParamsIdentityIndividualScriptNames(TypedDict): + kana: NotRequired["AccountUpdateParamsIdentityIndividualScriptNamesKana"] + """ + Persons name in kana script. + """ + kanji: NotRequired["AccountUpdateParamsIdentityIndividualScriptNamesKanji"] + """ + Persons name in kanji script. + """ + + +class AccountUpdateParamsIdentityIndividualScriptNamesKana(TypedDict): + given_name: NotRequired[str] + """ + The person's first or given name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ + + +class AccountUpdateParamsIdentityIndividualScriptNamesKanji(TypedDict): + given_name: NotRequired[str] + """ + The person's first or given name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ diff --git a/stripe/params/v2/core/accounts/__init__.py b/stripe/params/v2/core/accounts/__init__.py new file mode 100644 index 000000000..867be9766 --- /dev/null +++ b/stripe/params/v2/core/accounts/__init__.py @@ -0,0 +1,404 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from importlib import import_module +from typing_extensions import TYPE_CHECKING + +if TYPE_CHECKING: + from stripe.params.v2.core.accounts._person_create_params import ( + PersonCreateParams as PersonCreateParams, + PersonCreateParamsAdditionalAddress as PersonCreateParamsAdditionalAddress, + PersonCreateParamsAdditionalName as PersonCreateParamsAdditionalName, + PersonCreateParamsAdditionalTermsOfService as PersonCreateParamsAdditionalTermsOfService, + PersonCreateParamsAdditionalTermsOfServiceAccount as PersonCreateParamsAdditionalTermsOfServiceAccount, + PersonCreateParamsAddress as PersonCreateParamsAddress, + PersonCreateParamsDateOfBirth as PersonCreateParamsDateOfBirth, + PersonCreateParamsDocuments as PersonCreateParamsDocuments, + PersonCreateParamsDocumentsCompanyAuthorization as PersonCreateParamsDocumentsCompanyAuthorization, + PersonCreateParamsDocumentsPassport as PersonCreateParamsDocumentsPassport, + PersonCreateParamsDocumentsPrimaryVerification as PersonCreateParamsDocumentsPrimaryVerification, + PersonCreateParamsDocumentsPrimaryVerificationFrontBack as PersonCreateParamsDocumentsPrimaryVerificationFrontBack, + PersonCreateParamsDocumentsSecondaryVerification as PersonCreateParamsDocumentsSecondaryVerification, + PersonCreateParamsDocumentsSecondaryVerificationFrontBack as PersonCreateParamsDocumentsSecondaryVerificationFrontBack, + PersonCreateParamsDocumentsVisa as PersonCreateParamsDocumentsVisa, + PersonCreateParamsIdNumber as PersonCreateParamsIdNumber, + PersonCreateParamsRelationship as PersonCreateParamsRelationship, + PersonCreateParamsScriptAddresses as PersonCreateParamsScriptAddresses, + PersonCreateParamsScriptAddressesKana as PersonCreateParamsScriptAddressesKana, + PersonCreateParamsScriptAddressesKanji as PersonCreateParamsScriptAddressesKanji, + PersonCreateParamsScriptNames as PersonCreateParamsScriptNames, + PersonCreateParamsScriptNamesKana as PersonCreateParamsScriptNamesKana, + PersonCreateParamsScriptNamesKanji as PersonCreateParamsScriptNamesKanji, + ) + from stripe.params.v2.core.accounts._person_delete_params import ( + PersonDeleteParams as PersonDeleteParams, + ) + from stripe.params.v2.core.accounts._person_list_params import ( + PersonListParams as PersonListParams, + ) + from stripe.params.v2.core.accounts._person_retrieve_params import ( + PersonRetrieveParams as PersonRetrieveParams, + ) + from stripe.params.v2.core.accounts._person_token_create_params import ( + PersonTokenCreateParams as PersonTokenCreateParams, + PersonTokenCreateParamsAdditionalAddress as PersonTokenCreateParamsAdditionalAddress, + PersonTokenCreateParamsAdditionalName as PersonTokenCreateParamsAdditionalName, + PersonTokenCreateParamsAdditionalTermsOfService as PersonTokenCreateParamsAdditionalTermsOfService, + PersonTokenCreateParamsAdditionalTermsOfServiceAccount as PersonTokenCreateParamsAdditionalTermsOfServiceAccount, + PersonTokenCreateParamsAddress as PersonTokenCreateParamsAddress, + PersonTokenCreateParamsDateOfBirth as PersonTokenCreateParamsDateOfBirth, + PersonTokenCreateParamsDocuments as PersonTokenCreateParamsDocuments, + PersonTokenCreateParamsDocumentsCompanyAuthorization as PersonTokenCreateParamsDocumentsCompanyAuthorization, + PersonTokenCreateParamsDocumentsPassport as PersonTokenCreateParamsDocumentsPassport, + PersonTokenCreateParamsDocumentsPrimaryVerification as PersonTokenCreateParamsDocumentsPrimaryVerification, + PersonTokenCreateParamsDocumentsPrimaryVerificationFrontBack as PersonTokenCreateParamsDocumentsPrimaryVerificationFrontBack, + PersonTokenCreateParamsDocumentsSecondaryVerification as PersonTokenCreateParamsDocumentsSecondaryVerification, + PersonTokenCreateParamsDocumentsSecondaryVerificationFrontBack as PersonTokenCreateParamsDocumentsSecondaryVerificationFrontBack, + PersonTokenCreateParamsDocumentsVisa as PersonTokenCreateParamsDocumentsVisa, + PersonTokenCreateParamsIdNumber as PersonTokenCreateParamsIdNumber, + PersonTokenCreateParamsRelationship as PersonTokenCreateParamsRelationship, + PersonTokenCreateParamsScriptAddresses as PersonTokenCreateParamsScriptAddresses, + PersonTokenCreateParamsScriptAddressesKana as PersonTokenCreateParamsScriptAddressesKana, + PersonTokenCreateParamsScriptAddressesKanji as PersonTokenCreateParamsScriptAddressesKanji, + PersonTokenCreateParamsScriptNames as PersonTokenCreateParamsScriptNames, + PersonTokenCreateParamsScriptNamesKana as PersonTokenCreateParamsScriptNamesKana, + PersonTokenCreateParamsScriptNamesKanji as PersonTokenCreateParamsScriptNamesKanji, + ) + from stripe.params.v2.core.accounts._person_token_retrieve_params import ( + PersonTokenRetrieveParams as PersonTokenRetrieveParams, + ) + from stripe.params.v2.core.accounts._person_update_params import ( + PersonUpdateParams as PersonUpdateParams, + PersonUpdateParamsAdditionalAddress as PersonUpdateParamsAdditionalAddress, + PersonUpdateParamsAdditionalName as PersonUpdateParamsAdditionalName, + PersonUpdateParamsAdditionalTermsOfService as PersonUpdateParamsAdditionalTermsOfService, + PersonUpdateParamsAdditionalTermsOfServiceAccount as PersonUpdateParamsAdditionalTermsOfServiceAccount, + PersonUpdateParamsAddress as PersonUpdateParamsAddress, + PersonUpdateParamsDateOfBirth as PersonUpdateParamsDateOfBirth, + PersonUpdateParamsDocuments as PersonUpdateParamsDocuments, + PersonUpdateParamsDocumentsCompanyAuthorization as PersonUpdateParamsDocumentsCompanyAuthorization, + PersonUpdateParamsDocumentsPassport as PersonUpdateParamsDocumentsPassport, + PersonUpdateParamsDocumentsPrimaryVerification as PersonUpdateParamsDocumentsPrimaryVerification, + PersonUpdateParamsDocumentsPrimaryVerificationFrontBack as PersonUpdateParamsDocumentsPrimaryVerificationFrontBack, + PersonUpdateParamsDocumentsSecondaryVerification as PersonUpdateParamsDocumentsSecondaryVerification, + PersonUpdateParamsDocumentsSecondaryVerificationFrontBack as PersonUpdateParamsDocumentsSecondaryVerificationFrontBack, + PersonUpdateParamsDocumentsVisa as PersonUpdateParamsDocumentsVisa, + PersonUpdateParamsIdNumber as PersonUpdateParamsIdNumber, + PersonUpdateParamsRelationship as PersonUpdateParamsRelationship, + PersonUpdateParamsScriptAddresses as PersonUpdateParamsScriptAddresses, + PersonUpdateParamsScriptAddressesKana as PersonUpdateParamsScriptAddressesKana, + PersonUpdateParamsScriptAddressesKanji as PersonUpdateParamsScriptAddressesKanji, + PersonUpdateParamsScriptNames as PersonUpdateParamsScriptNames, + PersonUpdateParamsScriptNamesKana as PersonUpdateParamsScriptNamesKana, + PersonUpdateParamsScriptNamesKanji as PersonUpdateParamsScriptNamesKanji, + ) + +# name -> (import_target, is_submodule) +_import_map = { + "PersonCreateParams": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsAdditionalAddress": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsAdditionalName": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsAdditionalTermsOfService": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsAdditionalTermsOfServiceAccount": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsAddress": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsDateOfBirth": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsDocuments": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsDocumentsCompanyAuthorization": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsDocumentsPassport": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsDocumentsPrimaryVerification": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsDocumentsPrimaryVerificationFrontBack": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsDocumentsSecondaryVerification": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsDocumentsSecondaryVerificationFrontBack": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsDocumentsVisa": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsIdNumber": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsRelationship": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsScriptAddresses": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsScriptAddressesKana": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsScriptAddressesKanji": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsScriptNames": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsScriptNamesKana": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonCreateParamsScriptNamesKanji": ( + "stripe.params.v2.core.accounts._person_create_params", + False, + ), + "PersonDeleteParams": ( + "stripe.params.v2.core.accounts._person_delete_params", + False, + ), + "PersonListParams": ( + "stripe.params.v2.core.accounts._person_list_params", + False, + ), + "PersonRetrieveParams": ( + "stripe.params.v2.core.accounts._person_retrieve_params", + False, + ), + "PersonTokenCreateParams": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsAdditionalAddress": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsAdditionalName": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsAdditionalTermsOfService": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsAdditionalTermsOfServiceAccount": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsAddress": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsDateOfBirth": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsDocuments": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsDocumentsCompanyAuthorization": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsDocumentsPassport": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsDocumentsPrimaryVerification": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsDocumentsPrimaryVerificationFrontBack": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsDocumentsSecondaryVerification": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsDocumentsSecondaryVerificationFrontBack": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsDocumentsVisa": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsIdNumber": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsRelationship": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsScriptAddresses": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsScriptAddressesKana": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsScriptAddressesKanji": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsScriptNames": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsScriptNamesKana": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenCreateParamsScriptNamesKanji": ( + "stripe.params.v2.core.accounts._person_token_create_params", + False, + ), + "PersonTokenRetrieveParams": ( + "stripe.params.v2.core.accounts._person_token_retrieve_params", + False, + ), + "PersonUpdateParams": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsAdditionalAddress": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsAdditionalName": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsAdditionalTermsOfService": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsAdditionalTermsOfServiceAccount": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsAddress": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsDateOfBirth": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsDocuments": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsDocumentsCompanyAuthorization": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsDocumentsPassport": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsDocumentsPrimaryVerification": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsDocumentsPrimaryVerificationFrontBack": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsDocumentsSecondaryVerification": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsDocumentsSecondaryVerificationFrontBack": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsDocumentsVisa": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsIdNumber": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsRelationship": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsScriptAddresses": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsScriptAddressesKana": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsScriptAddressesKanji": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsScriptNames": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsScriptNamesKana": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), + "PersonUpdateParamsScriptNamesKanji": ( + "stripe.params.v2.core.accounts._person_update_params", + False, + ), +} +if not TYPE_CHECKING: + + def __getattr__(name): + try: + target, is_submodule = _import_map[name] + module = import_module(target) + if is_submodule: + return module + + return getattr( + module, + name, + ) + except KeyError: + raise AttributeError() diff --git a/stripe/params/v2/core/accounts/_person_create_params.py b/stripe/params/v2/core/accounts/_person_create_params.py new file mode 100644 index 000000000..2c8bd0cda --- /dev/null +++ b/stripe/params/v2/core/accounts/_person_create_params.py @@ -0,0 +1,545 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from typing import Dict, List +from typing_extensions import Literal, NotRequired, TypedDict + + +class PersonCreateParams(TypedDict): + additional_addresses: NotRequired[ + List["PersonCreateParamsAdditionalAddress"] + ] + """ + Additional addresses associated with the person. + """ + additional_names: NotRequired[List["PersonCreateParamsAdditionalName"]] + """ + Additional names (e.g. aliases) associated with the person. + """ + additional_terms_of_service: NotRequired[ + "PersonCreateParamsAdditionalTermsOfService" + ] + """ + Attestations of accepted terms of service agreements. + """ + address: NotRequired["PersonCreateParamsAddress"] + """ + The person's residential address. + """ + date_of_birth: NotRequired["PersonCreateParamsDateOfBirth"] + """ + The person's date of birth. + """ + documents: NotRequired["PersonCreateParamsDocuments"] + """ + Documents that may be submitted to satisfy various informational requests. + """ + email: NotRequired[str] + """ + Email. + """ + given_name: NotRequired[str] + """ + The person's first name. + """ + id_numbers: NotRequired[List["PersonCreateParamsIdNumber"]] + """ + The identification numbers (e.g., SSN) associated with the person. + """ + legal_gender: NotRequired[Literal["female", "male"]] + """ + The person's gender (International regulations require either "male" or "female"). + """ + 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. + """ + nationalities: NotRequired[List[str]] + """ + The nationalities (countries) this person is associated with. + """ + person_token: NotRequired[str] + """ + The person token generated by the person token api. + """ + phone: NotRequired[str] + """ + The phone number for this person. + """ + political_exposure: NotRequired[Literal["existing", "none"]] + """ + The person's political exposure. + """ + relationship: NotRequired["PersonCreateParamsRelationship"] + """ + The relationship that this person has with the Account's business or legal entity. + """ + script_addresses: NotRequired["PersonCreateParamsScriptAddresses"] + """ + The script addresses (e.g., non-Latin characters) associated with the person. + """ + script_names: NotRequired["PersonCreateParamsScriptNames"] + """ + The script names (e.g. non-Latin characters) associated with the person. + """ + surname: NotRequired[str] + """ + The person's last name. + """ + + +class PersonCreateParamsAdditionalAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: str + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + purpose: Literal["registered"] + """ + Purpose of additional address. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class PersonCreateParamsAdditionalName(TypedDict): + full_name: NotRequired[str] + """ + The person's full name. + """ + given_name: NotRequired[str] + """ + The person's first or given name. + """ + purpose: Literal["alias", "maiden"] + """ + The purpose or type of the additional name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ + + +class PersonCreateParamsAdditionalTermsOfService(TypedDict): + account: NotRequired["PersonCreateParamsAdditionalTermsOfServiceAccount"] + """ + Stripe terms of service agreement. + """ + + +class PersonCreateParamsAdditionalTermsOfServiceAccount(TypedDict): + date: str + """ + The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: str + """ + The IP address from which the Account's representative accepted the terms of service. + """ + user_agent: NotRequired[str] + """ + The user agent of the browser from which the Account's representative accepted the terms of service. + """ + + +class PersonCreateParamsAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: str + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class PersonCreateParamsDateOfBirth(TypedDict): + day: int + """ + The day of birth. + """ + month: int + """ + The month of birth. + """ + year: int + """ + The year of birth. + """ + + +class PersonCreateParamsDocuments(TypedDict): + company_authorization: NotRequired[ + "PersonCreateParamsDocumentsCompanyAuthorization" + ] + """ + One or more documents that demonstrate proof that this person is authorized to represent the company. + """ + passport: NotRequired["PersonCreateParamsDocumentsPassport"] + """ + One or more documents showing the person's passport page with photo and personal data. + """ + primary_verification: NotRequired[ + "PersonCreateParamsDocumentsPrimaryVerification" + ] + """ + An identifying document showing the person's name, either a passport or local ID card. + """ + secondary_verification: NotRequired[ + "PersonCreateParamsDocumentsSecondaryVerification" + ] + """ + A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. + """ + visa: NotRequired["PersonCreateParamsDocumentsVisa"] + """ + One or more documents showing the person's visa required for living in the country where they are residing. + """ + + +class PersonCreateParamsDocumentsCompanyAuthorization(TypedDict): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class PersonCreateParamsDocumentsPassport(TypedDict): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class PersonCreateParamsDocumentsPrimaryVerification(TypedDict): + front_back: "PersonCreateParamsDocumentsPrimaryVerificationFrontBack" + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + + +class PersonCreateParamsDocumentsPrimaryVerificationFrontBack(TypedDict): + back: NotRequired[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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: str + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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 PersonCreateParamsDocumentsSecondaryVerification(TypedDict): + front_back: "PersonCreateParamsDocumentsSecondaryVerificationFrontBack" + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + + +class PersonCreateParamsDocumentsSecondaryVerificationFrontBack(TypedDict): + back: NotRequired[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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: str + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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 PersonCreateParamsDocumentsVisa(TypedDict): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class PersonCreateParamsIdNumber(TypedDict): + type: Literal[ + "ae_eid", + "ao_nif", + "ar_cuil", + "ar_dni", + "at_stn", + "az_tin", + "bd_brc", + "bd_etin", + "bd_nid", + "be_nrn", + "bg_ucn", + "bn_nric", + "br_cpf", + "ca_sin", + "ch_oasi", + "cl_rut", + "cn_pp", + "co_nuip", + "cr_ci", + "cr_cpf", + "cr_dimex", + "cr_nite", + "cy_tic", + "cz_rc", + "de_stn", + "dk_cpr", + "do_cie", + "do_rcn", + "ec_ci", + "ee_ik", + "es_nif", + "fi_hetu", + "fr_nir", + "gb_nino", + "gr_afm", + "gt_nit", + "hk_id", + "hr_oib", + "hu_ad", + "id_nik", + "ie_ppsn", + "is_kt", + "it_cf", + "jp_inc", + "ke_pin", + "kz_iin", + "li_peid", + "lt_ak", + "lu_nif", + "lv_pk", + "mx_rfc", + "my_nric", + "mz_nuit", + "ng_nin", + "nl_bsn", + "no_nin", + "nz_ird", + "pe_dni", + "pk_cnic", + "pk_snic", + "pl_pesel", + "pt_nif", + "ro_cnp", + "sa_tin", + "se_pin", + "sg_fin", + "sg_nric", + "sk_dic", + "th_lc", + "th_pin", + "tr_tin", + "us_itin", + "us_itin_last_4", + "us_ssn", + "us_ssn_last_4", + "uy_dni", + "za_id", + ] + """ + The ID number type of an individual. + """ + value: str + """ + The value of the ID number. + """ + + +class PersonCreateParamsRelationship(TypedDict): + authorizer: NotRequired[bool] + """ + Whether the individual is an authorizer of the Account's identity. + """ + director: NotRequired[bool] + """ + Indicates whether the person is a director of the associated legal entity. + """ + executive: NotRequired[bool] + """ + Indicates whether the person is an executive of the associated legal entity. + """ + legal_guardian: NotRequired[bool] + """ + Indicates whether the person is a legal guardian of the associated legal entity. + """ + owner: NotRequired[bool] + """ + Indicates whether the person is an owner of the associated legal entity. + """ + percent_ownership: NotRequired[str] + """ + The percentage of ownership the person has in the associated legal entity. + """ + representative: NotRequired[bool] + """ + Indicates whether the person is a representative of the associated legal entity. + """ + title: NotRequired[str] + """ + The title or position the person holds in the associated legal entity. + """ + + +class PersonCreateParamsScriptAddresses(TypedDict): + kana: NotRequired["PersonCreateParamsScriptAddressesKana"] + """ + Kana Address. + """ + kanji: NotRequired["PersonCreateParamsScriptAddressesKanji"] + """ + Kanji Address. + """ + + +class PersonCreateParamsScriptAddressesKana(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: str + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class PersonCreateParamsScriptAddressesKanji(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: str + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class PersonCreateParamsScriptNames(TypedDict): + kana: NotRequired["PersonCreateParamsScriptNamesKana"] + """ + Persons name in kana script. + """ + kanji: NotRequired["PersonCreateParamsScriptNamesKanji"] + """ + Persons name in kanji script. + """ + + +class PersonCreateParamsScriptNamesKana(TypedDict): + given_name: NotRequired[str] + """ + The person's first or given name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ + + +class PersonCreateParamsScriptNamesKanji(TypedDict): + given_name: NotRequired[str] + """ + The person's first or given name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ diff --git a/stripe/params/v2/core/accounts/_person_delete_params.py b/stripe/params/v2/core/accounts/_person_delete_params.py new file mode 100644 index 000000000..1dbea64d3 --- /dev/null +++ b/stripe/params/v2/core/accounts/_person_delete_params.py @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from typing_extensions import TypedDict + + +class PersonDeleteParams(TypedDict): + pass diff --git a/stripe/params/v2/core/accounts/_person_list_params.py b/stripe/params/v2/core/accounts/_person_list_params.py new file mode 100644 index 000000000..3c881ec02 --- /dev/null +++ b/stripe/params/v2/core/accounts/_person_list_params.py @@ -0,0 +1,10 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from typing_extensions import NotRequired, TypedDict + + +class PersonListParams(TypedDict): + limit: NotRequired[int] + """ + The upper limit on the number of accounts returned by the List Account request. + """ diff --git a/stripe/params/v2/core/accounts/_person_retrieve_params.py b/stripe/params/v2/core/accounts/_person_retrieve_params.py new file mode 100644 index 000000000..e34d217ce --- /dev/null +++ b/stripe/params/v2/core/accounts/_person_retrieve_params.py @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from typing_extensions import TypedDict + + +class PersonRetrieveParams(TypedDict): + pass diff --git a/stripe/params/v2/core/accounts/_person_token_create_params.py b/stripe/params/v2/core/accounts/_person_token_create_params.py new file mode 100644 index 000000000..846020361 --- /dev/null +++ b/stripe/params/v2/core/accounts/_person_token_create_params.py @@ -0,0 +1,541 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from typing import Dict, List, Optional +from typing_extensions import Literal, NotRequired, TypedDict + + +class PersonTokenCreateParams(TypedDict): + additional_addresses: NotRequired[ + List["PersonTokenCreateParamsAdditionalAddress"] + ] + """ + Additional addresses associated with the person. + """ + additional_names: NotRequired[ + List["PersonTokenCreateParamsAdditionalName"] + ] + """ + Additional names (e.g. aliases) associated with the person. + """ + additional_terms_of_service: NotRequired[ + "PersonTokenCreateParamsAdditionalTermsOfService" + ] + """ + Attestations of accepted terms of service agreements. + """ + address: NotRequired["PersonTokenCreateParamsAddress"] + """ + The person's residential address. + """ + date_of_birth: NotRequired["PersonTokenCreateParamsDateOfBirth"] + """ + The person's date of birth. + """ + documents: NotRequired["PersonTokenCreateParamsDocuments"] + """ + Documents that may be submitted to satisfy various informational requests. + """ + email: NotRequired[str] + """ + Email. + """ + given_name: NotRequired[str] + """ + The person's first name. + """ + id_numbers: NotRequired[List["PersonTokenCreateParamsIdNumber"]] + """ + The identification numbers (e.g., SSN) associated with the person. + """ + legal_gender: NotRequired[Literal["female", "male"]] + """ + The person's gender (International regulations require either "male" or "female"). + """ + metadata: NotRequired[Dict[str, Optional[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. + """ + nationalities: NotRequired[List[str]] + """ + The nationalities (countries) this person is associated with. + """ + phone: NotRequired[str] + """ + The phone number for this person. + """ + political_exposure: NotRequired[Literal["existing", "none"]] + """ + The person's political exposure. + """ + relationship: NotRequired["PersonTokenCreateParamsRelationship"] + """ + The relationship that this person has with the Account's business or legal entity. + """ + script_addresses: NotRequired["PersonTokenCreateParamsScriptAddresses"] + """ + The script addresses (e.g., non-Latin characters) associated with the person. + """ + script_names: NotRequired["PersonTokenCreateParamsScriptNames"] + """ + The script names (e.g. non-Latin characters) associated with the person. + """ + surname: NotRequired[str] + """ + The person's last name. + """ + + +class PersonTokenCreateParamsAdditionalAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + purpose: Literal["registered"] + """ + Purpose of additional address. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class PersonTokenCreateParamsAdditionalName(TypedDict): + full_name: NotRequired[str] + """ + The person's full name. + """ + given_name: NotRequired[str] + """ + The person's first or given name. + """ + purpose: Literal["alias", "maiden"] + """ + The purpose or type of the additional name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ + + +class PersonTokenCreateParamsAdditionalTermsOfService(TypedDict): + account: NotRequired[ + "PersonTokenCreateParamsAdditionalTermsOfServiceAccount" + ] + """ + Details on the Person's acceptance of the [Stripe Services Agreement]; IP, date, and User Agent are expanded by Stripe. + """ + + +class PersonTokenCreateParamsAdditionalTermsOfServiceAccount(TypedDict): + shown_and_accepted: NotRequired[bool] + """ + The boolean value indicating if the terms of service have been accepted. + """ + + +class PersonTokenCreateParamsAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class PersonTokenCreateParamsDateOfBirth(TypedDict): + day: int + """ + The day of the birth. + """ + month: int + """ + The month of birth. + """ + year: int + """ + The year of birth. + """ + + +class PersonTokenCreateParamsDocuments(TypedDict): + company_authorization: NotRequired[ + "PersonTokenCreateParamsDocumentsCompanyAuthorization" + ] + """ + One or more documents that demonstrate proof that this person is authorized to represent the company. + """ + passport: NotRequired["PersonTokenCreateParamsDocumentsPassport"] + """ + One or more documents showing the person's passport page with photo and personal data. + """ + primary_verification: NotRequired[ + "PersonTokenCreateParamsDocumentsPrimaryVerification" + ] + """ + An identifying document showing the person's name, either a passport or local ID card. + """ + secondary_verification: NotRequired[ + "PersonTokenCreateParamsDocumentsSecondaryVerification" + ] + """ + A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. + """ + visa: NotRequired["PersonTokenCreateParamsDocumentsVisa"] + """ + One or more documents showing the person's visa required for living in the country where they are residing. + """ + + +class PersonTokenCreateParamsDocumentsCompanyAuthorization(TypedDict): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class PersonTokenCreateParamsDocumentsPassport(TypedDict): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class PersonTokenCreateParamsDocumentsPrimaryVerification(TypedDict): + front_back: "PersonTokenCreateParamsDocumentsPrimaryVerificationFrontBack" + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + + +class PersonTokenCreateParamsDocumentsPrimaryVerificationFrontBack(TypedDict): + back: NotRequired[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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 PersonTokenCreateParamsDocumentsSecondaryVerification(TypedDict): + front_back: ( + "PersonTokenCreateParamsDocumentsSecondaryVerificationFrontBack" + ) + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + + +class PersonTokenCreateParamsDocumentsSecondaryVerificationFrontBack( + TypedDict +): + back: NotRequired[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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 PersonTokenCreateParamsDocumentsVisa(TypedDict): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class PersonTokenCreateParamsIdNumber(TypedDict): + type: Literal[ + "ae_eid", + "ao_nif", + "ar_cuil", + "ar_dni", + "at_stn", + "az_tin", + "bd_brc", + "bd_etin", + "bd_nid", + "be_nrn", + "bg_ucn", + "bn_nric", + "br_cpf", + "ca_sin", + "ch_oasi", + "cl_rut", + "cn_pp", + "co_nuip", + "cr_ci", + "cr_cpf", + "cr_dimex", + "cr_nite", + "cy_tic", + "cz_rc", + "de_stn", + "dk_cpr", + "do_cie", + "do_rcn", + "ec_ci", + "ee_ik", + "es_nif", + "fi_hetu", + "fr_nir", + "gb_nino", + "gr_afm", + "gt_nit", + "hk_id", + "hr_oib", + "hu_ad", + "id_nik", + "ie_ppsn", + "is_kt", + "it_cf", + "jp_inc", + "ke_pin", + "kz_iin", + "li_peid", + "lt_ak", + "lu_nif", + "lv_pk", + "mx_rfc", + "my_nric", + "mz_nuit", + "ng_nin", + "nl_bsn", + "no_nin", + "nz_ird", + "pe_dni", + "pk_cnic", + "pk_snic", + "pl_pesel", + "pt_nif", + "ro_cnp", + "sa_tin", + "se_pin", + "sg_fin", + "sg_nric", + "sk_dic", + "th_lc", + "th_pin", + "tr_tin", + "us_itin", + "us_itin_last_4", + "us_ssn", + "us_ssn_last_4", + "uy_dni", + "za_id", + ] + """ + The ID number type of an individual. + """ + value: str + """ + The value of the ID number. + """ + + +class PersonTokenCreateParamsRelationship(TypedDict): + authorizer: NotRequired[bool] + """ + Whether the individual is an authorizer of the Account's identity. + """ + director: NotRequired[bool] + """ + Indicates whether the person is a director of the associated legal entity. + """ + executive: NotRequired[bool] + """ + Indicates whether the person is an executive of the associated legal entity. + """ + legal_guardian: NotRequired[bool] + """ + Indicates whether the person is a legal guardian of the associated legal entity. + """ + owner: NotRequired[bool] + """ + Indicates whether the person is an owner of the associated legal entity. + """ + percent_ownership: NotRequired[str] + """ + The percentage of ownership the person has in the associated legal entity. + """ + representative: NotRequired[bool] + """ + Indicates whether the person is a representative of the associated legal entity. + """ + title: NotRequired[str] + """ + The title or position the person holds in the associated legal entity. + """ + + +class PersonTokenCreateParamsScriptAddresses(TypedDict): + kana: NotRequired["PersonTokenCreateParamsScriptAddressesKana"] + """ + Kana Address. + """ + kanji: NotRequired["PersonTokenCreateParamsScriptAddressesKanji"] + """ + Kanji Address. + """ + + +class PersonTokenCreateParamsScriptAddressesKana(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class PersonTokenCreateParamsScriptAddressesKanji(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class PersonTokenCreateParamsScriptNames(TypedDict): + kana: NotRequired["PersonTokenCreateParamsScriptNamesKana"] + """ + Persons name in kana script. + """ + kanji: NotRequired["PersonTokenCreateParamsScriptNamesKanji"] + """ + Persons name in kanji script. + """ + + +class PersonTokenCreateParamsScriptNamesKana(TypedDict): + given_name: NotRequired[str] + """ + The person's first or given name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ + + +class PersonTokenCreateParamsScriptNamesKanji(TypedDict): + given_name: NotRequired[str] + """ + The person's first or given name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ diff --git a/stripe/params/v2/core/accounts/_person_token_retrieve_params.py b/stripe/params/v2/core/accounts/_person_token_retrieve_params.py new file mode 100644 index 000000000..3ea625655 --- /dev/null +++ b/stripe/params/v2/core/accounts/_person_token_retrieve_params.py @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from typing_extensions import TypedDict + + +class PersonTokenRetrieveParams(TypedDict): + pass diff --git a/stripe/params/v2/core/accounts/_person_update_params.py b/stripe/params/v2/core/accounts/_person_update_params.py new file mode 100644 index 000000000..a56cca6f8 --- /dev/null +++ b/stripe/params/v2/core/accounts/_person_update_params.py @@ -0,0 +1,545 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from typing import Dict, List, Optional +from typing_extensions import Literal, NotRequired, TypedDict + + +class PersonUpdateParams(TypedDict): + additional_addresses: NotRequired[ + List["PersonUpdateParamsAdditionalAddress"] + ] + """ + Additional addresses associated with the person. + """ + additional_names: NotRequired[List["PersonUpdateParamsAdditionalName"]] + """ + Additional names (e.g. aliases) associated with the person. + """ + additional_terms_of_service: NotRequired[ + "PersonUpdateParamsAdditionalTermsOfService" + ] + """ + Attestations of accepted terms of service agreements. + """ + address: NotRequired["PersonUpdateParamsAddress"] + """ + The primary address associated with the person. + """ + date_of_birth: NotRequired["PersonUpdateParamsDateOfBirth"] + """ + The person's date of birth. + """ + documents: NotRequired["PersonUpdateParamsDocuments"] + """ + Documents that may be submitted to satisfy various informational requests. + """ + email: NotRequired[str] + """ + Email. + """ + given_name: NotRequired[str] + """ + The person's first name. + """ + id_numbers: NotRequired[List["PersonUpdateParamsIdNumber"]] + """ + The identification numbers (e.g., SSN) associated with the person. + """ + legal_gender: NotRequired[Literal["female", "male"]] + """ + The person's gender (International regulations require either "male" or "female"). + """ + metadata: NotRequired[Dict[str, Optional[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. + """ + nationalities: NotRequired[List[str]] + """ + The nationalities (countries) this person is associated with. + """ + person_token: NotRequired[str] + """ + The person token generated by the person token api. + """ + phone: NotRequired[str] + """ + The phone number for this person. + """ + political_exposure: NotRequired[Literal["existing", "none"]] + """ + The person's political exposure. + """ + relationship: NotRequired["PersonUpdateParamsRelationship"] + """ + The relationship that this person has with the Account's business or legal entity. + """ + script_addresses: NotRequired["PersonUpdateParamsScriptAddresses"] + """ + The script addresses (e.g., non-Latin characters) associated with the person. + """ + script_names: NotRequired["PersonUpdateParamsScriptNames"] + """ + The script names (e.g. non-Latin characters) associated with the person. + """ + surname: NotRequired[str] + """ + The person's last name. + """ + + +class PersonUpdateParamsAdditionalAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + purpose: Literal["registered"] + """ + Purpose of additional address. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class PersonUpdateParamsAdditionalName(TypedDict): + full_name: NotRequired[str] + """ + The person's full name. + """ + given_name: NotRequired[str] + """ + The person's first or given name. + """ + purpose: Literal["alias", "maiden"] + """ + The purpose or type of the additional name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ + + +class PersonUpdateParamsAdditionalTermsOfService(TypedDict): + account: NotRequired["PersonUpdateParamsAdditionalTermsOfServiceAccount"] + """ + Stripe terms of service agreement. + """ + + +class PersonUpdateParamsAdditionalTermsOfServiceAccount(TypedDict): + date: NotRequired[str] + """ + The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: NotRequired[str] + """ + The IP address from which the Account's representative accepted the terms of service. + """ + user_agent: NotRequired[str] + """ + The user agent of the browser from which the Account's representative accepted the terms of service. + """ + + +class PersonUpdateParamsAddress(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class PersonUpdateParamsDateOfBirth(TypedDict): + day: int + """ + The day of the birth. + """ + month: int + """ + The month of birth. + """ + year: int + """ + The year of birth. + """ + + +class PersonUpdateParamsDocuments(TypedDict): + company_authorization: NotRequired[ + "PersonUpdateParamsDocumentsCompanyAuthorization" + ] + """ + One or more documents that demonstrate proof that this person is authorized to represent the company. + """ + passport: NotRequired["PersonUpdateParamsDocumentsPassport"] + """ + One or more documents showing the person's passport page with photo and personal data. + """ + primary_verification: NotRequired[ + "PersonUpdateParamsDocumentsPrimaryVerification" + ] + """ + An identifying document showing the person's name, either a passport or local ID card. + """ + secondary_verification: NotRequired[ + "PersonUpdateParamsDocumentsSecondaryVerification" + ] + """ + A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. + """ + visa: NotRequired["PersonUpdateParamsDocumentsVisa"] + """ + One or more documents showing the person's visa required for living in the country where they are residing. + """ + + +class PersonUpdateParamsDocumentsCompanyAuthorization(TypedDict): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class PersonUpdateParamsDocumentsPassport(TypedDict): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class PersonUpdateParamsDocumentsPrimaryVerification(TypedDict): + front_back: "PersonUpdateParamsDocumentsPrimaryVerificationFrontBack" + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + + +class PersonUpdateParamsDocumentsPrimaryVerificationFrontBack(TypedDict): + back: NotRequired[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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 PersonUpdateParamsDocumentsSecondaryVerification(TypedDict): + front_back: "PersonUpdateParamsDocumentsSecondaryVerificationFrontBack" + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens referring to each side of the document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + + +class PersonUpdateParamsDocumentsSecondaryVerificationFrontBack(TypedDict): + back: NotRequired[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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 PersonUpdateParamsDocumentsVisa(TypedDict): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + +class PersonUpdateParamsIdNumber(TypedDict): + type: Literal[ + "ae_eid", + "ao_nif", + "ar_cuil", + "ar_dni", + "at_stn", + "az_tin", + "bd_brc", + "bd_etin", + "bd_nid", + "be_nrn", + "bg_ucn", + "bn_nric", + "br_cpf", + "ca_sin", + "ch_oasi", + "cl_rut", + "cn_pp", + "co_nuip", + "cr_ci", + "cr_cpf", + "cr_dimex", + "cr_nite", + "cy_tic", + "cz_rc", + "de_stn", + "dk_cpr", + "do_cie", + "do_rcn", + "ec_ci", + "ee_ik", + "es_nif", + "fi_hetu", + "fr_nir", + "gb_nino", + "gr_afm", + "gt_nit", + "hk_id", + "hr_oib", + "hu_ad", + "id_nik", + "ie_ppsn", + "is_kt", + "it_cf", + "jp_inc", + "ke_pin", + "kz_iin", + "li_peid", + "lt_ak", + "lu_nif", + "lv_pk", + "mx_rfc", + "my_nric", + "mz_nuit", + "ng_nin", + "nl_bsn", + "no_nin", + "nz_ird", + "pe_dni", + "pk_cnic", + "pk_snic", + "pl_pesel", + "pt_nif", + "ro_cnp", + "sa_tin", + "se_pin", + "sg_fin", + "sg_nric", + "sk_dic", + "th_lc", + "th_pin", + "tr_tin", + "us_itin", + "us_itin_last_4", + "us_ssn", + "us_ssn_last_4", + "uy_dni", + "za_id", + ] + """ + The ID number type of an individual. + """ + value: str + """ + The value of the ID number. + """ + + +class PersonUpdateParamsRelationship(TypedDict): + authorizer: NotRequired[bool] + """ + Whether the individual is an authorizer of the Account's identity. + """ + director: NotRequired[bool] + """ + Indicates whether the person is a director of the associated legal entity. + """ + executive: NotRequired[bool] + """ + Indicates whether the person is an executive of the associated legal entity. + """ + legal_guardian: NotRequired[bool] + """ + Indicates whether the person is a legal guardian of the associated legal entity. + """ + owner: NotRequired[bool] + """ + Indicates whether the person is an owner of the associated legal entity. + """ + percent_ownership: NotRequired[str] + """ + The percentage of ownership the person has in the associated legal entity. + """ + representative: NotRequired[bool] + """ + Indicates whether the person is a representative of the associated legal entity. + """ + title: NotRequired[str] + """ + The title or position the person holds in the associated legal entity. + """ + + +class PersonUpdateParamsScriptAddresses(TypedDict): + kana: NotRequired["PersonUpdateParamsScriptAddressesKana"] + """ + Kana Address. + """ + kanji: NotRequired["PersonUpdateParamsScriptAddressesKanji"] + """ + Kanji Address. + """ + + +class PersonUpdateParamsScriptAddressesKana(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class PersonUpdateParamsScriptAddressesKanji(TypedDict): + city: NotRequired[str] + """ + City, district, suburb, town, or village. + """ + country: NotRequired[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: NotRequired[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: NotRequired[str] + """ + ZIP or postal code. + """ + state: NotRequired[str] + """ + State, county, province, or region. + """ + town: NotRequired[str] + """ + Town or district. + """ + + +class PersonUpdateParamsScriptNames(TypedDict): + kana: NotRequired["PersonUpdateParamsScriptNamesKana"] + """ + Persons name in kana script. + """ + kanji: NotRequired["PersonUpdateParamsScriptNamesKanji"] + """ + Persons name in kanji script. + """ + + +class PersonUpdateParamsScriptNamesKana(TypedDict): + given_name: NotRequired[str] + """ + The person's first or given name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ + + +class PersonUpdateParamsScriptNamesKanji(TypedDict): + given_name: NotRequired[str] + """ + The person's first or given name. + """ + surname: NotRequired[str] + """ + The person's last or family name. + """ diff --git a/stripe/radar/_early_fraud_warning.py b/stripe/radar/_early_fraud_warning.py index 14d60429d..63defa05f 100644 --- a/stripe/radar/_early_fraud_warning.py +++ b/stripe/radar/_early_fraud_warning.py @@ -22,7 +22,7 @@ class EarlyFraudWarning(ListableAPIResource["EarlyFraudWarning"]): An early fraud warning indicates that the card issuer has notified us that a charge may be fraudulent. - Related guide: [Early fraud warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings) + Related guide: [Early fraud warnings](https://docs.stripe.com/disputes/measuring#early-fraud-warnings) """ OBJECT_NAME: ClassVar[Literal["radar.early_fraud_warning"]] = ( diff --git a/stripe/radar/_value_list.py b/stripe/radar/_value_list.py index eb9623d1a..6192c53d5 100644 --- a/stripe/radar/_value_list.py +++ b/stripe/radar/_value_list.py @@ -35,7 +35,7 @@ class ValueList( """ Value lists allow you to group values together which can then be referenced in rules. - Related guide: [Default Stripe lists](https://stripe.com/docs/radar/lists#managing-list-items) + Related guide: [Default Stripe lists](https://docs.stripe.com/radar/lists#managing-list-items) """ OBJECT_NAME: ClassVar[Literal["radar.value_list"]] = "radar.value_list" @@ -84,7 +84,7 @@ class ValueList( """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ name: str """ diff --git a/stripe/radar/_value_list_item.py b/stripe/radar/_value_list_item.py index 6ef11fe6f..8c680a31b 100644 --- a/stripe/radar/_value_list_item.py +++ b/stripe/radar/_value_list_item.py @@ -31,7 +31,7 @@ class ValueListItem( """ Value list items allow you to add specific values to a given Radar value list, which can then be used in rules. - Related guide: [Managing list items](https://stripe.com/docs/radar/lists#managing-list-items) + Related guide: [Managing list items](https://docs.stripe.com/radar/lists#managing-list-items) """ OBJECT_NAME: ClassVar[Literal["radar.value_list_item"]] = ( diff --git a/stripe/reporting/_report_run.py b/stripe/reporting/_report_run.py index aba84bc9a..3eda46c25 100644 --- a/stripe/reporting/_report_run.py +++ b/stripe/reporting/_report_run.py @@ -29,10 +29,10 @@ class ReportRun( specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see - [API Access to Reports](https://stripe.com/docs/reporting/statements/api). + [API Access to Reports](https://docs.stripe.com/reporting/statements/api). Note that certain report types can only be run based on your live-mode data (not test-mode - data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). + data), and will error when queried without a [live-mode API key](https://docs.stripe.com/keys#test-live-modes). """ OBJECT_NAME: ClassVar[Literal["reporting.report_run"]] = ( @@ -97,7 +97,7 @@ class Parameters(StripeObject): parameters: Parameters report_type: str """ - The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`. + The ID of the [report type](https://docs.stripe.com/reports/report-types) to run, such as `"balance.summary.1"`. """ result: Optional["File"] """ diff --git a/stripe/reporting/_report_type.py b/stripe/reporting/_report_type.py index 8d765a769..1cf2a57f2 100644 --- a/stripe/reporting/_report_type.py +++ b/stripe/reporting/_report_type.py @@ -19,11 +19,11 @@ class ReportType(ListableAPIResource["ReportType"]): The Report Type resource corresponds to a particular type of report, such as the "Activity summary" or "Itemized payouts" reports. These objects are identified by an ID belonging to a set of enumerated values. See - [API Access to Reports documentation](https://stripe.com/docs/reporting/statements/api) + [API Access to Reports documentation](https://docs.stripe.com/reporting/statements/api) for those Report Type IDs, along with required and optional parameters. Note that certain report types can only be run based on your live-mode data (not test-mode - data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). + data), and will error when queried without a [live-mode API key](https://docs.stripe.com/keys#test-live-modes). """ OBJECT_NAME: ClassVar[Literal["reporting.report_type"]] = ( @@ -43,7 +43,7 @@ class ReportType(ListableAPIResource["ReportType"]): """ id: str """ - The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`. + The [ID of the Report Type](https://docs.stripe.com/reporting/statements/api#available-report-types), such as `balance.summary.1`. """ livemode: bool """ diff --git a/stripe/sigma/_scheduled_query_run.py b/stripe/sigma/_scheduled_query_run.py index 7aa8a2f25..29cae6df0 100644 --- a/stripe/sigma/_scheduled_query_run.py +++ b/stripe/sigma/_scheduled_query_run.py @@ -18,7 +18,7 @@ class ScheduledQueryRun(ListableAPIResource["ScheduledQueryRun"]): """ - If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll + If you have [scheduled a Sigma query](https://docs.stripe.com/sigma/scheduled-queries), you'll receive a `sigma.scheduled_query_run.created` webhook each time the query runs. The webhook contains a `ScheduledQueryRun` object, which you can use to retrieve the query results. diff --git a/stripe/tax/_association.py b/stripe/tax/_association.py index 5f3ef6bcc..a44800b1f 100644 --- a/stripe/tax/_association.py +++ b/stripe/tax/_association.py @@ -22,7 +22,7 @@ class TaxTransactionAttempt(StripeObject): class Committed(StripeObject): transaction: str """ - The [Tax Transaction](https://stripe.com/docs/api/tax/transaction/object) + The [Tax Transaction](https://docs.stripe.com/api/tax/transaction/object) """ class Errored(StripeObject): @@ -51,7 +51,7 @@ class Errored(StripeObject): calculation: str """ - The [Tax Calculation](https://stripe.com/docs/api/tax/calculations/object) that was included in PaymentIntent. + The [Tax Calculation](https://docs.stripe.com/api/tax/calculations/object) that was included in PaymentIntent. """ id: str """ @@ -63,7 +63,7 @@ class Errored(StripeObject): """ payment_intent: str """ - The [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) that this Tax Association is tracking. + The [PaymentIntent](https://docs.stripe.com/api/payment_intents/object) that this Tax Association is tracking. """ tax_transaction_attempts: Optional[List[TaxTransactionAttempt]] """ diff --git a/stripe/tax/_calculation.py b/stripe/tax/_calculation.py index f3a19992c..60239a652 100644 --- a/stripe/tax/_calculation.py +++ b/stripe/tax/_calculation.py @@ -24,7 +24,7 @@ class Calculation(CreateableAPIResource["Calculation"]): """ A Tax Calculation allows you to calculate the tax to collect from your customer. - Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom) + Related guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom) """ OBJECT_NAME: ClassVar[Literal["tax.calculation"]] = "tax.calculation" @@ -285,7 +285,7 @@ class TaxRateDetails(StripeObject): amount: int """ - The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ jurisdiction: Jurisdiction sourcing: Literal["destination", "origin"] @@ -318,7 +318,7 @@ class TaxRateDetails(StripeObject): """ taxable_amount: int """ - The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ _inner_class_types = { "jurisdiction": Jurisdiction, @@ -327,15 +327,15 @@ class TaxRateDetails(StripeObject): amount: int """ - The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. + The shipping amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. """ amount_tax: int """ - The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The amount of tax calculated for shipping, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ shipping_rate: Optional[str] """ - The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object). + The ID of an existing [ShippingRate](https://docs.stripe.com/api/shipping_rates/object). """ tax_behavior: Literal["exclusive", "inclusive"] """ @@ -347,7 +347,7 @@ class TaxRateDetails(StripeObject): """ tax_code: str """ - The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping. + The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping. """ _inner_class_types = {"tax_breakdown": TaxBreakdown} @@ -381,7 +381,7 @@ class FlatAmount(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ tax_type: Optional[ Literal[ @@ -408,7 +408,7 @@ class FlatAmount(StripeObject): amount: int """ - The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ inclusive: bool """ @@ -437,13 +437,13 @@ class FlatAmount(StripeObject): """ taxable_amount: int """ - The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ _inner_class_types = {"tax_rate_details": TaxRateDetails} amount_total: int """ - Total amount after taxes in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + Total amount after taxes in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ currency: str """ @@ -451,7 +451,7 @@ class FlatAmount(StripeObject): """ customer: Optional[str] """ - The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. + The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource. """ customer_details: CustomerDetails expires_at: Optional[int] diff --git a/stripe/tax/_calculation_line_item.py b/stripe/tax/_calculation_line_item.py index 7a62d267d..702b039e6 100644 --- a/stripe/tax/_calculation_line_item.py +++ b/stripe/tax/_calculation_line_item.py @@ -60,7 +60,7 @@ class TaxRateDetails(StripeObject): amount: int """ - The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ jurisdiction: Jurisdiction sourcing: Literal["destination", "origin"] @@ -93,7 +93,7 @@ class TaxRateDetails(StripeObject): """ taxable_amount: int """ - The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ _inner_class_types = { "jurisdiction": Jurisdiction, @@ -102,11 +102,11 @@ class TaxRateDetails(StripeObject): amount: int """ - The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. + The line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. """ amount_tax: int """ - The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ id: str """ @@ -118,7 +118,7 @@ class TaxRateDetails(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["tax.calculation_line_item"] """ @@ -126,7 +126,7 @@ class TaxRateDetails(StripeObject): """ product: Optional[str] """ - The ID of an existing [Product](https://stripe.com/docs/api/products/object). + The ID of an existing [Product](https://docs.stripe.com/api/products/object). """ quantity: int """ @@ -146,6 +146,6 @@ class TaxRateDetails(StripeObject): """ tax_code: str """ - The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource. + The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource. """ _inner_class_types = {"tax_breakdown": TaxBreakdown} diff --git a/stripe/tax/_registration.py b/stripe/tax/_registration.py index 09bbc9c93..328747a08 100644 --- a/stripe/tax/_registration.py +++ b/stripe/tax/_registration.py @@ -30,11 +30,11 @@ class Registration( UpdateableAPIResource["Registration"], ): """ - A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://stripe.com/docs/tax). + A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://docs.stripe.com/tax). - Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/docs/tax/registering). + Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://docs.stripe.com/tax/registering). - Related guide: [Using the Registrations API](https://stripe.com/docs/tax/registrations-api) + Related guide: [Using the Registrations API](https://docs.stripe.com/tax/registrations-api) """ OBJECT_NAME: ClassVar[Literal["tax.registration"]] = "tax.registration" diff --git a/stripe/tax/_settings.py b/stripe/tax/_settings.py index c67ed2f99..7a3f7988d 100644 --- a/stripe/tax/_settings.py +++ b/stripe/tax/_settings.py @@ -20,7 +20,7 @@ class Settings( """ You can use Tax `Settings` to manage configurations used by Stripe Tax calculations. - Related guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api) + Related guide: [Using the Settings API](https://docs.stripe.com/tax/settings-api) """ OBJECT_NAME: ClassVar[Literal["tax.settings"]] = "tax.settings" @@ -65,7 +65,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Address diff --git a/stripe/tax/_transaction.py b/stripe/tax/_transaction.py index d2851fee2..d76506217 100644 --- a/stripe/tax/_transaction.py +++ b/stripe/tax/_transaction.py @@ -27,7 +27,7 @@ class Transaction(APIResource["Transaction"]): """ A Tax Transaction records the tax collected from or refunded to your customer. - Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom#tax-transaction) + Related guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom#tax-transaction) """ OBJECT_NAME: ClassVar[Literal["tax.transaction"]] = "tax.transaction" @@ -294,7 +294,7 @@ class TaxRateDetails(StripeObject): amount: int """ - The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ jurisdiction: Jurisdiction sourcing: Literal["destination", "origin"] @@ -327,7 +327,7 @@ class TaxRateDetails(StripeObject): """ taxable_amount: int """ - The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ _inner_class_types = { "jurisdiction": Jurisdiction, @@ -336,15 +336,15 @@ class TaxRateDetails(StripeObject): amount: int """ - The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. + The shipping amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. """ amount_tax: int """ - The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The amount of tax calculated for shipping, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ shipping_rate: Optional[str] """ - The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object). + The ID of an existing [ShippingRate](https://docs.stripe.com/api/shipping_rates/object). """ tax_behavior: Literal["exclusive", "inclusive"] """ @@ -356,7 +356,7 @@ class TaxRateDetails(StripeObject): """ tax_code: str """ - The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping. + The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping. """ _inner_class_types = {"tax_breakdown": TaxBreakdown} @@ -370,7 +370,7 @@ class TaxRateDetails(StripeObject): """ customer: Optional[str] """ - The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. + The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource. """ customer_details: CustomerDetails id: str @@ -387,7 +387,7 @@ class TaxRateDetails(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["tax.transaction"] """ diff --git a/stripe/tax/_transaction_line_item.py b/stripe/tax/_transaction_line_item.py index 87c817b36..9f575613d 100644 --- a/stripe/tax/_transaction_line_item.py +++ b/stripe/tax/_transaction_line_item.py @@ -18,11 +18,11 @@ class Reversal(StripeObject): amount: int """ - The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. + The line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. """ amount_tax: int """ - The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ id: str """ @@ -34,7 +34,7 @@ class Reversal(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["tax.transaction_line_item"] """ @@ -42,7 +42,7 @@ class Reversal(StripeObject): """ product: Optional[str] """ - The ID of an existing [Product](https://stripe.com/docs/api/products/object). + The ID of an existing [Product](https://docs.stripe.com/api/products/object). """ quantity: int """ @@ -62,7 +62,7 @@ class Reversal(StripeObject): """ tax_code: str """ - The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource. + The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource. """ type: Literal["reversal", "transaction"] """ diff --git a/stripe/terminal/_connection_token.py b/stripe/terminal/_connection_token.py index 0804333cb..ccb3d46e5 100644 --- a/stripe/terminal/_connection_token.py +++ b/stripe/terminal/_connection_token.py @@ -14,7 +14,7 @@ class ConnectionToken(CreateableAPIResource["ConnectionToken"]): """ A Connection Token is used by the Stripe Terminal SDK to connect to a reader. - Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations) + Related guide: [Fleet management](https://docs.stripe.com/terminal/fleet/locations) """ OBJECT_NAME: ClassVar[Literal["terminal.connection_token"]] = ( diff --git a/stripe/terminal/_location.py b/stripe/terminal/_location.py index d7d44b6b7..03cb2a0db 100644 --- a/stripe/terminal/_location.py +++ b/stripe/terminal/_location.py @@ -35,7 +35,7 @@ class Location( """ A Location represents a grouping of readers. - Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations) + Related guide: [Fleet management](https://docs.stripe.com/terminal/fleet/locations) """ OBJECT_NAME: ClassVar[Literal["terminal.location"]] = "terminal.location" @@ -63,7 +63,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ class AddressKana(StripeObject): @@ -159,7 +159,7 @@ class AddressKanji(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["terminal.location"] """ diff --git a/stripe/terminal/_reader.py b/stripe/terminal/_reader.py index c133a5527..1f78be200 100644 --- a/stripe/terminal/_reader.py +++ b/stripe/terminal/_reader.py @@ -70,7 +70,7 @@ class Reader( """ A Reader represents a physical device for accepting payment details. - Related guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader) + Related guide: [Connecting to a reader](https://docs.stripe.com/terminal/payments/connect-reader) """ OBJECT_NAME: ClassVar[Literal["terminal.reader"]] = "terminal.reader" @@ -241,7 +241,7 @@ class Toggle(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ _inner_class_types = {"inputs": Input} @@ -278,10 +278,10 @@ class Tipping(StripeObject): payment_method: Optional["PaymentMethod"] """ PaymentMethod objects represent your customer's payment instruments. - You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to + You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. - Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). + Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). """ _inner_class_types = {"collect_config": CollectConfig} @@ -376,7 +376,7 @@ class RefundPaymentConfig(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ payment_intent: Optional[ExpandableField["PaymentIntent"]] """ @@ -411,7 +411,7 @@ class Cart(StripeObject): class LineItem(StripeObject): amount: int """ - The amount of the line item. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + The amount of the line item. A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ description: str """ @@ -432,11 +432,11 @@ class LineItem(StripeObject): """ tax: Optional[int] """ - Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ total: int """ - Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ _inner_class_types = {"line_items": LineItem} @@ -552,7 +552,7 @@ class LineItem(StripeObject): """ last_seen_at: Optional[int] """ - The last time this reader reported to Stripe backend. + The last time this reader reported to Stripe backend. Timestamp is measured in milliseconds since the Unix epoch. Unlike most other Stripe timestamp fields which use seconds, this field uses milliseconds. """ livemode: bool """ @@ -564,7 +564,7 @@ class LineItem(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["terminal.reader"] """ diff --git a/stripe/treasury/_credit_reversal.py b/stripe/treasury/_credit_reversal.py index 4ed324cb6..d3724e5df 100644 --- a/stripe/treasury/_credit_reversal.py +++ b/stripe/treasury/_credit_reversal.py @@ -26,7 +26,7 @@ class CreditReversal( ListableAPIResource["CreditReversal"], ): """ - You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal. + You can reverse some [ReceivedCredits](https://api.stripe.com#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal. """ OBJECT_NAME: ClassVar[Literal["treasury.credit_reversal"]] = ( @@ -57,7 +57,7 @@ class StatusTransitions(StripeObject): """ hosted_regulatory_receipt_url: Optional[str] """ - A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. """ id: str """ @@ -69,7 +69,7 @@ class StatusTransitions(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ network: Literal["ach", "stripe"] """ diff --git a/stripe/treasury/_debit_reversal.py b/stripe/treasury/_debit_reversal.py index ff98a4e23..3a32d5778 100644 --- a/stripe/treasury/_debit_reversal.py +++ b/stripe/treasury/_debit_reversal.py @@ -26,7 +26,7 @@ class DebitReversal( ListableAPIResource["DebitReversal"], ): """ - You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal. + You can reverse some [ReceivedDebits](https://api.stripe.com#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal. """ OBJECT_NAME: ClassVar[Literal["treasury.debit_reversal"]] = ( @@ -63,7 +63,7 @@ class StatusTransitions(StripeObject): """ hosted_regulatory_receipt_url: Optional[str] """ - A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. """ id: str """ @@ -79,7 +79,7 @@ class StatusTransitions(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ network: Literal["ach", "card"] """ diff --git a/stripe/treasury/_financial_account.py b/stripe/treasury/_financial_account.py index 5858d26f6..eebba859b 100644 --- a/stripe/treasury/_financial_account.py +++ b/stripe/treasury/_financial_account.py @@ -178,7 +178,7 @@ class Closed(StripeObject): """ metadata: Optional[Dict[str, str]] """ - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ nickname: Optional[str] """ diff --git a/stripe/treasury/_inbound_transfer.py b/stripe/treasury/_inbound_transfer.py index 2c06ec5fb..7c7704948 100644 --- a/stripe/treasury/_inbound_transfer.py +++ b/stripe/treasury/_inbound_transfer.py @@ -41,7 +41,7 @@ class InboundTransfer( ListableAPIResource["InboundTransfer"], ): """ - Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. + Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://api.stripe.com#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. Related guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) """ @@ -101,7 +101,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Address @@ -142,7 +142,7 @@ class UsBankAccount(StripeObject): """ 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. + The network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. """ routing_number: Optional[str] """ @@ -204,7 +204,7 @@ class StatusTransitions(StripeObject): """ hosted_regulatory_receipt_url: Optional[str] """ - A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. """ id: str """ @@ -217,7 +217,7 @@ class StatusTransitions(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["treasury.inbound_transfer"] """ diff --git a/stripe/treasury/_outbound_payment.py b/stripe/treasury/_outbound_payment.py index 08a834cdc..d855c0ffc 100644 --- a/stripe/treasury/_outbound_payment.py +++ b/stripe/treasury/_outbound_payment.py @@ -44,7 +44,7 @@ class OutboundPayment( ListableAPIResource["OutboundPayment"], ): """ - Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers). + Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://api.stripe.com#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://api.stripe.com#outbound_transfers). Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects. @@ -80,7 +80,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Address @@ -131,7 +131,7 @@ class UsBankAccount(StripeObject): """ 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. + The network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. """ routing_number: Optional[str] """ @@ -247,7 +247,7 @@ class UsDomesticWire(StripeObject): """ customer: Optional[str] """ - ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent. + ID of the [customer](https://docs.stripe.com/api/customers) to whom an OutboundPayment is sent. """ description: Optional[str] """ @@ -277,7 +277,7 @@ class UsDomesticWire(StripeObject): """ hosted_regulatory_receipt_url: Optional[str] """ - A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. """ id: str """ @@ -289,7 +289,7 @@ class UsDomesticWire(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["treasury.outbound_payment"] """ diff --git a/stripe/treasury/_outbound_transfer.py b/stripe/treasury/_outbound_transfer.py index fe71e6fa4..eb9808aab 100644 --- a/stripe/treasury/_outbound_transfer.py +++ b/stripe/treasury/_outbound_transfer.py @@ -44,7 +44,7 @@ class OutboundTransfer( ListableAPIResource["OutboundTransfer"], ): """ - Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. + Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://api.stripe.com#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://api.stripe.com#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects. @@ -80,7 +80,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Address @@ -131,7 +131,7 @@ class UsBankAccount(StripeObject): """ 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. + The network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. """ routing_number: Optional[str] """ @@ -254,7 +254,7 @@ class UsDomesticWire(StripeObject): """ hosted_regulatory_receipt_url: Optional[str] """ - A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. """ id: str """ @@ -266,7 +266,7 @@ class UsDomesticWire(StripeObject): """ metadata: 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. + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ object: Literal["treasury.outbound_transfer"] """ diff --git a/stripe/treasury/_received_credit.py b/stripe/treasury/_received_credit.py index 3b7863a57..f9ee3602b 100644 --- a/stripe/treasury/_received_credit.py +++ b/stripe/treasury/_received_credit.py @@ -27,7 +27,7 @@ class ReceivedCredit(ListableAPIResource["ReceivedCredit"]): """ - ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount. + ReceivedCredits represent funds sent to a [FinancialAccount](https://api.stripe.com#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount. """ OBJECT_NAME: ClassVar[Literal["treasury.received_credit"]] = ( @@ -59,7 +59,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Address @@ -105,7 +105,7 @@ class UsBankAccount(StripeObject): financial_account: Optional[FinancialAccount] issuing_card: Optional[str] """ - Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID. + Set when `type` is `issuing_card`. This is an [Issuing Card](https://api.stripe.com#issuing_cards) ID. """ type: Literal[ "balance", @@ -128,11 +128,11 @@ class LinkedFlows(StripeObject): class SourceFlowDetails(StripeObject): credit_reversal: Optional["CreditReversal"] """ - You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal. + You can reverse some [ReceivedCredits](https://api.stripe.com#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal. """ outbound_payment: Optional["OutboundPayment"] """ - Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers). + Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://api.stripe.com#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://api.stripe.com#outbound_transfers). Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects. @@ -140,7 +140,7 @@ class SourceFlowDetails(StripeObject): """ outbound_transfer: Optional["OutboundTransfer"] """ - Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. + Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://api.stripe.com#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://api.stripe.com#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects. @@ -155,7 +155,7 @@ class SourceFlowDetails(StripeObject): schedules](https://docs.stripe.com/docs/connect/manage-payout-schedule), depending on your country and industry. - Related guide: [Receiving payouts](https://stripe.com/docs/payouts) + Related guide: [Receiving payouts](https://docs.stripe.com/payouts) """ type: Literal[ "credit_reversal", @@ -174,11 +174,11 @@ class SourceFlowDetails(StripeObject): """ issuing_authorization: Optional[str] """ - Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. + Set if the ReceivedCredit was created due to an [Issuing Authorization](https://api.stripe.com#issuing_authorizations) object. """ issuing_transaction: Optional[str] """ - Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object. + Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://api.stripe.com#issuing_transactions) object. """ source_flow: Optional[str] """ @@ -245,7 +245,7 @@ class ReversalDetails(StripeObject): """ hosted_regulatory_receipt_url: Optional[str] """ - A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. """ id: str """ diff --git a/stripe/treasury/_received_debit.py b/stripe/treasury/_received_debit.py index ab84855b5..2a255b8c3 100644 --- a/stripe/treasury/_received_debit.py +++ b/stripe/treasury/_received_debit.py @@ -23,7 +23,7 @@ class ReceivedDebit(ListableAPIResource["ReceivedDebit"]): """ - ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount. + ReceivedDebits represent funds pulled from a [FinancialAccount](https://api.stripe.com#financial_accounts). These are not initiated from the FinancialAccount. """ OBJECT_NAME: ClassVar[Literal["treasury.received_debit"]] = ( @@ -55,7 +55,7 @@ class Address(StripeObject): """ state: Optional[str] """ - State, county, province, or region. + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ address: Address @@ -101,7 +101,7 @@ class UsBankAccount(StripeObject): financial_account: Optional[FinancialAccount] issuing_card: Optional[str] """ - Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID. + Set when `type` is `issuing_card`. This is an [Issuing Card](https://api.stripe.com#issuing_cards) ID. """ type: Literal[ "balance", @@ -131,15 +131,15 @@ class LinkedFlows(StripeObject): """ issuing_authorization: Optional[str] """ - Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. + Set if the ReceivedDebit was created due to an [Issuing Authorization](https://api.stripe.com#issuing_authorizations) object. """ issuing_transaction: Optional[str] """ - Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object. + Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://api.stripe.com#issuing_disputes) object. """ payout: Optional[str] """ - Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object. + Set if the ReceivedDebit was created due to a [Payout](https://api.stripe.com#payouts) object. """ class ReversalDetails(StripeObject): @@ -194,7 +194,7 @@ class ReversalDetails(StripeObject): """ hosted_regulatory_receipt_url: Optional[str] """ - A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. """ id: str """ diff --git a/stripe/treasury/_transaction.py b/stripe/treasury/_transaction.py index 3892b1764..d747cffef 100644 --- a/stripe/treasury/_transaction.py +++ b/stripe/treasury/_transaction.py @@ -26,7 +26,7 @@ class Transaction(ListableAPIResource["Transaction"]): """ - Transactions represent changes to a [FinancialAccount's](https://stripe.com/docs/api#financial_accounts) balance. + Transactions represent changes to a [FinancialAccount's](https://api.stripe.com#financial_accounts) balance. """ OBJECT_NAME: ClassVar[Literal["treasury.transaction"]] = ( @@ -50,29 +50,29 @@ class BalanceImpact(StripeObject): class FlowDetails(StripeObject): credit_reversal: Optional["CreditReversal"] """ - You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal. + You can reverse some [ReceivedCredits](https://api.stripe.com#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal. """ debit_reversal: Optional["DebitReversal"] """ - You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal. + You can reverse some [ReceivedDebits](https://api.stripe.com#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal. """ inbound_transfer: Optional["InboundTransfer"] """ - Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. + Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://api.stripe.com#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. Related guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) """ issuing_authorization: Optional["Authorization"] """ - When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization` - object is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the + When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization` + object is created. [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the purchase to be completed successfully. - Related guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations) + Related guide: [Issued card authorizations](https://docs.stripe.com/issuing/purchases/authorizations) """ outbound_payment: Optional["OutboundPayment"] """ - Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers). + Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://api.stripe.com#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://api.stripe.com#outbound_transfers). Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects. @@ -80,7 +80,7 @@ class FlowDetails(StripeObject): """ outbound_transfer: Optional["OutboundTransfer"] """ - Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. + Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://api.stripe.com#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://api.stripe.com#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects. @@ -88,11 +88,11 @@ class FlowDetails(StripeObject): """ received_credit: Optional["ReceivedCredit"] """ - ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount. + ReceivedCredits represent funds sent to a [FinancialAccount](https://api.stripe.com#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount. """ received_debit: Optional["ReceivedDebit"] """ - ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount. + ReceivedDebits represent funds pulled from a [FinancialAccount](https://api.stripe.com#financial_accounts). These are not initiated from the FinancialAccount. """ type: Literal[ "credit_reversal", diff --git a/stripe/treasury/_transaction_entry.py b/stripe/treasury/_transaction_entry.py index 2e4012cb2..66845f811 100644 --- a/stripe/treasury/_transaction_entry.py +++ b/stripe/treasury/_transaction_entry.py @@ -27,7 +27,7 @@ class TransactionEntry(ListableAPIResource["TransactionEntry"]): """ - TransactionEntries represent individual units of money movements within a single [Transaction](https://stripe.com/docs/api#transactions). + TransactionEntries represent individual units of money movements within a single [Transaction](https://api.stripe.com#transactions). """ OBJECT_NAME: ClassVar[Literal["treasury.transaction_entry"]] = ( @@ -51,29 +51,29 @@ class BalanceImpact(StripeObject): class FlowDetails(StripeObject): credit_reversal: Optional["CreditReversal"] """ - You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal. + You can reverse some [ReceivedCredits](https://api.stripe.com#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal. """ debit_reversal: Optional["DebitReversal"] """ - You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal. + You can reverse some [ReceivedDebits](https://api.stripe.com#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal. """ inbound_transfer: Optional["InboundTransfer"] """ - Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. + Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://api.stripe.com#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. Related guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) """ issuing_authorization: Optional["Authorization"] """ - When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization` - object is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the + When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization` + object is created. [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the purchase to be completed successfully. - Related guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations) + Related guide: [Issued card authorizations](https://docs.stripe.com/issuing/purchases/authorizations) """ outbound_payment: Optional["OutboundPayment"] """ - Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers). + Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://api.stripe.com#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://api.stripe.com#outbound_transfers). Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects. @@ -81,7 +81,7 @@ class FlowDetails(StripeObject): """ outbound_transfer: Optional["OutboundTransfer"] """ - Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. + Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://api.stripe.com#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://api.stripe.com#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects. @@ -89,11 +89,11 @@ class FlowDetails(StripeObject): """ received_credit: Optional["ReceivedCredit"] """ - ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount. + ReceivedCredits represent funds sent to a [FinancialAccount](https://api.stripe.com#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount. """ received_debit: Optional["ReceivedDebit"] """ - ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount. + ReceivedDebits represent funds pulled from a [FinancialAccount](https://api.stripe.com#financial_accounts). These are not initiated from the FinancialAccount. """ type: Literal[ "credit_reversal", diff --git a/stripe/v2/_core_service.py b/stripe/v2/_core_service.py index 746a472ad..6d95f80e3 100644 --- a/stripe/v2/_core_service.py +++ b/stripe/v2/_core_service.py @@ -5,12 +5,24 @@ from typing_extensions import TYPE_CHECKING if TYPE_CHECKING: + from stripe.v2.core._account_link_service import AccountLinkService + from stripe.v2.core._account_service import AccountService + from stripe.v2.core._account_token_service import AccountTokenService from stripe.v2.core._event_destination_service import ( EventDestinationService, ) from stripe.v2.core._event_service import EventService _subservices = { + "accounts": ["stripe.v2.core._account_service", "AccountService"], + "account_links": [ + "stripe.v2.core._account_link_service", + "AccountLinkService", + ], + "account_tokens": [ + "stripe.v2.core._account_token_service", + "AccountTokenService", + ], "events": ["stripe.v2.core._event_service", "EventService"], "event_destinations": [ "stripe.v2.core._event_destination_service", @@ -20,6 +32,9 @@ class CoreService(StripeService): + accounts: "AccountService" + account_links: "AccountLinkService" + account_tokens: "AccountTokenService" events: "EventService" event_destinations: "EventDestinationService" diff --git a/stripe/v2/core/__init__.py b/stripe/v2/core/__init__.py index dc715b4b4..8ff2aeb1e 100644 --- a/stripe/v2/core/__init__.py +++ b/stripe/v2/core/__init__.py @@ -12,6 +12,23 @@ from importlib import import_module if TYPE_CHECKING: + from stripe.v2.core import accounts as accounts + from stripe.v2.core._account import Account as Account + from stripe.v2.core._account_link import AccountLink as AccountLink + from stripe.v2.core._account_link_service import ( + AccountLinkService as AccountLinkService, + ) + from stripe.v2.core._account_person import AccountPerson as AccountPerson + from stripe.v2.core._account_person_token import ( + AccountPersonToken as AccountPersonToken, + ) + from stripe.v2.core._account_service import ( + AccountService as AccountService, + ) + from stripe.v2.core._account_token import AccountToken as AccountToken + from stripe.v2.core._account_token_service import ( + AccountTokenService as AccountTokenService, + ) from stripe.v2.core._event import Event as Event from stripe.v2.core._event_destination import ( EventDestination as EventDestination, @@ -23,6 +40,15 @@ # name -> (import_target, is_submodule) _import_map = { + "accounts": ("stripe.v2.core.accounts", True), + "Account": ("stripe.v2.core._account", False), + "AccountLink": ("stripe.v2.core._account_link", False), + "AccountLinkService": ("stripe.v2.core._account_link_service", False), + "AccountPerson": ("stripe.v2.core._account_person", False), + "AccountPersonToken": ("stripe.v2.core._account_person_token", False), + "AccountService": ("stripe.v2.core._account_service", False), + "AccountToken": ("stripe.v2.core._account_token", False), + "AccountTokenService": ("stripe.v2.core._account_token_service", False), "Event": ("stripe.v2.core._event", False), "EventDestination": ("stripe.v2.core._event_destination", False), "EventDestinationService": ( diff --git a/stripe/v2/core/_account.py b/stripe/v2/core/_account.py new file mode 100644 index 000000000..868740f3d --- /dev/null +++ b/stripe/v2/core/_account.py @@ -0,0 +1,4312 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from stripe._stripe_object import StripeObject +from typing import ClassVar, Dict, List, Optional +from typing_extensions import Literal + + +class Account(StripeObject): + """ + A V2 Account is a representation of a company or individual that a Stripe user does business with. Accounts contain the contact details, Legal Entity information, and configuration required to enable the Account for use across Stripe products. + """ + + OBJECT_NAME: ClassVar[Literal["v2.core.account"]] = "v2.core.account" + + class Configuration(StripeObject): + class Customer(StripeObject): + class AutomaticIndirectTax(StripeObject): + class Location(StripeObject): + country: Optional[str] + """ + The identified tax country of the customer. + """ + state: Optional[str] + """ + The identified tax state, county, province, or region of the customer. + """ + + exempt: Optional[Literal["exempt", "none", "reverse"]] + """ + The customer account's tax exemption status: `none`, `exempt`, or `reverse`. When `reverse`, invoice and receipt PDFs include "Reverse charge". + """ + ip_address: Optional[str] + """ + A recent IP address of the customer used for tax reporting and tax location inference. + """ + location: Optional[Location] + """ + The customer account's identified tax location, derived from `location_source`. Only rendered if the `automatic_indirect_tax` feature is requested and `active`. + """ + location_source: Optional[ + Literal[ + "identity_address", + "ip_address", + "payment_method", + "shipping_address", + ] + ] + """ + Data source used to identify the customer account's tax location. Defaults to `identity_address`. Used for automatic indirect tax calculation. + """ + _inner_class_types = {"location": Location} + + class Billing(StripeObject): + class Invoice(StripeObject): + class CustomField(StripeObject): + name: str + """ + The name of the custom field. This may be up to 40 characters. + """ + value: str + """ + The value of the custom field. This may be up to 140 characters. When updating, pass an empty string to remove previously-defined values. + """ + + class Rendering(StripeObject): + amount_tax_display: Optional[ + Literal["exclude_tax", "include_inclusive_tax"] + ] + """ + Indicates whether displayed line item prices and amounts on invoice PDFs include inclusive tax amounts. Must be either `include_inclusive_tax` or `exclude_tax`. + """ + template: Optional[str] + """ + ID of the invoice rendering template to use for future invoices. + """ + + custom_fields: List[CustomField] + """ + 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. + """ + footer: Optional[str] + """ + Default invoice footer. + """ + next_sequence: Optional[int] + """ + Sequence number to use on the customer account's next invoice. Defaults to 1. + """ + prefix: Optional[str] + """ + Prefix used to generate unique invoice numbers. Must be 3-12 uppercase letters or numbers. + """ + rendering: Optional[Rendering] + """ + Default invoice PDF rendering options. + """ + _inner_class_types = { + "custom_fields": CustomField, + "rendering": Rendering, + } + + default_payment_method: Optional[str] + """ + ID of a PaymentMethod attached to the customer account to use as the default for invoices and subscriptions. + """ + invoice: Optional[Invoice] + """ + Default invoice settings for the customer account. + """ + _inner_class_types = {"invoice": Invoice} + + class Capabilities(StripeObject): + class AutomaticIndirectTax(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + automatic_indirect_tax: Optional[AutomaticIndirectTax] + """ + Generates requirements for enabling automatic indirect tax calculation on this customer's invoices or subscriptions. Recommended to request this capability if planning to enable automatic tax calculation on this customer's invoices or subscriptions. + """ + _inner_class_types = { + "automatic_indirect_tax": AutomaticIndirectTax, + } + + class Shipping(StripeObject): + class Address(StripeObject): + city: Optional[str] + """ + City, district, suburb, town, or village. + """ + country: Optional[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: Optional[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: Optional[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: Optional[str] + """ + ZIP or postal code. + """ + state: Optional[str] + """ + State, county, province, or region. + """ + + address: Optional[Address] + """ + Customer shipping address. + """ + name: Optional[str] + """ + Customer name. + """ + phone: Optional[str] + """ + Customer phone (including extension). + """ + _inner_class_types = {"address": Address} + + applied: bool + """ + Indicates whether the customer configuration is active. You can deactivate or reactivate the customer configuration by updating this property. Deactivating the configuration by setting this value to false will unrequest all capabilities within the configuration. It will not delete any of the configuration's other properties. + """ + automatic_indirect_tax: Optional[AutomaticIndirectTax] + """ + Settings for automatic indirect tax calculation on the customer's invoices, subscriptions, Checkout Sessions, and Payment Links. Available when automatic tax calculation is available for the customer account's location. + """ + billing: Optional[Billing] + """ + Default Billing settings for the customer account, used in Invoices and Subscriptions. + """ + capabilities: Optional[Capabilities] + """ + Capabilities that have been requested on the Customer Configuration. + """ + shipping: Optional[Shipping] + """ + The customer's shipping information. Appears on invoices emailed to this customer. + """ + test_clock: Optional[str] + """ + ID of the test clock to attach to the customer. Can only be set on testmode Accounts, and when the Customer Configuration is first set on an Account. + """ + _inner_class_types = { + "automatic_indirect_tax": AutomaticIndirectTax, + "billing": Billing, + "capabilities": Capabilities, + "shipping": Shipping, + } + + class Merchant(StripeObject): + class BacsDebitPayments(StripeObject): + display_name: Optional[str] + """ + Display name for Bacs Direct Debit payments. + """ + service_user_number: Optional[str] + """ + Service User Number (SUN) for Bacs Direct Debit payments. + """ + + class Branding(StripeObject): + icon: Optional[str] + """ + ID of a [file upload](https://docs.stripe.com/api/persons/update#create_file): An icon for the merchant. Must be square and at least 128px x 128px. + """ + logo: Optional[str] + """ + ID of a [file upload](https://docs.stripe.com/api/persons/update#create_file): A logo for the merchant that will be used in Checkout instead of the icon and without the merchant's name next to it if provided. Must be at least 128px x 128px. + """ + primary_color: Optional[str] + """ + A CSS hex color value representing the primary branding color for the merchant. + """ + secondary_color: Optional[str] + """ + A CSS hex color value representing the secondary branding color for the merchant. + """ + + class Capabilities(StripeObject): + class AchDebitPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class AcssDebitPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class AffirmPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class AfterpayClearpayPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class AlmaPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class AmazonPayPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class AuBecsDebitPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class BacsDebitPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class BancontactPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class BlikPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class BoletoPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class CardPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class CartesBancairesPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class CashappPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class EpsPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class FpxPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class GbBankTransferPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class GrabpayPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class IdealPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class JcbPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class JpBankTransferPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class KakaoPayPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class KlarnaPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class KonbiniPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class KrCardPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class LinkPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class MobilepayPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class MultibancoPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class MxBankTransferPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class NaverPayPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class OxxoPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class P24Payments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class PayByBankPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class PaycoPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class PaynowPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class PromptpayPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class RevolutPayPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class SamsungPayPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class SepaBankTransferPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class SepaDebitPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class StripeBalance(StripeObject): + class Payouts(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", + "no_resolution", + "provide_info", + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + payouts: Optional[Payouts] + """ + Enables this Account to complete payouts from their Stripe Balance (/v1/balance). + """ + _inner_class_types = {"payouts": Payouts} + + class SwishPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class TwintPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class UsBankTransferPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class ZipPayments(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", "no_resolution", "provide_info" + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + ach_debit_payments: Optional[AchDebitPayments] + """ + Allow the merchant to process ACH debit payments. + """ + acss_debit_payments: Optional[AcssDebitPayments] + """ + Allow the merchant to process ACSS debit payments. + """ + affirm_payments: Optional[AffirmPayments] + """ + Allow the merchant to process Affirm payments. + """ + afterpay_clearpay_payments: Optional[AfterpayClearpayPayments] + """ + Allow the merchant to process Afterpay/Clearpay payments. + """ + alma_payments: Optional[AlmaPayments] + """ + Allow the merchant to process Alma payments. + """ + amazon_pay_payments: Optional[AmazonPayPayments] + """ + Allow the merchant to process Amazon Pay payments. + """ + au_becs_debit_payments: Optional[AuBecsDebitPayments] + """ + Allow the merchant to process Australian BECS Direct Debit payments. + """ + bacs_debit_payments: Optional[BacsDebitPayments] + """ + Allow the merchant to process BACS Direct Debit payments. + """ + bancontact_payments: Optional[BancontactPayments] + """ + Allow the merchant to process Bancontact payments. + """ + blik_payments: Optional[BlikPayments] + """ + Allow the merchant to process BLIK payments. + """ + boleto_payments: Optional[BoletoPayments] + """ + Allow the merchant to process Boleto payments. + """ + card_payments: Optional[CardPayments] + """ + Allow the merchant to collect card payments. + """ + cartes_bancaires_payments: Optional[CartesBancairesPayments] + """ + Allow the merchant to process Cartes Bancaires payments. + """ + cashapp_payments: Optional[CashappPayments] + """ + Allow the merchant to process Cash App payments. + """ + eps_payments: Optional[EpsPayments] + """ + Allow the merchant to process EPS payments. + """ + fpx_payments: Optional[FpxPayments] + """ + Allow the merchant to process FPX payments. + """ + gb_bank_transfer_payments: Optional[GbBankTransferPayments] + """ + Allow the merchant to process UK bank transfer payments. + """ + grabpay_payments: Optional[GrabpayPayments] + """ + Allow the merchant to process GrabPay payments. + """ + ideal_payments: Optional[IdealPayments] + """ + Allow the merchant to process iDEAL payments. + """ + jcb_payments: Optional[JcbPayments] + """ + Allow the merchant to process JCB card payments. + """ + jp_bank_transfer_payments: Optional[JpBankTransferPayments] + """ + Allow the merchant to process Japanese bank transfer payments. + """ + kakao_pay_payments: Optional[KakaoPayPayments] + """ + Allow the merchant to process Kakao Pay payments. + """ + klarna_payments: Optional[KlarnaPayments] + """ + Allow the merchant to process Klarna payments. + """ + konbini_payments: Optional[KonbiniPayments] + """ + Allow the merchant to process Konbini convenience store payments. + """ + kr_card_payments: Optional[KrCardPayments] + """ + Allow the merchant to process Korean card payments. + """ + link_payments: Optional[LinkPayments] + """ + Allow the merchant to process Link payments. + """ + mobilepay_payments: Optional[MobilepayPayments] + """ + Allow the merchant to process MobilePay payments. + """ + multibanco_payments: Optional[MultibancoPayments] + """ + Allow the merchant to process Multibanco payments. + """ + mx_bank_transfer_payments: Optional[MxBankTransferPayments] + """ + Allow the merchant to process Mexican bank transfer payments. + """ + naver_pay_payments: Optional[NaverPayPayments] + """ + Allow the merchant to process Naver Pay payments. + """ + oxxo_payments: Optional[OxxoPayments] + """ + Allow the merchant to process OXXO payments. + """ + p24_payments: Optional[P24Payments] + """ + Allow the merchant to process Przelewy24 (P24) payments. + """ + pay_by_bank_payments: Optional[PayByBankPayments] + """ + Allow the merchant to process Pay by Bank payments. + """ + payco_payments: Optional[PaycoPayments] + """ + Allow the merchant to process PAYCO payments. + """ + paynow_payments: Optional[PaynowPayments] + """ + Allow the merchant to process PayNow payments. + """ + promptpay_payments: Optional[PromptpayPayments] + """ + Allow the merchant to process PromptPay payments. + """ + revolut_pay_payments: Optional[RevolutPayPayments] + """ + Allow the merchant to process Revolut Pay payments. + """ + samsung_pay_payments: Optional[SamsungPayPayments] + """ + Allow the merchant to process Samsung Pay payments. + """ + sepa_bank_transfer_payments: Optional[SepaBankTransferPayments] + """ + Allow the merchant to process SEPA bank transfer payments. + """ + sepa_debit_payments: Optional[SepaDebitPayments] + """ + Allow the merchant to process SEPA Direct Debit payments. + """ + stripe_balance: Optional[StripeBalance] + """ + Capabilities that enable the merchant to manage their Stripe Balance (/v1/balance). + """ + swish_payments: Optional[SwishPayments] + """ + Allow the merchant to process Swish payments. + """ + twint_payments: Optional[TwintPayments] + """ + Allow the merchant to process TWINT payments. + """ + us_bank_transfer_payments: Optional[UsBankTransferPayments] + """ + Allow the merchant to process US bank transfer payments. + """ + zip_payments: Optional[ZipPayments] + """ + Allow the merchant to process Zip payments. + """ + _inner_class_types = { + "ach_debit_payments": AchDebitPayments, + "acss_debit_payments": AcssDebitPayments, + "affirm_payments": AffirmPayments, + "afterpay_clearpay_payments": AfterpayClearpayPayments, + "alma_payments": AlmaPayments, + "amazon_pay_payments": AmazonPayPayments, + "au_becs_debit_payments": AuBecsDebitPayments, + "bacs_debit_payments": BacsDebitPayments, + "bancontact_payments": BancontactPayments, + "blik_payments": BlikPayments, + "boleto_payments": BoletoPayments, + "card_payments": CardPayments, + "cartes_bancaires_payments": CartesBancairesPayments, + "cashapp_payments": CashappPayments, + "eps_payments": EpsPayments, + "fpx_payments": FpxPayments, + "gb_bank_transfer_payments": GbBankTransferPayments, + "grabpay_payments": GrabpayPayments, + "ideal_payments": IdealPayments, + "jcb_payments": JcbPayments, + "jp_bank_transfer_payments": JpBankTransferPayments, + "kakao_pay_payments": KakaoPayPayments, + "klarna_payments": KlarnaPayments, + "konbini_payments": KonbiniPayments, + "kr_card_payments": KrCardPayments, + "link_payments": LinkPayments, + "mobilepay_payments": MobilepayPayments, + "multibanco_payments": MultibancoPayments, + "mx_bank_transfer_payments": MxBankTransferPayments, + "naver_pay_payments": NaverPayPayments, + "oxxo_payments": OxxoPayments, + "p24_payments": P24Payments, + "pay_by_bank_payments": PayByBankPayments, + "payco_payments": PaycoPayments, + "paynow_payments": PaynowPayments, + "promptpay_payments": PromptpayPayments, + "revolut_pay_payments": RevolutPayPayments, + "samsung_pay_payments": SamsungPayPayments, + "sepa_bank_transfer_payments": SepaBankTransferPayments, + "sepa_debit_payments": SepaDebitPayments, + "stripe_balance": StripeBalance, + "swish_payments": SwishPayments, + "twint_payments": TwintPayments, + "us_bank_transfer_payments": UsBankTransferPayments, + "zip_payments": ZipPayments, + } + + class CardPayments(StripeObject): + class DeclineOn(StripeObject): + avs_failure: Optional[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: Optional[bool] + """ + Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification. + """ + + decline_on: Optional[DeclineOn] + """ + Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge. + """ + _inner_class_types = {"decline_on": DeclineOn} + + class KonbiniPayments(StripeObject): + class Support(StripeObject): + class Hours(StripeObject): + end_time: Optional[str] + """ + Support hours end time (JST time of day) for in `HH:MM` format. + """ + start_time: Optional[str] + """ + Support hours start time (JST time of day) for in `HH:MM` format. + """ + + email: Optional[str] + """ + Support email address for Konbini payments. + """ + hours: Optional[Hours] + """ + Support hours for Konbini payments. + """ + phone: Optional[str] + """ + Support phone number for Konbini payments. + """ + _inner_class_types = {"hours": Hours} + + support: Optional[Support] + """ + Support for Konbini payments. + """ + _inner_class_types = {"support": Support} + + class ScriptStatementDescriptor(StripeObject): + class Kana(StripeObject): + descriptor: Optional[str] + """ + The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a statement_descriptor_prefix, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + prefix: Optional[str] + """ + Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don't specify this value, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + + class Kanji(StripeObject): + descriptor: Optional[str] + """ + The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a statement_descriptor_prefix, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + prefix: Optional[str] + """ + Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don't specify this value, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + + kana: Optional[Kana] + """ + The Kana variation of statement_descriptor used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). + """ + kanji: Optional[Kanji] + """ + The Kanji variation of statement_descriptor used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). + """ + _inner_class_types = {"kana": Kana, "kanji": Kanji} + + class SepaDebitPayments(StripeObject): + creditor_id: Optional[str] + """ + Creditor ID for SEPA Direct Debit payments. + """ + + class StatementDescriptor(StripeObject): + descriptor: Optional[str] + """ + The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a statement_descriptor_prefix, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the statement_descriptor text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + prefix: Optional[str] + """ + Default text that appears on statements for card charges outside of Japan, prefixing any dynamic statement_descriptor_suffix specified on the charge. To maximize space for the dynamic part of the descriptor, keep this text short. If you don't specify this value, statement_descriptor is used as the prefix. For more information about statement descriptors and their requirements, see the Merchant Configuration settings documentation. + """ + + class Support(StripeObject): + class Address(StripeObject): + city: Optional[str] + """ + City, district, suburb, town, or village. + """ + country: Optional[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: Optional[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: Optional[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: Optional[str] + """ + ZIP or postal code. + """ + state: Optional[str] + """ + State, county, province, or region. + """ + town: Optional[str] + """ + Town or district. + """ + + address: Optional[Address] + """ + A publicly available mailing address for sending support issues to. + """ + email: Optional[str] + """ + A publicly available email address for sending support issues to. + """ + phone: Optional[str] + """ + A publicly available phone number to call with support issues. + """ + url: Optional[str] + """ + A publicly available website for handling support issues. + """ + _inner_class_types = {"address": Address} + + applied: bool + """ + Indicates whether the merchant configuration is active. You can deactivate or reactivate the merchant configuration by updating this property. Deactivating the configuration by setting this value to false doesn't delete the configuration's properties. + """ + bacs_debit_payments: Optional[BacsDebitPayments] + """ + Settings for Bacs Direct Debit payments. + """ + branding: Optional[Branding] + """ + Settings used to apply the merchant's branding to email receipts, invoices, Checkout, and other products. + """ + capabilities: Optional[Capabilities] + """ + Capabilities that have been requested on the Merchant Configuration. + """ + card_payments: Optional[CardPayments] + """ + Card payments settings. + """ + konbini_payments: Optional[KonbiniPayments] + """ + Settings specific to Konbini payments on the account. + """ + mcc: Optional[str] + """ + The Merchant Category Code (MCC) for the merchant. MCCs classify businesses based on the goods or services they provide. + """ + script_statement_descriptor: Optional[ScriptStatementDescriptor] + """ + Settings for the default text that appears on statements for language variations. + """ + sepa_debit_payments: Optional[SepaDebitPayments] + """ + Settings for SEPA Direct Debit payments. + """ + statement_descriptor: Optional[StatementDescriptor] + """ + Statement descriptor. + """ + support: Optional[Support] + """ + Publicly available contact information for sending support issues to. + """ + _inner_class_types = { + "bacs_debit_payments": BacsDebitPayments, + "branding": Branding, + "capabilities": Capabilities, + "card_payments": CardPayments, + "konbini_payments": KonbiniPayments, + "script_statement_descriptor": ScriptStatementDescriptor, + "sepa_debit_payments": SepaDebitPayments, + "statement_descriptor": StatementDescriptor, + "support": Support, + } + + class Recipient(StripeObject): + class Capabilities(StripeObject): + class StripeBalance(StripeObject): + class Payouts(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", + "no_resolution", + "provide_info", + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + class StripeTransfers(StripeObject): + class StatusDetail(StripeObject): + code: Literal[ + "determining_status", + "requirements_past_due", + "requirements_pending_verification", + "restricted_other", + "unsupported_business", + "unsupported_country", + "unsupported_entity_type", + ] + """ + Machine-readable code explaining the reason for the Capability to be in its current status. + """ + resolution: Literal[ + "contact_stripe", + "no_resolution", + "provide_info", + ] + """ + Machine-readable code explaining how to make the Capability active. + """ + + status: Literal[ + "active", "pending", "restricted", "unsupported" + ] + """ + The status of the Capability. + """ + status_details: List[StatusDetail] + """ + Additional details about the capability's status. This value is empty when `status` is `active`. + """ + _inner_class_types = {"status_details": StatusDetail} + + payouts: Optional[Payouts] + """ + Enables this Account to complete payouts from their Stripe Balance (/v1/balance). + """ + stripe_transfers: Optional[StripeTransfers] + """ + Enables this Account to receive /v1/transfers into their Stripe Balance (/v1/balance). + """ + _inner_class_types = { + "payouts": Payouts, + "stripe_transfers": StripeTransfers, + } + + stripe_balance: Optional[StripeBalance] + """ + Capabilities that enable the recipient to manage their Stripe Balance (/v1/balance). + """ + _inner_class_types = {"stripe_balance": StripeBalance} + + applied: bool + """ + Indicates whether the recipient configuration is active. You can deactivate or reactivate the recipient configuration by updating this property. Deactivating the configuration by setting this value to false unrequest all capabilities within the configuration. It will not delete any of the configuration's other properties. + """ + capabilities: Optional[Capabilities] + """ + Capabilities that have been requested on the Recipient Configuration. + """ + _inner_class_types = {"capabilities": Capabilities} + + customer: Optional[Customer] + """ + The Customer Configuration allows the Account to be used in inbound payment flows. + """ + merchant: Optional[Merchant] + """ + Enables the Account to act as a connected account and collect payments facilitated by a Connect platform. You must onboard your platform to Connect before you can add this configuration to your connected accounts. Utilize this configuration when the Account will be the Merchant of Record, like with Direct charges or Destination Charges with on_behalf_of set. + """ + recipient: Optional[Recipient] + """ + The Recipient Configuration allows the Account to receive funds. Utilize this configuration if the Account will not be the Merchant of Record, like with Separate Charges & Transfers, or Destination Charges without on_behalf_of set. + """ + _inner_class_types = { + "customer": Customer, + "merchant": Merchant, + "recipient": Recipient, + } + + class Defaults(StripeObject): + class Profile(StripeObject): + business_url: Optional[str] + """ + The business's publicly-available website. + """ + doing_business_as: Optional[str] + """ + The customer-facing business name. + """ + product_description: Optional[str] + """ + Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. + """ + + class Responsibilities(StripeObject): + fees_collector: Optional[ + Literal[ + "application", + "application_custom", + "application_express", + "stripe", + ] + ] + """ + Indicates whether the platform or connected account is responsible for paying Stripe fees for pricing-control-eligible products. + """ + losses_collector: Optional[Literal["application", "stripe"]] + """ + A value indicating responsibility for collecting requirements on this account. + """ + requirements_collector: Literal["application", "stripe"] + """ + A value indicating responsibility for collecting requirements on this account. + """ + + currency: Optional[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). + """ + locales: Optional[ + List[ + Literal[ + "ar-SA", + "bg", + "bg-BG", + "cs", + "cs-CZ", + "da", + "da-DK", + "de", + "de-DE", + "el", + "el-GR", + "en", + "en-AU", + "en-CA", + "en-GB", + "en-IE", + "en-IN", + "en-NZ", + "en-SG", + "en-US", + "es", + "es-419", + "es-ES", + "et", + "et-EE", + "fi", + "fil", + "fil-PH", + "fi-FI", + "fr", + "fr-CA", + "fr-FR", + "he-IL", + "hr", + "hr-HR", + "hu", + "hu-HU", + "id", + "id-ID", + "it", + "it-IT", + "ja", + "ja-JP", + "ko", + "ko-KR", + "lt", + "lt-LT", + "lv", + "lv-LV", + "ms", + "ms-MY", + "mt", + "mt-MT", + "nb", + "nb-NO", + "nl", + "nl-NL", + "pl", + "pl-PL", + "pt", + "pt-BR", + "pt-PT", + "ro", + "ro-RO", + "ru", + "ru-RU", + "sk", + "sk-SK", + "sl", + "sl-SI", + "sv", + "sv-SE", + "th", + "th-TH", + "tr", + "tr-TR", + "vi", + "vi-VN", + "zh", + "zh-Hans", + "zh-Hant-HK", + "zh-Hant-TW", + "zh-HK", + "zh-TW", + ] + ] + ] + """ + The Account's preferred locales (languages), ordered by preference. + """ + profile: Optional[Profile] + """ + Account profile information. + """ + responsibilities: Responsibilities + """ + Default responsibilities held by either Stripe or the platform. + """ + _inner_class_types = { + "profile": Profile, + "responsibilities": Responsibilities, + } + + class FutureRequirements(StripeObject): + class Entry(StripeObject): + class Error(StripeObject): + code: Literal[ + "invalid_address_city_state_postal_code", + "invalid_address_highway_contract_box", + "invalid_address_private_mailbox", + "invalid_business_profile_name", + "invalid_business_profile_name_denylisted", + "invalid_company_name_denylisted", + "invalid_dob_age_over_maximum", + "invalid_dob_age_under_18", + "invalid_dob_age_under_minimum", + "invalid_product_description_length", + "invalid_product_description_url_match", + "invalid_representative_country", + "invalid_statement_descriptor_business_mismatch", + "invalid_statement_descriptor_denylisted", + "invalid_statement_descriptor_length", + "invalid_statement_descriptor_prefix_denylisted", + "invalid_statement_descriptor_prefix_mismatch", + "invalid_street_address", + "invalid_tax_id", + "invalid_tax_id_format", + "invalid_tos_acceptance", + "invalid_url_denylisted", + "invalid_url_format", + "invalid_url_website_business_information_mismatch", + "invalid_url_website_empty", + "invalid_url_website_inaccessible", + "invalid_url_website_inaccessible_geoblocked", + "invalid_url_website_inaccessible_password_protected", + "invalid_url_website_incomplete", + "invalid_url_website_incomplete_cancellation_policy", + "invalid_url_website_incomplete_customer_service_details", + "invalid_url_website_incomplete_legal_restrictions", + "invalid_url_website_incomplete_refund_policy", + "invalid_url_website_incomplete_return_policy", + "invalid_url_website_incomplete_terms_and_conditions", + "invalid_url_website_incomplete_under_construction", + "invalid_url_website_other", + "invalid_url_web_presence_detected", + "invalid_value_other", + "unresolvable_ip_address", + "unresolvable_postal_code", + "verification_directors_mismatch", + "verification_document_address_mismatch", + "verification_document_address_missing", + "verification_document_corrupt", + "verification_document_country_not_supported", + "verification_document_directors_mismatch", + "verification_document_dob_mismatch", + "verification_document_duplicate_type", + "verification_document_expired", + "verification_document_failed_copy", + "verification_document_failed_greyscale", + "verification_document_failed_other", + "verification_document_failed_test_mode", + "verification_document_fraudulent", + "verification_document_id_number_mismatch", + "verification_document_id_number_missing", + "verification_document_incomplete", + "verification_document_invalid", + "verification_document_issue_or_expiry_date_missing", + "verification_document_manipulated", + "verification_document_missing_back", + "verification_document_missing_front", + "verification_document_name_mismatch", + "verification_document_name_missing", + "verification_document_nationality_mismatch", + "verification_document_not_readable", + "verification_document_not_signed", + "verification_document_not_uploaded", + "verification_document_photo_mismatch", + "verification_document_too_large", + "verification_document_type_not_supported", + "verification_extraneous_directors", + "verification_failed_address_match", + "verification_failed_business_iec_number", + "verification_failed_document_match", + "verification_failed_id_number_match", + "verification_failed_keyed_identity", + "verification_failed_keyed_match", + "verification_failed_name_match", + "verification_failed_other", + "verification_failed_representative_authority", + "verification_failed_residential_address", + "verification_failed_tax_id_match", + "verification_failed_tax_id_not_issued", + "verification_missing_directors", + "verification_missing_executives", + "verification_missing_owners", + "verification_requires_additional_memorandum_of_associations", + "verification_requires_additional_proof_of_registration", + "verification_selfie_document_missing_photo", + "verification_selfie_face_mismatch", + "verification_selfie_manipulated", + "verification_selfie_unverified_other", + "verification_supportability", + "verification_token_stale", + ] + """ + Machine-readable code describing the error. + """ + description: str + """ + Human-readable description of the error. + """ + + class Impact(StripeObject): + class RestrictsCapability(StripeObject): + class Deadline(StripeObject): + status: Literal[ + "currently_due", "eventually_due", "past_due" + ] + """ + The current status of the requirement's impact. + """ + + capability: Literal[ + "ach_debit_payments", + "acss_debit_payments", + "affirm_payments", + "afterpay_clearpay_payments", + "alma_payments", + "amazon_pay_payments", + "automatic_indirect_tax", + "au_becs_debit_payments", + "bacs_debit_payments", + "bancontact_payments", + "bank_accounts.local", + "bank_accounts.wire", + "blik_payments", + "boleto_payments", + "cards", + "card_payments", + "cartes_bancaires_payments", + "cashapp_payments", + "eps_payments", + "fpx_payments", + "gb_bank_transfer_payments", + "grabpay_payments", + "ideal_payments", + "jcb_payments", + "jp_bank_transfer_payments", + "kakao_pay_payments", + "klarna_payments", + "konbini_payments", + "kr_card_payments", + "link_payments", + "mobilepay_payments", + "multibanco_payments", + "mx_bank_transfer_payments", + "naver_pay_payments", + "oxxo_payments", + "p24_payments", + "payco_payments", + "paynow_payments", + "pay_by_bank_payments", + "promptpay_payments", + "revolut_pay_payments", + "samsung_pay_payments", + "sepa_bank_transfer_payments", + "sepa_debit_payments", + "stripe_balance.payouts", + "stripe_balance.stripe_transfers", + "swish_payments", + "twint_payments", + "us_bank_transfer_payments", + "zip_payments", + ] + """ + The name of the Capability which will be restricted. + """ + configuration: Literal["customer", "merchant", "recipient"] + """ + The configuration which specifies the Capability which will be restricted. + """ + deadline: Deadline + """ + Details about when in the account lifecycle the requirement must be collected by the avoid the Capability restriction. + """ + _inner_class_types = {"deadline": Deadline} + + restricts_capabilities: Optional[List[RestrictsCapability]] + """ + The Capabilities that will be restricted if the requirement is not collected and satisfactory to Stripe. + """ + _inner_class_types = { + "restricts_capabilities": RestrictsCapability, + } + + class MinimumDeadline(StripeObject): + status: Literal["currently_due", "eventually_due", "past_due"] + """ + The current status of the requirement's impact. + """ + + class Reference(StripeObject): + inquiry: Optional[str] + """ + If `inquiry` is the type, the inquiry token. + """ + resource: Optional[str] + """ + If `resource` is the type, the resource token. + """ + type: Literal["inquiry", "payment_method", "person"] + """ + The type of the reference. If the type is "inquiry", the inquiry token can be found in the "inquiry" field. + Otherwise the type is an API resource, the token for which can be found in the "resource" field. + """ + + class RequestedReason(StripeObject): + code: Literal["routine_onboarding", "routine_verification"] + """ + Machine-readable description of Stripe's reason for collecting the requirement. + """ + + awaiting_action_from: Literal["stripe", "user"] + """ + Indicates whether the platform or Stripe is currently responsible for taking action on the requirement. Value can be `user` or `stripe`. + """ + description: str + """ + Machine-readable string describing the requirement. + """ + errors: List[Error] + """ + Descriptions of why the requirement must be collected, or why the collected information isn't satisfactory to Stripe. + """ + impact: Impact + """ + A hash describing the impact of not collecting the requirement, or Stripe not being able to verify the collected information. + """ + minimum_deadline: MinimumDeadline + """ + The soonest point when the account will be impacted by not providing the requirement. + """ + reference: Optional[Reference] + """ + A reference to the location of the requirement. + """ + requested_reasons: List[RequestedReason] + """ + A list of reasons why Stripe is collecting the requirement. + """ + _inner_class_types = { + "errors": Error, + "impact": Impact, + "minimum_deadline": MinimumDeadline, + "reference": Reference, + "requested_reasons": RequestedReason, + } + + class Summary(StripeObject): + class MinimumDeadline(StripeObject): + status: Literal["currently_due", "eventually_due", "past_due"] + """ + The current strictest status of all requirements on the Account. + """ + time: Optional[str] + """ + The soonest RFC3339 date & time UTC value a requirement can impact the Account. + """ + + minimum_deadline: Optional[MinimumDeadline] + """ + The soonest date and time a requirement on the Account will become `past due`. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: `2022-09-18T13:22:18.123Z`. + """ + _inner_class_types = {"minimum_deadline": MinimumDeadline} + + entries: Optional[List[Entry]] + """ + A list of requirements for the Account. + """ + minimum_transition_date: Optional[str] + """ + The time at which the future requirements become effective. + """ + summary: Optional[Summary] + """ + An object containing an overview of requirements for the Account. + """ + _inner_class_types = {"entries": Entry, "summary": Summary} + + class Identity(StripeObject): + class Attestations(StripeObject): + class DirectorshipDeclaration(StripeObject): + date: Optional[str] + """ + The time marking when the director attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: Optional[str] + """ + The IP address from which the director attestation was made. + """ + user_agent: Optional[str] + """ + The user agent of the browser from which the director attestation was made. + """ + + class OwnershipDeclaration(StripeObject): + date: Optional[str] + """ + The time marking when the beneficial owner attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: Optional[str] + """ + The IP address from which the beneficial owner attestation was made. + """ + user_agent: Optional[str] + """ + The user agent of the browser from which the beneficial owner attestation was made. + """ + + class PersonsProvided(StripeObject): + directors: Optional[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://docs.stripe.com/api/v2/core/accounts/createperson). + """ + executives: Optional[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://docs.stripe.com/api/v2/core/accounts/createperson). + """ + owners: Optional[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://docs.stripe.com/api/v2/core/accounts/createperson). + """ + ownership_exemption_reason: Optional[ + Literal[ + "qualified_entity_exceeds_ownership_threshold", + "qualifies_as_financial_institution", + ] + ] + """ + Reason for why the company is exempt from providing ownership information. + """ + + class RepresentativeDeclaration(StripeObject): + date: Optional[str] + """ + The time marking when the representative attestation was made. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: Optional[str] + """ + The IP address from which the representative attestation was made. + """ + user_agent: Optional[str] + """ + The user agent of the browser from which the representative attestation was made. + """ + + class TermsOfService(StripeObject): + class Account(StripeObject): + date: Optional[str] + """ + The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: Optional[str] + """ + The IP address from which the Account's representative accepted the terms of service. + """ + user_agent: Optional[str] + """ + The user agent of the browser from which the Account's representative accepted the terms of service. + """ + + account: Optional[Account] + """ + Details on the Account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance). + """ + _inner_class_types = {"account": Account} + + directorship_declaration: Optional[DirectorshipDeclaration] + """ + This hash is used to attest that the directors information provided to Stripe is both current and correct. + """ + ownership_declaration: Optional[OwnershipDeclaration] + """ + This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. + """ + persons_provided: Optional[PersonsProvided] + """ + Attestation that all Persons with a specific Relationship value have been provided. + """ + representative_declaration: Optional[RepresentativeDeclaration] + """ + This hash is used to attest that the representative is authorized to act as the representative of their legal entity. + """ + terms_of_service: Optional[TermsOfService] + """ + Attestations of accepted terms of service agreements. + """ + _inner_class_types = { + "directorship_declaration": DirectorshipDeclaration, + "ownership_declaration": OwnershipDeclaration, + "persons_provided": PersonsProvided, + "representative_declaration": RepresentativeDeclaration, + "terms_of_service": TermsOfService, + } + + class BusinessDetails(StripeObject): + class Address(StripeObject): + city: Optional[str] + """ + City, district, suburb, town, or village. + """ + country: Optional[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: Optional[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: Optional[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: Optional[str] + """ + ZIP or postal code. + """ + state: Optional[str] + """ + State, county, province, or region. + """ + town: Optional[str] + """ + Town or district. + """ + + class AnnualRevenue(StripeObject): + class Amount(StripeObject): + currency: Optional[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). + """ + value: Optional[int] + """ + A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). + """ + + amount: Optional[Amount] + """ + Annual revenue amount in minor currency units (for example, '123' for 1.23 USD). + """ + fiscal_year_end: Optional[str] + """ + The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. + """ + _inner_class_types = {"amount": Amount} + + class Documents(StripeObject): + class BankAccountOwnershipVerification(StripeObject): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + class CompanyLicense(StripeObject): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + class CompanyMemorandumOfAssociation(StripeObject): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + class CompanyMinisterialDecree(StripeObject): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + class CompanyRegistrationVerification(StripeObject): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + class CompanyTaxIdVerification(StripeObject): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + class PrimaryVerification(StripeObject): + class FrontBack(StripeObject): + back: Optional[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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: str + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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_back: FrontBack + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens for the front and back of the verification document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + _inner_class_types = {"front_back": FrontBack} + + class ProofOfAddress(StripeObject): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + class ProofOfRegistration(StripeObject): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + class ProofOfUltimateBeneficialOwnership(StripeObject): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + bank_account_ownership_verification: Optional[ + BankAccountOwnershipVerification + ] + """ + One or more documents that support the Bank account ownership verification requirement. Must be a document associated with the account's primary active bank account that displays the last 4 digits of the account number, either a statement or a check. + """ + company_license: Optional[CompanyLicense] + """ + One or more documents that demonstrate proof of a company's license to operate. + """ + company_memorandum_of_association: Optional[ + CompanyMemorandumOfAssociation + ] + """ + One or more documents showing the company's Memorandum of Association. + """ + company_ministerial_decree: Optional[CompanyMinisterialDecree] + """ + Certain countries only: One or more documents showing the ministerial decree legalizing the company's establishment. + """ + company_registration_verification: Optional[ + CompanyRegistrationVerification + ] + """ + One or more documents that demonstrate proof of a company's registration with the appropriate local authorities. + """ + company_tax_id_verification: Optional[CompanyTaxIdVerification] + """ + One or more documents that demonstrate proof of a company's tax ID. + """ + primary_verification: Optional[PrimaryVerification] + """ + A document verifying the business. + """ + proof_of_address: Optional[ProofOfAddress] + """ + One or more documents that demonstrate proof of address. + """ + proof_of_registration: Optional[ProofOfRegistration] + """ + One or more documents showing the company's proof of registration with the national business registry. + """ + proof_of_ultimate_beneficial_ownership: Optional[ + ProofOfUltimateBeneficialOwnership + ] + """ + One or more documents that demonstrate proof of ultimate beneficial ownership. + """ + _inner_class_types = { + "bank_account_ownership_verification": BankAccountOwnershipVerification, + "company_license": CompanyLicense, + "company_memorandum_of_association": CompanyMemorandumOfAssociation, + "company_ministerial_decree": CompanyMinisterialDecree, + "company_registration_verification": CompanyRegistrationVerification, + "company_tax_id_verification": CompanyTaxIdVerification, + "primary_verification": PrimaryVerification, + "proof_of_address": ProofOfAddress, + "proof_of_registration": ProofOfRegistration, + "proof_of_ultimate_beneficial_ownership": ProofOfUltimateBeneficialOwnership, + } + + class IdNumber(StripeObject): + registrar: Optional[str] + """ + The registrar of the ID number (Only valid for DE ID number types). + """ + type: Literal[ + "ae_crn", + "ae_vat", + "ao_nif", + "ar_cuit", + "at_fn", + "at_stn", + "at_vat", + "au_abn", + "au_acn", + "au_in", + "az_tin", + "bd_etin", + "be_cbe", + "be_vat", + "bg_uic", + "bg_vat", + "br_cnpj", + "ca_cn", + "ca_crarr", + "ca_gst_hst", + "ca_neq", + "ca_rid", + "ch_chid", + "ch_uid", + "cr_cpj", + "cr_nite", + "cy_he", + "cy_tic", + "cy_vat", + "cz_ico", + "cz_vat", + "de_hrn", + "de_stn", + "de_vat", + "dk_cvr", + "dk_vat", + "do_rcn", + "ee_rk", + "ee_vat", + "es_cif", + "es_vat", + "fi_vat", + "fi_yt", + "fr_rna", + "fr_siren", + "fr_vat", + "gb_crn", + "gi_crn", + "gr_afm", + "gr_gemi", + "gr_vat", + "gt_nit", + "hk_br", + "hk_cr", + "hr_mbs", + "hr_oib", + "hr_vat", + "hu_cjs", + "hu_tin", + "hu_vat", + "ie_crn", + "ie_trn", + "ie_vat", + "it_rea", + "it_vat", + "jp_cn", + "kz_bin", + "li_uid", + "lt_ccrn", + "lt_vat", + "lu_nif", + "lu_rcs", + "lu_vat", + "lv_urn", + "lv_vat", + "mt_crn", + "mt_tin", + "mt_vat", + "mx_rfc", + "my_brn", + "my_coid", + "my_itn", + "my_sst", + "mz_nuit", + "nl_kvk", + "nl_rsin", + "nl_vat", + "no_orgnr", + "nz_bn", + "nz_ird", + "pe_ruc", + "pk_ntn", + "pl_nip", + "pl_regon", + "pl_vat", + "pt_vat", + "ro_cui", + "ro_orc", + "ro_vat", + "sa_crn", + "sa_tin", + "se_orgnr", + "se_vat", + "sg_uen", + "si_msp", + "si_tin", + "si_vat", + "sk_dic", + "sk_ico", + "sk_vat", + "th_crn", + "th_prn", + "th_tin", + "us_ein", + ] + """ + Open Enum. The ID number type of a business entity. + """ + + class MonthlyEstimatedRevenue(StripeObject): + class Amount(StripeObject): + currency: Optional[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). + """ + value: Optional[int] + """ + A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). + """ + + amount: Optional[Amount] + """ + Estimated monthly revenue amount in minor currency units (for example, '123' for 1.23 USD). + """ + _inner_class_types = {"amount": Amount} + + class ScriptAddresses(StripeObject): + class Kana(StripeObject): + city: Optional[str] + """ + City, district, suburb, town, or village. + """ + country: Optional[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: Optional[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: Optional[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: Optional[str] + """ + ZIP or postal code. + """ + state: Optional[str] + """ + State, county, province, or region. + """ + town: Optional[str] + """ + Town or district. + """ + + class Kanji(StripeObject): + city: Optional[str] + """ + City, district, suburb, town, or village. + """ + country: Optional[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: Optional[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: Optional[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: Optional[str] + """ + ZIP or postal code. + """ + state: Optional[str] + """ + State, county, province, or region. + """ + town: Optional[str] + """ + Town or district. + """ + + kana: Optional[Kana] + """ + Kana Address. + """ + kanji: Optional[Kanji] + """ + Kanji Address. + """ + _inner_class_types = {"kana": Kana, "kanji": Kanji} + + class ScriptNames(StripeObject): + class Kana(StripeObject): + registered_name: Optional[str] + """ + Registered name of the business. + """ + + class Kanji(StripeObject): + registered_name: Optional[str] + """ + Registered name of the business. + """ + + kana: Optional[Kana] + """ + Kana name. + """ + kanji: Optional[Kanji] + """ + Kanji name. + """ + _inner_class_types = {"kana": Kana, "kanji": Kanji} + + address: Optional[Address] + """ + The company's primary address. + """ + annual_revenue: Optional[AnnualRevenue] + """ + The business gross annual revenue for its preceding fiscal year. + """ + documents: Optional[Documents] + """ + Documents that may be submitted to satisfy various informational requests. + """ + estimated_worker_count: Optional[int] + """ + Estimated maximum number of workers currently engaged by the business (including employees, contractors, and vendors). + """ + id_numbers: Optional[List[IdNumber]] + """ + The provided ID numbers of a business entity. + """ + monthly_estimated_revenue: Optional[MonthlyEstimatedRevenue] + """ + An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India. + """ + phone: Optional[str] + """ + The company's phone number (used for verification). + """ + registered_name: Optional[str] + """ + The business legal name. + """ + script_addresses: Optional[ScriptAddresses] + """ + The business registration address of the business entity in non latin script. + """ + script_names: Optional[ScriptNames] + """ + The business legal name in non latin script. + """ + structure: Optional[ + Literal[ + "cooperative", + "free_zone_establishment", + "free_zone_llc", + "governmental_unit", + "government_instrumentality", + "incorporated_association", + "incorporated_non_profit", + "incorporated_partnership", + "limited_liability_partnership", + "llc", + "multi_member_llc", + "private_company", + "private_corporation", + "private_partnership", + "public_company", + "public_corporation", + "public_listed_corporation", + "public_partnership", + "registered_charity", + "single_member_llc", + "sole_establishment", + "sole_proprietorship", + "tax_exempt_government_instrumentality", + "trust", + "unincorporated_association", + "unincorporated_non_profit", + "unincorporated_partnership", + ] + ] + """ + The category identifying the legal structure of the business. + """ + _inner_class_types = { + "address": Address, + "annual_revenue": AnnualRevenue, + "documents": Documents, + "id_numbers": IdNumber, + "monthly_estimated_revenue": MonthlyEstimatedRevenue, + "script_addresses": ScriptAddresses, + "script_names": ScriptNames, + } + + class Individual(StripeObject): + class AdditionalAddress(StripeObject): + city: Optional[str] + """ + City, district, suburb, town, or village. + """ + country: Optional[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: Optional[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: Optional[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: Optional[str] + """ + ZIP or postal code. + """ + purpose: Literal["registered"] + """ + Purpose of additional address. + """ + state: Optional[str] + """ + State, county, province, or region. + """ + town: Optional[str] + """ + Town or district. + """ + + class AdditionalName(StripeObject): + full_name: Optional[str] + """ + The individual's full name. + """ + given_name: Optional[str] + """ + The individual's first or given name. + """ + purpose: Literal["alias", "maiden"] + """ + The purpose or type of the additional name. + """ + surname: Optional[str] + """ + The individual's last or family name. + """ + + class AdditionalTermsOfService(StripeObject): + class Account(StripeObject): + date: Optional[str] + """ + The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: Optional[str] + """ + The IP address from which the Account's representative accepted the terms of service. + """ + user_agent: Optional[str] + """ + The user agent of the browser from which the Account's representative accepted the terms of service. + """ + + account: Optional[Account] + """ + Stripe terms of service agreement. + """ + _inner_class_types = {"account": Account} + + class Address(StripeObject): + city: Optional[str] + """ + City, district, suburb, town, or village. + """ + country: Optional[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: Optional[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: Optional[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: Optional[str] + """ + ZIP or postal code. + """ + state: Optional[str] + """ + State, county, province, or region. + """ + town: Optional[str] + """ + Town or district. + """ + + class DateOfBirth(StripeObject): + day: int + """ + The day of birth, between 1 and 31. + """ + month: int + """ + The month of birth, between 1 and 12. + """ + year: int + """ + The four-digit year of birth. + """ + + class Documents(StripeObject): + class CompanyAuthorization(StripeObject): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + class Passport(StripeObject): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + class PrimaryVerification(StripeObject): + class FrontBack(StripeObject): + back: Optional[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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: str + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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_back: FrontBack + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens for the front and back of the verification document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + _inner_class_types = {"front_back": FrontBack} + + class SecondaryVerification(StripeObject): + class FrontBack(StripeObject): + back: Optional[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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: str + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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_back: FrontBack + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens for the front and back of the verification document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + _inner_class_types = {"front_back": FrontBack} + + class Visa(StripeObject): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + company_authorization: Optional[CompanyAuthorization] + """ + One or more documents that demonstrate proof that this person is authorized to represent the company. + """ + passport: Optional[Passport] + """ + One or more documents showing the person's passport page with photo and personal data. + """ + primary_verification: Optional[PrimaryVerification] + """ + An identifying document showing the person's name, either a passport or local ID card. + """ + secondary_verification: Optional[SecondaryVerification] + """ + A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. + """ + visa: Optional[Visa] + """ + One or more documents showing the person's visa required for living in the country where they are residing. + """ + _inner_class_types = { + "company_authorization": CompanyAuthorization, + "passport": Passport, + "primary_verification": PrimaryVerification, + "secondary_verification": SecondaryVerification, + "visa": Visa, + } + + class IdNumber(StripeObject): + type: Literal[ + "ae_eid", + "ao_nif", + "ar_cuil", + "ar_dni", + "at_stn", + "az_tin", + "bd_brc", + "bd_etin", + "bd_nid", + "be_nrn", + "bg_ucn", + "bn_nric", + "br_cpf", + "ca_sin", + "ch_oasi", + "cl_rut", + "cn_pp", + "co_nuip", + "cr_ci", + "cr_cpf", + "cr_dimex", + "cr_nite", + "cy_tic", + "cz_rc", + "de_stn", + "dk_cpr", + "do_cie", + "do_rcn", + "ec_ci", + "ee_ik", + "es_nif", + "fi_hetu", + "fr_nir", + "gb_nino", + "gr_afm", + "gt_nit", + "hk_id", + "hr_oib", + "hu_ad", + "id_nik", + "ie_ppsn", + "is_kt", + "it_cf", + "jp_inc", + "ke_pin", + "kz_iin", + "li_peid", + "lt_ak", + "lu_nif", + "lv_pk", + "mx_rfc", + "my_nric", + "mz_nuit", + "ng_nin", + "nl_bsn", + "no_nin", + "nz_ird", + "pe_dni", + "pk_cnic", + "pk_snic", + "pl_pesel", + "pt_nif", + "ro_cnp", + "sa_tin", + "se_pin", + "sg_fin", + "sg_nric", + "sk_dic", + "th_lc", + "th_pin", + "tr_tin", + "us_itin", + "us_itin_last_4", + "us_ssn", + "us_ssn_last_4", + "uy_dni", + "za_id", + ] + """ + The ID number type of an individual. + """ + + class Relationship(StripeObject): + authorizer: Optional[bool] + """ + Whether the individual is an authorizer of the Account's identity. + """ + director: Optional[bool] + """ + Whether the individual is a director of the Account's identity. Directors are typically members of the governing board of the company or are responsible for making sure that the company meets its regulatory obligations. + """ + executive: Optional[bool] + """ + Whether the individual has significant responsibility to control, manage, or direct the organization. + """ + legal_guardian: Optional[bool] + """ + Whether the individual is the legal guardian of the Account's representative. + """ + owner: Optional[bool] + """ + Whether the individual is an owner of the Account's identity. + """ + percent_ownership: Optional[str] + """ + The percentage of the Account's identity that the individual owns. + """ + representative: Optional[bool] + """ + Whether the individual 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: Optional[str] + """ + The individual's title (e.g., CEO, Support Engineer). + """ + + class ScriptAddresses(StripeObject): + class Kana(StripeObject): + city: Optional[str] + """ + City, district, suburb, town, or village. + """ + country: Optional[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: Optional[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: Optional[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: Optional[str] + """ + ZIP or postal code. + """ + state: Optional[str] + """ + State, county, province, or region. + """ + town: Optional[str] + """ + Town or district. + """ + + class Kanji(StripeObject): + city: Optional[str] + """ + City, district, suburb, town, or village. + """ + country: Optional[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: Optional[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: Optional[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: Optional[str] + """ + ZIP or postal code. + """ + state: Optional[str] + """ + State, county, province, or region. + """ + town: Optional[str] + """ + Town or district. + """ + + kana: Optional[Kana] + """ + Kana Address. + """ + kanji: Optional[Kanji] + """ + Kanji Address. + """ + _inner_class_types = {"kana": Kana, "kanji": Kanji} + + class ScriptNames(StripeObject): + class Kana(StripeObject): + given_name: Optional[str] + """ + The person's first or given name. + """ + surname: Optional[str] + """ + The person's last or family name. + """ + + class Kanji(StripeObject): + given_name: Optional[str] + """ + The person's first or given name. + """ + surname: Optional[str] + """ + The person's last or family name. + """ + + kana: Optional[Kana] + """ + Persons name in kana script. + """ + kanji: Optional[Kanji] + """ + Persons name in kanji script. + """ + _inner_class_types = {"kana": Kana, "kanji": Kanji} + + account: str + """ + The account ID which the individual belongs to. + """ + additional_addresses: Optional[List[AdditionalAddress]] + """ + Additional addresses associated with the individual. + """ + additional_names: Optional[List[AdditionalName]] + """ + Additional names (e.g. aliases) associated with the individual. + """ + additional_terms_of_service: Optional[AdditionalTermsOfService] + """ + Terms of service acceptances. + """ + address: Optional[Address] + """ + The individual's residential address. + """ + created: str + """ + Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + date_of_birth: Optional[DateOfBirth] + """ + The individual's date of birth. + """ + documents: Optional[Documents] + """ + Documents that may be submitted to satisfy various informational requests. + """ + email: Optional[str] + """ + The individual's email address. + """ + given_name: Optional[str] + """ + The individual's first name. + """ + id: str + """ + Unique identifier for the object. + """ + id_numbers: Optional[List[IdNumber]] + """ + The identification numbers (e.g., SSN) associated with the individual. + """ + legal_gender: Optional[Literal["female", "male"]] + """ + The individual's gender (International regulations require either "male” or "female"). + """ + metadata: Optional[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. + """ + nationalities: Optional[List[str]] + """ + The countries where the individual is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + object: str + """ + String representing the object's type. Objects of the same type share the same value. + """ + phone: Optional[str] + """ + The individual's phone number. + """ + political_exposure: Optional[Literal["existing", "none"]] + """ + Indicates if the individual 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. + """ + relationship: Optional[Relationship] + """ + The relationship that this individual has with the Account's identity. + """ + script_addresses: Optional[ScriptAddresses] + """ + The script addresses (e.g., non-Latin characters) associated with the individual. + """ + script_names: Optional[ScriptNames] + """ + The script names (e.g. non-Latin characters) associated with the individual. + """ + surname: Optional[str] + """ + The individual's last name. + """ + updated: str + """ + Time at which the object was last updated. + """ + _inner_class_types = { + "additional_addresses": AdditionalAddress, + "additional_names": AdditionalName, + "additional_terms_of_service": AdditionalTermsOfService, + "address": Address, + "date_of_birth": DateOfBirth, + "documents": Documents, + "id_numbers": IdNumber, + "relationship": Relationship, + "script_addresses": ScriptAddresses, + "script_names": ScriptNames, + } + + attestations: Optional[Attestations] + """ + Attestations from the identity's key people, e.g. owners, executives, directors, representatives. + """ + business_details: Optional[BusinessDetails] + """ + Information about the company or business. + """ + country: Optional[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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. + """ + entity_type: Optional[ + Literal["company", "government_entity", "individual", "non_profit"] + ] + """ + The entity type. + """ + individual: Optional[Individual] + """ + Information about the individual represented by the Account. This property is `null` unless `entity_type` is set to `individual`. + """ + _inner_class_types = { + "attestations": Attestations, + "business_details": BusinessDetails, + "individual": Individual, + } + + class Requirements(StripeObject): + class Entry(StripeObject): + class Error(StripeObject): + code: Literal[ + "invalid_address_city_state_postal_code", + "invalid_address_highway_contract_box", + "invalid_address_private_mailbox", + "invalid_business_profile_name", + "invalid_business_profile_name_denylisted", + "invalid_company_name_denylisted", + "invalid_dob_age_over_maximum", + "invalid_dob_age_under_18", + "invalid_dob_age_under_minimum", + "invalid_product_description_length", + "invalid_product_description_url_match", + "invalid_representative_country", + "invalid_statement_descriptor_business_mismatch", + "invalid_statement_descriptor_denylisted", + "invalid_statement_descriptor_length", + "invalid_statement_descriptor_prefix_denylisted", + "invalid_statement_descriptor_prefix_mismatch", + "invalid_street_address", + "invalid_tax_id", + "invalid_tax_id_format", + "invalid_tos_acceptance", + "invalid_url_denylisted", + "invalid_url_format", + "invalid_url_website_business_information_mismatch", + "invalid_url_website_empty", + "invalid_url_website_inaccessible", + "invalid_url_website_inaccessible_geoblocked", + "invalid_url_website_inaccessible_password_protected", + "invalid_url_website_incomplete", + "invalid_url_website_incomplete_cancellation_policy", + "invalid_url_website_incomplete_customer_service_details", + "invalid_url_website_incomplete_legal_restrictions", + "invalid_url_website_incomplete_refund_policy", + "invalid_url_website_incomplete_return_policy", + "invalid_url_website_incomplete_terms_and_conditions", + "invalid_url_website_incomplete_under_construction", + "invalid_url_website_other", + "invalid_url_web_presence_detected", + "invalid_value_other", + "unresolvable_ip_address", + "unresolvable_postal_code", + "verification_directors_mismatch", + "verification_document_address_mismatch", + "verification_document_address_missing", + "verification_document_corrupt", + "verification_document_country_not_supported", + "verification_document_directors_mismatch", + "verification_document_dob_mismatch", + "verification_document_duplicate_type", + "verification_document_expired", + "verification_document_failed_copy", + "verification_document_failed_greyscale", + "verification_document_failed_other", + "verification_document_failed_test_mode", + "verification_document_fraudulent", + "verification_document_id_number_mismatch", + "verification_document_id_number_missing", + "verification_document_incomplete", + "verification_document_invalid", + "verification_document_issue_or_expiry_date_missing", + "verification_document_manipulated", + "verification_document_missing_back", + "verification_document_missing_front", + "verification_document_name_mismatch", + "verification_document_name_missing", + "verification_document_nationality_mismatch", + "verification_document_not_readable", + "verification_document_not_signed", + "verification_document_not_uploaded", + "verification_document_photo_mismatch", + "verification_document_too_large", + "verification_document_type_not_supported", + "verification_extraneous_directors", + "verification_failed_address_match", + "verification_failed_business_iec_number", + "verification_failed_document_match", + "verification_failed_id_number_match", + "verification_failed_keyed_identity", + "verification_failed_keyed_match", + "verification_failed_name_match", + "verification_failed_other", + "verification_failed_representative_authority", + "verification_failed_residential_address", + "verification_failed_tax_id_match", + "verification_failed_tax_id_not_issued", + "verification_missing_directors", + "verification_missing_executives", + "verification_missing_owners", + "verification_requires_additional_memorandum_of_associations", + "verification_requires_additional_proof_of_registration", + "verification_selfie_document_missing_photo", + "verification_selfie_face_mismatch", + "verification_selfie_manipulated", + "verification_selfie_unverified_other", + "verification_supportability", + "verification_token_stale", + ] + """ + Machine-readable code describing the error. + """ + description: str + """ + Human-readable description of the error. + """ + + class Impact(StripeObject): + class RestrictsCapability(StripeObject): + class Deadline(StripeObject): + status: Literal[ + "currently_due", "eventually_due", "past_due" + ] + """ + The current status of the requirement's impact. + """ + + capability: Literal[ + "ach_debit_payments", + "acss_debit_payments", + "affirm_payments", + "afterpay_clearpay_payments", + "alma_payments", + "amazon_pay_payments", + "automatic_indirect_tax", + "au_becs_debit_payments", + "bacs_debit_payments", + "bancontact_payments", + "bank_accounts.local", + "bank_accounts.wire", + "blik_payments", + "boleto_payments", + "cards", + "card_payments", + "cartes_bancaires_payments", + "cashapp_payments", + "eps_payments", + "fpx_payments", + "gb_bank_transfer_payments", + "grabpay_payments", + "ideal_payments", + "jcb_payments", + "jp_bank_transfer_payments", + "kakao_pay_payments", + "klarna_payments", + "konbini_payments", + "kr_card_payments", + "link_payments", + "mobilepay_payments", + "multibanco_payments", + "mx_bank_transfer_payments", + "naver_pay_payments", + "oxxo_payments", + "p24_payments", + "payco_payments", + "paynow_payments", + "pay_by_bank_payments", + "promptpay_payments", + "revolut_pay_payments", + "samsung_pay_payments", + "sepa_bank_transfer_payments", + "sepa_debit_payments", + "stripe_balance.payouts", + "stripe_balance.stripe_transfers", + "swish_payments", + "twint_payments", + "us_bank_transfer_payments", + "zip_payments", + ] + """ + The name of the Capability which will be restricted. + """ + configuration: Literal["customer", "merchant", "recipient"] + """ + The configuration which specifies the Capability which will be restricted. + """ + deadline: Deadline + """ + Details about when in the account lifecycle the requirement must be collected by the avoid the Capability restriction. + """ + _inner_class_types = {"deadline": Deadline} + + restricts_capabilities: Optional[List[RestrictsCapability]] + """ + The Capabilities that will be restricted if the requirement is not collected and satisfactory to Stripe. + """ + _inner_class_types = { + "restricts_capabilities": RestrictsCapability, + } + + class MinimumDeadline(StripeObject): + status: Literal["currently_due", "eventually_due", "past_due"] + """ + The current status of the requirement's impact. + """ + + class Reference(StripeObject): + inquiry: Optional[str] + """ + If `inquiry` is the type, the inquiry token. + """ + resource: Optional[str] + """ + If `resource` is the type, the resource token. + """ + type: Literal["inquiry", "payment_method", "person"] + """ + The type of the reference. If the type is "inquiry", the inquiry token can be found in the "inquiry" field. + Otherwise the type is an API resource, the token for which can be found in the "resource" field. + """ + + class RequestedReason(StripeObject): + code: Literal["routine_onboarding", "routine_verification"] + """ + Machine-readable description of Stripe's reason for collecting the requirement. + """ + + awaiting_action_from: Literal["stripe", "user"] + """ + Indicates whether the platform or Stripe is currently responsible for taking action on the requirement. Value can be `user` or `stripe`. + """ + description: str + """ + Machine-readable string describing the requirement. + """ + errors: List[Error] + """ + Descriptions of why the requirement must be collected, or why the collected information isn't satisfactory to Stripe. + """ + impact: Impact + """ + A hash describing the impact of not collecting the requirement, or Stripe not being able to verify the collected information. + """ + minimum_deadline: MinimumDeadline + """ + The soonest point when the account will be impacted by not providing the requirement. + """ + reference: Optional[Reference] + """ + A reference to the location of the requirement. + """ + requested_reasons: List[RequestedReason] + """ + A list of reasons why Stripe is collecting the requirement. + """ + _inner_class_types = { + "errors": Error, + "impact": Impact, + "minimum_deadline": MinimumDeadline, + "reference": Reference, + "requested_reasons": RequestedReason, + } + + class Summary(StripeObject): + class MinimumDeadline(StripeObject): + status: Literal["currently_due", "eventually_due", "past_due"] + """ + The current strictest status of all requirements on the Account. + """ + time: Optional[str] + """ + The soonest RFC3339 date & time UTC value a requirement can impact the Account. + """ + + minimum_deadline: Optional[MinimumDeadline] + """ + The soonest date and time a requirement on the Account will become `past due`. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: `2022-09-18T13:22:18.123Z`. + """ + _inner_class_types = {"minimum_deadline": MinimumDeadline} + + entries: Optional[List[Entry]] + """ + A list of requirements for the Account. + """ + summary: Optional[Summary] + """ + An object containing an overview of requirements for the Account. + """ + _inner_class_types = {"entries": Entry, "summary": Summary} + + applied_configurations: List[Literal["customer", "merchant", "recipient"]] + """ + The configurations that have been applied to this account. + """ + closed: Optional[bool] + """ + Indicates whether the account has been closed. + """ + configuration: Optional[Configuration] + """ + An Account represents a company, individual, or other entity that a user interacts with. Accounts store identity information and one or more configurations that enable product-specific capabilities. You can assign configurations at creation or add them later. + """ + contact_email: Optional[str] + """ + The default contact email address for the Account. Required when configuring the account as a merchant or recipient. + """ + created: str + """ + Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + dashboard: Optional[Literal["express", "full", "none"]] + """ + A value indicating the Stripe dashboard this Account has access to. This will depend on which configurations are enabled for this account. + """ + defaults: Optional[Defaults] + """ + Default values for settings shared across Account configurations. + """ + display_name: Optional[str] + """ + A descriptive name for the Account. This name will be surfaced in the Stripe Dashboard and on any invoices sent to the Account. + """ + future_requirements: Optional[FutureRequirements] + """ + Information about the future requirements for the Account that will eventually come into effect, including what information needs to be collected, and by when. + """ + id: str + """ + Unique identifier for the Account. + """ + identity: Optional[Identity] + """ + Information about the company, individual, and business represented by the Account. + """ + livemode: bool + """ + Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + """ + metadata: Optional[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. + """ + object: Literal["v2.core.account"] + """ + String representing the object's type. Objects of the same type share the same value of the object field. + """ + requirements: Optional[Requirements] + """ + Information about the active requirements for the Account, including what information needs to be collected, and by when. + """ + _inner_class_types = { + "configuration": Configuration, + "defaults": Defaults, + "future_requirements": FutureRequirements, + "identity": Identity, + "requirements": Requirements, + } diff --git a/stripe/v2/core/_account_link.py b/stripe/v2/core/_account_link.py new file mode 100644 index 000000000..65f715e0e --- /dev/null +++ b/stripe/v2/core/_account_link.py @@ -0,0 +1,121 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from stripe._stripe_object import StripeObject +from typing import ClassVar, List, Optional +from typing_extensions import Literal + + +class AccountLink(StripeObject): + """ + Account Links let a platform create a temporary, single-use URL that an account can use to access a Stripe-hosted flow for collecting or updating required information. + """ + + OBJECT_NAME: ClassVar[Literal["v2.core.account_link"]] = ( + "v2.core.account_link" + ) + + class UseCase(StripeObject): + class AccountOnboarding(StripeObject): + class CollectionOptions(StripeObject): + fields: Optional[Literal["currently_due", "eventually_due"]] + """ + 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: Optional[Literal["include", "omit"]] + """ + Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`. + """ + + collection_options: Optional[CollectionOptions] + """ + Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow. + """ + configurations: List[Literal["customer", "merchant", "recipient"]] + """ + Open Enum. A v2/core/account can be configured to enable certain functionality. The configuration param targets the v2/core/account_link to collect information for the specified v2/core/account configuration/s. + """ + refresh_url: str + """ + The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party. + """ + return_url: Optional[str] + """ + The URL that the user will be redirected to upon completing the linked flow. + """ + _inner_class_types = {"collection_options": CollectionOptions} + + class AccountUpdate(StripeObject): + class CollectionOptions(StripeObject): + fields: Optional[Literal["currently_due", "eventually_due"]] + """ + Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). The default value is `currently_due`. + """ + future_requirements: Optional[Literal["include", "omit"]] + """ + Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`. + """ + + collection_options: Optional[CollectionOptions] + """ + Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow. + """ + configurations: List[Literal["customer", "merchant", "recipient"]] + """ + Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s. + """ + refresh_url: str + """ + The URL the user will be redirected to if the Account Link is expired, has been used, 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 URL so they can continue the flow. Make sure to authenticate the user before redirecting to the new Account Link, in case the URL leaks to a third party. If a new Account Link can't be generated, or if the redirect fails, you should display a useful error to the user. + """ + return_url: Optional[str] + """ + The URL that the user will be redirected to upon completing the linked flow. + """ + _inner_class_types = {"collection_options": CollectionOptions} + + account_onboarding: Optional[AccountOnboarding] + """ + Hash containing configuration options for an Account Link object that onboards a new account. + """ + account_update: Optional[AccountUpdate] + """ + Hash containing configuration options for an Account Link that updates an existing account. + """ + type: Literal["account_onboarding", "account_update"] + """ + Open Enum. The type of Account Link the user is requesting. + """ + _inner_class_types = { + "account_onboarding": AccountOnboarding, + "account_update": AccountUpdate, + } + + account: str + """ + The ID of the connected account this Account Link applies to. + """ + created: str + """ + The timestamp at which this Account Link was created. + """ + expires_at: str + """ + The timestamp at which this Account Link will expire. + """ + livemode: bool + """ + Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + """ + object: Literal["v2.core.account_link"] + """ + String representing the object's type. Objects of the same type share the same value of the object field. + """ + url: str + """ + The URL at which the account can access the Stripe-hosted flow. + """ + use_case: UseCase + """ + Hash containing usage options. + """ + _inner_class_types = {"use_case": UseCase} diff --git a/stripe/v2/core/_account_link_service.py b/stripe/v2/core/_account_link_service.py new file mode 100644 index 000000000..19b868c0c --- /dev/null +++ b/stripe/v2/core/_account_link_service.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from stripe._stripe_service import StripeService +from typing import Optional, cast +from typing_extensions import TYPE_CHECKING + +if TYPE_CHECKING: + from stripe._request_options import RequestOptions + from stripe.params.v2.core._account_link_create_params import ( + AccountLinkCreateParams, + ) + from stripe.v2.core._account_link import AccountLink + + +class AccountLinkService(StripeService): + def create( + self, + params: "AccountLinkCreateParams", + options: Optional["RequestOptions"] = None, + ) -> "AccountLink": + """ + Creates an AccountLink object that includes a single-use URL that an account can use to access a Stripe-hosted flow for collecting or updating required information. + """ + return cast( + "AccountLink", + self._request( + "post", + "/v2/core/account_links", + base_address="api", + params=params, + options=options, + ), + ) + + async def create_async( + self, + params: "AccountLinkCreateParams", + options: Optional["RequestOptions"] = None, + ) -> "AccountLink": + """ + Creates an AccountLink object that includes a single-use URL that an account can use to access a Stripe-hosted flow for collecting or updating required information. + """ + return cast( + "AccountLink", + await self._request_async( + "post", + "/v2/core/account_links", + base_address="api", + params=params, + options=options, + ), + ) diff --git a/stripe/v2/core/_account_person.py b/stripe/v2/core/_account_person.py new file mode 100644 index 000000000..05d51e4b2 --- /dev/null +++ b/stripe/v2/core/_account_person.py @@ -0,0 +1,562 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from stripe._stripe_object import StripeObject +from typing import ClassVar, Dict, List, Optional +from typing_extensions import Literal + + +class AccountPerson(StripeObject): + """ + A Person represents an individual associated with an Account's identity (for example, an owner, director, executive, or representative). Use Persons to provide and update identity information for verification and compliance. + """ + + OBJECT_NAME: ClassVar[Literal["v2.core.account_person"]] = ( + "v2.core.account_person" + ) + + class AdditionalAddress(StripeObject): + city: Optional[str] + """ + City, district, suburb, town, or village. + """ + country: Optional[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: Optional[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: Optional[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: Optional[str] + """ + ZIP or postal code. + """ + purpose: Literal["registered"] + """ + Purpose of additional address. + """ + state: Optional[str] + """ + State, county, province, or region. + """ + town: Optional[str] + """ + Town or district. + """ + + class AdditionalName(StripeObject): + full_name: Optional[str] + """ + The individual's full name. + """ + given_name: Optional[str] + """ + The individual's first or given name. + """ + purpose: Literal["alias", "maiden"] + """ + The purpose or type of the additional name. + """ + surname: Optional[str] + """ + The individual's last or family name. + """ + + class AdditionalTermsOfService(StripeObject): + class Account(StripeObject): + date: Optional[str] + """ + The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + ip: Optional[str] + """ + The IP address from which the Account's representative accepted the terms of service. + """ + user_agent: Optional[str] + """ + The user agent of the browser from which the Account's representative accepted the terms of service. + """ + + account: Optional[Account] + """ + Stripe terms of service agreement. + """ + _inner_class_types = {"account": Account} + + class Address(StripeObject): + city: Optional[str] + """ + City, district, suburb, town, or village. + """ + country: Optional[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: Optional[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: Optional[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: Optional[str] + """ + ZIP or postal code. + """ + state: Optional[str] + """ + State, county, province, or region. + """ + town: Optional[str] + """ + Town or district. + """ + + class DateOfBirth(StripeObject): + day: int + """ + The day of birth, between 1 and 31. + """ + month: int + """ + The month of birth, between 1 and 12. + """ + year: int + """ + The four-digit year of birth. + """ + + class Documents(StripeObject): + class CompanyAuthorization(StripeObject): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + class Passport(StripeObject): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + class PrimaryVerification(StripeObject): + class FrontBack(StripeObject): + back: Optional[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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: str + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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_back: FrontBack + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens for the front and back of the verification document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + _inner_class_types = {"front_back": FrontBack} + + class SecondaryVerification(StripeObject): + class FrontBack(StripeObject): + back: Optional[str] + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the back of the verification document. The purpose of the uploaded file should be '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: str + """ + A [file upload](https://docs.stripe.com/api/persons/update#create_file) token representing the front of the verification document. The purpose of the uploaded file should be '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_back: FrontBack + """ + The [file upload](https://docs.stripe.com/api/persons/update#create_file) tokens for the front and back of the verification document. + """ + type: Literal["front_back"] + """ + The format of the verification document. Currently supports `front_back` only. + """ + _inner_class_types = {"front_back": FrontBack} + + class Visa(StripeObject): + files: List[str] + """ + One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`. + """ + type: Literal["files"] + """ + The format of the document. Currently supports `files` only. + """ + + company_authorization: Optional[CompanyAuthorization] + """ + One or more documents that demonstrate proof that this person is authorized to represent the company. + """ + passport: Optional[Passport] + """ + One or more documents showing the person's passport page with photo and personal data. + """ + primary_verification: Optional[PrimaryVerification] + """ + An identifying document showing the person's name, either a passport or local ID card. + """ + secondary_verification: Optional[SecondaryVerification] + """ + A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. + """ + visa: Optional[Visa] + """ + One or more documents showing the person's visa required for living in the country where they are residing. + """ + _inner_class_types = { + "company_authorization": CompanyAuthorization, + "passport": Passport, + "primary_verification": PrimaryVerification, + "secondary_verification": SecondaryVerification, + "visa": Visa, + } + + class IdNumber(StripeObject): + type: Literal[ + "ae_eid", + "ao_nif", + "ar_cuil", + "ar_dni", + "at_stn", + "az_tin", + "bd_brc", + "bd_etin", + "bd_nid", + "be_nrn", + "bg_ucn", + "bn_nric", + "br_cpf", + "ca_sin", + "ch_oasi", + "cl_rut", + "cn_pp", + "co_nuip", + "cr_ci", + "cr_cpf", + "cr_dimex", + "cr_nite", + "cy_tic", + "cz_rc", + "de_stn", + "dk_cpr", + "do_cie", + "do_rcn", + "ec_ci", + "ee_ik", + "es_nif", + "fi_hetu", + "fr_nir", + "gb_nino", + "gr_afm", + "gt_nit", + "hk_id", + "hr_oib", + "hu_ad", + "id_nik", + "ie_ppsn", + "is_kt", + "it_cf", + "jp_inc", + "ke_pin", + "kz_iin", + "li_peid", + "lt_ak", + "lu_nif", + "lv_pk", + "mx_rfc", + "my_nric", + "mz_nuit", + "ng_nin", + "nl_bsn", + "no_nin", + "nz_ird", + "pe_dni", + "pk_cnic", + "pk_snic", + "pl_pesel", + "pt_nif", + "ro_cnp", + "sa_tin", + "se_pin", + "sg_fin", + "sg_nric", + "sk_dic", + "th_lc", + "th_pin", + "tr_tin", + "us_itin", + "us_itin_last_4", + "us_ssn", + "us_ssn_last_4", + "uy_dni", + "za_id", + ] + """ + The ID number type of an individual. + """ + + class Relationship(StripeObject): + authorizer: Optional[bool] + """ + Whether the individual is an authorizer of the Account's identity. + """ + director: Optional[bool] + """ + Whether the individual is a director of the Account's identity. Directors are typically members of the governing board of the company or are responsible for making sure that the company meets its regulatory obligations. + """ + executive: Optional[bool] + """ + Whether the individual has significant responsibility to control, manage, or direct the organization. + """ + legal_guardian: Optional[bool] + """ + Whether the individual is the legal guardian of the Account's representative. + """ + owner: Optional[bool] + """ + Whether the individual is an owner of the Account's identity. + """ + percent_ownership: Optional[str] + """ + The percentage of the Account's identity that the individual owns. + """ + representative: Optional[bool] + """ + Whether the individual 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: Optional[str] + """ + The individual's title (e.g., CEO, Support Engineer). + """ + + class ScriptAddresses(StripeObject): + class Kana(StripeObject): + city: Optional[str] + """ + City, district, suburb, town, or village. + """ + country: Optional[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: Optional[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: Optional[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: Optional[str] + """ + ZIP or postal code. + """ + state: Optional[str] + """ + State, county, province, or region. + """ + town: Optional[str] + """ + Town or district. + """ + + class Kanji(StripeObject): + city: Optional[str] + """ + City, district, suburb, town, or village. + """ + country: Optional[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: Optional[str] + """ + Address line 1 (e.g., street, PO Box, or company name). + """ + line2: Optional[str] + """ + Address line 2 (e.g., apartment, suite, unit, or building). + """ + postal_code: Optional[str] + """ + ZIP or postal code. + """ + state: Optional[str] + """ + State, county, province, or region. + """ + town: Optional[str] + """ + Town or district. + """ + + kana: Optional[Kana] + """ + Kana Address. + """ + kanji: Optional[Kanji] + """ + Kanji Address. + """ + _inner_class_types = {"kana": Kana, "kanji": Kanji} + + class ScriptNames(StripeObject): + class Kana(StripeObject): + given_name: Optional[str] + """ + The person's first or given name. + """ + surname: Optional[str] + """ + The person's last or family name. + """ + + class Kanji(StripeObject): + given_name: Optional[str] + """ + The person's first or given name. + """ + surname: Optional[str] + """ + The person's last or family name. + """ + + kana: Optional[Kana] + """ + Persons name in kana script. + """ + kanji: Optional[Kanji] + """ + Persons name in kanji script. + """ + _inner_class_types = {"kana": Kana, "kanji": Kanji} + + account: str + """ + The account ID which the individual belongs to. + """ + additional_addresses: Optional[List[AdditionalAddress]] + """ + Additional addresses associated with the person. + """ + additional_names: Optional[List[AdditionalName]] + """ + Additional names (e.g. aliases) associated with the person. + """ + additional_terms_of_service: Optional[AdditionalTermsOfService] + """ + Attestations of accepted terms of service agreements. + """ + address: Optional[Address] + """ + The person's residential address. + """ + created: str + """ + Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + date_of_birth: Optional[DateOfBirth] + """ + The person's date of birth. + """ + documents: Optional[Documents] + """ + Documents that may be submitted to satisfy various informational requests. + """ + email: Optional[str] + """ + The person's email address. + """ + given_name: Optional[str] + """ + The person's first name. + """ + id: str + """ + Unique identifier for the Person. + """ + id_numbers: Optional[List[IdNumber]] + """ + The identification numbers (e.g., SSN) associated with the person. + """ + legal_gender: Optional[Literal["female", "male"]] + """ + The person's gender (International regulations require either "male" or "female"). + """ + livemode: bool + """ + Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + """ + metadata: Optional[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. + """ + nationalities: Optional[List[str]] + """ + The countries 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)). + """ + object: Literal["v2.core.account_person"] + """ + String representing the object's type. Objects of the same type share the same value of the object field. + """ + phone: Optional[str] + """ + The person's phone number. + """ + political_exposure: Optional[Literal["existing", "none"]] + """ + The person's political exposure. + """ + relationship: Optional[Relationship] + """ + The relationship that this person has with the Account's business or legal entity. + """ + script_addresses: Optional[ScriptAddresses] + """ + The script addresses (e.g., non-Latin characters) associated with the person. + """ + script_names: Optional[ScriptNames] + """ + The script names (e.g. non-Latin characters) associated with the person. + """ + surname: Optional[str] + """ + The person's last name. + """ + updated: str + """ + Time at which the object was last updated. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + _inner_class_types = { + "additional_addresses": AdditionalAddress, + "additional_names": AdditionalName, + "additional_terms_of_service": AdditionalTermsOfService, + "address": Address, + "date_of_birth": DateOfBirth, + "documents": Documents, + "id_numbers": IdNumber, + "relationship": Relationship, + "script_addresses": ScriptAddresses, + "script_names": ScriptNames, + } diff --git a/stripe/v2/core/_account_person_token.py b/stripe/v2/core/_account_person_token.py new file mode 100644 index 000000000..34b07a1e6 --- /dev/null +++ b/stripe/v2/core/_account_person_token.py @@ -0,0 +1,39 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from stripe._stripe_object import StripeObject +from typing import ClassVar +from typing_extensions import Literal + + +class AccountPersonToken(StripeObject): + """ + Person Tokens are single-use tokens which tokenize person information, and are used for creating or updating a Person. + """ + + OBJECT_NAME: ClassVar[Literal["v2.core.account_person_token"]] = ( + "v2.core.account_person_token" + ) + created: str + """ + Time at which the token was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + expires_at: str + """ + Time at which the token will expire. + """ + id: str + """ + Unique identifier for the token. + """ + livemode: bool + """ + Has the value `true` if the token exists in live mode or the value `false` if the object exists in test mode. + """ + object: Literal["v2.core.account_person_token"] + """ + String representing the object's type. Objects of the same type share the same value of the object field. + """ + used: bool + """ + Determines if the token has already been used (tokens can only be used once). + """ diff --git a/stripe/v2/core/_account_service.py b/stripe/v2/core/_account_service.py new file mode 100644 index 000000000..d4f2f6c0c --- /dev/null +++ b/stripe/v2/core/_account_service.py @@ -0,0 +1,255 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from stripe._stripe_service import StripeService +from stripe._util import sanitize_id +from typing import Optional, cast +from importlib import import_module +from typing_extensions import TYPE_CHECKING + +if TYPE_CHECKING: + from stripe._request_options import RequestOptions + from stripe.params.v2.core._account_close_params import AccountCloseParams + from stripe.params.v2.core._account_create_params import ( + AccountCreateParams, + ) + from stripe.params.v2.core._account_list_params import AccountListParams + from stripe.params.v2.core._account_retrieve_params import ( + AccountRetrieveParams, + ) + from stripe.params.v2.core._account_update_params import ( + AccountUpdateParams, + ) + from stripe.v2._list_object import ListObject + from stripe.v2.core._account import Account + from stripe.v2.core.accounts._person_service import PersonService + from stripe.v2.core.accounts._person_token_service import ( + PersonTokenService, + ) + +_subservices = { + "persons": ["stripe.v2.core.accounts._person_service", "PersonService"], + "person_tokens": [ + "stripe.v2.core.accounts._person_token_service", + "PersonTokenService", + ], +} + + +class AccountService(StripeService): + persons: "PersonService" + person_tokens: "PersonTokenService" + + def __init__(self, requestor): + super().__init__(requestor) + + def __getattr__(self, name): + try: + import_from, service = _subservices[name] + service_class = getattr( + import_module(import_from), + service, + ) + setattr( + self, + name, + service_class(self._requestor), + ) + return getattr(self, name) + except KeyError: + raise AttributeError() + + def list( + self, + params: Optional["AccountListParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "ListObject[Account]": + """ + Returns a list of Accounts. + """ + return cast( + "ListObject[Account]", + self._request( + "get", + "/v2/core/accounts", + base_address="api", + params=params, + options=options, + ), + ) + + async def list_async( + self, + params: Optional["AccountListParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "ListObject[Account]": + """ + Returns a list of Accounts. + """ + return cast( + "ListObject[Account]", + await self._request_async( + "get", + "/v2/core/accounts", + base_address="api", + params=params, + options=options, + ), + ) + + def create( + self, + params: Optional["AccountCreateParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "Account": + """ + An Account is a representation of a company, individual or other entity that a user interacts with. Accounts contain identifying information about the entity, and configurations that store the features an account has access to. An account can be configured as any or all of the following configurations: Customer, Merchant and/or Recipient. + """ + return cast( + "Account", + self._request( + "post", + "/v2/core/accounts", + base_address="api", + params=params, + options=options, + ), + ) + + async def create_async( + self, + params: Optional["AccountCreateParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "Account": + """ + An Account is a representation of a company, individual or other entity that a user interacts with. Accounts contain identifying information about the entity, and configurations that store the features an account has access to. An account can be configured as any or all of the following configurations: Customer, Merchant and/or Recipient. + """ + return cast( + "Account", + await self._request_async( + "post", + "/v2/core/accounts", + base_address="api", + params=params, + options=options, + ), + ) + + def retrieve( + self, + id: str, + params: Optional["AccountRetrieveParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "Account": + """ + Retrieves the details of an Account. + """ + return cast( + "Account", + self._request( + "get", + "/v2/core/accounts/{id}".format(id=sanitize_id(id)), + base_address="api", + params=params, + options=options, + ), + ) + + async def retrieve_async( + self, + id: str, + params: Optional["AccountRetrieveParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "Account": + """ + Retrieves the details of an Account. + """ + return cast( + "Account", + await self._request_async( + "get", + "/v2/core/accounts/{id}".format(id=sanitize_id(id)), + base_address="api", + params=params, + options=options, + ), + ) + + def update( + self, + id: str, + params: Optional["AccountUpdateParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "Account": + """ + Updates the details of an Account. + """ + return cast( + "Account", + self._request( + "post", + "/v2/core/accounts/{id}".format(id=sanitize_id(id)), + base_address="api", + params=params, + options=options, + ), + ) + + async def update_async( + self, + id: str, + params: Optional["AccountUpdateParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "Account": + """ + Updates the details of an Account. + """ + return cast( + "Account", + await self._request_async( + "post", + "/v2/core/accounts/{id}".format(id=sanitize_id(id)), + base_address="api", + params=params, + options=options, + ), + ) + + def close( + self, + id: str, + params: Optional["AccountCloseParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "Account": + """ + Removes access to the Account and its associated resources. Closed Accounts can no longer be operated on, but limited information can still be retrieved through the API in order to be able to track their history. + """ + return cast( + "Account", + self._request( + "post", + "/v2/core/accounts/{id}/close".format(id=sanitize_id(id)), + base_address="api", + params=params, + options=options, + ), + ) + + async def close_async( + self, + id: str, + params: Optional["AccountCloseParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "Account": + """ + Removes access to the Account and its associated resources. Closed Accounts can no longer be operated on, but limited information can still be retrieved through the API in order to be able to track their history. + """ + return cast( + "Account", + await self._request_async( + "post", + "/v2/core/accounts/{id}/close".format(id=sanitize_id(id)), + base_address="api", + params=params, + options=options, + ), + ) diff --git a/stripe/v2/core/_account_token.py b/stripe/v2/core/_account_token.py new file mode 100644 index 000000000..c64b53754 --- /dev/null +++ b/stripe/v2/core/_account_token.py @@ -0,0 +1,39 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from stripe._stripe_object import StripeObject +from typing import ClassVar +from typing_extensions import Literal + + +class AccountToken(StripeObject): + """ + Account tokens are single-use tokens which tokenize company/individual/business information, and are used for creating or updating an Account. + """ + + OBJECT_NAME: ClassVar[Literal["v2.core.account_token"]] = ( + "v2.core.account_token" + ) + created: str + """ + Time at which the token was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. + """ + expires_at: str + """ + Time at which the token will expire. + """ + id: str + """ + Unique identifier for the token. + """ + livemode: bool + """ + Has the value `true` if the token exists in live mode or the value `false` if the object exists in test mode. + """ + object: Literal["v2.core.account_token"] + """ + String representing the object's type. Objects of the same type share the same value of the object field. + """ + used: bool + """ + Determines if the token has already been used (tokens can only be used once). + """ diff --git a/stripe/v2/core/_account_token_service.py b/stripe/v2/core/_account_token_service.py new file mode 100644 index 000000000..a79949eee --- /dev/null +++ b/stripe/v2/core/_account_token_service.py @@ -0,0 +1,96 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from stripe._stripe_service import StripeService +from stripe._util import sanitize_id +from typing import Optional, cast +from typing_extensions import TYPE_CHECKING + +if TYPE_CHECKING: + from stripe._request_options import RequestOptions + from stripe.params.v2.core._account_token_create_params import ( + AccountTokenCreateParams, + ) + from stripe.params.v2.core._account_token_retrieve_params import ( + AccountTokenRetrieveParams, + ) + from stripe.v2.core._account_token import AccountToken + + +class AccountTokenService(StripeService): + def create( + self, + params: Optional["AccountTokenCreateParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "AccountToken": + """ + Creates an Account Token. + """ + return cast( + "AccountToken", + self._request( + "post", + "/v2/core/account_tokens", + base_address="api", + params=params, + options=options, + ), + ) + + async def create_async( + self, + params: Optional["AccountTokenCreateParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "AccountToken": + """ + Creates an Account Token. + """ + return cast( + "AccountToken", + await self._request_async( + "post", + "/v2/core/account_tokens", + base_address="api", + params=params, + options=options, + ), + ) + + def retrieve( + self, + id: str, + params: Optional["AccountTokenRetrieveParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "AccountToken": + """ + Retrieves an Account Token. + """ + return cast( + "AccountToken", + self._request( + "get", + "/v2/core/account_tokens/{id}".format(id=sanitize_id(id)), + base_address="api", + params=params, + options=options, + ), + ) + + async def retrieve_async( + self, + id: str, + params: Optional["AccountTokenRetrieveParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "AccountToken": + """ + Retrieves an Account Token. + """ + return cast( + "AccountToken", + await self._request_async( + "get", + "/v2/core/account_tokens/{id}".format(id=sanitize_id(id)), + base_address="api", + params=params, + options=options, + ), + ) diff --git a/stripe/v2/core/_event.py b/stripe/v2/core/_event.py index 415a2879e..cb7ad021b 100644 --- a/stripe/v2/core/_event.py +++ b/stripe/v2/core/_event.py @@ -42,6 +42,10 @@ class Request(StripeObject): """ _inner_class_types = {"request": Request} + changes: Optional[Dict[str, "Any"]] + """ + Before and after changes for the primary related object. + """ context: Optional[str] """ Authentication context needed to fetch the event or related object. diff --git a/stripe/v2/core/accounts/__init__.py b/stripe/v2/core/accounts/__init__.py new file mode 100644 index 000000000..6cc5ff799 --- /dev/null +++ b/stripe/v2/core/accounts/__init__.py @@ -0,0 +1,36 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from importlib import import_module +from typing_extensions import TYPE_CHECKING + +if TYPE_CHECKING: + from stripe.v2.core.accounts._person_service import ( + PersonService as PersonService, + ) + from stripe.v2.core.accounts._person_token_service import ( + PersonTokenService as PersonTokenService, + ) + +# name -> (import_target, is_submodule) +_import_map = { + "PersonService": ("stripe.v2.core.accounts._person_service", False), + "PersonTokenService": ( + "stripe.v2.core.accounts._person_token_service", + False, + ), +} +if not TYPE_CHECKING: + + def __getattr__(name): + try: + target, is_submodule = _import_map[name] + module = import_module(target) + if is_submodule: + return module + + return getattr( + module, + name, + ) + except KeyError: + raise AttributeError() diff --git a/stripe/v2/core/accounts/_person_service.py b/stripe/v2/core/accounts/_person_service.py new file mode 100644 index 000000000..0d99f5344 --- /dev/null +++ b/stripe/v2/core/accounts/_person_service.py @@ -0,0 +1,261 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from stripe._stripe_service import StripeService +from stripe._util import sanitize_id +from typing import Optional, cast +from typing_extensions import TYPE_CHECKING + +if TYPE_CHECKING: + from stripe._request_options import RequestOptions + from stripe.params.v2.core.accounts._person_create_params import ( + PersonCreateParams, + ) + from stripe.params.v2.core.accounts._person_delete_params import ( + PersonDeleteParams, + ) + from stripe.params.v2.core.accounts._person_list_params import ( + PersonListParams, + ) + from stripe.params.v2.core.accounts._person_retrieve_params import ( + PersonRetrieveParams, + ) + from stripe.params.v2.core.accounts._person_update_params import ( + PersonUpdateParams, + ) + from stripe.v2._deleted_object import DeletedObject + from stripe.v2._list_object import ListObject + from stripe.v2.core._account_person import AccountPerson + + +class PersonService(StripeService): + def list( + self, + account_id: str, + params: Optional["PersonListParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "ListObject[AccountPerson]": + """ + Returns a paginated list of Persons associated with an Account. + """ + return cast( + "ListObject[AccountPerson]", + self._request( + "get", + "/v2/core/accounts/{account_id}/persons".format( + account_id=sanitize_id(account_id), + ), + base_address="api", + params=params, + options=options, + ), + ) + + async def list_async( + self, + account_id: str, + params: Optional["PersonListParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "ListObject[AccountPerson]": + """ + Returns a paginated list of Persons associated with an Account. + """ + return cast( + "ListObject[AccountPerson]", + await self._request_async( + "get", + "/v2/core/accounts/{account_id}/persons".format( + account_id=sanitize_id(account_id), + ), + base_address="api", + params=params, + options=options, + ), + ) + + def create( + self, + account_id: str, + params: Optional["PersonCreateParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "AccountPerson": + """ + Create a Person. Adds an individual to an Account's identity. You can set relationship attributes and identity information at creation. + """ + return cast( + "AccountPerson", + self._request( + "post", + "/v2/core/accounts/{account_id}/persons".format( + account_id=sanitize_id(account_id), + ), + base_address="api", + params=params, + options=options, + ), + ) + + async def create_async( + self, + account_id: str, + params: Optional["PersonCreateParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "AccountPerson": + """ + Create a Person. Adds an individual to an Account's identity. You can set relationship attributes and identity information at creation. + """ + return cast( + "AccountPerson", + await self._request_async( + "post", + "/v2/core/accounts/{account_id}/persons".format( + account_id=sanitize_id(account_id), + ), + base_address="api", + params=params, + options=options, + ), + ) + + def delete( + self, + account_id: str, + id: str, + params: Optional["PersonDeleteParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "DeletedObject": + """ + Delete a Person associated with an Account. + """ + return cast( + "DeletedObject", + self._request( + "delete", + "/v2/core/accounts/{account_id}/persons/{id}".format( + account_id=sanitize_id(account_id), + id=sanitize_id(id), + ), + base_address="api", + params=params, + options=options, + ), + ) + + async def delete_async( + self, + account_id: str, + id: str, + params: Optional["PersonDeleteParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "DeletedObject": + """ + Delete a Person associated with an Account. + """ + return cast( + "DeletedObject", + await self._request_async( + "delete", + "/v2/core/accounts/{account_id}/persons/{id}".format( + account_id=sanitize_id(account_id), + id=sanitize_id(id), + ), + base_address="api", + params=params, + options=options, + ), + ) + + def retrieve( + self, + account_id: str, + id: str, + params: Optional["PersonRetrieveParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "AccountPerson": + """ + Retrieves a Person associated with an Account. + """ + return cast( + "AccountPerson", + self._request( + "get", + "/v2/core/accounts/{account_id}/persons/{id}".format( + account_id=sanitize_id(account_id), + id=sanitize_id(id), + ), + base_address="api", + params=params, + options=options, + ), + ) + + async def retrieve_async( + self, + account_id: str, + id: str, + params: Optional["PersonRetrieveParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "AccountPerson": + """ + Retrieves a Person associated with an Account. + """ + return cast( + "AccountPerson", + await self._request_async( + "get", + "/v2/core/accounts/{account_id}/persons/{id}".format( + account_id=sanitize_id(account_id), + id=sanitize_id(id), + ), + base_address="api", + params=params, + options=options, + ), + ) + + def update( + self, + account_id: str, + id: str, + params: Optional["PersonUpdateParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "AccountPerson": + """ + Updates a Person associated with an Account. + """ + return cast( + "AccountPerson", + self._request( + "post", + "/v2/core/accounts/{account_id}/persons/{id}".format( + account_id=sanitize_id(account_id), + id=sanitize_id(id), + ), + base_address="api", + params=params, + options=options, + ), + ) + + async def update_async( + self, + account_id: str, + id: str, + params: Optional["PersonUpdateParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "AccountPerson": + """ + Updates a Person associated with an Account. + """ + return cast( + "AccountPerson", + await self._request_async( + "post", + "/v2/core/accounts/{account_id}/persons/{id}".format( + account_id=sanitize_id(account_id), + id=sanitize_id(id), + ), + base_address="api", + params=params, + options=options, + ), + ) diff --git a/stripe/v2/core/accounts/_person_token_service.py b/stripe/v2/core/accounts/_person_token_service.py new file mode 100644 index 000000000..0868da342 --- /dev/null +++ b/stripe/v2/core/accounts/_person_token_service.py @@ -0,0 +1,110 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from stripe._stripe_service import StripeService +from stripe._util import sanitize_id +from typing import Optional, cast +from typing_extensions import TYPE_CHECKING + +if TYPE_CHECKING: + from stripe._request_options import RequestOptions + from stripe.params.v2.core.accounts._person_token_create_params import ( + PersonTokenCreateParams, + ) + from stripe.params.v2.core.accounts._person_token_retrieve_params import ( + PersonTokenRetrieveParams, + ) + from stripe.v2.core._account_person_token import AccountPersonToken + + +class PersonTokenService(StripeService): + def create( + self, + account_id: str, + params: Optional["PersonTokenCreateParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "AccountPersonToken": + """ + Creates a Person Token associated with an Account. + """ + return cast( + "AccountPersonToken", + self._request( + "post", + "/v2/core/accounts/{account_id}/person_tokens".format( + account_id=sanitize_id(account_id), + ), + base_address="api", + params=params, + options=options, + ), + ) + + async def create_async( + self, + account_id: str, + params: Optional["PersonTokenCreateParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "AccountPersonToken": + """ + Creates a Person Token associated with an Account. + """ + return cast( + "AccountPersonToken", + await self._request_async( + "post", + "/v2/core/accounts/{account_id}/person_tokens".format( + account_id=sanitize_id(account_id), + ), + base_address="api", + params=params, + options=options, + ), + ) + + def retrieve( + self, + account_id: str, + id: str, + params: Optional["PersonTokenRetrieveParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "AccountPersonToken": + """ + Retrieves a Person Token associated with an Account. + """ + return cast( + "AccountPersonToken", + self._request( + "get", + "/v2/core/accounts/{account_id}/person_tokens/{id}".format( + account_id=sanitize_id(account_id), + id=sanitize_id(id), + ), + base_address="api", + params=params, + options=options, + ), + ) + + async def retrieve_async( + self, + account_id: str, + id: str, + params: Optional["PersonTokenRetrieveParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "AccountPersonToken": + """ + Retrieves a Person Token associated with an Account. + """ + return cast( + "AccountPersonToken", + await self._request_async( + "get", + "/v2/core/accounts/{account_id}/person_tokens/{id}".format( + account_id=sanitize_id(account_id), + id=sanitize_id(id), + ), + base_address="api", + params=params, + options=options, + ), + ) diff --git a/tests/test_generated_examples.py b/tests/test_generated_examples.py index ef8d5c05c..5f8d6fe14 100644 --- a/tests/test_generated_examples.py +++ b/tests/test_generated_examples.py @@ -43575,6 +43575,359 @@ def test_v2_billing_meter_event_stream_post_service( is_json=True, ) + def test_v2_core_account_get_service( + self, http_client_mock: HTTPClientMock + ) -> None: + http_client_mock.stub_request( + "get", + "/v2/core/accounts", + ) + client = StripeClient( + "sk_test_123", + http_client=http_client_mock.get_mock_http_client(), + ) + + client.v2.core.accounts.list() + http_client_mock.assert_requested( + "get", + path="/v2/core/accounts", + query_string="", + api_base="https://api.stripe.com", + ) + + def test_v2_core_account_post_service( + self, http_client_mock: HTTPClientMock + ) -> None: + http_client_mock.stub_request( + "post", + "/v2/core/accounts", + ) + client = StripeClient( + "sk_test_123", + http_client=http_client_mock.get_mock_http_client(), + ) + + client.v2.core.accounts.create() + http_client_mock.assert_requested( + "post", + path="/v2/core/accounts", + query_string="", + api_base="https://api.stripe.com", + post_data="{}", + is_json=True, + ) + + def test_v2_core_account_get_2_service( + self, http_client_mock: HTTPClientMock + ) -> None: + http_client_mock.stub_request( + "get", + "/v2/core/accounts/id_123", + ) + client = StripeClient( + "sk_test_123", + http_client=http_client_mock.get_mock_http_client(), + ) + + client.v2.core.accounts.retrieve("id_123") + http_client_mock.assert_requested( + "get", + path="/v2/core/accounts/id_123", + query_string="", + api_base="https://api.stripe.com", + ) + + def test_v2_core_account_post_2_service( + self, http_client_mock: HTTPClientMock + ) -> None: + http_client_mock.stub_request( + "post", + "/v2/core/accounts/id_123", + ) + client = StripeClient( + "sk_test_123", + http_client=http_client_mock.get_mock_http_client(), + ) + + client.v2.core.accounts.update("id_123") + http_client_mock.assert_requested( + "post", + path="/v2/core/accounts/id_123", + query_string="", + api_base="https://api.stripe.com", + post_data="{}", + is_json=True, + ) + + def test_v2_core_account_post_3_service( + self, http_client_mock: HTTPClientMock + ) -> None: + http_client_mock.stub_request( + "post", + "/v2/core/accounts/id_123/close", + ) + client = StripeClient( + "sk_test_123", + http_client=http_client_mock.get_mock_http_client(), + ) + + client.v2.core.accounts.close("id_123") + http_client_mock.assert_requested( + "post", + path="/v2/core/accounts/id_123/close", + query_string="", + api_base="https://api.stripe.com", + post_data="{}", + is_json=True, + ) + + def test_v2_core_accounts_person_get_service( + self, http_client_mock: HTTPClientMock + ) -> None: + http_client_mock.stub_request( + "get", + "/v2/core/accounts/account_id_123/persons", + ) + client = StripeClient( + "sk_test_123", + http_client=http_client_mock.get_mock_http_client(), + ) + + client.v2.core.accounts.persons.list("account_id_123") + http_client_mock.assert_requested( + "get", + path="/v2/core/accounts/account_id_123/persons", + query_string="", + api_base="https://api.stripe.com", + ) + + def test_v2_core_accounts_person_post_service( + self, http_client_mock: HTTPClientMock + ) -> None: + http_client_mock.stub_request( + "post", + "/v2/core/accounts/account_id_123/persons", + ) + client = StripeClient( + "sk_test_123", + http_client=http_client_mock.get_mock_http_client(), + ) + + client.v2.core.accounts.persons.create("account_id_123") + http_client_mock.assert_requested( + "post", + path="/v2/core/accounts/account_id_123/persons", + query_string="", + api_base="https://api.stripe.com", + post_data="{}", + is_json=True, + ) + + def test_v2_core_accounts_person_delete_service( + self, http_client_mock: HTTPClientMock + ) -> None: + http_client_mock.stub_request( + "delete", + "/v2/core/accounts/account_id_123/persons/id_123", + ) + client = StripeClient( + "sk_test_123", + http_client=http_client_mock.get_mock_http_client(), + ) + + client.v2.core.accounts.persons.delete( + "account_id_123", + "id_123", + ) + http_client_mock.assert_requested( + "delete", + path="/v2/core/accounts/account_id_123/persons/id_123", + query_string="", + api_base="https://api.stripe.com", + ) + + def test_v2_core_accounts_person_get_2_service( + self, http_client_mock: HTTPClientMock + ) -> None: + http_client_mock.stub_request( + "get", + "/v2/core/accounts/account_id_123/persons/id_123", + ) + client = StripeClient( + "sk_test_123", + http_client=http_client_mock.get_mock_http_client(), + ) + + client.v2.core.accounts.persons.retrieve( + "account_id_123", + "id_123", + ) + http_client_mock.assert_requested( + "get", + path="/v2/core/accounts/account_id_123/persons/id_123", + query_string="", + api_base="https://api.stripe.com", + ) + + def test_v2_core_accounts_person_post_2_service( + self, http_client_mock: HTTPClientMock + ) -> None: + http_client_mock.stub_request( + "post", + "/v2/core/accounts/account_id_123/persons/id_123", + ) + client = StripeClient( + "sk_test_123", + http_client=http_client_mock.get_mock_http_client(), + ) + + client.v2.core.accounts.persons.update( + "account_id_123", + "id_123", + ) + http_client_mock.assert_requested( + "post", + path="/v2/core/accounts/account_id_123/persons/id_123", + query_string="", + api_base="https://api.stripe.com", + post_data="{}", + is_json=True, + ) + + def test_v2_core_accounts_person_token_post_service( + self, http_client_mock: HTTPClientMock + ) -> None: + http_client_mock.stub_request( + "post", + "/v2/core/accounts/account_id_123/person_tokens", + ) + client = StripeClient( + "sk_test_123", + http_client=http_client_mock.get_mock_http_client(), + ) + + client.v2.core.accounts.person_tokens.create("account_id_123") + http_client_mock.assert_requested( + "post", + path="/v2/core/accounts/account_id_123/person_tokens", + query_string="", + api_base="https://api.stripe.com", + post_data="{}", + is_json=True, + ) + + def test_v2_core_accounts_person_token_get_service( + self, http_client_mock: HTTPClientMock + ) -> None: + http_client_mock.stub_request( + "get", + "/v2/core/accounts/account_id_123/person_tokens/id_123", + ) + client = StripeClient( + "sk_test_123", + http_client=http_client_mock.get_mock_http_client(), + ) + + client.v2.core.accounts.person_tokens.retrieve( + "account_id_123", + "id_123", + ) + http_client_mock.assert_requested( + "get", + path="/v2/core/accounts/account_id_123/person_tokens/id_123", + query_string="", + api_base="https://api.stripe.com", + ) + + def test_v2_core_account_link_post_service( + self, http_client_mock: HTTPClientMock + ) -> None: + http_client_mock.stub_request( + "post", + "/v2/core/account_links", + ) + client = StripeClient( + "sk_test_123", + http_client=http_client_mock.get_mock_http_client(), + ) + + client.v2.core.account_links.create( + { + "account": "account", + "use_case": { + "type": "account_onboarding", + "account_onboarding": { + "collection_options": { + "fields": "eventually_due", + "future_requirements": "include", + }, + "configurations": ["merchant"], + "refresh_url": "refresh_url", + "return_url": "return_url", + }, + "account_update": { + "collection_options": { + "fields": "eventually_due", + "future_requirements": "include", + }, + "configurations": ["merchant"], + "refresh_url": "refresh_url", + "return_url": "return_url", + }, + }, + } + ) + http_client_mock.assert_requested( + "post", + path="/v2/core/account_links", + query_string="", + api_base="https://api.stripe.com", + post_data='{"account":"account","use_case":{"type":"account_onboarding","account_onboarding":{"collection_options":{"fields":"eventually_due","future_requirements":"include"},"configurations":["merchant"],"refresh_url":"refresh_url","return_url":"return_url"},"account_update":{"collection_options":{"fields":"eventually_due","future_requirements":"include"},"configurations":["merchant"],"refresh_url":"refresh_url","return_url":"return_url"}}}', + is_json=True, + ) + + def test_v2_core_account_token_post_service( + self, http_client_mock: HTTPClientMock + ) -> None: + http_client_mock.stub_request( + "post", + "/v2/core/account_tokens", + ) + client = StripeClient( + "sk_test_123", + http_client=http_client_mock.get_mock_http_client(), + ) + + client.v2.core.account_tokens.create() + http_client_mock.assert_requested( + "post", + path="/v2/core/account_tokens", + query_string="", + api_base="https://api.stripe.com", + post_data="{}", + is_json=True, + ) + + def test_v2_core_account_token_get_service( + self, http_client_mock: HTTPClientMock + ) -> None: + http_client_mock.stub_request( + "get", + "/v2/core/account_tokens/id_123", + ) + client = StripeClient( + "sk_test_123", + http_client=http_client_mock.get_mock_http_client(), + ) + + client.v2.core.account_tokens.retrieve("id_123") + http_client_mock.assert_requested( + "get", + path="/v2/core/account_tokens/id_123", + query_string="", + api_base="https://api.stripe.com", + ) + def test_v2_core_event_get_service( self, http_client_mock: HTTPClientMock ) -> None: From aa91207898610adb1f75aa4061f160b695f203f1 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Tue, 16 Dec 2025 02:44:11 +0000 Subject: [PATCH 03/10] Update generated code for v2143 and --- API_VERSION | 2 +- stripe/events/_event_classes.py | 42 ++++++++++++++++----------------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/API_VERSION b/API_VERSION index a46aaa649..72fc940f3 100644 --- a/API_VERSION +++ b/API_VERSION @@ -1 +1 @@ -66e389e8ac4e3bb89bf1a5b24c553e9638e581e8 \ No newline at end of file +a3035d6cb25cc44d50589c1da75b21abbd3601ca \ No newline at end of file diff --git a/stripe/events/_event_classes.py b/stripe/events/_event_classes.py index ffbad8bf3..08f535ac9 100644 --- a/stripe/events/_event_classes.py +++ b/stripe/events/_event_classes.py @@ -22,6 +22,12 @@ from stripe.events._v2_billing_cadence_created_event import ( V2BillingCadenceCreatedEventNotification, ) + from stripe.events._v2_billing_licensed_item_created_event import ( + V2BillingLicensedItemCreatedEventNotification, + ) + from stripe.events._v2_billing_licensed_item_updated_event import ( + V2BillingLicensedItemUpdatedEventNotification, + ) from stripe.events._v2_billing_license_fee_created_event import ( V2BillingLicenseFeeCreatedEventNotification, ) @@ -31,30 +37,21 @@ from stripe.events._v2_billing_license_fee_version_created_event import ( V2BillingLicenseFeeVersionCreatedEventNotification, ) - from stripe.events._v2_billing_licensed_item_created_event import ( - V2BillingLicensedItemCreatedEventNotification, - ) - from stripe.events._v2_billing_licensed_item_updated_event import ( - V2BillingLicensedItemUpdatedEventNotification, - ) from stripe.events._v2_billing_metered_item_created_event import ( V2BillingMeteredItemCreatedEventNotification, ) from stripe.events._v2_billing_metered_item_updated_event import ( V2BillingMeteredItemUpdatedEventNotification, ) - from stripe.events._v2_billing_pricing_plan_created_event import ( - V2BillingPricingPlanCreatedEventNotification, - ) - from stripe.events._v2_billing_pricing_plan_updated_event import ( - V2BillingPricingPlanUpdatedEventNotification, - ) from stripe.events._v2_billing_pricing_plan_component_created_event import ( V2BillingPricingPlanComponentCreatedEventNotification, ) from stripe.events._v2_billing_pricing_plan_component_updated_event import ( V2BillingPricingPlanComponentUpdatedEventNotification, ) + from stripe.events._v2_billing_pricing_plan_created_event import ( + V2BillingPricingPlanCreatedEventNotification, + ) from stripe.events._v2_billing_pricing_plan_subscription_collection_awaiting_customer_action_event import ( V2BillingPricingPlanSubscriptionCollectionAwaitingCustomerActionEventNotification, ) @@ -79,15 +76,15 @@ from stripe.events._v2_billing_pricing_plan_subscription_servicing_paused_event import ( V2BillingPricingPlanSubscriptionServicingPausedEventNotification, ) + from stripe.events._v2_billing_pricing_plan_updated_event import ( + V2BillingPricingPlanUpdatedEventNotification, + ) from stripe.events._v2_billing_pricing_plan_version_created_event import ( V2BillingPricingPlanVersionCreatedEventNotification, ) from stripe.events._v2_billing_rate_card_created_event import ( V2BillingRateCardCreatedEventNotification, ) - from stripe.events._v2_billing_rate_card_updated_event import ( - V2BillingRateCardUpdatedEventNotification, - ) from stripe.events._v2_billing_rate_card_rate_created_event import ( V2BillingRateCardRateCreatedEventNotification, ) @@ -121,6 +118,9 @@ from stripe.events._v2_billing_rate_card_subscription_servicing_paused_event import ( V2BillingRateCardSubscriptionServicingPausedEventNotification, ) + from stripe.events._v2_billing_rate_card_updated_event import ( + V2BillingRateCardUpdatedEventNotification, + ) from stripe.events._v2_billing_rate_card_version_created_event import ( V2BillingRateCardVersionCreatedEventNotification, ) @@ -130,9 +130,6 @@ from stripe.events._v2_core_account_created_event import ( V2CoreAccountCreatedEventNotification, ) - from stripe.events._v2_core_account_updated_event import ( - V2CoreAccountUpdatedEventNotification, - ) from stripe.events._v2_core_account_including_configuration_card_creator_capability_status_updated_event import ( V2CoreAccountIncludingConfigurationCardCreatorCapabilityStatusUpdatedEventNotification, ) @@ -184,6 +181,9 @@ from stripe.events._v2_core_account_person_updated_event import ( V2CoreAccountPersonUpdatedEventNotification, ) + from stripe.events._v2_core_account_updated_event import ( + V2CoreAccountUpdatedEventNotification, + ) from stripe.events._v2_core_claimable_sandbox_claimed_event import ( V2CoreClaimableSandboxClaimedEventNotification, ) @@ -442,9 +442,6 @@ from stripe.events._v2_payments_settlement_allocation_intent_settled_event import ( V2PaymentsSettlementAllocationIntentSettledEventNotification, ) - from stripe.events._v2_payments_settlement_allocation_intent_submitted_event import ( - V2PaymentsSettlementAllocationIntentSubmittedEventNotification, - ) from stripe.events._v2_payments_settlement_allocation_intent_split_canceled_event import ( V2PaymentsSettlementAllocationIntentSplitCanceledEventNotification, ) @@ -454,6 +451,9 @@ from stripe.events._v2_payments_settlement_allocation_intent_split_settled_event import ( V2PaymentsSettlementAllocationIntentSplitSettledEventNotification, ) + from stripe.events._v2_payments_settlement_allocation_intent_submitted_event import ( + V2PaymentsSettlementAllocationIntentSubmittedEventNotification, + ) from stripe.events._v2_reporting_report_run_created_event import ( V2ReportingReportRunCreatedEventNotification, ) From 10dd396953c7a24adedd8159f69198d5ede3aa67 Mon Sep 17 00:00:00 2001 From: Steve Kowalik Date: Wed, 17 Dec 2025 00:09:32 +1100 Subject: [PATCH 04/10] Do not apply a mark to async_http_client fixture (#1700) Applying marks to a pytest fixture has never actually worked, it has just been a no-op. Starting with pytest 9, it now raises an error to fix code that does so. Remove the mark. --- tests/test_integration.py | 1 - 1 file changed, 1 deletion(-) diff --git a/tests/test_integration.py b/tests/test_integration.py index a84ddf1c6..cc558a4b9 100644 --- a/tests/test_integration.py +++ b/tests/test_integration.py @@ -335,7 +335,6 @@ def do_request(self, req_num): usage = telemetry["last_request_metrics"]["usage"] assert usage == ["stripe_client", "async"] - @pytest.mark.anyio @pytest.fixture(params=["aiohttp", "httpx"]) async def async_http_client(self, request, anyio_backend): if request.param == "httpx": From 493aeab4943f6924ff41f4e8356842b99b5749c5 Mon Sep 17 00:00:00 2001 From: System Administrator Date: Tue, 16 Dec 2025 11:50:28 -0800 Subject: [PATCH 05/10] Bump version to 14.1.0 --- CHANGELOG.md | 44 +++++++++++++++++++++++++++++++++++++++++++- VERSION | 2 +- pyproject.toml | 2 +- stripe/_version.py | 2 +- 4 files changed, 46 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1d9972996..6a77d91bf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,48 @@ +## 14.1.0 - 2025-12-16 +This release changes the pinned API version to `2025-12-15.clover`. + +* [#1696](https://github.com/stripe/stripe-python/pull/1696) Update generated code + * Add support for new resources `v2.core.AccountLink`, `v2.core.AccountPersonToken`, `v2.core.AccountPerson`, `v2.core.AccountToken`, and `v2.core.Account` + * Add support for `create` and `retrieve` methods on resources `v2.core.AccountPersonToken` and `v2.core.AccountToken` + * Add support for `create` method on resource `v2.core.AccountLink` + * Add support for `close`, `create`, `list`, `modify`, and `retrieve` methods on resource `v2.core.Account` + * Add support for `create`, `delete`, `list`, `modify`, and `retrieve` methods on resource `v2.core.AccountPerson` + * Add support for `customer_account` on `Billing.CreditBalanceSummary`, `Billing.CreditGrant`, `BillingPortal.Session`, `CashBalance`, `Checkout.Session`, `ConfirmationToken.PaymentMethodPreview`, `CreditNoteListParams`, `CreditNote`, `CustomerBalanceTransaction`, `CustomerCashBalanceTransaction`, `CustomerSessionCreateParams`, `CustomerSession`, `Customer`, `Discount`, `FinancialConnections.Account.AccountHolder`, `FinancialConnections.Session.AccountHolder`, `InvoiceCreateParams`, `InvoiceCreatePreviewParams`, `InvoiceItemCreateParams`, `InvoiceItemListParams`, `InvoiceItem`, `InvoiceListParams`, `Invoice`, `PaymentIntentCreateParams`, `PaymentIntentListParams`, `PaymentIntentModifyParams`, `PaymentIntent`, `PaymentMethodAttachParams`, `PaymentMethodListParams`, `PaymentMethod`, `PromotionCodeCreateParams`, `PromotionCodeListParams`, `PromotionCode`, `QuoteCreateParams`, `QuoteListParams`, `QuoteModifyParams`, `Quote`, `SetupAttempt`, `SetupIntentCreateParams`, `SetupIntentListParams`, `SetupIntentModifyParams`, `SetupIntent`, `SubscriptionCreateParams`, `SubscriptionListParams`, `SubscriptionScheduleCreateParams`, `SubscriptionScheduleListParams`, `SubscriptionSchedule`, `Subscription`, `TaxId.Owner`, `TaxIdCreateParamsOwner`, `TaxIdListParamsOwner`, `TaxId`, `billing.CreditBalanceSummaryRetrieveParams`, `billing.CreditBalanceTransactionListParams`, `billing.CreditGrantCreateParams`, `billing.CreditGrantListParams`, `billing_portal.SessionCreateParams`, `checkout.SessionCreateParams`, `checkout.SessionListParams`, `financial_connections.AccountListParamsAccountHolder`, and `financial_connections.SessionCreateParamsAccountHolder` + * Add support for `metadata` on `LineItem` and `checkout.SessionCreateParamsLineItem` + * Add support for `payto_payments` on `Account.Capability`, `AccountCreateParamsCapability`, and `AccountModifyParamsCapability` + * Add support for `signer` on `AccountCreateParamsDocumentProofOfRegistration`, `AccountCreateParamsDocumentProofOfUltimateBeneficialOwnership`, `AccountModifyParamsDocumentProofOfRegistration`, and `AccountModifyParamsDocumentProofOfUltimateBeneficialOwnership` + * Change `CustomerSessionCreateParams.customer`, `InvoiceItemCreateParams.customer`, `PaymentMethodAttachParams.customer`, `SubscriptionCreateParams.customer`, `billing.CreditBalanceSummaryRetrieveParams.customer`, `billing.CreditBalanceTransactionListParams.customer`, `billing.CreditGrantCreateParams.customer`, and `billing_portal.SessionCreateParams.customer` to be optional + * Add support for `billing_cycle_anchor` on `BillingPortal.Configuration.Feature.SubscriptionUpdate`, `billing_portal.ConfigurationCreateParamsFeatureSubscriptionUpdate`, and `billing_portal.ConfigurationModifyParamsFeatureSubscriptionUpdate` + * Add support for `payto` on `Charge.PaymentMethodDetail`, `Checkout.Session.PaymentMethodOption`, `ConfirmationToken.PaymentMethodPreview`, `ConfirmationTokenCreateParamsPaymentMethodDatum`, `Invoice.PaymentSetting.PaymentMethodOption`, `InvoiceCreateParamsPaymentSettingPaymentMethodOption`, `InvoiceModifyParamsPaymentSettingPaymentMethodOption`, `Mandate.PaymentMethodDetail`, `PaymentAttemptRecord.PaymentMethodDetail`, `PaymentIntent.PaymentMethodOption`, `PaymentIntentConfirmParamsPaymentMethodDatum`, `PaymentIntentConfirmParamsPaymentMethodOption`, `PaymentIntentCreateParamsPaymentMethodDatum`, `PaymentIntentCreateParamsPaymentMethodOption`, `PaymentIntentModifyParamsPaymentMethodDatum`, `PaymentIntentModifyParamsPaymentMethodOption`, `PaymentMethodConfigurationCreateParams`, `PaymentMethodConfigurationModifyParams`, `PaymentMethodConfiguration`, `PaymentMethodCreateParams`, `PaymentMethodModifyParams`, `PaymentMethod`, `PaymentRecord.PaymentMethodDetail`, `SetupAttempt.PaymentMethodDetail`, `SetupIntent.PaymentMethodOption`, `SetupIntentConfirmParamsPaymentMethodDatum`, `SetupIntentConfirmParamsPaymentMethodOption`, `SetupIntentCreateParamsPaymentMethodDatum`, `SetupIntentCreateParamsPaymentMethodOption`, `SetupIntentModifyParamsPaymentMethodDatum`, `SetupIntentModifyParamsPaymentMethodOption`, `Subscription.PaymentSetting.PaymentMethodOption`, `SubscriptionCreateParamsPaymentSettingPaymentMethodOption`, `SubscriptionModifyParamsPaymentSettingPaymentMethodOption`, and `checkout.SessionCreateParamsPaymentMethodOption` + * Add support for `expected_debit_date` on `Charge.PaymentMethodDetail.AcssDebit`, `Charge.PaymentMethodDetail.AuBecsDebit`, `Charge.PaymentMethodDetail.BacsDebit`, `Charge.PaymentMethodDetail.NzBankAccount`, `Charge.PaymentMethodDetail.SepaDebit`, `Charge.PaymentMethodDetail.UsBankAccount`, `PaymentAttemptRecord.PaymentMethodDetail.AcssDebit`, `PaymentAttemptRecord.PaymentMethodDetail.AuBecsDebit`, `PaymentAttemptRecord.PaymentMethodDetail.BacsDebit`, `PaymentAttemptRecord.PaymentMethodDetail.NzBankAccount`, `PaymentAttemptRecord.PaymentMethodDetail.SepaDebit`, `PaymentAttemptRecord.PaymentMethodDetail.UsBankAccount`, `PaymentRecord.PaymentMethodDetail.AcssDebit`, `PaymentRecord.PaymentMethodDetail.AuBecsDebit`, `PaymentRecord.PaymentMethodDetail.BacsDebit`, `PaymentRecord.PaymentMethodDetail.NzBankAccount`, `PaymentRecord.PaymentMethodDetail.SepaDebit`, and `PaymentRecord.PaymentMethodDetail.UsBankAccount` + * Add support for new value `mollie` on enums `Charge.PaymentMethodDetail.Ideal.bank`, `ConfirmationToken.PaymentMethodPreview.Ideal.bank`, `ConfirmationTokenCreateParamsPaymentMethodDatumIdeal.bank`, `PaymentAttemptRecord.PaymentMethodDetail.Ideal.bank`, `PaymentIntentConfirmParamsPaymentMethodDatumIdeal.bank`, `PaymentIntentCreateParamsPaymentMethodDatumIdeal.bank`, `PaymentIntentModifyParamsPaymentMethodDatumIdeal.bank`, `PaymentMethod.Ideal.bank`, `PaymentMethodCreateParamsIdeal.bank`, `PaymentRecord.PaymentMethodDetail.Ideal.bank`, `SetupAttempt.PaymentMethodDetail.Ideal.bank`, `SetupIntentConfirmParamsPaymentMethodDatumIdeal.bank`, `SetupIntentCreateParamsPaymentMethodDatumIdeal.bank`, and `SetupIntentModifyParamsPaymentMethodDatumIdeal.bank` + * Add support for new value `MLLENL2A` on enums `Charge.PaymentMethodDetail.Ideal.bic`, `ConfirmationToken.PaymentMethodPreview.Ideal.bic`, `PaymentAttemptRecord.PaymentMethodDetail.Ideal.bic`, `PaymentMethod.Ideal.bic`, `PaymentRecord.PaymentMethodDetail.Ideal.bic`, and `SetupAttempt.PaymentMethodDetail.Ideal.bic` + * Add support for new value `payto` on enums `PaymentIntent.excluded_payment_method_types`, `PaymentIntentConfirmParams.excluded_payment_method_types`, `PaymentIntentCreateParams.excluded_payment_method_types`, `PaymentIntentModifyParams.excluded_payment_method_types`, `SetupIntent.excluded_payment_method_types`, `SetupIntentCreateParams.excluded_payment_method_types`, `SetupIntentModifyParams.excluded_payment_method_types`, and `checkout.SessionCreateParams.excluded_payment_method_types` + * Add support for new value `payto` on enum `checkout.SessionCreateParams.payment_method_types` + * Add support for `line_items` on `checkout.SessionModifyParams` + * Add support for new value `payto` on enums `ConfirmationTokenCreateParamsPaymentMethodDatum.type`, `PaymentIntentConfirmParamsPaymentMethodDatum.type`, `PaymentIntentCreateParamsPaymentMethodDatum.type`, `PaymentIntentModifyParamsPaymentMethodDatum.type`, `SetupIntentConfirmParamsPaymentMethodDatum.type`, `SetupIntentCreateParamsPaymentMethodDatum.type`, and `SetupIntentModifyParamsPaymentMethodDatum.type` + * Add support for new value `payto` on enums `ConfirmationToken.PaymentMethodPreview.type` and `PaymentMethod.type` + * Add support for new value `payto` on enums `CustomerListPaymentMethodsParams.type`, `PaymentMethodCreateParams.type`, and `PaymentMethodListParams.type` + * Add support for `invoice` on `CustomerListCustomerBalanceTransactionParams` + * Add support for `related_customer_account` on `Identity.VerificationSession`, `identity.VerificationSessionCreateParams`, and `identity.VerificationSessionListParams` + * Change type of `InvoiceItem.Pricing.PriceDetail.price` and `InvoiceLineItem.Pricing.PriceDetail.price` from `string` to `expandable($Price)` + * Add support for new value `payto` on enums `Invoice.PaymentSetting.payment_method_types`, `InvoiceCreateParamsPaymentSetting.payment_method_types`, `InvoiceModifyParamsPaymentSetting.payment_method_types`, `Subscription.PaymentSetting.payment_method_types`, `SubscriptionCreateParamsPaymentSetting.payment_method_types`, and `SubscriptionModifyParamsPaymentSetting.payment_method_types` + * Add support for `subtotal` on `InvoiceLineItem` + * Add support for `authorization_code`, `description`, `iin`, `installments`, `issuer`, `network_advice_code`, `network_decline_code`, and `stored_credential_usage` on `PaymentAttemptRecord.PaymentMethodDetail.Card` and `PaymentRecord.PaymentMethodDetail.Card` + * Change `PaymentIntent.transfer_data` to be optional + * Add support for new value `payto` on enums `PaymentLink.payment_method_types`, `PaymentLinkCreateParams.payment_method_types`, and `PaymentLinkModifyParams.payment_method_types` + * Add support for `allow_redisplay` on `PaymentMethodListParams` + * Add support for `reported_by` on `PaymentRecord` + * Change `Product.tax_code` to be optional + * Add support for new values `2025-12-15.clover` and `2026-01-28.clover` on enum `WebhookEndpointCreateParams.api_version` + * Add support for `changes` on `V2.Core.Event` + * Add support for error code `account_token_required_for_v2_account` on `Invoice.LastFinalizationError`, `PaymentIntent.LastPaymentError`, `SetupAttempt.SetupError`, `SetupIntent.LastSetupError`, and `StripeError` +* [#1692](https://github.com/stripe/stripe-python/pull/1692) Updated bundled CA certificates +* [#1676](https://github.com/stripe/stripe-python/pull/1676) Add create_async method to EphemeralKey + ## 14.0.1 - 2025-11-21 * [#1684](https://github.com/stripe/stripe-python/pull/1684) Update generated code - * `stripe.error` module is now accessible globally. Fixes [#1682](https://github.com/stripe/stripe-python/issues/1682) + * `stripe.error` module is now accessible globally. Fixes [#1682](https://github.com/stripe/stripe-python/issues/1682) * [#1681](https://github.com/stripe/stripe-python/pull/1681) Throw a specific error when accessing `payment_intent` property on `Invoice` object to ease debugging. ## 14.0.0 - 2025-11-18 diff --git a/VERSION b/VERSION index 63dba868a..7b3b6e02b 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -14.0.1 +14.1.0 diff --git a/pyproject.toml b/pyproject.toml index c647f2e41..d0e73c616 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "stripe" -version = "14.0.1" +version = "14.1.0" readme = "README.md" description = "Python bindings for the Stripe API" authors = [{ name = "Stripe", email = "support@stripe.com" }] diff --git a/stripe/_version.py b/stripe/_version.py index c79d234de..013cbd193 100644 --- a/stripe/_version.py +++ b/stripe/_version.py @@ -1 +1 @@ -VERSION = "14.0.1" +VERSION = "14.1.0" From 973aa39fc5227f6e4348042b43f9bf556861892c Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Wed, 17 Dec 2025 08:38:49 +0000 Subject: [PATCH 06/10] Update generated code for v2144 and --- OPENAPI_VERSION | 2 +- stripe/params/__init__.py | 10 ++++++++++ stripe/params/_payment_intent_confirm_params.py | 2 +- stripe/params/_payment_intent_create_params.py | 2 +- stripe/params/_payment_intent_modify_params.py | 2 +- stripe/params/_payment_intent_update_params.py | 2 +- stripe/params/_plan_create_params.py | 11 +++++++++++ stripe/params/_price_create_params.py | 11 +++++++++++ stripe/params/_setup_intent_confirm_params.py | 2 +- stripe/params/_setup_intent_create_params.py | 2 +- stripe/params/_setup_intent_modify_params.py | 2 +- stripe/params/_setup_intent_update_params.py | 2 +- 12 files changed, 41 insertions(+), 9 deletions(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index abf60f206..d3b53dafb 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v2143 \ No newline at end of file +v2144 \ No newline at end of file diff --git a/stripe/params/__init__.py b/stripe/params/__init__.py index 284a66613..f2bd1baf7 100644 --- a/stripe/params/__init__.py +++ b/stripe/params/__init__.py @@ -4081,6 +4081,7 @@ from stripe.params._plan_create_params import ( PlanCreateParams as PlanCreateParams, PlanCreateParamsProduct as PlanCreateParamsProduct, + PlanCreateParamsProductTaxDetails as PlanCreateParamsProductTaxDetails, PlanCreateParamsTier as PlanCreateParamsTier, PlanCreateParamsTransformUsage as PlanCreateParamsTransformUsage, ) @@ -4107,6 +4108,7 @@ PriceCreateParamsCurrencyOptionsTier as PriceCreateParamsCurrencyOptionsTier, PriceCreateParamsCustomUnitAmount as PriceCreateParamsCustomUnitAmount, PriceCreateParamsProductData as PriceCreateParamsProductData, + PriceCreateParamsProductDataTaxDetails as PriceCreateParamsProductDataTaxDetails, PriceCreateParamsRecurring as PriceCreateParamsRecurring, PriceCreateParamsTier as PriceCreateParamsTier, PriceCreateParamsTransformQuantity as PriceCreateParamsTransformQuantity, @@ -19346,6 +19348,10 @@ "PayoutUpdateParams": ("stripe.params._payout_update_params", False), "PlanCreateParams": ("stripe.params._plan_create_params", False), "PlanCreateParamsProduct": ("stripe.params._plan_create_params", False), + "PlanCreateParamsProductTaxDetails": ( + "stripe.params._plan_create_params", + False, + ), "PlanCreateParamsTier": ("stripe.params._plan_create_params", False), "PlanCreateParamsTransformUsage": ( "stripe.params._plan_create_params", @@ -19378,6 +19384,10 @@ "stripe.params._price_create_params", False, ), + "PriceCreateParamsProductDataTaxDetails": ( + "stripe.params._price_create_params", + False, + ), "PriceCreateParamsRecurring": ( "stripe.params._price_create_params", False, diff --git a/stripe/params/_payment_intent_confirm_params.py b/stripe/params/_payment_intent_confirm_params.py index a8858dd3f..151ca8d19 100644 --- a/stripe/params/_payment_intent_confirm_params.py +++ b/stripe/params/_payment_intent_confirm_params.py @@ -466,7 +466,7 @@ class PaymentIntentConfirmParamsPaymentDetails(TypedDict): class PaymentIntentConfirmParamsPaymentDetailsBenefit(TypedDict): fr_meal_voucher: NotRequired[ - "PaymentIntentConfirmParamsPaymentDetailsBenefitFrMealVoucher" + "Literal['']|PaymentIntentConfirmParamsPaymentDetailsBenefitFrMealVoucher" ] """ French meal voucher benefit details for this PaymentIntent. diff --git a/stripe/params/_payment_intent_create_params.py b/stripe/params/_payment_intent_create_params.py index 192a4ffeb..fdcf1a37c 100644 --- a/stripe/params/_payment_intent_create_params.py +++ b/stripe/params/_payment_intent_create_params.py @@ -613,7 +613,7 @@ class PaymentIntentCreateParamsPaymentDetails(TypedDict): class PaymentIntentCreateParamsPaymentDetailsBenefit(TypedDict): fr_meal_voucher: NotRequired[ - "PaymentIntentCreateParamsPaymentDetailsBenefitFrMealVoucher" + "Literal['']|PaymentIntentCreateParamsPaymentDetailsBenefitFrMealVoucher" ] """ French meal voucher benefit details for this PaymentIntent. diff --git a/stripe/params/_payment_intent_modify_params.py b/stripe/params/_payment_intent_modify_params.py index 2d2afa5ab..abd4c4d78 100644 --- a/stripe/params/_payment_intent_modify_params.py +++ b/stripe/params/_payment_intent_modify_params.py @@ -461,7 +461,7 @@ class PaymentIntentModifyParamsPaymentDetails(TypedDict): class PaymentIntentModifyParamsPaymentDetailsBenefit(TypedDict): fr_meal_voucher: NotRequired[ - "PaymentIntentModifyParamsPaymentDetailsBenefitFrMealVoucher" + "Literal['']|PaymentIntentModifyParamsPaymentDetailsBenefitFrMealVoucher" ] """ French meal voucher benefit details for this PaymentIntent. diff --git a/stripe/params/_payment_intent_update_params.py b/stripe/params/_payment_intent_update_params.py index 1a68fd31a..861f03a42 100644 --- a/stripe/params/_payment_intent_update_params.py +++ b/stripe/params/_payment_intent_update_params.py @@ -460,7 +460,7 @@ class PaymentIntentUpdateParamsPaymentDetails(TypedDict): class PaymentIntentUpdateParamsPaymentDetailsBenefit(TypedDict): fr_meal_voucher: NotRequired[ - "PaymentIntentUpdateParamsPaymentDetailsBenefitFrMealVoucher" + "Literal['']|PaymentIntentUpdateParamsPaymentDetailsBenefitFrMealVoucher" ] """ French meal voucher benefit details for this PaymentIntent. diff --git a/stripe/params/_plan_create_params.py b/stripe/params/_plan_create_params.py index d3cdabcdf..2f9f28aa9 100644 --- a/stripe/params/_plan_create_params.py +++ b/stripe/params/_plan_create_params.py @@ -108,6 +108,17 @@ class PlanCreateParamsProduct(TypedDict): """ A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. """ + tax_details: NotRequired["PlanCreateParamsProductTaxDetails"] + """ + Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location. + """ + + +class PlanCreateParamsProductTaxDetails(TypedDict): + tax_code: str + """ + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. + """ class PlanCreateParamsTier(TypedDict): diff --git a/stripe/params/_price_create_params.py b/stripe/params/_price_create_params.py index b584425ca..c51bd5291 100644 --- a/stripe/params/_price_create_params.py +++ b/stripe/params/_price_create_params.py @@ -203,6 +203,17 @@ class PriceCreateParamsProductData(TypedDict): """ A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. """ + tax_details: NotRequired["PriceCreateParamsProductDataTaxDetails"] + """ + Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location. + """ + + +class PriceCreateParamsProductDataTaxDetails(TypedDict): + tax_code: str + """ + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. + """ class PriceCreateParamsRecurring(TypedDict): diff --git a/stripe/params/_setup_intent_confirm_params.py b/stripe/params/_setup_intent_confirm_params.py index bb064441e..99cbdf2f3 100644 --- a/stripe/params/_setup_intent_confirm_params.py +++ b/stripe/params/_setup_intent_confirm_params.py @@ -1678,7 +1678,7 @@ class SetupIntentConfirmParamsSetupDetails(TypedDict): class SetupIntentConfirmParamsSetupDetailsBenefit(TypedDict): fr_meal_voucher: NotRequired[ - "SetupIntentConfirmParamsSetupDetailsBenefitFrMealVoucher" + "Literal['']|SetupIntentConfirmParamsSetupDetailsBenefitFrMealVoucher" ] """ French meal voucher benefit details for this SetupIntent. diff --git a/stripe/params/_setup_intent_create_params.py b/stripe/params/_setup_intent_create_params.py index 2ec3611c0..797f7f1b2 100644 --- a/stripe/params/_setup_intent_create_params.py +++ b/stripe/params/_setup_intent_create_params.py @@ -1805,7 +1805,7 @@ class SetupIntentCreateParamsSetupDetails(TypedDict): class SetupIntentCreateParamsSetupDetailsBenefit(TypedDict): fr_meal_voucher: NotRequired[ - "SetupIntentCreateParamsSetupDetailsBenefitFrMealVoucher" + "Literal['']|SetupIntentCreateParamsSetupDetailsBenefitFrMealVoucher" ] """ French meal voucher benefit details for this SetupIntent. diff --git a/stripe/params/_setup_intent_modify_params.py b/stripe/params/_setup_intent_modify_params.py index 29077eac6..fbd495fd3 100644 --- a/stripe/params/_setup_intent_modify_params.py +++ b/stripe/params/_setup_intent_modify_params.py @@ -1646,7 +1646,7 @@ class SetupIntentModifyParamsSetupDetails(TypedDict): class SetupIntentModifyParamsSetupDetailsBenefit(TypedDict): fr_meal_voucher: NotRequired[ - "SetupIntentModifyParamsSetupDetailsBenefitFrMealVoucher" + "Literal['']|SetupIntentModifyParamsSetupDetailsBenefitFrMealVoucher" ] """ French meal voucher benefit details for this SetupIntent. diff --git a/stripe/params/_setup_intent_update_params.py b/stripe/params/_setup_intent_update_params.py index c48fb66ec..325677b75 100644 --- a/stripe/params/_setup_intent_update_params.py +++ b/stripe/params/_setup_intent_update_params.py @@ -1645,7 +1645,7 @@ class SetupIntentUpdateParamsSetupDetails(TypedDict): class SetupIntentUpdateParamsSetupDetailsBenefit(TypedDict): fr_meal_voucher: NotRequired[ - "SetupIntentUpdateParamsSetupDetailsBenefitFrMealVoucher" + "Literal['']|SetupIntentUpdateParamsSetupDetailsBenefitFrMealVoucher" ] """ French meal voucher benefit details for this SetupIntent. From 93fb4c2dcca37dbb119767ccd451e970bf6f7650 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Wed, 17 Dec 2025 20:00:16 +0000 Subject: [PATCH 07/10] Update generated code for v2145 and --- API_VERSION | 2 +- OPENAPI_VERSION | 2 +- stripe/params/shared_payment/__init__.py | 8 ++-- ...ams.py => _granted_token_revoke_params.py} | 2 +- .../test_helpers/shared_payment/__init__.py | 8 ++-- ...ams.py => _granted_token_revoke_params.py} | 2 +- stripe/shared_payment/_granted_token.py | 40 +++++++++---------- .../shared_payment/_granted_token_service.py | 12 +++--- 8 files changed, 38 insertions(+), 38 deletions(-) rename stripe/params/shared_payment/{_granted_token_update_params.py => _granted_token_revoke_params.py} (86%) rename stripe/params/test_helpers/shared_payment/{_granted_token_update_params.py => _granted_token_revoke_params.py} (85%) diff --git a/API_VERSION b/API_VERSION index 4fb5364fd..a6cd1432a 100644 --- a/API_VERSION +++ b/API_VERSION @@ -1 +1 @@ -bd43cbb47f556744f4727eeea7cddebc9b1cc05f \ No newline at end of file +62f4f6bb7256abf1d83d35d2fb79a309954b19c9 \ No newline at end of file diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index d3b53dafb..cc4a2400e 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v2144 \ No newline at end of file +v2145 \ No newline at end of file diff --git a/stripe/params/shared_payment/__init__.py b/stripe/params/shared_payment/__init__.py index 1d82bfbc3..4e12a7d09 100644 --- a/stripe/params/shared_payment/__init__.py +++ b/stripe/params/shared_payment/__init__.py @@ -11,8 +11,8 @@ from stripe.params.shared_payment._granted_token_retrieve_params import ( GrantedTokenRetrieveParams as GrantedTokenRetrieveParams, ) - from stripe.params.shared_payment._granted_token_update_params import ( - GrantedTokenUpdateParams as GrantedTokenUpdateParams, + from stripe.params.shared_payment._granted_token_revoke_params import ( + GrantedTokenRevokeParams as GrantedTokenRevokeParams, ) # name -> (import_target, is_submodule) @@ -29,8 +29,8 @@ "stripe.params.shared_payment._granted_token_retrieve_params", False, ), - "GrantedTokenUpdateParams": ( - "stripe.params.shared_payment._granted_token_update_params", + "GrantedTokenRevokeParams": ( + "stripe.params.shared_payment._granted_token_revoke_params", False, ), } diff --git a/stripe/params/shared_payment/_granted_token_update_params.py b/stripe/params/shared_payment/_granted_token_revoke_params.py similarity index 86% rename from stripe/params/shared_payment/_granted_token_update_params.py rename to stripe/params/shared_payment/_granted_token_revoke_params.py index 7eb144054..7bc291a52 100644 --- a/stripe/params/shared_payment/_granted_token_update_params.py +++ b/stripe/params/shared_payment/_granted_token_revoke_params.py @@ -5,7 +5,7 @@ from typing_extensions import NotRequired -class GrantedTokenUpdateParams(RequestOptions): +class GrantedTokenRevokeParams(RequestOptions): expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. diff --git a/stripe/params/test_helpers/shared_payment/__init__.py b/stripe/params/test_helpers/shared_payment/__init__.py index 4056f5750..9290020d8 100644 --- a/stripe/params/test_helpers/shared_payment/__init__.py +++ b/stripe/params/test_helpers/shared_payment/__init__.py @@ -8,8 +8,8 @@ GrantedTokenCreateParams as GrantedTokenCreateParams, GrantedTokenCreateParamsUsageLimits as GrantedTokenCreateParamsUsageLimits, ) - from stripe.params.test_helpers.shared_payment._granted_token_update_params import ( - GrantedTokenUpdateParams as GrantedTokenUpdateParams, + from stripe.params.test_helpers.shared_payment._granted_token_revoke_params import ( + GrantedTokenRevokeParams as GrantedTokenRevokeParams, ) # name -> (import_target, is_submodule) @@ -22,8 +22,8 @@ "stripe.params.test_helpers.shared_payment._granted_token_create_params", False, ), - "GrantedTokenUpdateParams": ( - "stripe.params.test_helpers.shared_payment._granted_token_update_params", + "GrantedTokenRevokeParams": ( + "stripe.params.test_helpers.shared_payment._granted_token_revoke_params", False, ), } diff --git a/stripe/params/test_helpers/shared_payment/_granted_token_update_params.py b/stripe/params/test_helpers/shared_payment/_granted_token_revoke_params.py similarity index 85% rename from stripe/params/test_helpers/shared_payment/_granted_token_update_params.py rename to stripe/params/test_helpers/shared_payment/_granted_token_revoke_params.py index 0a0385be2..95d0ccd0b 100644 --- a/stripe/params/test_helpers/shared_payment/_granted_token_update_params.py +++ b/stripe/params/test_helpers/shared_payment/_granted_token_revoke_params.py @@ -4,7 +4,7 @@ from typing_extensions import NotRequired, TypedDict -class GrantedTokenUpdateParams(TypedDict): +class GrantedTokenRevokeParams(TypedDict): expand: NotRequired[List[str]] """ Specifies which fields in the response should be expanded. diff --git a/stripe/shared_payment/_granted_token.py b/stripe/shared_payment/_granted_token.py index 47fc8c23f..4bb6ed416 100644 --- a/stripe/shared_payment/_granted_token.py +++ b/stripe/shared_payment/_granted_token.py @@ -14,8 +14,8 @@ from stripe.params.shared_payment._granted_token_retrieve_params import ( GrantedTokenRetrieveParams, ) - from stripe.params.shared_payment._granted_token_update_params import ( - GrantedTokenUpdateParams, + from stripe.params.shared_payment._granted_token_revoke_params import ( + GrantedTokenRevokeParams, ) @@ -155,10 +155,10 @@ async def create_async( ) @classmethod - def _cls_update( + def _cls_revoke( cls, shared_payment_granted_token: str, - **params: Unpack["GrantedTokenUpdateParams"], + **params: Unpack["GrantedTokenRevokeParams"], ) -> "GrantedToken": """ Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration @@ -178,9 +178,9 @@ def _cls_update( @overload @staticmethod - def update( + def revoke( shared_payment_granted_token: str, - **params: Unpack["GrantedTokenUpdateParams"], + **params: Unpack["GrantedTokenRevokeParams"], ) -> "GrantedToken": """ Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration @@ -188,17 +188,17 @@ def update( ... @overload - def update( - self, **params: Unpack["GrantedTokenUpdateParams"] + def revoke( + self, **params: Unpack["GrantedTokenRevokeParams"] ) -> "GrantedToken": """ Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration """ ... - @class_method_variant("_cls_update") - def update( # pyright: ignore[reportGeneralTypeIssues] - self, **params: Unpack["GrantedTokenUpdateParams"] + @class_method_variant("_cls_revoke") + def revoke( # pyright: ignore[reportGeneralTypeIssues] + self, **params: Unpack["GrantedTokenRevokeParams"] ) -> "GrantedToken": """ Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration @@ -217,10 +217,10 @@ def update( # pyright: ignore[reportGeneralTypeIssues] ) @classmethod - async def _cls_update_async( + async def _cls_revoke_async( cls, shared_payment_granted_token: str, - **params: Unpack["GrantedTokenUpdateParams"], + **params: Unpack["GrantedTokenRevokeParams"], ) -> "GrantedToken": """ Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration @@ -240,9 +240,9 @@ async def _cls_update_async( @overload @staticmethod - async def update_async( + async def revoke_async( shared_payment_granted_token: str, - **params: Unpack["GrantedTokenUpdateParams"], + **params: Unpack["GrantedTokenRevokeParams"], ) -> "GrantedToken": """ Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration @@ -250,17 +250,17 @@ async def update_async( ... @overload - async def update_async( - self, **params: Unpack["GrantedTokenUpdateParams"] + async def revoke_async( + self, **params: Unpack["GrantedTokenRevokeParams"] ) -> "GrantedToken": """ Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration """ ... - @class_method_variant("_cls_update_async") - async def update_async( # pyright: ignore[reportGeneralTypeIssues] - self, **params: Unpack["GrantedTokenUpdateParams"] + @class_method_variant("_cls_revoke_async") + async def revoke_async( # pyright: ignore[reportGeneralTypeIssues] + self, **params: Unpack["GrantedTokenRevokeParams"] ) -> "GrantedToken": """ Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration diff --git a/stripe/test_helpers/shared_payment/_granted_token_service.py b/stripe/test_helpers/shared_payment/_granted_token_service.py index 7ee1ee739..66bfd21b2 100644 --- a/stripe/test_helpers/shared_payment/_granted_token_service.py +++ b/stripe/test_helpers/shared_payment/_granted_token_service.py @@ -10,8 +10,8 @@ from stripe.params.test_helpers.shared_payment._granted_token_create_params import ( GrantedTokenCreateParams, ) - from stripe.params.test_helpers.shared_payment._granted_token_update_params import ( - GrantedTokenUpdateParams, + from stripe.params.test_helpers.shared_payment._granted_token_revoke_params import ( + GrantedTokenRevokeParams, ) from stripe.shared_payment._granted_token import GrantedToken @@ -55,10 +55,10 @@ async def create_async( ), ) - def update( + def revoke( self, shared_payment_granted_token: str, - params: Optional["GrantedTokenUpdateParams"] = None, + params: Optional["GrantedTokenRevokeParams"] = None, options: Optional["RequestOptions"] = None, ) -> "GrantedToken": """ @@ -79,10 +79,10 @@ def update( ), ) - async def update_async( + async def revoke_async( self, shared_payment_granted_token: str, - params: Optional["GrantedTokenUpdateParams"] = None, + params: Optional["GrantedTokenRevokeParams"] = None, options: Optional["RequestOptions"] = None, ) -> "GrantedToken": """ From bdd16ba3bffbfb60d1d5aee611207bb2ee5c52f9 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Wed, 17 Dec 2025 20:14:18 +0000 Subject: [PATCH 08/10] Update generated code for v2146 and --- OPENAPI_VERSION | 2 +- .../delegated_checkout/_requested_session_modify_params.py | 6 +++--- .../delegated_checkout/_requested_session_update_params.py | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index cc4a2400e..cef0e8992 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v2145 \ No newline at end of file +v2146 \ No newline at end of file diff --git a/stripe/params/delegated_checkout/_requested_session_modify_params.py b/stripe/params/delegated_checkout/_requested_session_modify_params.py index 78a9252f6..d1f5319c3 100644 --- a/stripe/params/delegated_checkout/_requested_session_modify_params.py +++ b/stripe/params/delegated_checkout/_requested_session_modify_params.py @@ -22,7 +22,7 @@ class RequestedSessionModifyParams(RequestOptions): """ The details of the line items. """ - metadata: NotRequired[Dict[str, str]] + metadata: NotRequired["Literal['']|Dict[str, str]"] """ The metadata for this requested session. """ @@ -31,12 +31,12 @@ class RequestedSessionModifyParams(RequestOptions): The payment method for this requested session. """ payment_method_data: NotRequired[ - "RequestedSessionModifyParamsPaymentMethodData" + "Literal['']|RequestedSessionModifyParamsPaymentMethodData" ] """ The payment method data for this requested session. """ - shared_metadata: NotRequired[Dict[str, str]] + shared_metadata: NotRequired["Literal['']|Dict[str, str]"] """ The shared metadata for this requested session. """ diff --git a/stripe/params/delegated_checkout/_requested_session_update_params.py b/stripe/params/delegated_checkout/_requested_session_update_params.py index e1e0580f6..e80124a3d 100644 --- a/stripe/params/delegated_checkout/_requested_session_update_params.py +++ b/stripe/params/delegated_checkout/_requested_session_update_params.py @@ -21,7 +21,7 @@ class RequestedSessionUpdateParams(TypedDict): """ The details of the line items. """ - metadata: NotRequired[Dict[str, str]] + metadata: NotRequired["Literal['']|Dict[str, str]"] """ The metadata for this requested session. """ @@ -30,12 +30,12 @@ class RequestedSessionUpdateParams(TypedDict): The payment method for this requested session. """ payment_method_data: NotRequired[ - "RequestedSessionUpdateParamsPaymentMethodData" + "Literal['']|RequestedSessionUpdateParamsPaymentMethodData" ] """ The payment method data for this requested session. """ - shared_metadata: NotRequired[Dict[str, str]] + shared_metadata: NotRequired["Literal['']|Dict[str, str]"] """ The shared metadata for this requested session. """ From 3cda55ea660fcb901f7203aff59113ceca336e04 Mon Sep 17 00:00:00 2001 From: Ramya Rao <100975018+ramya-stripe@users.noreply.github.com> Date: Wed, 17 Dec 2025 12:34:37 -0800 Subject: [PATCH 09/10] Update ci to run on Python 3.14 as well (#1703) --- .github/workflows/ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a894b2a2f..02ff03e35 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -86,6 +86,7 @@ jobs: - "3.11" - "3.12" - "3.13" + - "3.14" - "pypy-3.7" - "pypy-3.8" - "pypy-3.9" From 1bb70fa51a63d48273215ae2c01e3265c9d0503c Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Fri, 19 Dec 2025 07:46:56 +0000 Subject: [PATCH 10/10] Update generated code for v2148 and --- API_VERSION | 2 +- OPENAPI_VERSION | 2 +- stripe/_object_classes.py | 1 + stripe/_tax_code.py | 16 +- stripe/_tax_service.py | 3 + stripe/params/_invoice_add_lines_params.py | 4 + .../_invoice_line_item_update_params.py | 4 + stripe/params/_invoice_update_lines_params.py | 4 + stripe/params/_payment_link_create_params.py | 4 + stripe/params/_plan_create_params.py | 4 + stripe/params/_price_create_params.py | 4 + stripe/params/_product_create_params.py | 4 + stripe/params/_product_modify_params.py | 4 + stripe/params/_product_update_params.py | 4 + .../params/checkout/_session_create_params.py | 4 + .../params/checkout/_session_modify_params.py | 4 + .../params/checkout/_session_update_params.py | 4 + stripe/params/tax/__init__.py | 23 +++ .../params/tax/_calculation_create_params.py | 4 + stripe/params/tax/_location_create_params.py | 51 ++++++ stripe/params/tax/_location_list_params.py | 28 +++ .../params/tax/_location_retrieve_params.py | 12 ++ .../params/tax/_registration_create_params.py | 8 + stripe/tax/__init__.py | 4 + stripe/tax/_calculation.py | 18 +- stripe/tax/_calculation_line_item.py | 14 +- stripe/tax/_location.py | 172 ++++++++++++++++++ stripe/tax/_location_service.py | 146 +++++++++++++++ stripe/tax/_registration.py | 72 ++++++++ stripe/tax/_transaction.py | 10 +- 30 files changed, 628 insertions(+), 6 deletions(-) create mode 100644 stripe/params/tax/_location_create_params.py create mode 100644 stripe/params/tax/_location_list_params.py create mode 100644 stripe/params/tax/_location_retrieve_params.py create mode 100644 stripe/tax/_location.py create mode 100644 stripe/tax/_location_service.py diff --git a/API_VERSION b/API_VERSION index 5a463f460..672166605 100644 --- a/API_VERSION +++ b/API_VERSION @@ -1 +1 @@ -bc2a2b73b8f1dddbb5b3b46f7c50f04ad09bc778 \ No newline at end of file +0822236fb875490aa7ccc7b66dbb52f8965ee062 \ No newline at end of file diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index cef0e8992..6a50c81b8 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v2146 \ No newline at end of file +v2148 \ No newline at end of file diff --git a/stripe/_object_classes.py b/stripe/_object_classes.py index 658f09458..7ed47fd28 100644 --- a/stripe/_object_classes.py +++ b/stripe/_object_classes.py @@ -324,6 +324,7 @@ "CalculationLineItem", ), "tax.form": ("stripe.tax._form", "Form"), + "tax.location": ("stripe.tax._location", "Location"), "tax.registration": ("stripe.tax._registration", "Registration"), "tax.settings": ("stripe.tax._settings", "Settings"), "tax.transaction": ("stripe.tax._transaction", "Transaction"), diff --git a/stripe/_tax_code.py b/stripe/_tax_code.py index 281a4985a..3b570be5d 100644 --- a/stripe/_tax_code.py +++ b/stripe/_tax_code.py @@ -2,7 +2,8 @@ # File generated from our OpenAPI spec from stripe._list_object import ListObject from stripe._listable_api_resource import ListableAPIResource -from typing import ClassVar +from stripe._stripe_object import StripeObject +from typing import ClassVar, Optional from typing_extensions import Literal, Unpack, TYPE_CHECKING if TYPE_CHECKING: @@ -16,6 +17,13 @@ class TaxCode(ListableAPIResource["TaxCode"]): """ OBJECT_NAME: ClassVar[Literal["tax_code"]] = "tax_code" + + class Requirements(StripeObject): + performance_location: Optional[Literal["optional", "required"]] + """ + Describes whether a performance location is required for a successful tax calculation with a tax code. + """ + description: str """ A detailed description of which types of products the tax code represents. @@ -32,6 +40,10 @@ class TaxCode(ListableAPIResource["TaxCode"]): """ String representing the object's type. Objects of the same type share the same value. """ + requirements: Optional[Requirements] + """ + An object that describes more information about the tax location required for this tax code. Some [tax codes](https://docs.stripe.com/tax/tax-for-tickets/integration-guide#types-of-products) require a tax location of type `performance` to calculate tax correctly. + """ @classmethod def list( @@ -94,3 +106,5 @@ async def retrieve_async( instance = cls(id, **params) await instance.refresh_async() return instance + + _inner_class_types = {"requirements": Requirements} diff --git a/stripe/_tax_service.py b/stripe/_tax_service.py index cc3d8626f..970381939 100644 --- a/stripe/_tax_service.py +++ b/stripe/_tax_service.py @@ -8,6 +8,7 @@ from stripe.tax._association_service import AssociationService from stripe.tax._calculation_service import CalculationService from stripe.tax._form_service import FormService + from stripe.tax._location_service import LocationService from stripe.tax._registration_service import RegistrationService from stripe.tax._settings_service import SettingsService from stripe.tax._transaction_service import TransactionService @@ -16,6 +17,7 @@ "associations": ["stripe.tax._association_service", "AssociationService"], "calculations": ["stripe.tax._calculation_service", "CalculationService"], "forms": ["stripe.tax._form_service", "FormService"], + "locations": ["stripe.tax._location_service", "LocationService"], "registrations": [ "stripe.tax._registration_service", "RegistrationService", @@ -29,6 +31,7 @@ class TaxService(StripeService): associations: "AssociationService" calculations: "CalculationService" forms: "FormService" + locations: "LocationService" registrations: "RegistrationService" settings: "SettingsService" transactions: "TransactionService" diff --git a/stripe/params/_invoice_add_lines_params.py b/stripe/params/_invoice_add_lines_params.py index f09efbf2e..b66d23451 100644 --- a/stripe/params/_invoice_add_lines_params.py +++ b/stripe/params/_invoice_add_lines_params.py @@ -198,6 +198,10 @@ class InvoiceAddLinesParamsLinePriceDataProductData(TypedDict): class InvoiceAddLinesParamsLinePriceDataProductDataTaxDetails(TypedDict): + performance_location: NotRequired[str] + """ + A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported. + """ tax_code: str """ A [tax code](https://docs.stripe.com/tax/tax-categories) ID. diff --git a/stripe/params/_invoice_line_item_update_params.py b/stripe/params/_invoice_line_item_update_params.py index 4cb83427b..5986339a3 100644 --- a/stripe/params/_invoice_line_item_update_params.py +++ b/stripe/params/_invoice_line_item_update_params.py @@ -184,6 +184,10 @@ class InvoiceLineItemUpdateParamsPriceDataProductData(TypedDict): class InvoiceLineItemUpdateParamsPriceDataProductDataTaxDetails(TypedDict): + performance_location: NotRequired[str] + """ + A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported. + """ tax_code: str """ A [tax code](https://docs.stripe.com/tax/tax-categories) ID. diff --git a/stripe/params/_invoice_update_lines_params.py b/stripe/params/_invoice_update_lines_params.py index 9ef0a1e27..951fd83d6 100644 --- a/stripe/params/_invoice_update_lines_params.py +++ b/stripe/params/_invoice_update_lines_params.py @@ -202,6 +202,10 @@ class InvoiceUpdateLinesParamsLinePriceDataProductData(TypedDict): class InvoiceUpdateLinesParamsLinePriceDataProductDataTaxDetails(TypedDict): + performance_location: NotRequired[str] + """ + A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported. + """ tax_code: str """ A [tax code](https://docs.stripe.com/tax/tax-categories) ID. diff --git a/stripe/params/_payment_link_create_params.py b/stripe/params/_payment_link_create_params.py index 197762780..07f361c98 100644 --- a/stripe/params/_payment_link_create_params.py +++ b/stripe/params/_payment_link_create_params.py @@ -617,6 +617,10 @@ class PaymentLinkCreateParamsLineItemPriceDataProductData(TypedDict): class PaymentLinkCreateParamsLineItemPriceDataProductDataTaxDetails(TypedDict): + performance_location: NotRequired[str] + """ + A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported. + """ tax_code: str """ A [tax code](https://docs.stripe.com/tax/tax-categories) ID. diff --git a/stripe/params/_plan_create_params.py b/stripe/params/_plan_create_params.py index 2f9f28aa9..a8f2b1368 100644 --- a/stripe/params/_plan_create_params.py +++ b/stripe/params/_plan_create_params.py @@ -115,6 +115,10 @@ class PlanCreateParamsProduct(TypedDict): class PlanCreateParamsProductTaxDetails(TypedDict): + performance_location: NotRequired[str] + """ + A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported. + """ tax_code: str """ A [tax code](https://docs.stripe.com/tax/tax-categories) ID. diff --git a/stripe/params/_price_create_params.py b/stripe/params/_price_create_params.py index c51bd5291..4c676b48b 100644 --- a/stripe/params/_price_create_params.py +++ b/stripe/params/_price_create_params.py @@ -210,6 +210,10 @@ class PriceCreateParamsProductData(TypedDict): class PriceCreateParamsProductDataTaxDetails(TypedDict): + performance_location: NotRequired[str] + """ + A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported. + """ tax_code: str """ A [tax code](https://docs.stripe.com/tax/tax-categories) ID. diff --git a/stripe/params/_product_create_params.py b/stripe/params/_product_create_params.py index 749e36a2e..65fc4c9b7 100644 --- a/stripe/params/_product_create_params.py +++ b/stripe/params/_product_create_params.py @@ -248,6 +248,10 @@ class ProductCreateParamsPackageDimensions(TypedDict): class ProductCreateParamsTaxDetails(TypedDict): + performance_location: NotRequired[str] + """ + A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported. + """ tax_code: str """ A [tax code](https://docs.stripe.com/tax/tax-categories) ID. diff --git a/stripe/params/_product_modify_params.py b/stripe/params/_product_modify_params.py index 6391c4f7c..ed5764efc 100644 --- a/stripe/params/_product_modify_params.py +++ b/stripe/params/_product_modify_params.py @@ -102,6 +102,10 @@ class ProductModifyParamsPackageDimensions(TypedDict): class ProductModifyParamsTaxDetails(TypedDict): + performance_location: NotRequired[str] + """ + A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported. + """ tax_code: str """ A [tax code](https://docs.stripe.com/tax/tax-categories) ID. diff --git a/stripe/params/_product_update_params.py b/stripe/params/_product_update_params.py index 35108f301..b6a533308 100644 --- a/stripe/params/_product_update_params.py +++ b/stripe/params/_product_update_params.py @@ -101,6 +101,10 @@ class ProductUpdateParamsPackageDimensions(TypedDict): class ProductUpdateParamsTaxDetails(TypedDict): + performance_location: NotRequired[str] + """ + A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported. + """ tax_code: str """ A [tax code](https://docs.stripe.com/tax/tax-categories) ID. diff --git a/stripe/params/checkout/_session_create_params.py b/stripe/params/checkout/_session_create_params.py index 5b565925a..3d002fcc3 100644 --- a/stripe/params/checkout/_session_create_params.py +++ b/stripe/params/checkout/_session_create_params.py @@ -995,6 +995,10 @@ class SessionCreateParamsLineItemPriceDataProductData(TypedDict): class SessionCreateParamsLineItemPriceDataProductDataTaxDetails(TypedDict): + performance_location: NotRequired[str] + """ + A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported. + """ tax_code: str """ A [tax code](https://docs.stripe.com/tax/tax-categories) ID. diff --git a/stripe/params/checkout/_session_modify_params.py b/stripe/params/checkout/_session_modify_params.py index 36e78511b..60db6a5fd 100644 --- a/stripe/params/checkout/_session_modify_params.py +++ b/stripe/params/checkout/_session_modify_params.py @@ -303,6 +303,10 @@ class SessionModifyParamsLineItemPriceDataProductData(TypedDict): class SessionModifyParamsLineItemPriceDataProductDataTaxDetails(TypedDict): + performance_location: NotRequired[str] + """ + A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported. + """ tax_code: str """ A [tax code](https://docs.stripe.com/tax/tax-categories) ID. diff --git a/stripe/params/checkout/_session_update_params.py b/stripe/params/checkout/_session_update_params.py index 66432bc3c..ac1f7af47 100644 --- a/stripe/params/checkout/_session_update_params.py +++ b/stripe/params/checkout/_session_update_params.py @@ -302,6 +302,10 @@ class SessionUpdateParamsLineItemPriceDataProductData(TypedDict): class SessionUpdateParamsLineItemPriceDataProductDataTaxDetails(TypedDict): + performance_location: NotRequired[str] + """ + A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported. + """ tax_code: str """ A [tax code](https://docs.stripe.com/tax/tax-categories) ID. diff --git a/stripe/params/tax/__init__.py b/stripe/params/tax/__init__.py index 0db0a9dca..85a1ec8f9 100644 --- a/stripe/params/tax/__init__.py +++ b/stripe/params/tax/__init__.py @@ -36,6 +36,16 @@ from stripe.params.tax._form_retrieve_params import ( FormRetrieveParams as FormRetrieveParams, ) + from stripe.params.tax._location_create_params import ( + LocationCreateParams as LocationCreateParams, + LocationCreateParamsAddress as LocationCreateParamsAddress, + ) + from stripe.params.tax._location_list_params import ( + LocationListParams as LocationListParams, + ) + from stripe.params.tax._location_retrieve_params import ( + LocationRetrieveParams as LocationRetrieveParams, + ) from stripe.params.tax._registration_create_params import ( RegistrationCreateParams as RegistrationCreateParams, RegistrationCreateParamsCountryOptions as RegistrationCreateParamsCountryOptions, @@ -301,6 +311,19 @@ "FormListParamsPayee": ("stripe.params.tax._form_list_params", False), "FormPdfParams": ("stripe.params.tax._form_pdf_params", False), "FormRetrieveParams": ("stripe.params.tax._form_retrieve_params", False), + "LocationCreateParams": ( + "stripe.params.tax._location_create_params", + False, + ), + "LocationCreateParamsAddress": ( + "stripe.params.tax._location_create_params", + False, + ), + "LocationListParams": ("stripe.params.tax._location_list_params", False), + "LocationRetrieveParams": ( + "stripe.params.tax._location_retrieve_params", + False, + ), "RegistrationCreateParams": ( "stripe.params.tax._registration_create_params", False, diff --git a/stripe/params/tax/_calculation_create_params.py b/stripe/params/tax/_calculation_create_params.py index 5f6f71166..5ad00015f 100644 --- a/stripe/params/tax/_calculation_create_params.py +++ b/stripe/params/tax/_calculation_create_params.py @@ -244,6 +244,10 @@ class CalculationCreateParamsLineItem(TypedDict): """ A [tax code](https://docs.stripe.com/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. """ + performance_location: NotRequired[str] + """ + A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported. + """ class CalculationCreateParamsShipFromDetails(TypedDict): diff --git a/stripe/params/tax/_location_create_params.py b/stripe/params/tax/_location_create_params.py new file mode 100644 index 000000000..8aa5abfca --- /dev/null +++ b/stripe/params/tax/_location_create_params.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from stripe._request_options import RequestOptions +from typing import List +from typing_extensions import Literal, NotRequired, TypedDict + + +class LocationCreateParams(RequestOptions): + address: "LocationCreateParamsAddress" + """ + The physical address of the tax location. + """ + description: NotRequired[str] + """ + Details to identify the tax location by its venue, types of events held, or available services, such as "A spacious auditorium suitable for large concerts and events.". + """ + expand: NotRequired[List[str]] + """ + Specifies which fields in the response should be expanded. + """ + type: Literal["performance"] + """ + The type of tax location. The only supported value is "performance". + """ + + +class LocationCreateParamsAddress(TypedDict): + city: NotRequired["Literal['']|str"] + """ + City, district, suburb, town, or village. + """ + country: str + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: NotRequired["Literal['']|str"] + """ + Address line 1, such as the street, PO Box, or company name. + """ + line2: NotRequired["Literal['']|str"] + """ + Address line 2, such as the apartment, suite, unit, or building. + """ + postal_code: NotRequired["Literal['']|str"] + """ + ZIP or postal code. + """ + state: NotRequired["Literal['']|str"] + """ + State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX". + """ diff --git a/stripe/params/tax/_location_list_params.py b/stripe/params/tax/_location_list_params.py new file mode 100644 index 000000000..cbe266706 --- /dev/null +++ b/stripe/params/tax/_location_list_params.py @@ -0,0 +1,28 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from stripe._request_options import RequestOptions +from typing import List +from typing_extensions import Literal, NotRequired + + +class LocationListParams(RequestOptions): + ending_before: NotRequired[str] + """ + A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + """ + expand: NotRequired[List[str]] + """ + Specifies which fields in the response should be expanded. + """ + limit: NotRequired[int] + """ + A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + """ + starting_after: NotRequired[str] + """ + A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + """ + type: Literal["performance"] + """ + Type of the tax location. Currently the only option is `performance`. + """ diff --git a/stripe/params/tax/_location_retrieve_params.py b/stripe/params/tax/_location_retrieve_params.py new file mode 100644 index 000000000..107563bb5 --- /dev/null +++ b/stripe/params/tax/_location_retrieve_params.py @@ -0,0 +1,12 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from stripe._request_options import RequestOptions +from typing import List +from typing_extensions import NotRequired + + +class LocationRetrieveParams(RequestOptions): + expand: NotRequired[List[str]] + """ + Specifies which fields in the response should be expanded. + """ diff --git a/stripe/params/tax/_registration_create_params.py b/stripe/params/tax/_registration_create_params.py index 01e660e14..fc73f649d 100644 --- a/stripe/params/tax/_registration_create_params.py +++ b/stripe/params/tax/_registration_create_params.py @@ -1770,11 +1770,19 @@ class RegistrationCreateParamsCountryOptionsUs(TypedDict): Options for the state sales tax registration. """ type: Literal[ + "admissions_tax", + "attendance_tax", + "entertainment_tax", + "gross_receipts_tax", + "hospitality_tax", "local_amusement_tax", "local_lease_tax", + "luxury_tax", + "resort_tax", "state_communications_tax", "state_retail_delivery_fee", "state_sales_tax", + "tourism_tax", ] """ Type of registration to be created in the US. diff --git a/stripe/tax/__init__.py b/stripe/tax/__init__.py index f820b52f4..43c706c5e 100644 --- a/stripe/tax/__init__.py +++ b/stripe/tax/__init__.py @@ -20,6 +20,8 @@ ) from stripe.tax._form import Form as Form from stripe.tax._form_service import FormService as FormService + from stripe.tax._location import Location as Location + from stripe.tax._location_service import LocationService as LocationService from stripe.tax._registration import Registration as Registration from stripe.tax._registration_service import ( RegistrationService as RegistrationService, @@ -50,6 +52,8 @@ "CalculationService": ("stripe.tax._calculation_service", False), "Form": ("stripe.tax._form", False), "FormService": ("stripe.tax._form_service", False), + "Location": ("stripe.tax._location", False), + "LocationService": ("stripe.tax._location_service", False), "Registration": ("stripe.tax._registration", False), "RegistrationService": ("stripe.tax._registration_service", False), "Settings": ("stripe.tax._settings", False), diff --git a/stripe/tax/_calculation.py b/stripe/tax/_calculation.py index 60239a652..7cc0320f4 100644 --- a/stripe/tax/_calculation.py +++ b/stripe/tax/_calculation.py @@ -264,19 +264,27 @@ class TaxRateDetails(StripeObject): The tax rate percentage as a string. For example, 8.5% is represented as "8.5". """ tax_type: Literal[ + "admissions_tax", "amusement_tax", + "attendance_tax", "communications_tax", + "entertainment_tax", + "gross_receipts_tax", "gst", + "hospitality_tax", "hst", "igst", "jct", "lease_tax", + "luxury_tax", "pst", "qst", + "resort_tax", "retail_delivery_fee", "rst", "sales_tax", "service_tax", + "tourism_tax", "vat", ] """ @@ -288,7 +296,7 @@ class TaxRateDetails(StripeObject): The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ jurisdiction: Jurisdiction - sourcing: Literal["destination", "origin"] + sourcing: Literal["destination", "origin", "performance"] """ Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address). """ @@ -385,19 +393,27 @@ class FlatAmount(StripeObject): """ tax_type: Optional[ Literal[ + "admissions_tax", "amusement_tax", + "attendance_tax", "communications_tax", + "entertainment_tax", + "gross_receipts_tax", "gst", + "hospitality_tax", "hst", "igst", "jct", "lease_tax", + "luxury_tax", "pst", "qst", + "resort_tax", "retail_delivery_fee", "rst", "sales_tax", "service_tax", + "tourism_tax", "vat", ] ] diff --git a/stripe/tax/_calculation_line_item.py b/stripe/tax/_calculation_line_item.py index 702b039e6..ae62748a3 100644 --- a/stripe/tax/_calculation_line_item.py +++ b/stripe/tax/_calculation_line_item.py @@ -39,19 +39,27 @@ class TaxRateDetails(StripeObject): The tax rate percentage as a string. For example, 8.5% is represented as "8.5". """ tax_type: Literal[ + "admissions_tax", "amusement_tax", + "attendance_tax", "communications_tax", + "entertainment_tax", + "gross_receipts_tax", "gst", + "hospitality_tax", "hst", "igst", "jct", "lease_tax", + "luxury_tax", "pst", "qst", + "resort_tax", "retail_delivery_fee", "rst", "sales_tax", "service_tax", + "tourism_tax", "vat", ] """ @@ -63,7 +71,7 @@ class TaxRateDetails(StripeObject): The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ jurisdiction: Jurisdiction - sourcing: Literal["destination", "origin"] + sourcing: Literal["destination", "origin", "performance"] """ Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address). """ @@ -124,6 +132,10 @@ class TaxRateDetails(StripeObject): """ String representing the object's type. Objects of the same type share the same value. """ + performance_location: Optional[str] + """ + A tax location for a line item that acts as a performance location. This indicates that the line item might be taxed at the place where it is being performed at. This is helpful for events or other services being performed at non-customer addresses like venues or offices. This can be left empty for tax codes that do not require a tax location. For tax codes where the location requirement is "optional", this would override the customer address in most use cases. + """ product: Optional[str] """ The ID of an existing [Product](https://docs.stripe.com/api/products/object). diff --git a/stripe/tax/_location.py b/stripe/tax/_location.py new file mode 100644 index 000000000..1fda99425 --- /dev/null +++ b/stripe/tax/_location.py @@ -0,0 +1,172 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from stripe._createable_api_resource import CreateableAPIResource +from stripe._list_object import ListObject +from stripe._listable_api_resource import ListableAPIResource +from stripe._stripe_object import StripeObject +from typing import ClassVar, Optional, cast +from typing_extensions import Literal, Unpack, TYPE_CHECKING + +if TYPE_CHECKING: + from stripe.params.tax._location_create_params import LocationCreateParams + from stripe.params.tax._location_list_params import LocationListParams + from stripe.params.tax._location_retrieve_params import ( + LocationRetrieveParams, + ) + + +class Location( + CreateableAPIResource["Location"], + ListableAPIResource["Location"], +): + """ + Tax locations represent venues for services, tickets, or other product types. + """ + + OBJECT_NAME: ClassVar[Literal["tax.location"]] = "tax.location" + + class Address(StripeObject): + city: Optional[str] + """ + City, district, suburb, town, or village. + """ + country: Optional[str] + """ + Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + """ + line1: Optional[str] + """ + Address line 1, such as the street, PO Box, or company name. + """ + line2: Optional[str] + """ + Address line 2, such as the apartment, suite, unit, or building. + """ + postal_code: Optional[str] + """ + ZIP or postal code. + """ + state: Optional[str] + """ + State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). + """ + + address: Address + description: Optional[str] + """ + A descriptive text providing additional context about the tax location. This can include information about the venue, types of events held, services available, or any relevant details for better identification (e.g., "A spacious auditorium suitable for large concerts and events."). + """ + id: str + """ + Unique identifier for the object. + """ + object: Literal["tax.location"] + """ + String representing the object's type. Objects of the same type share the same value. + """ + type: Literal["performance"] + """ + The type of tax location to be defined. Currently the only option is `performance`. + """ + + @classmethod + def create(cls, **params: Unpack["LocationCreateParams"]) -> "Location": + """ + Create a tax location to use in calculating taxes for a service, ticket, or other type of product. The resulting object contains the id, address, name, description, and current operational status of the tax location. + """ + return cast( + "Location", + cls._static_request( + "post", + cls.class_url(), + params=params, + ), + ) + + @classmethod + async def create_async( + cls, **params: Unpack["LocationCreateParams"] + ) -> "Location": + """ + Create a tax location to use in calculating taxes for a service, ticket, or other type of product. The resulting object contains the id, address, name, description, and current operational status of the tax location. + """ + return cast( + "Location", + await cls._static_request_async( + "post", + cls.class_url(), + params=params, + ), + ) + + @classmethod + def list( + cls, **params: Unpack["LocationListParams"] + ) -> ListObject["Location"]: + """ + Retrieve a list of all tax locations. Tax locations can represent the venues for services, tickets, or other product types. + + The response includes detailed information for each tax location, such as its address, name, description, and current operational status. + + You can paginate through the list by using the limit parameter to control the number of results returned in each request. + """ + result = cls._static_request( + "get", + cls.class_url(), + params=params, + ) + if not isinstance(result, ListObject): + raise TypeError( + "Expected list object from API, got %s" + % (type(result).__name__) + ) + + return result + + @classmethod + async def list_async( + cls, **params: Unpack["LocationListParams"] + ) -> ListObject["Location"]: + """ + Retrieve a list of all tax locations. Tax locations can represent the venues for services, tickets, or other product types. + + The response includes detailed information for each tax location, such as its address, name, description, and current operational status. + + You can paginate through the list by using the limit parameter to control the number of results returned in each request. + """ + result = await cls._static_request_async( + "get", + cls.class_url(), + params=params, + ) + if not isinstance(result, ListObject): + raise TypeError( + "Expected list object from API, got %s" + % (type(result).__name__) + ) + + return result + + @classmethod + def retrieve( + cls, id: str, **params: Unpack["LocationRetrieveParams"] + ) -> "Location": + """ + Fetch the details of a specific tax location using its unique identifier. Use a tax location to calculate taxes based on the location of the end product, such as a performance, instead of the customer address. For more details, check the [integration guide](https://docs.stripe.com/tax/tax-for-tickets/integration-guide). + """ + instance = cls(id, **params) + instance.refresh() + return instance + + @classmethod + async def retrieve_async( + cls, id: str, **params: Unpack["LocationRetrieveParams"] + ) -> "Location": + """ + Fetch the details of a specific tax location using its unique identifier. Use a tax location to calculate taxes based on the location of the end product, such as a performance, instead of the customer address. For more details, check the [integration guide](https://docs.stripe.com/tax/tax-for-tickets/integration-guide). + """ + instance = cls(id, **params) + await instance.refresh_async() + return instance + + _inner_class_types = {"address": Address} diff --git a/stripe/tax/_location_service.py b/stripe/tax/_location_service.py new file mode 100644 index 000000000..3d33322b7 --- /dev/null +++ b/stripe/tax/_location_service.py @@ -0,0 +1,146 @@ +# -*- coding: utf-8 -*- +# File generated from our OpenAPI spec +from stripe._stripe_service import StripeService +from stripe._util import sanitize_id +from typing import Optional, cast +from typing_extensions import TYPE_CHECKING + +if TYPE_CHECKING: + from stripe._list_object import ListObject + from stripe._request_options import RequestOptions + from stripe.params.tax._location_create_params import LocationCreateParams + from stripe.params.tax._location_list_params import LocationListParams + from stripe.params.tax._location_retrieve_params import ( + LocationRetrieveParams, + ) + from stripe.tax._location import Location + + +class LocationService(StripeService): + def list( + self, + params: "LocationListParams", + options: Optional["RequestOptions"] = None, + ) -> "ListObject[Location]": + """ + Retrieve a list of all tax locations. Tax locations can represent the venues for services, tickets, or other product types. + + The response includes detailed information for each tax location, such as its address, name, description, and current operational status. + + You can paginate through the list by using the limit parameter to control the number of results returned in each request. + """ + return cast( + "ListObject[Location]", + self._request( + "get", + "/v1/tax/locations", + base_address="api", + params=params, + options=options, + ), + ) + + async def list_async( + self, + params: "LocationListParams", + options: Optional["RequestOptions"] = None, + ) -> "ListObject[Location]": + """ + Retrieve a list of all tax locations. Tax locations can represent the venues for services, tickets, or other product types. + + The response includes detailed information for each tax location, such as its address, name, description, and current operational status. + + You can paginate through the list by using the limit parameter to control the number of results returned in each request. + """ + return cast( + "ListObject[Location]", + await self._request_async( + "get", + "/v1/tax/locations", + base_address="api", + params=params, + options=options, + ), + ) + + def create( + self, + params: "LocationCreateParams", + options: Optional["RequestOptions"] = None, + ) -> "Location": + """ + Create a tax location to use in calculating taxes for a service, ticket, or other type of product. The resulting object contains the id, address, name, description, and current operational status of the tax location. + """ + return cast( + "Location", + self._request( + "post", + "/v1/tax/locations", + base_address="api", + params=params, + options=options, + ), + ) + + async def create_async( + self, + params: "LocationCreateParams", + options: Optional["RequestOptions"] = None, + ) -> "Location": + """ + Create a tax location to use in calculating taxes for a service, ticket, or other type of product. The resulting object contains the id, address, name, description, and current operational status of the tax location. + """ + return cast( + "Location", + await self._request_async( + "post", + "/v1/tax/locations", + base_address="api", + params=params, + options=options, + ), + ) + + def retrieve( + self, + location: str, + params: Optional["LocationRetrieveParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "Location": + """ + Fetch the details of a specific tax location using its unique identifier. Use a tax location to calculate taxes based on the location of the end product, such as a performance, instead of the customer address. For more details, check the [integration guide](https://docs.stripe.com/tax/tax-for-tickets/integration-guide). + """ + return cast( + "Location", + self._request( + "get", + "/v1/tax/locations/{location}".format( + location=sanitize_id(location), + ), + base_address="api", + params=params, + options=options, + ), + ) + + async def retrieve_async( + self, + location: str, + params: Optional["LocationRetrieveParams"] = None, + options: Optional["RequestOptions"] = None, + ) -> "Location": + """ + Fetch the details of a specific tax location using its unique identifier. Use a tax location to calculate taxes based on the location of the end product, such as a performance, instead of the customer address. For more details, check the [integration guide](https://docs.stripe.com/tax/tax-for-tickets/integration-guide). + """ + return cast( + "Location", + await self._request_async( + "get", + "/v1/tax/locations/{location}".format( + location=sanitize_id(location), + ), + base_address="api", + params=params, + options=options, + ), + ) diff --git a/stripe/tax/_registration.py b/stripe/tax/_registration.py index 328747a08..a157f9358 100644 --- a/stripe/tax/_registration.py +++ b/stripe/tax/_registration.py @@ -941,6 +941,36 @@ class Ug(StripeObject): """ class Us(StripeObject): + class AdmissionsTax(StripeObject): + jurisdiction: str + """ + A [jurisdiction code](https://docs.stripe.com/tax/registering?type=admissions_tax#registration-types) representing the local jurisdiction. + """ + + class AttendanceTax(StripeObject): + jurisdiction: str + """ + A [jurisdiction code](https://docs.stripe.com/tax/registering?type=attendance_tax#registration-types) representing the local jurisdiction. + """ + + class EntertainmentTax(StripeObject): + jurisdiction: str + """ + A [jurisdiction code](https://docs.stripe.com/tax/registering?type=entertainment_tax#registration-types) representing the local jurisdiction. + """ + + class GrossReceiptsTax(StripeObject): + jurisdiction: str + """ + A [jurisdiction code](https://docs.stripe.com/tax/registering?type=gross_receipts_tax#registration-types) representing the local jurisdiction. + """ + + class HospitalityTax(StripeObject): + jurisdiction: str + """ + A [jurisdiction code](https://docs.stripe.com/tax/registering?type=hospitality_tax#registration-types) representing the local jurisdiction. + """ + class LocalAmusementTax(StripeObject): jurisdiction: str """ @@ -953,6 +983,18 @@ class LocalLeaseTax(StripeObject): A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. """ + class LuxuryTax(StripeObject): + jurisdiction: str + """ + A [jurisdiction code](https://docs.stripe.com/tax/registering?type=luxury_tax#registration-types) representing the local jurisdiction. + """ + + class ResortTax(StripeObject): + jurisdiction: str + """ + A [jurisdiction code](https://docs.stripe.com/tax/registering?type=resort_tax#registration-types) representing the local jurisdiction. + """ + class StateSalesTax(StripeObject): class Election(StripeObject): jurisdiction: Optional[str] @@ -974,27 +1016,57 @@ class Election(StripeObject): """ _inner_class_types = {"elections": Election} + class TourismTax(StripeObject): + jurisdiction: str + """ + A [jurisdiction code](https://docs.stripe.com/tax/registering?type=tourism_tax#registration-types) representing the local jurisdiction. + """ + + admissions_tax: Optional[AdmissionsTax] + attendance_tax: Optional[AttendanceTax] + entertainment_tax: Optional[EntertainmentTax] + gross_receipts_tax: Optional[GrossReceiptsTax] + hospitality_tax: Optional[HospitalityTax] local_amusement_tax: Optional[LocalAmusementTax] local_lease_tax: Optional[LocalLeaseTax] + luxury_tax: Optional[LuxuryTax] + resort_tax: Optional[ResortTax] state: str """ Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). """ state_sales_tax: Optional[StateSalesTax] + tourism_tax: Optional[TourismTax] type: Literal[ + "admissions_tax", + "attendance_tax", + "entertainment_tax", + "gross_receipts_tax", + "hospitality_tax", "local_amusement_tax", "local_lease_tax", + "luxury_tax", + "resort_tax", "state_communications_tax", "state_retail_delivery_fee", "state_sales_tax", + "tourism_tax", ] """ Type of registration in the US. """ _inner_class_types = { + "admissions_tax": AdmissionsTax, + "attendance_tax": AttendanceTax, + "entertainment_tax": EntertainmentTax, + "gross_receipts_tax": GrossReceiptsTax, + "hospitality_tax": HospitalityTax, "local_amusement_tax": LocalAmusementTax, "local_lease_tax": LocalLeaseTax, + "luxury_tax": LuxuryTax, + "resort_tax": ResortTax, "state_sales_tax": StateSalesTax, + "tourism_tax": TourismTax, } class Uy(StripeObject): diff --git a/stripe/tax/_transaction.py b/stripe/tax/_transaction.py index d76506217..3a16f4abc 100644 --- a/stripe/tax/_transaction.py +++ b/stripe/tax/_transaction.py @@ -273,19 +273,27 @@ class TaxRateDetails(StripeObject): The tax rate percentage as a string. For example, 8.5% is represented as "8.5". """ tax_type: Literal[ + "admissions_tax", "amusement_tax", + "attendance_tax", "communications_tax", + "entertainment_tax", + "gross_receipts_tax", "gst", + "hospitality_tax", "hst", "igst", "jct", "lease_tax", + "luxury_tax", "pst", "qst", + "resort_tax", "retail_delivery_fee", "rst", "sales_tax", "service_tax", + "tourism_tax", "vat", ] """ @@ -297,7 +305,7 @@ class TaxRateDetails(StripeObject): The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). """ jurisdiction: Jurisdiction - sourcing: Literal["destination", "origin"] + sourcing: Literal["destination", "origin", "performance"] """ Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address). """