diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 7044b5abcd..3dfb688b80 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v911 \ No newline at end of file +v932 \ No newline at end of file diff --git a/test/resources/generated_examples_test.spec.js b/test/resources/generated_examples_test.spec.js index 81b15c7ce8..c95afc1a2b 100644 --- a/test/resources/generated_examples_test.spec.js +++ b/test/resources/generated_examples_test.spec.js @@ -176,7 +176,7 @@ describe('Generated tests', function() { method: 'GET', path: '/v1/accounts/acc_123', response: - '{"business_profile":{"annual_revenue":{"amount":1413853096,"currency":"currency","fiscal_year_end":"fiscal_year_end"},"estimated_worker_count":884794319,"mcc":"mcc","monthly_estimated_revenue":{"amount":1413853096,"currency":"currency"},"name":"name","product_description":"product_description","support_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"support_email":"support_email","support_phone":"support_phone","support_url":"support_url","url":"url"},"business_type":"government_entity","capabilities":{"acss_debit_payments":"inactive","affirm_payments":"pending","afterpay_clearpay_payments":"inactive","amazon_pay_payments":"inactive","au_becs_debit_payments":"active","bacs_debit_payments":"active","bancontact_payments":"inactive","bank_transfer_payments":"pending","blik_payments":"inactive","boleto_payments":"inactive","card_issuing":"active","card_payments":"active","cartes_bancaires_payments":"active","cashapp_payments":"active","eps_payments":"inactive","fpx_payments":"active","giropay_payments":"active","grabpay_payments":"pending","ideal_payments":"inactive","india_international_payments":"inactive","jcb_payments":"inactive","klarna_payments":"active","konbini_payments":"active","legacy_payments":"active","link_payments":"inactive","mobilepay_payments":"pending","oxxo_payments":"pending","p24_payments":"inactive","paynow_payments":"active","promptpay_payments":"active","revolut_pay_payments":"inactive","sepa_debit_payments":"inactive","sofort_payments":"active","swish_payments":"inactive","tax_reporting_us_1099_k":"inactive","tax_reporting_us_1099_misc":"pending","transfers":"inactive","treasury":"pending","us_bank_account_ach_payments":"pending","zip_payments":"pending"},"charges_enabled":true,"company":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"address_kana":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"address_kanji":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"directors_provided":true,"executives_provided":true,"export_license_id":"export_license_id","export_purpose_code":"export_purpose_code","name":"name","name_kana":"name_kana","name_kanji":"name_kanji","owners_provided":true,"ownership_declaration":{"date":"3076014","ip":"ip","user_agent":"user_agent"},"phone":"phone","structure":"single_member_llc","tax_id_provided":true,"tax_id_registrar":"tax_id_registrar","vat_id_provided":true,"verification":{"document":{"back":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"details":"details","details_code":"details_code","front":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"}}}},"controller":{"is_controller":true,"type":"account"},"country":"country","created":"1028554472","default_currency":"default_currency","details_submitted":true,"email":"email","external_accounts":null,"future_requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"current_deadline":"270965154","currently_due":["currently_due"],"disabled_reason":"disabled_reason","errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"id":"obj_123","individual":{"account":"account","additional_tos_acceptances":{"account":{"date":"3076014","ip":"ip","user_agent":"user_agent"}},"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"address_kana":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"address_kanji":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"created":"1028554472","dob":{"day":99228,"month":104080000,"year":3704893},"email":"email","first_name":"first_name","first_name_kana":"first_name_kana","first_name_kanji":"first_name_kanji","full_name_aliases":["full_name_aliases"],"future_requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"currently_due":["currently_due"],"errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"gender":"gender","id":"obj_123","id_number_provided":true,"id_number_secondary_provided":true,"last_name":"last_name","last_name_kana":"last_name_kana","last_name_kanji":"last_name_kanji","maiden_name":"maiden_name","metadata":{"undefined":"metadata"},"nationality":"nationality","object":"person","phone":"phone","political_exposure":"none","registered_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"relationship":{"director":true,"executive":true,"legal_guardian":true,"owner":true,"percent_ownership":760989685,"representative":true,"title":"title"},"requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"currently_due":["currently_due"],"errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"ssn_last_4_provided":true,"verification":{"additional_document":{"back":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"details":"details","details_code":"details_code","front":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"}},"details":"details","details_code":"details_code","document":{"back":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"details":"details","details_code":"details_code","front":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"}},"status":"status"}},"metadata":{"undefined":"metadata"},"object":"account","payouts_enabled":true,"requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"current_deadline":"270965154","currently_due":["currently_due"],"disabled_reason":"disabled_reason","errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"settings":{"bacs_debit_payments":{"display_name":"display_name","service_user_number":"service_user_number"},"branding":{"icon":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"logo":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"primary_color":"primary_color","secondary_color":"secondary_color"},"card_issuing":{"tos_acceptance":{"date":3076014,"ip":"ip","user_agent":"user_agent"}},"card_payments":{"decline_on":{"avs_failure":true,"cvc_failure":true},"statement_descriptor_prefix":"statement_descriptor_prefix","statement_descriptor_prefix_kana":"statement_descriptor_prefix_kana","statement_descriptor_prefix_kanji":"statement_descriptor_prefix_kanji"},"dashboard":{"display_name":"display_name","timezone":"timezone"},"invoices":{"default_account_tax_ids":[{"country":"country","created":"1028554472","customer":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"balance":339185956,"cash_balance":{"available":{"undefined":733902135},"customer":"customer","livemode":true,"object":"cash_balance","settings":{"reconciliation_mode":"manual","using_merchant_default":true}},"created":"1028554472","currency":"currency","default_source":null,"delinquent":true,"description":"description","discount":{"checkout_session":"checkout_session","coupon":null,"customer":null,"end":"100571","id":"obj_123","invoice":"invoice","invoice_item":"invoice_item","object":"discount","promotion_code":null,"start":"109757538","subscription":"subscription"},"email":"email","id":"obj_123","invoice_credit_balance":{"undefined":1267696360},"invoice_prefix":"invoice_prefix","invoice_settings":{"custom_fields":[{"name":"name","value":"value"}],"default_payment_method":{"acss_debit":{"bank_name":"bank_name","fingerprint":"fingerprint","institution_number":"institution_number","last4":"last4","transit_number":"transit_number"},"affirm":{},"afterpay_clearpay":{},"alipay":{},"au_becs_debit":{"bsb_number":"bsb_number","fingerprint":"fingerprint","last4":"last4"},"bacs_debit":{"fingerprint":"fingerprint","last4":"last4","sort_code":"sort_code"},"bancontact":{},"billing_details":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"email":"email","name":"name","phone":"phone"},"blik":{},"boleto":{"tax_id":"tax_id"},"card":{"brand":"brand","checks":{"address_line1_check":"address_line1_check","address_postal_code_check":"address_postal_code_check","cvc_check":"cvc_check"},"country":"country","description":"description","display_brand":"display_brand","exp_month":40417826,"exp_year":1940618977,"fingerprint":"fingerprint","funding":"funding","iin":"iin","issuer":"issuer","last4":"last4","networks":{"available":["available"],"preferred":"preferred"},"three_d_secure_usage":{"supported":true},"wallet":{"amex_express_checkout":{},"apple_pay":{},"dynamic_last4":"dynamic_last4","google_pay":{},"link":{},"masterpass":{"billing_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"email":"email","name":"name","shipping_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"}},"samsung_pay":{},"type":"link","visa_checkout":{"billing_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"email":"email","name":"name","shipping_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"}}}},"card_present":{"brand":"brand","cardholder_name":"cardholder_name","country":"country","description":"description","exp_month":40417826,"exp_year":1940618977,"fingerprint":"fingerprint","funding":"funding","iin":"iin","issuer":"issuer","last4":"last4","networks":{"available":["available"],"preferred":"preferred"},"read_method":"magnetic_stripe_track2"},"cashapp":{"buyer_id":"buyer_id","cashtag":"cashtag"},"created":"1028554472","customer":null,"customer_balance":{},"eps":{"bank":"btv_vier_lander_bank"},"fpx":{"account_holder_type":"individual","bank":"bsn"},"giropay":{},"grabpay":{},"id":"obj_123","ideal":{"bank":"sns_bank","bic":"BUNQNL2A"},"interac_present":{"brand":"brand","cardholder_name":"cardholder_name","country":"country","description":"description","exp_month":40417826,"exp_year":1940618977,"fingerprint":"fingerprint","funding":"funding","iin":"iin","issuer":"issuer","last4":"last4","networks":{"available":["available"],"preferred":"preferred"},"preferred_locales":["preferred_locales"],"read_method":"magnetic_stripe_track2"},"klarna":{"dob":{"day":99228,"month":104080000,"year":3704893}},"konbini":{},"link":{"email":"email","persistent_token":"persistent_token"},"livemode":true,"metadata":{"undefined":"metadata"},"mobilepay":{},"object":"payment_method","oxxo":{},"p24":{"bank":"noble_pay"},"paynow":{},"paypal":{"payer_email":"payer_email","payer_id":"payer_id"},"pix":{},"promptpay":{},"radar_options":{"session":"session"},"revolut_pay":{},"sepa_debit":{"bank_code":"bank_code","branch_code":"branch_code","country":"country","fingerprint":"fingerprint","generated_from":{"charge":null,"setup_attempt":null},"last4":"last4"},"sofort":{"country":"country"},"swish":{},"type":"interac_present","us_bank_account":{"account_holder_type":"individual","account_type":"checking","bank_name":"bank_name","financial_connections_account":"financial_connections_account","fingerprint":"fingerprint","last4":"last4","networks":{"preferred":"preferred","supported":["ach"]},"routing_number":"routing_number","status_details":{"blocked":{"network_code":"R29","reason":"bank_account_unusable"}}},"wechat_pay":{},"zip":{}},"footer":"footer","rendering_options":{"amount_tax_display":"amount_tax_display"}},"livemode":true,"metadata":{"undefined":"metadata"},"name":"name","next_invoice_sequence":1356358751,"object":"customer","phone":"phone","preferred_locales":["preferred_locales"],"shipping":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"carrier":"carrier","name":"name","phone":"phone","tracking_number":"tracking_number"},"sources":null,"subscriptions":null,"tax":{"automatic_tax":"unrecognized_location","ip_address":"ip_address","location":{"country":"country","source":"ip_address","state":"state"}},"tax_exempt":"reverse","tax_ids":null,"test_clock":{"created":"1028554472","deletes_after":"73213179","frozen_time":"2033541876","id":"obj_123","livemode":true,"name":"name","object":"test_helpers.test_clock","status":"advancing"}},"id":"obj_123","livemode":true,"object":"tax_id","owner":{"account":{"business_profile":{"annual_revenue":{"amount":1413853096,"currency":"currency","fiscal_year_end":"fiscal_year_end"},"estimated_worker_count":884794319,"mcc":"mcc","monthly_estimated_revenue":{"amount":1413853096,"currency":"currency"},"name":"name","product_description":"product_description","support_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"support_email":"support_email","support_phone":"support_phone","support_url":"support_url","url":"url"},"business_type":"government_entity","capabilities":{"acss_debit_payments":"inactive","affirm_payments":"pending","afterpay_clearpay_payments":"inactive","amazon_pay_payments":"inactive","au_becs_debit_payments":"active","bacs_debit_payments":"active","bancontact_payments":"inactive","bank_transfer_payments":"pending","blik_payments":"inactive","boleto_payments":"inactive","card_issuing":"active","card_payments":"active","cartes_bancaires_payments":"active","cashapp_payments":"active","eps_payments":"inactive","fpx_payments":"active","giropay_payments":"active","grabpay_payments":"pending","ideal_payments":"inactive","india_international_payments":"inactive","jcb_payments":"inactive","klarna_payments":"active","konbini_payments":"active","legacy_payments":"active","link_payments":"inactive","mobilepay_payments":"pending","oxxo_payments":"pending","p24_payments":"inactive","paynow_payments":"active","promptpay_payments":"active","revolut_pay_payments":"inactive","sepa_debit_payments":"inactive","sofort_payments":"active","swish_payments":"inactive","tax_reporting_us_1099_k":"inactive","tax_reporting_us_1099_misc":"pending","transfers":"inactive","treasury":"pending","us_bank_account_ach_payments":"pending","zip_payments":"pending"},"charges_enabled":true,"company":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"address_kana":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"address_kanji":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"directors_provided":true,"executives_provided":true,"export_license_id":"export_license_id","export_purpose_code":"export_purpose_code","name":"name","name_kana":"name_kana","name_kanji":"name_kanji","owners_provided":true,"ownership_declaration":{"date":"3076014","ip":"ip","user_agent":"user_agent"},"phone":"phone","structure":"single_member_llc","tax_id_provided":true,"tax_id_registrar":"tax_id_registrar","vat_id_provided":true,"verification":{"document":{"back":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"details":"details","details_code":"details_code","front":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"}}}},"controller":{"is_controller":true,"type":"account"},"country":"country","created":"1028554472","default_currency":"default_currency","details_submitted":true,"email":"email","external_accounts":null,"future_requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"current_deadline":"270965154","currently_due":["currently_due"],"disabled_reason":"disabled_reason","errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"id":"obj_123","individual":{"account":"account","additional_tos_acceptances":{"account":{"date":"3076014","ip":"ip","user_agent":"user_agent"}},"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"address_kana":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"address_kanji":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"created":"1028554472","dob":{"day":99228,"month":104080000,"year":3704893},"email":"email","first_name":"first_name","first_name_kana":"first_name_kana","first_name_kanji":"first_name_kanji","full_name_aliases":["full_name_aliases"],"future_requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"currently_due":["currently_due"],"errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"gender":"gender","id":"obj_123","id_number_provided":true,"id_number_secondary_provided":true,"last_name":"last_name","last_name_kana":"last_name_kana","last_name_kanji":"last_name_kanji","maiden_name":"maiden_name","metadata":{"undefined":"metadata"},"nationality":"nationality","object":"person","phone":"phone","political_exposure":"none","registered_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"relationship":{"director":true,"executive":true,"legal_guardian":true,"owner":true,"percent_ownership":760989685,"representative":true,"title":"title"},"requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"currently_due":["currently_due"],"errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"ssn_last_4_provided":true,"verification":{"additional_document":{"back":null,"details":"details","details_code":"details_code","front":null},"details":"details","details_code":"details_code","document":{"back":null,"details":"details","details_code":"details_code","front":null},"status":"status"}},"metadata":{"undefined":"metadata"},"object":"account","payouts_enabled":true,"requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"current_deadline":"270965154","currently_due":["currently_due"],"disabled_reason":"disabled_reason","errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"settings":{"bacs_debit_payments":{"display_name":"display_name","service_user_number":"service_user_number"},"branding":{"icon":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"logo":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"primary_color":"primary_color","secondary_color":"secondary_color"},"card_issuing":{"tos_acceptance":{"date":3076014,"ip":"ip","user_agent":"user_agent"}},"card_payments":{"decline_on":{"avs_failure":true,"cvc_failure":true},"statement_descriptor_prefix":"statement_descriptor_prefix","statement_descriptor_prefix_kana":"statement_descriptor_prefix_kana","statement_descriptor_prefix_kanji":"statement_descriptor_prefix_kanji"},"dashboard":{"display_name":"display_name","timezone":"timezone"},"invoices":{"default_account_tax_ids":[{"country":"country","created":"1028554472","customer":null,"id":"obj_123","livemode":true,"object":"tax_id","owner":{"account":null,"application":null,"customer":null,"type":"customer"},"type":"jp_cn","value":"value","verification":{"status":"unverified","verified_address":"verified_address","verified_name":"verified_name"}}]},"payments":{"statement_descriptor":"statement_descriptor","statement_descriptor_kana":"statement_descriptor_kana","statement_descriptor_kanji":"statement_descriptor_kanji","statement_descriptor_prefix_kana":"statement_descriptor_prefix_kana","statement_descriptor_prefix_kanji":"statement_descriptor_prefix_kanji"},"payouts":{"debit_negative_balances":true,"schedule":{"delay_days":1647351405,"interval":"interval","monthly_anchor":1920305369,"weekly_anchor":"weekly_anchor"},"statement_descriptor":"statement_descriptor"},"sepa_debit_payments":{"creditor_id":"creditor_id"},"treasury":{"tos_acceptance":{"date":3076014,"ip":"ip","user_agent":"user_agent"}}},"tos_acceptance":{"date":"3076014","ip":"ip","service_agreement":"service_agreement","user_agent":"user_agent"},"type":"custom"},"application":{"id":"obj_123","name":"name","object":"application"},"customer":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"balance":339185956,"cash_balance":{"available":{"undefined":733902135},"customer":"customer","livemode":true,"object":"cash_balance","settings":{"reconciliation_mode":"manual","using_merchant_default":true}},"created":"1028554472","currency":"currency","default_source":null,"delinquent":true,"description":"description","discount":{"checkout_session":"checkout_session","coupon":null,"customer":null,"end":"100571","id":"obj_123","invoice":"invoice","invoice_item":"invoice_item","object":"discount","promotion_code":null,"start":"109757538","subscription":"subscription"},"email":"email","id":"obj_123","invoice_credit_balance":{"undefined":1267696360},"invoice_prefix":"invoice_prefix","invoice_settings":{"custom_fields":[{"name":"name","value":"value"}],"default_payment_method":{"acss_debit":{"bank_name":"bank_name","fingerprint":"fingerprint","institution_number":"institution_number","last4":"last4","transit_number":"transit_number"},"affirm":{},"afterpay_clearpay":{},"alipay":{},"au_becs_debit":{"bsb_number":"bsb_number","fingerprint":"fingerprint","last4":"last4"},"bacs_debit":{"fingerprint":"fingerprint","last4":"last4","sort_code":"sort_code"},"bancontact":{},"billing_details":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"email":"email","name":"name","phone":"phone"},"blik":{},"boleto":{"tax_id":"tax_id"},"card":{"brand":"brand","checks":{"address_line1_check":"address_line1_check","address_postal_code_check":"address_postal_code_check","cvc_check":"cvc_check"},"country":"country","description":"description","display_brand":"display_brand","exp_month":40417826,"exp_year":1940618977,"fingerprint":"fingerprint","funding":"funding","iin":"iin","issuer":"issuer","last4":"last4","networks":{"available":["available"],"preferred":"preferred"},"three_d_secure_usage":{"supported":true},"wallet":{"amex_express_checkout":{},"apple_pay":{},"dynamic_last4":"dynamic_last4","google_pay":{},"link":{},"masterpass":{"billing_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"email":"email","name":"name","shipping_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"}},"samsung_pay":{},"type":"link","visa_checkout":{"billing_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"email":"email","name":"name","shipping_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"}}}},"card_present":{"brand":"brand","cardholder_name":"cardholder_name","country":"country","description":"description","exp_month":40417826,"exp_year":1940618977,"fingerprint":"fingerprint","funding":"funding","iin":"iin","issuer":"issuer","last4":"last4","networks":{"available":["available"],"preferred":"preferred"},"read_method":"magnetic_stripe_track2"},"cashapp":{"buyer_id":"buyer_id","cashtag":"cashtag"},"created":"1028554472","customer":null,"customer_balance":{},"eps":{"bank":"btv_vier_lander_bank"},"fpx":{"account_holder_type":"individual","bank":"bsn"},"giropay":{},"grabpay":{},"id":"obj_123","ideal":{"bank":"sns_bank","bic":"BUNQNL2A"},"interac_present":{"brand":"brand","cardholder_name":"cardholder_name","country":"country","description":"description","exp_month":40417826,"exp_year":1940618977,"fingerprint":"fingerprint","funding":"funding","iin":"iin","issuer":"issuer","last4":"last4","networks":{"available":["available"],"preferred":"preferred"},"preferred_locales":["preferred_locales"],"read_method":"magnetic_stripe_track2"},"klarna":{"dob":{"day":99228,"month":104080000,"year":3704893}},"konbini":{},"link":{"email":"email","persistent_token":"persistent_token"},"livemode":true,"metadata":{"undefined":"metadata"},"mobilepay":{},"object":"payment_method","oxxo":{},"p24":{"bank":"noble_pay"},"paynow":{},"paypal":{"payer_email":"payer_email","payer_id":"payer_id"},"pix":{},"promptpay":{},"radar_options":{"session":"session"},"revolut_pay":{},"sepa_debit":{"bank_code":"bank_code","branch_code":"branch_code","country":"country","fingerprint":"fingerprint","generated_from":{"charge":null,"setup_attempt":null},"last4":"last4"},"sofort":{"country":"country"},"swish":{},"type":"interac_present","us_bank_account":{"account_holder_type":"individual","account_type":"checking","bank_name":"bank_name","financial_connections_account":"financial_connections_account","fingerprint":"fingerprint","last4":"last4","networks":{"preferred":"preferred","supported":["ach"]},"routing_number":"routing_number","status_details":{"blocked":{"network_code":"R29","reason":"bank_account_unusable"}}},"wechat_pay":{},"zip":{}},"footer":"footer","rendering_options":{"amount_tax_display":"amount_tax_display"}},"livemode":true,"metadata":{"undefined":"metadata"},"name":"name","next_invoice_sequence":1356358751,"object":"customer","phone":"phone","preferred_locales":["preferred_locales"],"shipping":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"carrier":"carrier","name":"name","phone":"phone","tracking_number":"tracking_number"},"sources":null,"subscriptions":null,"tax":{"automatic_tax":"unrecognized_location","ip_address":"ip_address","location":{"country":"country","source":"ip_address","state":"state"}},"tax_exempt":"reverse","tax_ids":null,"test_clock":{"created":"1028554472","deletes_after":"73213179","frozen_time":"2033541876","id":"obj_123","livemode":true,"name":"name","object":"test_helpers.test_clock","status":"advancing"}},"type":"customer"},"type":"jp_cn","value":"value","verification":{"status":"unverified","verified_address":"verified_address","verified_name":"verified_name"}}]},"payments":{"statement_descriptor":"statement_descriptor","statement_descriptor_kana":"statement_descriptor_kana","statement_descriptor_kanji":"statement_descriptor_kanji","statement_descriptor_prefix_kana":"statement_descriptor_prefix_kana","statement_descriptor_prefix_kanji":"statement_descriptor_prefix_kanji"},"payouts":{"debit_negative_balances":true,"schedule":{"delay_days":1647351405,"interval":"interval","monthly_anchor":1920305369,"weekly_anchor":"weekly_anchor"},"statement_descriptor":"statement_descriptor"},"sepa_debit_payments":{"creditor_id":"creditor_id"},"treasury":{"tos_acceptance":{"date":3076014,"ip":"ip","user_agent":"user_agent"}}},"tos_acceptance":{"date":"3076014","ip":"ip","service_agreement":"service_agreement","user_agent":"user_agent"},"type":"custom"}', + '{"business_profile":{"annual_revenue":{"amount":1413853096,"currency":"currency","fiscal_year_end":"fiscal_year_end"},"estimated_worker_count":884794319,"mcc":"mcc","monthly_estimated_revenue":{"amount":1413853096,"currency":"currency"},"name":"name","product_description":"product_description","support_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"support_email":"support_email","support_phone":"support_phone","support_url":"support_url","url":"url"},"business_type":"government_entity","capabilities":{"acss_debit_payments":"inactive","affirm_payments":"pending","afterpay_clearpay_payments":"inactive","amazon_pay_payments":"inactive","au_becs_debit_payments":"active","bacs_debit_payments":"active","bancontact_payments":"inactive","bank_transfer_payments":"pending","blik_payments":"inactive","boleto_payments":"inactive","card_issuing":"active","card_payments":"active","cartes_bancaires_payments":"active","cashapp_payments":"active","eps_payments":"inactive","fpx_payments":"active","giropay_payments":"active","grabpay_payments":"pending","ideal_payments":"inactive","india_international_payments":"inactive","jcb_payments":"inactive","klarna_payments":"active","konbini_payments":"active","legacy_payments":"active","link_payments":"inactive","mobilepay_payments":"pending","oxxo_payments":"pending","p24_payments":"inactive","paynow_payments":"active","promptpay_payments":"active","revolut_pay_payments":"inactive","sepa_debit_payments":"inactive","sofort_payments":"active","swish_payments":"inactive","tax_reporting_us_1099_k":"inactive","tax_reporting_us_1099_misc":"pending","transfers":"inactive","treasury":"pending","us_bank_account_ach_payments":"pending","zip_payments":"pending"},"charges_enabled":true,"company":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"address_kana":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"address_kanji":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"directors_provided":true,"executives_provided":true,"export_license_id":"export_license_id","export_purpose_code":"export_purpose_code","name":"name","name_kana":"name_kana","name_kanji":"name_kanji","owners_provided":true,"ownership_declaration":{"date":"3076014","ip":"ip","user_agent":"user_agent"},"phone":"phone","structure":"single_member_llc","tax_id_provided":true,"tax_id_registrar":"tax_id_registrar","vat_id_provided":true,"verification":{"document":{"back":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"details":"details","details_code":"details_code","front":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"}}}},"controller":{"is_controller":true,"type":"account"},"country":"country","created":"1028554472","default_currency":"default_currency","details_submitted":true,"email":"email","external_accounts":null,"future_requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"current_deadline":"270965154","currently_due":["currently_due"],"disabled_reason":"disabled_reason","errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"id":"obj_123","individual":{"account":"account","additional_tos_acceptances":{"account":{"date":"3076014","ip":"ip","user_agent":"user_agent"}},"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"address_kana":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"address_kanji":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"created":"1028554472","dob":{"day":99228,"month":104080000,"year":3704893},"email":"email","first_name":"first_name","first_name_kana":"first_name_kana","first_name_kanji":"first_name_kanji","full_name_aliases":["full_name_aliases"],"future_requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"currently_due":["currently_due"],"errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"gender":"gender","id":"obj_123","id_number_provided":true,"id_number_secondary_provided":true,"last_name":"last_name","last_name_kana":"last_name_kana","last_name_kanji":"last_name_kanji","maiden_name":"maiden_name","metadata":{"undefined":"metadata"},"nationality":"nationality","object":"person","phone":"phone","political_exposure":"none","registered_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"relationship":{"director":true,"executive":true,"legal_guardian":true,"owner":true,"percent_ownership":760989685,"representative":true,"title":"title"},"requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"currently_due":["currently_due"],"errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"ssn_last_4_provided":true,"verification":{"additional_document":{"back":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"details":"details","details_code":"details_code","front":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"}},"details":"details","details_code":"details_code","document":{"back":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"details":"details","details_code":"details_code","front":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"}},"status":"status"}},"metadata":{"undefined":"metadata"},"object":"account","payouts_enabled":true,"requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"current_deadline":"270965154","currently_due":["currently_due"],"disabled_reason":"disabled_reason","errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"settings":{"bacs_debit_payments":{"display_name":"display_name","service_user_number":"service_user_number"},"branding":{"icon":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"logo":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"primary_color":"primary_color","secondary_color":"secondary_color"},"card_issuing":{"tos_acceptance":{"date":3076014,"ip":"ip","user_agent":"user_agent"}},"card_payments":{"decline_on":{"avs_failure":true,"cvc_failure":true},"statement_descriptor_prefix":"statement_descriptor_prefix","statement_descriptor_prefix_kana":"statement_descriptor_prefix_kana","statement_descriptor_prefix_kanji":"statement_descriptor_prefix_kanji"},"dashboard":{"display_name":"display_name","timezone":"timezone"},"invoices":{"default_account_tax_ids":[{"country":"country","created":"1028554472","customer":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"balance":339185956,"cash_balance":{"available":{"undefined":733902135},"customer":"customer","livemode":true,"object":"cash_balance","settings":{"reconciliation_mode":"manual","using_merchant_default":true}},"created":"1028554472","currency":"currency","default_source":null,"delinquent":true,"description":"description","discount":{"checkout_session":"checkout_session","coupon":null,"customer":null,"end":"100571","id":"obj_123","invoice":"invoice","invoice_item":"invoice_item","object":"discount","promotion_code":null,"start":"109757538","subscription":"subscription","subscription_item":"subscription_item"},"email":"email","id":"obj_123","invoice_credit_balance":{"undefined":1267696360},"invoice_prefix":"invoice_prefix","invoice_settings":{"custom_fields":[{"name":"name","value":"value"}],"default_payment_method":{"acss_debit":{"bank_name":"bank_name","fingerprint":"fingerprint","institution_number":"institution_number","last4":"last4","transit_number":"transit_number"},"affirm":{},"afterpay_clearpay":{},"alipay":{},"au_becs_debit":{"bsb_number":"bsb_number","fingerprint":"fingerprint","last4":"last4"},"bacs_debit":{"fingerprint":"fingerprint","last4":"last4","sort_code":"sort_code"},"bancontact":{},"billing_details":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"email":"email","name":"name","phone":"phone"},"blik":{},"boleto":{"tax_id":"tax_id"},"card":{"brand":"brand","checks":{"address_line1_check":"address_line1_check","address_postal_code_check":"address_postal_code_check","cvc_check":"cvc_check"},"country":"country","description":"description","display_brand":"display_brand","exp_month":40417826,"exp_year":1940618977,"fingerprint":"fingerprint","funding":"funding","iin":"iin","issuer":"issuer","last4":"last4","networks":{"available":["available"],"preferred":"preferred"},"three_d_secure_usage":{"supported":true},"wallet":{"amex_express_checkout":{},"apple_pay":{},"dynamic_last4":"dynamic_last4","google_pay":{},"link":{},"masterpass":{"billing_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"email":"email","name":"name","shipping_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"}},"samsung_pay":{},"type":"link","visa_checkout":{"billing_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"email":"email","name":"name","shipping_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"}}}},"card_present":{"brand":"brand","cardholder_name":"cardholder_name","country":"country","description":"description","exp_month":40417826,"exp_year":1940618977,"fingerprint":"fingerprint","funding":"funding","iin":"iin","issuer":"issuer","last4":"last4","networks":{"available":["available"],"preferred":"preferred"},"read_method":"magnetic_stripe_track2"},"cashapp":{"buyer_id":"buyer_id","cashtag":"cashtag"},"created":"1028554472","customer":null,"customer_balance":{},"eps":{"bank":"btv_vier_lander_bank"},"fpx":{"account_holder_type":"individual","bank":"bsn"},"giropay":{},"grabpay":{},"id":"obj_123","ideal":{"bank":"sns_bank","bic":"BUNQNL2A"},"interac_present":{"brand":"brand","cardholder_name":"cardholder_name","country":"country","description":"description","exp_month":40417826,"exp_year":1940618977,"fingerprint":"fingerprint","funding":"funding","iin":"iin","issuer":"issuer","last4":"last4","networks":{"available":["available"],"preferred":"preferred"},"preferred_locales":["preferred_locales"],"read_method":"magnetic_stripe_track2"},"klarna":{"dob":{"day":99228,"month":104080000,"year":3704893}},"konbini":{},"link":{"email":"email","persistent_token":"persistent_token"},"livemode":true,"metadata":{"undefined":"metadata"},"mobilepay":{},"object":"payment_method","oxxo":{},"p24":{"bank":"noble_pay"},"paynow":{},"paypal":{"payer_email":"payer_email","payer_id":"payer_id"},"pix":{},"promptpay":{},"radar_options":{"session":"session"},"revolut_pay":{},"sepa_debit":{"bank_code":"bank_code","branch_code":"branch_code","country":"country","fingerprint":"fingerprint","generated_from":{"charge":null,"setup_attempt":null},"last4":"last4"},"sofort":{"country":"country"},"swish":{},"type":"interac_present","us_bank_account":{"account_holder_type":"individual","account_type":"checking","bank_name":"bank_name","financial_connections_account":"financial_connections_account","fingerprint":"fingerprint","last4":"last4","networks":{"preferred":"preferred","supported":["ach"]},"routing_number":"routing_number","status_details":{"blocked":{"network_code":"R29","reason":"bank_account_unusable"}}},"wechat_pay":{},"zip":{}},"footer":"footer","rendering_options":{"amount_tax_display":"amount_tax_display"}},"livemode":true,"metadata":{"undefined":"metadata"},"name":"name","next_invoice_sequence":1356358751,"object":"customer","phone":"phone","preferred_locales":["preferred_locales"],"shipping":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"carrier":"carrier","name":"name","phone":"phone","tracking_number":"tracking_number"},"sources":null,"subscriptions":null,"tax":{"automatic_tax":"unrecognized_location","ip_address":"ip_address","location":{"country":"country","source":"ip_address","state":"state"}},"tax_exempt":"reverse","tax_ids":null,"test_clock":{"created":"1028554472","deletes_after":"73213179","frozen_time":"2033541876","id":"obj_123","livemode":true,"name":"name","object":"test_helpers.test_clock","status":"advancing"}},"id":"obj_123","livemode":true,"object":"tax_id","owner":{"account":{"business_profile":{"annual_revenue":{"amount":1413853096,"currency":"currency","fiscal_year_end":"fiscal_year_end"},"estimated_worker_count":884794319,"mcc":"mcc","monthly_estimated_revenue":{"amount":1413853096,"currency":"currency"},"name":"name","product_description":"product_description","support_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"support_email":"support_email","support_phone":"support_phone","support_url":"support_url","url":"url"},"business_type":"government_entity","capabilities":{"acss_debit_payments":"inactive","affirm_payments":"pending","afterpay_clearpay_payments":"inactive","amazon_pay_payments":"inactive","au_becs_debit_payments":"active","bacs_debit_payments":"active","bancontact_payments":"inactive","bank_transfer_payments":"pending","blik_payments":"inactive","boleto_payments":"inactive","card_issuing":"active","card_payments":"active","cartes_bancaires_payments":"active","cashapp_payments":"active","eps_payments":"inactive","fpx_payments":"active","giropay_payments":"active","grabpay_payments":"pending","ideal_payments":"inactive","india_international_payments":"inactive","jcb_payments":"inactive","klarna_payments":"active","konbini_payments":"active","legacy_payments":"active","link_payments":"inactive","mobilepay_payments":"pending","oxxo_payments":"pending","p24_payments":"inactive","paynow_payments":"active","promptpay_payments":"active","revolut_pay_payments":"inactive","sepa_debit_payments":"inactive","sofort_payments":"active","swish_payments":"inactive","tax_reporting_us_1099_k":"inactive","tax_reporting_us_1099_misc":"pending","transfers":"inactive","treasury":"pending","us_bank_account_ach_payments":"pending","zip_payments":"pending"},"charges_enabled":true,"company":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"address_kana":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"address_kanji":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"directors_provided":true,"executives_provided":true,"export_license_id":"export_license_id","export_purpose_code":"export_purpose_code","name":"name","name_kana":"name_kana","name_kanji":"name_kanji","owners_provided":true,"ownership_declaration":{"date":"3076014","ip":"ip","user_agent":"user_agent"},"phone":"phone","structure":"single_member_llc","tax_id_provided":true,"tax_id_registrar":"tax_id_registrar","vat_id_provided":true,"verification":{"document":{"back":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"details":"details","details_code":"details_code","front":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"}}}},"controller":{"is_controller":true,"type":"account"},"country":"country","created":"1028554472","default_currency":"default_currency","details_submitted":true,"email":"email","external_accounts":null,"future_requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"current_deadline":"270965154","currently_due":["currently_due"],"disabled_reason":"disabled_reason","errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"id":"obj_123","individual":{"account":"account","additional_tos_acceptances":{"account":{"date":"3076014","ip":"ip","user_agent":"user_agent"}},"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"address_kana":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"address_kanji":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state","town":"town"},"created":"1028554472","dob":{"day":99228,"month":104080000,"year":3704893},"email":"email","first_name":"first_name","first_name_kana":"first_name_kana","first_name_kanji":"first_name_kanji","full_name_aliases":["full_name_aliases"],"future_requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"currently_due":["currently_due"],"errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"gender":"gender","id":"obj_123","id_number_provided":true,"id_number_secondary_provided":true,"last_name":"last_name","last_name_kana":"last_name_kana","last_name_kanji":"last_name_kanji","maiden_name":"maiden_name","metadata":{"undefined":"metadata"},"nationality":"nationality","object":"person","phone":"phone","political_exposure":"none","registered_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"relationship":{"director":true,"executive":true,"legal_guardian":true,"owner":true,"percent_ownership":760989685,"representative":true,"title":"title"},"requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"currently_due":["currently_due"],"errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"ssn_last_4_provided":true,"verification":{"additional_document":{"back":null,"details":"details","details_code":"details_code","front":null},"details":"details","details_code":"details_code","document":{"back":null,"details":"details","details_code":"details_code","front":null},"status":"status"}},"metadata":{"undefined":"metadata"},"object":"account","payouts_enabled":true,"requirements":{"alternatives":[{"alternative_fields_due":["alternative_fields_due"],"original_fields_due":["original_fields_due"]}],"current_deadline":"270965154","currently_due":["currently_due"],"disabled_reason":"disabled_reason","errors":[{"code":"invalid_url_website_incomplete_under_construction","reason":"reason","requirement":"requirement"}],"eventually_due":["eventually_due"],"past_due":["past_due"],"pending_verification":["pending_verification"]},"settings":{"bacs_debit_payments":{"display_name":"display_name","service_user_number":"service_user_number"},"branding":{"icon":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"logo":{"created":"1028554472","expires_at":"833811170","filename":"filename","id":"obj_123","links":null,"object":"file","purpose":"finance_report_run","size":3530753,"title":"title","type":"type","url":"url"},"primary_color":"primary_color","secondary_color":"secondary_color"},"card_issuing":{"tos_acceptance":{"date":3076014,"ip":"ip","user_agent":"user_agent"}},"card_payments":{"decline_on":{"avs_failure":true,"cvc_failure":true},"statement_descriptor_prefix":"statement_descriptor_prefix","statement_descriptor_prefix_kana":"statement_descriptor_prefix_kana","statement_descriptor_prefix_kanji":"statement_descriptor_prefix_kanji"},"dashboard":{"display_name":"display_name","timezone":"timezone"},"invoices":{"default_account_tax_ids":[{"country":"country","created":"1028554472","customer":null,"id":"obj_123","livemode":true,"object":"tax_id","owner":{"account":null,"application":null,"customer":null,"type":"customer"},"type":"jp_cn","value":"value","verification":{"status":"unverified","verified_address":"verified_address","verified_name":"verified_name"}}]},"payments":{"statement_descriptor":"statement_descriptor","statement_descriptor_kana":"statement_descriptor_kana","statement_descriptor_kanji":"statement_descriptor_kanji","statement_descriptor_prefix_kana":"statement_descriptor_prefix_kana","statement_descriptor_prefix_kanji":"statement_descriptor_prefix_kanji"},"payouts":{"debit_negative_balances":true,"schedule":{"delay_days":1647351405,"interval":"interval","monthly_anchor":1920305369,"weekly_anchor":"weekly_anchor"},"statement_descriptor":"statement_descriptor"},"sepa_debit_payments":{"creditor_id":"creditor_id"},"treasury":{"tos_acceptance":{"date":3076014,"ip":"ip","user_agent":"user_agent"}}},"tos_acceptance":{"date":"3076014","ip":"ip","service_agreement":"service_agreement","user_agent":"user_agent"},"type":"custom"},"application":{"id":"obj_123","name":"name","object":"application"},"customer":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"balance":339185956,"cash_balance":{"available":{"undefined":733902135},"customer":"customer","livemode":true,"object":"cash_balance","settings":{"reconciliation_mode":"manual","using_merchant_default":true}},"created":"1028554472","currency":"currency","default_source":null,"delinquent":true,"description":"description","discount":{"checkout_session":"checkout_session","coupon":null,"customer":null,"end":"100571","id":"obj_123","invoice":"invoice","invoice_item":"invoice_item","object":"discount","promotion_code":null,"start":"109757538","subscription":"subscription","subscription_item":"subscription_item"},"email":"email","id":"obj_123","invoice_credit_balance":{"undefined":1267696360},"invoice_prefix":"invoice_prefix","invoice_settings":{"custom_fields":[{"name":"name","value":"value"}],"default_payment_method":{"acss_debit":{"bank_name":"bank_name","fingerprint":"fingerprint","institution_number":"institution_number","last4":"last4","transit_number":"transit_number"},"affirm":{},"afterpay_clearpay":{},"alipay":{},"au_becs_debit":{"bsb_number":"bsb_number","fingerprint":"fingerprint","last4":"last4"},"bacs_debit":{"fingerprint":"fingerprint","last4":"last4","sort_code":"sort_code"},"bancontact":{},"billing_details":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"email":"email","name":"name","phone":"phone"},"blik":{},"boleto":{"tax_id":"tax_id"},"card":{"brand":"brand","checks":{"address_line1_check":"address_line1_check","address_postal_code_check":"address_postal_code_check","cvc_check":"cvc_check"},"country":"country","description":"description","display_brand":"display_brand","exp_month":40417826,"exp_year":1940618977,"fingerprint":"fingerprint","funding":"funding","iin":"iin","issuer":"issuer","last4":"last4","networks":{"available":["available"],"preferred":"preferred"},"three_d_secure_usage":{"supported":true},"wallet":{"amex_express_checkout":{},"apple_pay":{},"dynamic_last4":"dynamic_last4","google_pay":{},"link":{},"masterpass":{"billing_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"email":"email","name":"name","shipping_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"}},"samsung_pay":{},"type":"link","visa_checkout":{"billing_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"email":"email","name":"name","shipping_address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"}}}},"card_present":{"brand":"brand","cardholder_name":"cardholder_name","country":"country","description":"description","exp_month":40417826,"exp_year":1940618977,"fingerprint":"fingerprint","funding":"funding","iin":"iin","issuer":"issuer","last4":"last4","networks":{"available":["available"],"preferred":"preferred"},"read_method":"magnetic_stripe_track2"},"cashapp":{"buyer_id":"buyer_id","cashtag":"cashtag"},"created":"1028554472","customer":null,"customer_balance":{},"eps":{"bank":"btv_vier_lander_bank"},"fpx":{"account_holder_type":"individual","bank":"bsn"},"giropay":{},"grabpay":{},"id":"obj_123","ideal":{"bank":"sns_bank","bic":"BUNQNL2A"},"interac_present":{"brand":"brand","cardholder_name":"cardholder_name","country":"country","description":"description","exp_month":40417826,"exp_year":1940618977,"fingerprint":"fingerprint","funding":"funding","iin":"iin","issuer":"issuer","last4":"last4","networks":{"available":["available"],"preferred":"preferred"},"preferred_locales":["preferred_locales"],"read_method":"magnetic_stripe_track2"},"klarna":{"dob":{"day":99228,"month":104080000,"year":3704893}},"konbini":{},"link":{"email":"email","persistent_token":"persistent_token"},"livemode":true,"metadata":{"undefined":"metadata"},"mobilepay":{},"object":"payment_method","oxxo":{},"p24":{"bank":"noble_pay"},"paynow":{},"paypal":{"payer_email":"payer_email","payer_id":"payer_id"},"pix":{},"promptpay":{},"radar_options":{"session":"session"},"revolut_pay":{},"sepa_debit":{"bank_code":"bank_code","branch_code":"branch_code","country":"country","fingerprint":"fingerprint","generated_from":{"charge":null,"setup_attempt":null},"last4":"last4"},"sofort":{"country":"country"},"swish":{},"type":"interac_present","us_bank_account":{"account_holder_type":"individual","account_type":"checking","bank_name":"bank_name","financial_connections_account":"financial_connections_account","fingerprint":"fingerprint","last4":"last4","networks":{"preferred":"preferred","supported":["ach"]},"routing_number":"routing_number","status_details":{"blocked":{"network_code":"R29","reason":"bank_account_unusable"}}},"wechat_pay":{},"zip":{}},"footer":"footer","rendering_options":{"amount_tax_display":"amount_tax_display"}},"livemode":true,"metadata":{"undefined":"metadata"},"name":"name","next_invoice_sequence":1356358751,"object":"customer","phone":"phone","preferred_locales":["preferred_locales"],"shipping":{"address":{"city":"city","country":"country","line1":"line1","line2":"line2","postal_code":"postal_code","state":"state"},"carrier":"carrier","name":"name","phone":"phone","tracking_number":"tracking_number"},"sources":null,"subscriptions":null,"tax":{"automatic_tax":"unrecognized_location","ip_address":"ip_address","location":{"country":"country","source":"ip_address","state":"state"}},"tax_exempt":"reverse","tax_ids":null,"test_clock":{"created":"1028554472","deletes_after":"73213179","frozen_time":"2033541876","id":"obj_123","livemode":true,"name":"name","object":"test_helpers.test_clock","status":"advancing"}},"type":"customer"},"type":"jp_cn","value":"value","verification":{"status":"unverified","verified_address":"verified_address","verified_name":"verified_name"}}]},"payments":{"statement_descriptor":"statement_descriptor","statement_descriptor_kana":"statement_descriptor_kana","statement_descriptor_kanji":"statement_descriptor_kanji","statement_descriptor_prefix_kana":"statement_descriptor_prefix_kana","statement_descriptor_prefix_kanji":"statement_descriptor_prefix_kanji"},"payouts":{"debit_negative_balances":true,"schedule":{"delay_days":1647351405,"interval":"interval","monthly_anchor":1920305369,"weekly_anchor":"weekly_anchor"},"statement_descriptor":"statement_descriptor"},"sepa_debit_payments":{"creditor_id":"creditor_id"},"treasury":{"tos_acceptance":{"date":3076014,"ip":"ip","user_agent":"user_agent"}}},"tos_acceptance":{"date":"3076014","ip":"ip","service_agreement":"service_agreement","user_agent":"user_agent"},"type":"custom"}', }, ]); const account = await stripe.accounts.retrieve('acc_123'); diff --git a/types/Accounts.d.ts b/types/Accounts.d.ts index 07f81f127b..d18fffca25 100644 --- a/types/Accounts.d.ts +++ b/types/Accounts.d.ts @@ -173,7 +173,7 @@ declare module 'stripe' { namespace BusinessProfile { interface AnnualRevenue { /** - * A non-negative integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + * A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount: number | null; @@ -190,7 +190,7 @@ declare module 'stripe' { interface MonthlyEstimatedRevenue { /** - * A non-negative integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + * A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount: number; diff --git a/types/AccountsResource.d.ts b/types/AccountsResource.d.ts index 25a33ba24e..f60865cca5 100644 --- a/types/AccountsResource.d.ts +++ b/types/AccountsResource.d.ts @@ -14,7 +14,7 @@ declare module 'stripe' { business_profile?: AccountCreateParams.BusinessProfile; /** - * The business type. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts. + * The business type. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. */ business_type?: AccountCreateParams.BusinessType; @@ -24,7 +24,7 @@ declare module 'stripe' { capabilities?: AccountCreateParams.Capabilities; /** - * Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts. + * Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. */ company?: AccountCreateParams.Company; @@ -34,7 +34,7 @@ declare module 'stripe' { country?: string; /** - * Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). + * Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). */ default_currency?: string; @@ -54,14 +54,14 @@ declare module 'stripe' { expand?: Array; /** - * A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won't be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation. + * A card or bank account to attach to the account for receiving [payouts](https://docs.stripe.com/connect/bank-debit-card-payouts) (you won't be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://docs.stripe.com/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://docs.stripe.com/api#account_create_bank_account) creation. * - * By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://stripe.com/docs/api#account_create_bank_account) or [card creation](https://stripe.com/docs/api#account_create_card) APIs. After you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts. + * By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://docs.stripe.com/api#account_create_bank_account) or [card creation](https://docs.stripe.com/api#account_create_card) APIs. After you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. */ external_account?: string | AccountCreateParams.ExternalAccount; /** - * Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts. + * Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. */ individual?: AccountCreateParams.Individual; @@ -76,7 +76,7 @@ declare module 'stripe' { settings?: AccountCreateParams.Settings; /** - * Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance) This property can only be updated for Custom accounts. + * Details on the account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance) This property can only be updated for Custom accounts. */ tos_acceptance?: AccountCreateParams.TosAcceptance; @@ -99,7 +99,7 @@ declare module 'stripe' { estimated_worker_count?: number; /** - * [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. + * [The merchant category code for the account](https://docs.stripe.com/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ mcc?: string; @@ -147,7 +147,7 @@ declare module 'stripe' { namespace BusinessProfile { interface AnnualRevenue { /** - * A non-negative integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + * A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount: number; @@ -164,7 +164,7 @@ declare module 'stripe' { interface MonthlyEstimatedRevenue { /** - * A non-negative integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + * A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount: number; @@ -682,12 +682,12 @@ declare module 'stripe' { address_kanji?: Stripe.JapanAddressParam; /** - * Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided. + * 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/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided. */ directors_provided?: boolean; /** - * Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` requirement. + * 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/persons) for accounts with a `relationship.executive` requirement. */ executives_provided?: boolean; @@ -717,7 +717,7 @@ declare module 'stripe' { name_kanji?: string; /** - * Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.owner` requirement. + * 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/persons) for accounts with a `relationship.owner` requirement. */ owners_provided?: boolean; @@ -737,7 +737,7 @@ declare module 'stripe' { registration_number?: string; /** - * The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value. + * The category identifying the legal structure of the company or legal entity. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value. */ structure?: Stripe.Emptyable; @@ -1004,12 +1004,12 @@ declare module 'stripe' { gender?: string; /** - * The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + * The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number?: string; /** - * The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + * The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number_secondary?: string; @@ -1224,7 +1224,7 @@ declare module 'stripe' { interface CardIssuing { /** - * Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://stripe.com/docs/issuing/connect/tos_acceptance). + * Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://docs.stripe.com/issuing/connect/tos_acceptance). */ tos_acceptance?: CardIssuing.TosAcceptance; } @@ -1303,12 +1303,12 @@ declare module 'stripe' { interface Payouts { /** - * A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances). + * A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://docs.stripe.com/connect/account-balances). */ debit_negative_balances?: boolean; /** - * Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation. + * Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation. */ schedule?: Payouts.Schedule; @@ -1321,7 +1321,7 @@ declare module 'stripe' { namespace Payouts { interface Schedule { /** - * The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://stripe.com/docs/connect/manage-payout-schedule). + * The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://docs.stripe.com/connect/manage-payout-schedule). */ delay_days?: 'minimum' | number; @@ -1426,7 +1426,7 @@ declare module 'stripe' { business_profile?: AccountUpdateParams.BusinessProfile; /** - * The business type. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts. + * The business type. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. */ business_type?: AccountUpdateParams.BusinessType; @@ -1436,12 +1436,12 @@ declare module 'stripe' { capabilities?: AccountUpdateParams.Capabilities; /** - * Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts. + * Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. */ company?: AccountUpdateParams.Company; /** - * Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). + * Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). */ default_currency?: string; @@ -1461,9 +1461,9 @@ declare module 'stripe' { expand?: Array; /** - * A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won't be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation. + * A card or bank account to attach to the account for receiving [payouts](https://docs.stripe.com/connect/bank-debit-card-payouts) (you won't be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://docs.stripe.com/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://docs.stripe.com/api#account_create_bank_account) creation. * - * By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://stripe.com/docs/api#account_create_bank_account) or [card creation](https://stripe.com/docs/api#account_create_card) APIs. After you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts. + * By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://docs.stripe.com/api#account_create_bank_account) or [card creation](https://docs.stripe.com/api#account_create_card) APIs. After you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. */ external_account?: Stripe.Emptyable< | string @@ -1473,7 +1473,7 @@ declare module 'stripe' { >; /** - * Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts. + * Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts. */ individual?: AccountUpdateParams.Individual; @@ -1488,7 +1488,7 @@ declare module 'stripe' { settings?: AccountUpdateParams.Settings; /** - * Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance) This property can only be updated for Custom accounts. + * Details on the account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance) This property can only be updated for Custom accounts. */ tos_acceptance?: AccountUpdateParams.TosAcceptance; } @@ -1544,7 +1544,7 @@ declare module 'stripe' { estimated_worker_count?: number; /** - * [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. + * [The merchant category code for the account](https://docs.stripe.com/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ mcc?: string; @@ -1592,7 +1592,7 @@ declare module 'stripe' { namespace BusinessProfile { interface AnnualRevenue { /** - * A non-negative integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + * A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount: number; @@ -1609,7 +1609,7 @@ declare module 'stripe' { interface MonthlyEstimatedRevenue { /** - * A non-negative integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + * A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount: number; @@ -2170,12 +2170,12 @@ declare module 'stripe' { address_kanji?: Stripe.JapanAddressParam; /** - * Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided. + * 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/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided. */ directors_provided?: boolean; /** - * Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` requirement. + * 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/persons) for accounts with a `relationship.executive` requirement. */ executives_provided?: boolean; @@ -2205,7 +2205,7 @@ declare module 'stripe' { name_kanji?: string; /** - * Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.owner` requirement. + * 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/persons) for accounts with a `relationship.owner` requirement. */ owners_provided?: boolean; @@ -2225,7 +2225,7 @@ declare module 'stripe' { registration_number?: string; /** - * The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value. + * The category identifying the legal structure of the company or legal entity. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value. */ structure?: Stripe.Emptyable; @@ -2455,12 +2455,12 @@ declare module 'stripe' { gender?: string; /** - * The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + * The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number?: string; /** - * The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + * The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number_secondary?: string; @@ -2680,7 +2680,7 @@ declare module 'stripe' { interface CardIssuing { /** - * Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://stripe.com/docs/issuing/connect/tos_acceptance). + * Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://docs.stripe.com/issuing/connect/tos_acceptance). */ tos_acceptance?: CardIssuing.TosAcceptance; } @@ -2766,12 +2766,12 @@ declare module 'stripe' { interface Payouts { /** - * A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances). + * A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://docs.stripe.com/connect/account-balances). */ debit_negative_balances?: boolean; /** - * Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation. + * Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation. */ schedule?: Payouts.Schedule; @@ -2784,7 +2784,7 @@ declare module 'stripe' { namespace Payouts { interface Schedule { /** - * The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://stripe.com/docs/connect/manage-payout-schedule). + * The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://docs.stripe.com/connect/manage-payout-schedule). */ delay_days?: 'minimum' | number; @@ -3063,12 +3063,12 @@ declare module 'stripe' { gender?: string; /** - * The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + * The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number?: string; /** - * The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + * The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number_secondary?: string; @@ -3103,7 +3103,7 @@ declare module 'stripe' { nationality?: string; /** - * A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. + * A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. */ person_token?: string; @@ -3593,12 +3593,12 @@ declare module 'stripe' { gender?: string; /** - * The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + * The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number?: string; /** - * The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + * The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number_secondary?: string; @@ -3633,7 +3633,7 @@ declare module 'stripe' { nationality?: string; /** - * A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. + * A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. */ person_token?: string; diff --git a/types/Billing/MeterEventsResource.d.ts b/types/Billing/MeterEventsResource.d.ts index b55122c132..4ecc71e281 100644 --- a/types/Billing/MeterEventsResource.d.ts +++ b/types/Billing/MeterEventsResource.d.ts @@ -27,7 +27,7 @@ declare module 'stripe' { expand?: Array; /** - * A unique identifier for the event. If not provided, one will be generated. + * A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We'll enforce uniqueness within a rolling 24 hour period. */ identifier?: string; } diff --git a/types/BillingPortal/Configurations.d.ts b/types/BillingPortal/Configurations.d.ts index 08ad6c6333..66da8425db 100644 --- a/types/BillingPortal/Configurations.d.ts +++ b/types/BillingPortal/Configurations.d.ts @@ -95,9 +95,9 @@ declare module 'stripe' { subscription_cancel: Features.SubscriptionCancel; - subscription_pause: Features.SubscriptionPause; - subscription_update: Features.SubscriptionUpdate; + + subscription_pause: Features.SubscriptionPause; } namespace Features { diff --git a/types/BillingPortal/ConfigurationsResource.d.ts b/types/BillingPortal/ConfigurationsResource.d.ts index 448f4c531b..173ac56423 100644 --- a/types/BillingPortal/ConfigurationsResource.d.ts +++ b/types/BillingPortal/ConfigurationsResource.d.ts @@ -75,14 +75,14 @@ declare module 'stripe' { subscription_cancel?: Features.SubscriptionCancel; /** - * Information about pausing subscriptions in the portal. + * Information about updating subscriptions in the portal. */ - subscription_pause?: Features.SubscriptionPause; + subscription_update?: Features.SubscriptionUpdate; /** - * Information about updating subscriptions in the portal. + * Information about pausing subscriptions in the portal. */ - subscription_update?: Features.SubscriptionUpdate; + subscription_pause?: Features.SubscriptionPause; } namespace Features { @@ -183,7 +183,7 @@ declare module 'stripe' { /** * Whether the feature is enabled. */ - enabled?: boolean; + enabled: boolean; } interface SubscriptionUpdate { @@ -324,14 +324,14 @@ declare module 'stripe' { subscription_cancel?: Features.SubscriptionCancel; /** - * Information about pausing subscriptions in the portal. + * Information about updating subscriptions in the portal. */ - subscription_pause?: Features.SubscriptionPause; + subscription_update?: Features.SubscriptionUpdate; /** - * Information about updating subscriptions in the portal. + * Information about pausing subscriptions in the portal. */ - subscription_update?: Features.SubscriptionUpdate; + subscription_pause?: Features.SubscriptionPause; } namespace Features { @@ -432,7 +432,7 @@ declare module 'stripe' { /** * Whether the feature is enabled. */ - enabled?: boolean; + enabled: boolean; } interface SubscriptionUpdate { diff --git a/types/Charges.d.ts b/types/Charges.d.ts index 2a52ff035d..584ecbb4d2 100644 --- a/types/Charges.d.ts +++ b/types/Charges.d.ts @@ -1972,7 +1972,7 @@ declare module 'stripe' { /** * Reference number to locate ACH payments with customer's bank. */ - payment_reference?: string | null; + payment_reference: string | null; /** * Routing number of the bank account. diff --git a/types/Checkout/SessionsResource.d.ts b/types/Checkout/SessionsResource.d.ts index 9d6eabd820..334321e7f6 100644 --- a/types/Checkout/SessionsResource.d.ts +++ b/types/Checkout/SessionsResource.d.ts @@ -589,12 +589,12 @@ declare module 'stripe' { namespace InvoiceData { interface CustomField { /** - * The name of the custom field. This may be up to 30 characters. + * The name of the custom field. This may be up to 40 characters. */ name: string; /** - * The value of the custom field. This may be up to 30 characters. + * The value of the custom field. This may be up to 140 characters. */ value: string; } @@ -1642,7 +1642,7 @@ declare module 'stripe' { /** * The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent. */ - reference?: Stripe.Emptyable; + reference?: string; } interface UsBankAccount { diff --git a/types/CustomersResource.d.ts b/types/CustomersResource.d.ts index e667f3bd8b..fd032c2e2a 100644 --- a/types/CustomersResource.d.ts +++ b/types/CustomersResource.d.ts @@ -73,7 +73,7 @@ declare module 'stripe' { preferred_locales?: Array; /** - * The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. + * The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ promotion_code?: string; @@ -154,12 +154,12 @@ declare module 'stripe' { namespace InvoiceSettings { interface CustomField { /** - * The name of the custom field. This may be up to 30 characters. + * The name of the custom field. This may be up to 40 characters. */ name: string; /** - * The value of the custom field. This may be up to 30 characters. + * The value of the custom field. This may be up to 140 characters. */ value: string; } @@ -382,7 +382,7 @@ declare module 'stripe' { preferred_locales?: Array; /** - * The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. + * The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ promotion_code?: string; @@ -453,12 +453,12 @@ declare module 'stripe' { namespace InvoiceSettings { interface CustomField { /** - * The name of the custom field. This may be up to 30 characters. + * The name of the custom field. This may be up to 40 characters. */ name: string; /** - * The value of the custom field. This may be up to 30 characters. + * The value of the custom field. This may be up to 140 characters. */ value: string; } diff --git a/types/Discounts.d.ts b/types/Discounts.d.ts index f643ce7757..0af3157069 100644 --- a/types/Discounts.d.ts +++ b/types/Discounts.d.ts @@ -62,6 +62,11 @@ declare module 'stripe' { * The subscription that this coupon is applied to, if it is applied to a particular subscription. */ subscription: string | null; + + /** + * The subscription item that this coupon is applied to, if it is applied to a particular subscription item. + */ + subscription_item: string | null; } /** @@ -132,6 +137,11 @@ declare module 'stripe' { * The subscription that this coupon is applied to, if it is applied to a particular subscription. */ subscription: string | null; + + /** + * The subscription item that this coupon is applied to, if it is applied to a particular subscription item. + */ + subscription_item: string | null; } } } diff --git a/types/Identity/VerificationReports.d.ts b/types/Identity/VerificationReports.d.ts index 2abb3d3624..036125c7df 100644 --- a/types/Identity/VerificationReports.d.ts +++ b/types/Identity/VerificationReports.d.ts @@ -42,6 +42,11 @@ declare module 'stripe' { */ document?: VerificationReport.Document; + /** + * Result from a email check + */ + email?: VerificationReport.Email; + /** * Result from an id_number check */ @@ -54,6 +59,11 @@ declare module 'stripe' { options?: VerificationReport.Options; + /** + * Result from a phone check + */ + phone?: VerificationReport.Phone; + /** * Result from a selfie check */ @@ -64,6 +74,11 @@ declare module 'stripe' { */ type: VerificationReport.Type; + /** + * The configuration token of a Verification Flow from the dashboard. + */ + verification_flow?: string; + /** * ID of the VerificationSession that created this report. */ @@ -209,6 +224,45 @@ declare module 'stripe' { type Type = 'driving_license' | 'id_card' | 'passport'; } + interface Email { + /** + * Email to be verified. + */ + email: string | null; + + /** + * Details on the verification error. Present when status is `unverified`. + */ + error: Email.Error | null; + + /** + * Status of this `email` check. + */ + status: Email.Status; + } + + namespace Email { + interface Error { + /** + * A short machine-readable string giving the reason for the verification failure. + */ + code: Error.Code | null; + + /** + * A human-readable message giving the reason for the failure. These messages can be shown to your users. + */ + reason: string | null; + } + + namespace Error { + type Code = + | 'email_unverified_other' + | 'email_verification_declined'; + } + + type Status = 'unverified' | 'verified'; + } + interface IdNumber { /** * Date of birth. @@ -324,6 +378,45 @@ declare module 'stripe' { interface IdNumber {} } + interface Phone { + /** + * Details on the verification error. Present when status is `unverified`. + */ + error: Phone.Error | null; + + /** + * Phone to be verified. + */ + phone: string | null; + + /** + * Status of this `phone` check. + */ + status: Phone.Status; + } + + namespace Phone { + interface Error { + /** + * A short machine-readable string giving the reason for the verification failure. + */ + code: Error.Code | null; + + /** + * A human-readable message giving the reason for the failure. These messages can be shown to your users. + */ + reason: string | null; + } + + namespace Error { + type Code = + | 'phone_unverified_other' + | 'phone_verification_declined'; + } + + type Status = 'unverified' | 'verified'; + } + interface Selfie { /** * ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check. @@ -370,7 +463,7 @@ declare module 'stripe' { type Status = 'unverified' | 'verified'; } - type Type = 'document' | 'id_number'; + type Type = 'document' | 'id_number' | 'verification_flow'; } } } diff --git a/types/Identity/VerificationSessions.d.ts b/types/Identity/VerificationSessions.d.ts index 1b3f261bf6..db07e12bdd 100644 --- a/types/Identity/VerificationSessions.d.ts +++ b/types/Identity/VerificationSessions.d.ts @@ -70,6 +70,11 @@ declare module 'stripe' { */ options: VerificationSession.Options | null; + /** + * Details provided about the user being verified. These details may be shown to the user. + */ + provided_details?: VerificationSession.ProvidedDetails | null; + /** * Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. */ @@ -90,6 +95,11 @@ declare module 'stripe' { */ url: string | null; + /** + * The configuration token of a Verification Flow from the dashboard. + */ + verification_flow?: string; + /** * The user's verified data. */ @@ -118,9 +128,13 @@ declare module 'stripe' { | 'document_expired' | 'document_type_not_supported' | 'document_unverified_other' + | 'email_unverified_other' + | 'email_verification_declined' | 'id_number_insufficient_document_data' | 'id_number_mismatch' | 'id_number_unverified_other' + | 'phone_unverified_other' + | 'phone_verification_declined' | 'selfie_document_missing_photo' | 'selfie_face_mismatch' | 'selfie_manipulated' @@ -131,7 +145,11 @@ declare module 'stripe' { interface Options { document?: Options.Document; + email?: Options.Email; + id_number?: Options.IdNumber; + + phone?: Options.Phone; } namespace Options { @@ -161,7 +179,33 @@ declare module 'stripe' { type AllowedType = 'driving_license' | 'id_card' | 'passport'; } + interface Email { + /** + * Request one time password verification of `provided_details.email`. + */ + require_verification?: boolean; + } + interface IdNumber {} + + interface Phone { + /** + * Request one time password verification of `provided_details.phone`. + */ + require_verification?: boolean; + } + } + + interface ProvidedDetails { + /** + * Email of user being verified + */ + email?: string; + + /** + * Phone number of user being verified + */ + phone?: string; } interface Redaction { @@ -177,7 +221,7 @@ declare module 'stripe' { type Status = 'canceled' | 'processing' | 'requires_input' | 'verified'; - type Type = 'document' | 'id_number'; + type Type = 'document' | 'id_number' | 'verification_flow'; interface VerifiedOutputs { /** @@ -190,6 +234,11 @@ declare module 'stripe' { */ dob: VerifiedOutputs.Dob | null; + /** + * The user's verified email address + */ + email?: string | null; + /** * The user's verified first name. */ @@ -209,6 +258,11 @@ declare module 'stripe' { * The user's verified last name. */ last_name: string | null; + + /** + * The user's verified phone number + */ + phone?: string | null; } namespace VerifiedOutputs { diff --git a/types/Identity/VerificationSessionsResource.d.ts b/types/Identity/VerificationSessionsResource.d.ts index 2cf933c45f..bdfb730b01 100644 --- a/types/Identity/VerificationSessionsResource.d.ts +++ b/types/Identity/VerificationSessionsResource.d.ts @@ -4,11 +4,6 @@ declare module 'stripe' { namespace Stripe { namespace Identity { interface VerificationSessionCreateParams { - /** - * The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. - */ - type: VerificationSessionCreateParams.Type; - /** * A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ @@ -29,10 +24,25 @@ declare module 'stripe' { */ options?: VerificationSessionCreateParams.Options; + /** + * Details provided about the user being verified. These details may be shown to the user. + */ + provided_details?: VerificationSessionCreateParams.ProvidedDetails; + /** * The URL that the user will be redirected to upon completing the verification flow. */ return_url?: string; + + /** + * The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. + */ + type?: VerificationSessionCreateParams.Type; + + /** + * The ID of a Verification Flow from the Dashboard. + */ + verification_flow?: string; } namespace VerificationSessionCreateParams { @@ -41,6 +51,16 @@ declare module 'stripe' { * Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document). */ document?: Stripe.Emptyable; + + /** + * Options that apply to the email check. + */ + email?: Stripe.Emptyable; + + /** + * Options that apply to the phone check. + */ + phone?: Stripe.Emptyable; } namespace Options { @@ -69,6 +89,32 @@ declare module 'stripe' { namespace Document { type AllowedType = 'driving_license' | 'id_card' | 'passport'; } + + interface Email { + /** + * Request one time password verification of `provided_details.email`. + */ + require_verification?: boolean; + } + + interface Phone { + /** + * Request one time password verification of `provided_details.phone`. + */ + require_verification?: boolean; + } + } + + interface ProvidedDetails { + /** + * Email of user being verified + */ + email?: string; + + /** + * Phone number of user being verified + */ + phone?: string; } type Type = 'document' | 'id_number'; @@ -97,6 +143,11 @@ declare module 'stripe' { */ options?: VerificationSessionUpdateParams.Options; + /** + * Details provided about the user being verified. These details may be shown to the user. + */ + provided_details?: VerificationSessionUpdateParams.ProvidedDetails; + /** * The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. */ @@ -109,6 +160,16 @@ declare module 'stripe' { * Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document). */ document?: Stripe.Emptyable; + + /** + * Options that apply to the email check. + */ + email?: Stripe.Emptyable; + + /** + * Options that apply to the phone check. + */ + phone?: Stripe.Emptyable; } namespace Options { @@ -137,6 +198,32 @@ declare module 'stripe' { namespace Document { type AllowedType = 'driving_license' | 'id_card' | 'passport'; } + + interface Email { + /** + * Request one time password verification of `provided_details.email`. + */ + require_verification?: boolean; + } + + interface Phone { + /** + * Request one time password verification of `provided_details.phone`. + */ + require_verification?: boolean; + } + } + + interface ProvidedDetails { + /** + * Email of user being verified + */ + email?: string; + + /** + * Phone number of user being verified + */ + phone?: string; } type Type = 'document' | 'id_number'; @@ -193,7 +280,10 @@ declare module 'stripe' { * Related guide: [Verify your users' identity documents](https://stripe.com/docs/identity/verify-identity-documents) */ create( - params: VerificationSessionCreateParams, + params?: VerificationSessionCreateParams, + options?: RequestOptions + ): Promise>; + create( options?: RequestOptions ): Promise>; diff --git a/types/InvoiceItemsResource.d.ts b/types/InvoiceItemsResource.d.ts index 1135988ae1..b2d5e5b277 100644 --- a/types/InvoiceItemsResource.d.ts +++ b/types/InvoiceItemsResource.d.ts @@ -29,7 +29,7 @@ declare module 'stripe' { discountable?: boolean; /** - * The coupons to redeem into discounts for the invoice item or invoice line item. + * The coupons and promotion codes to redeem into discounts for the invoice item or invoice line item. */ discounts?: Stripe.Emptyable>; @@ -110,6 +110,11 @@ declare module 'stripe' { * ID of an existing discount on the object (or one of its ancestors) to reuse. */ discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; } interface Period { @@ -182,7 +187,7 @@ declare module 'stripe' { discountable?: boolean; /** - * The coupons & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. + * The coupons, promotion codes & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. */ discounts?: Stripe.Emptyable>; @@ -253,6 +258,11 @@ declare module 'stripe' { * ID of an existing discount on the object (or one of its ancestors) to reuse. */ discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; } interface Period { diff --git a/types/InvoiceLineItems.d.ts b/types/InvoiceLineItems.d.ts index cd20764848..0a21bd4420 100644 --- a/types/InvoiceLineItems.d.ts +++ b/types/InvoiceLineItems.d.ts @@ -49,7 +49,7 @@ declare module 'stripe' { /** * The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - discounts: Array | null; + discounts: Array; /** * The ID of the invoice that contains this line item. diff --git a/types/Invoices.d.ts b/types/Invoices.d.ts index 962f56a4a9..cddbc56943 100644 --- a/types/Invoices.d.ts +++ b/types/Invoices.d.ts @@ -246,9 +246,7 @@ declare module 'stripe' { /** * The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - discounts: Array< - string | Stripe.Discount | Stripe.DeletedDiscount - > | null; + discounts: Array; /** * The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. diff --git a/types/InvoicesResource.d.ts b/types/InvoicesResource.d.ts index 69ed6a563c..6f3b789d22 100644 --- a/types/InvoicesResource.d.ts +++ b/types/InvoicesResource.d.ts @@ -69,7 +69,7 @@ declare module 'stripe' { description?: string; /** - * The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts. + * The coupons and promotion codes to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts. */ discounts?: Stripe.Emptyable>; @@ -201,12 +201,12 @@ declare module 'stripe' { interface CustomField { /** - * The name of the custom field. This may be up to 30 characters. + * The name of the custom field. This may be up to 40 characters. */ name: string; /** - * The value of the custom field. This may be up to 30 characters. + * The value of the custom field. This may be up to 140 characters. */ value: string; } @@ -221,6 +221,11 @@ declare module 'stripe' { * ID of an existing discount on the object (or one of its ancestors) to reuse. */ discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; } interface FromInvoice { @@ -905,12 +910,12 @@ declare module 'stripe' { interface CustomField { /** - * The name of the custom field. This may be up to 30 characters. + * The name of the custom field. This may be up to 40 characters. */ name: string; /** - * The value of the custom field. This may be up to 30 characters. + * The value of the custom field. This may be up to 140 characters. */ value: string; } @@ -925,6 +930,11 @@ declare module 'stripe' { * ID of an existing discount on the object (or one of its ancestors) to reuse. */ discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; } interface Issuer { @@ -1479,7 +1489,7 @@ declare module 'stripe' { automatic_tax?: InvoiceListUpcomingLinesParams.AutomaticTax; /** - * The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. + * The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; @@ -1499,7 +1509,7 @@ declare module 'stripe' { customer_details?: InvoiceListUpcomingLinesParams.CustomerDetails; /** - * The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead. + * The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. */ discounts?: Stripe.Emptyable< Array @@ -1968,6 +1978,11 @@ declare module 'stripe' { */ deleted?: boolean; + /** + * The coupons to redeem into discounts for the subscription item. + */ + discounts?: Stripe.Emptyable>; + /** * Subscription item to update. */ @@ -2012,6 +2027,23 @@ declare module 'stripe' { usage_gte: number; } + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface PriceData { /** * 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). @@ -2124,7 +2156,7 @@ declare module 'stripe' { automatic_tax?: InvoiceRetrieveUpcomingParams.AutomaticTax; /** - * The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. + * The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; @@ -2144,7 +2176,7 @@ declare module 'stripe' { customer_details?: InvoiceRetrieveUpcomingParams.CustomerDetails; /** - * The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead. + * The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. */ discounts?: Stripe.Emptyable< Array @@ -2613,6 +2645,11 @@ declare module 'stripe' { */ deleted?: boolean; + /** + * The coupons to redeem into discounts for the subscription item. + */ + discounts?: Stripe.Emptyable>; + /** * Subscription item to update. */ @@ -2657,6 +2694,23 @@ declare module 'stripe' { usage_gte: number; } + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface PriceData { /** * 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). @@ -2762,7 +2816,7 @@ declare module 'stripe' { discountable?: boolean; /** - * The coupons & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. + * The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. */ discounts?: Stripe.Emptyable>; @@ -2820,6 +2874,11 @@ declare module 'stripe' { * ID of an existing discount on the object (or one of its ancestors) to reuse. */ discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; } interface Period { @@ -3114,7 +3173,7 @@ declare module 'stripe' { * * Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount. * - * You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource. + * You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date value passed in the request. */ retrieveUpcoming( params?: InvoiceRetrieveUpcomingParams, diff --git a/types/Issuing/Cardholders.d.ts b/types/Issuing/Cardholders.d.ts index b5a438ce29..2d6e1904d1 100644 --- a/types/Issuing/Cardholders.d.ts +++ b/types/Issuing/Cardholders.d.ts @@ -229,11 +229,21 @@ declare module 'stripe' { */ allowed_categories: Array | null; + /** + * Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. + */ + allowed_merchant_countries: Array | null; + /** * 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`. */ blocked_categories: Array | null; + /** + * Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. + */ + blocked_merchant_countries: Array | null; + /** * Limit spending with amount-based rules that apply across this cardholder's cards. */ diff --git a/types/Issuing/CardholdersResource.d.ts b/types/Issuing/CardholdersResource.d.ts index 2439a6bf85..4741ae9404 100644 --- a/types/Issuing/CardholdersResource.d.ts +++ b/types/Issuing/CardholdersResource.d.ts @@ -216,11 +216,21 @@ declare module 'stripe' { */ allowed_categories?: Array; + /** + * Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. + */ + allowed_merchant_countries?: Array; + /** * 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`. */ blocked_categories?: Array; + /** + * Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. + */ + blocked_merchant_countries?: Array; + /** * Limit spending with amount-based rules that apply across this cardholder's cards. */ @@ -1367,11 +1377,21 @@ declare module 'stripe' { */ allowed_categories?: Array; + /** + * Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. + */ + allowed_merchant_countries?: Array; + /** * 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`. */ blocked_categories?: Array; + /** + * Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. + */ + blocked_merchant_countries?: Array; + /** * Limit spending with amount-based rules that apply across this cardholder's cards. */ diff --git a/types/Issuing/Cards.d.ts b/types/Issuing/Cards.d.ts index a17536de30..ef82439807 100644 --- a/types/Issuing/Cards.d.ts +++ b/types/Issuing/Cards.d.ts @@ -223,11 +223,21 @@ declare module 'stripe' { */ allowed_categories: Array | null; + /** + * Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. + */ + allowed_merchant_countries: Array | null; + /** * 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`. */ blocked_categories: Array | null; + /** + * Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. + */ + blocked_merchant_countries: Array | null; + /** * Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). */ diff --git a/types/Issuing/CardsResource.d.ts b/types/Issuing/CardsResource.d.ts index b116522802..a899864e4d 100644 --- a/types/Issuing/CardsResource.d.ts +++ b/types/Issuing/CardsResource.d.ts @@ -170,11 +170,21 @@ declare module 'stripe' { */ allowed_categories?: Array; + /** + * Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. + */ + allowed_merchant_countries?: Array; + /** * 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`. */ blocked_categories?: Array; + /** + * Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. + */ + blocked_merchant_countries?: Array; + /** * Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). */ @@ -1163,11 +1173,21 @@ declare module 'stripe' { */ allowed_categories?: Array; + /** + * Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. + */ + allowed_merchant_countries?: Array; + /** * 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`. */ blocked_categories?: Array; + /** + * Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. + */ + blocked_merchant_countries?: Array; + /** * Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). */ diff --git a/types/PaymentIntents.d.ts b/types/PaymentIntents.d.ts index e98dade248..83b6e1afcc 100644 --- a/types/PaymentIntents.d.ts +++ b/types/PaymentIntents.d.ts @@ -1108,14 +1108,14 @@ declare module 'stripe' { /** * The URL to the hosted Swish instructions page, which allows customers to view the QR code. */ - hosted_instructions_url?: string; + hosted_instructions_url: string; /** * The url for mobile redirect based auth (for internal use only and not typically available in standard API requests). */ - mobile_auth_url?: string; + mobile_auth_url: string; - qr_code?: SwishHandleRedirectOrDisplayQrCode.QrCode; + qr_code: SwishHandleRedirectOrDisplayQrCode.QrCode; } namespace SwishHandleRedirectOrDisplayQrCode { @@ -1123,17 +1123,17 @@ declare module 'stripe' { /** * The raw data string used to generate QR code, it should be used together with QR code library. */ - data?: string; + data: string; /** * The image_url_png string used to render QR code */ - image_url_png?: string; + image_url_png: string; /** * The image_url_svg string used to render QR code */ - image_url_svg?: string; + image_url_svg: string; } } @@ -2125,7 +2125,7 @@ declare module 'stripe' { /** * The order ID displayed in the Swish app after the payment is authorized. */ - reference?: string | null; + reference: string | null; /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. diff --git a/types/PaymentLinksResource.d.ts b/types/PaymentLinksResource.d.ts index ad6a671c2c..ad6b156c4e 100644 --- a/types/PaymentLinksResource.d.ts +++ b/types/PaymentLinksResource.d.ts @@ -463,12 +463,12 @@ declare module 'stripe' { namespace InvoiceData { interface CustomField { /** - * The name of the custom field. This may be up to 30 characters. + * The name of the custom field. This may be up to 40 characters. */ name: string; /** - * The value of the custom field. This may be up to 30 characters. + * The value of the custom field. This may be up to 140 characters. */ value: string; } @@ -1393,12 +1393,12 @@ declare module 'stripe' { namespace InvoiceData { interface CustomField { /** - * The name of the custom field. This may be up to 30 characters. + * The name of the custom field. This may be up to 40 characters. */ name: string; /** - * The value of the custom field. This may be up to 30 characters. + * The value of the custom field. This may be up to 140 characters. */ value: string; } diff --git a/types/PaymentMethodConfigurations.d.ts b/types/PaymentMethodConfigurations.d.ts index ed0b1c8e38..39c2621667 100644 --- a/types/PaymentMethodConfigurations.d.ts +++ b/types/PaymentMethodConfigurations.d.ts @@ -136,6 +136,8 @@ declare module 'stripe' { us_bank_account?: PaymentMethodConfiguration.UsBankAccount; wechat_pay?: PaymentMethodConfiguration.WechatPay; + + zip?: PaymentMethodConfiguration.Zip; } namespace PaymentMethodConfiguration { @@ -1464,6 +1466,40 @@ declare module 'stripe' { type Value = 'off' | 'on'; } } + + interface Zip { + /** + * Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. + */ + available: boolean; + + display_preference: Zip.DisplayPreference; + } + + namespace Zip { + interface DisplayPreference { + /** + * For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + */ + overridable: boolean | null; + + /** + * The account's display preference. + */ + preference: DisplayPreference.Preference; + + /** + * The effective display preference value. + */ + value: DisplayPreference.Value; + } + + namespace DisplayPreference { + type Preference = 'none' | 'off' | 'on'; + + type Value = 'off' | 'on'; + } + } } } } diff --git a/types/PaymentMethodConfigurationsResource.d.ts b/types/PaymentMethodConfigurationsResource.d.ts index fd715c2d0a..b192cce2bb 100644 --- a/types/PaymentMethodConfigurationsResource.d.ts +++ b/types/PaymentMethodConfigurationsResource.d.ts @@ -192,6 +192,11 @@ declare module 'stripe' { * 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_pay?: PaymentMethodConfigurationCreateParams.WechatPay; + + /** + * 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?: PaymentMethodConfigurationCreateParams.Zip; } namespace PaymentMethodConfigurationCreateParams { @@ -894,6 +899,26 @@ declare module 'stripe' { type Preference = 'none' | 'off' | 'on'; } } + + interface Zip { + /** + * Whether or not the payment method should be displayed. + */ + display_preference?: Zip.DisplayPreference; + } + + namespace Zip { + interface DisplayPreference { + /** + * The account's preference for whether or not to display this payment method. + */ + preference?: DisplayPreference.Preference; + } + + namespace DisplayPreference { + type Preference = 'none' | 'off' | 'on'; + } + } } interface PaymentMethodConfigurationRetrieveParams { @@ -1093,6 +1118,11 @@ declare module 'stripe' { * 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_pay?: PaymentMethodConfigurationUpdateParams.WechatPay; + + /** + * 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?: PaymentMethodConfigurationUpdateParams.Zip; } namespace PaymentMethodConfigurationUpdateParams { @@ -1795,6 +1825,26 @@ declare module 'stripe' { type Preference = 'none' | 'off' | 'on'; } } + + interface Zip { + /** + * Whether or not the payment method should be displayed. + */ + display_preference?: Zip.DisplayPreference; + } + + namespace Zip { + interface DisplayPreference { + /** + * The account's preference for whether or not to display this payment method. + */ + preference?: DisplayPreference.Preference; + } + + namespace DisplayPreference { + type Preference = 'none' | 'off' | 'on'; + } + } } interface PaymentMethodConfigurationListParams { diff --git a/types/QuotesResource.d.ts b/types/QuotesResource.d.ts index d5017f8952..96c4fa735e 100644 --- a/types/QuotesResource.d.ts +++ b/types/QuotesResource.d.ts @@ -147,6 +147,11 @@ declare module 'stripe' { * ID of an existing discount on the object (or one of its ancestors) to reuse. */ discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; } interface FromQuote { @@ -192,6 +197,11 @@ declare module 'stripe' { } interface LineItem { + /** + * The discounts applied to this line item. + */ + discounts?: Stripe.Emptyable>; + /** * The ID of the price object. One of `price` or `price_data` is required. */ @@ -214,6 +224,23 @@ declare module 'stripe' { } namespace LineItem { + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface PriceData { /** * 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). @@ -449,6 +476,11 @@ declare module 'stripe' { * ID of an existing discount on the object (or one of its ancestors) to reuse. */ discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; } interface InvoiceSettings { @@ -482,6 +514,11 @@ declare module 'stripe' { } interface LineItem { + /** + * The discounts applied to this line item. + */ + discounts?: Stripe.Emptyable>; + /** * The ID of an existing line item on the quote. */ @@ -509,6 +546,23 @@ declare module 'stripe' { } namespace LineItem { + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface PriceData { /** * 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). diff --git a/types/SetupAttempts.d.ts b/types/SetupAttempts.d.ts index b5118dabe9..7cb99f785e 100644 --- a/types/SetupAttempts.d.ts +++ b/types/SetupAttempts.d.ts @@ -361,6 +361,20 @@ declare module 'stripe' { * The ID of the Card PaymentMethod which was generated by this SetupAttempt. */ generated_card: string | Stripe.PaymentMethod | null; + + /** + * Details about payments collected offline. + */ + offline: CardPresent.Offline | null; + } + + namespace CardPresent { + interface Offline { + /** + * Time at which the payment was collected while offline + */ + stored_at: number | null; + } } interface Cashapp {} diff --git a/types/SetupIntents.d.ts b/types/SetupIntents.d.ts index f39f30186c..4bfb518386 100644 --- a/types/SetupIntents.d.ts +++ b/types/SetupIntents.d.ts @@ -568,6 +568,8 @@ declare module 'stripe' { card?: PaymentMethodOptions.Card; + card_present?: PaymentMethodOptions.CardPresent; + link?: PaymentMethodOptions.Link; paypal?: PaymentMethodOptions.Paypal; @@ -729,6 +731,8 @@ declare module 'stripe' { | 'challenge_only'; } + interface CardPresent {} + interface Link { /** * [Deprecated] This is a legacy parameter that no longer has any function. diff --git a/types/SetupIntentsResource.d.ts b/types/SetupIntentsResource.d.ts index 61fba8a7a3..5c61b3f8b5 100644 --- a/types/SetupIntentsResource.d.ts +++ b/types/SetupIntentsResource.d.ts @@ -764,6 +764,11 @@ declare module 'stripe' { */ card?: PaymentMethodOptions.Card; + /** + * If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options. + */ + card_present?: PaymentMethodOptions.CardPresent; + /** * If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options. */ @@ -1040,6 +1045,8 @@ declare module 'stripe' { } } + interface CardPresent {} + interface Link { /** * [Deprecated] This is a legacy parameter that no longer has any function. @@ -1812,6 +1819,11 @@ declare module 'stripe' { */ card?: PaymentMethodOptions.Card; + /** + * If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options. + */ + card_present?: PaymentMethodOptions.CardPresent; + /** * If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options. */ @@ -2088,6 +2100,8 @@ declare module 'stripe' { } } + interface CardPresent {} + interface Link { /** * [Deprecated] This is a legacy parameter that no longer has any function. @@ -2947,6 +2961,11 @@ declare module 'stripe' { */ card?: PaymentMethodOptions.Card; + /** + * If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options. + */ + card_present?: PaymentMethodOptions.CardPresent; + /** * If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options. */ @@ -3223,6 +3242,8 @@ declare module 'stripe' { } } + interface CardPresent {} + interface Link { /** * [Deprecated] This is a legacy parameter that no longer has any function. diff --git a/types/SubscriptionItems.d.ts b/types/SubscriptionItems.d.ts index fe8c9c2c05..1de6d22fe4 100644 --- a/types/SubscriptionItems.d.ts +++ b/types/SubscriptionItems.d.ts @@ -52,6 +52,11 @@ declare module 'stripe' { */ deleted?: void; + /** + * The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. + */ + discounts: Array; + /** * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ diff --git a/types/SubscriptionItemsResource.d.ts b/types/SubscriptionItemsResource.d.ts index 03ab64fa48..2c92d11501 100644 --- a/types/SubscriptionItemsResource.d.ts +++ b/types/SubscriptionItemsResource.d.ts @@ -15,6 +15,13 @@ declare module 'stripe' { SubscriptionItemCreateParams.BillingThresholds >; + /** + * The coupons to redeem into discounts for the subscription item. + */ + discounts?: Stripe.Emptyable< + Array + >; + /** * Specifies which fields in the response should be expanded. */ @@ -80,6 +87,23 @@ declare module 'stripe' { usage_gte: number; } + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + type PaymentBehavior = | 'allow_incomplete' | 'default_incomplete' @@ -156,6 +180,13 @@ declare module 'stripe' { SubscriptionItemUpdateParams.BillingThresholds >; + /** + * The coupons to redeem into discounts for the subscription item. + */ + discounts?: Stripe.Emptyable< + Array + >; + /** * Specifies which fields in the response should be expanded. */ @@ -226,6 +257,23 @@ declare module 'stripe' { usage_gte: number; } + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + type PaymentBehavior = | 'allow_incomplete' | 'default_incomplete' diff --git a/types/SubscriptionSchedules.d.ts b/types/SubscriptionSchedules.d.ts index e8046ef596..5fe955a248 100644 --- a/types/SubscriptionSchedules.d.ts +++ b/types/SubscriptionSchedules.d.ts @@ -308,6 +308,11 @@ declare module 'stripe' { */ description: string | null; + /** + * The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts. + */ + discounts: Array; + /** * The end of this phase of the subscription schedule. */ @@ -356,6 +361,11 @@ declare module 'stripe' { namespace Phase { interface AddInvoiceItem { + /** + * The stackable discounts that will be applied to the item. + */ + discounts: Array; + /** * ID of the price used to generate the invoice item. */ @@ -372,6 +382,25 @@ declare module 'stripe' { tax_rates?: Array | null; } + namespace AddInvoiceItem { + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon: string | Stripe.Coupon | null; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount: string | Stripe.Discount | null; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code: string | Stripe.PromotionCode | null; + } + } + interface AutomaticTax { /** * Whether Stripe automatically computes tax on invoices created during this phase. @@ -418,6 +447,23 @@ declare module 'stripe' { type CollectionMethod = 'charge_automatically' | 'send_invoice'; + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon: string | Stripe.Coupon | null; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount: string | Stripe.Discount | null; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code: string | Stripe.PromotionCode | null; + } + interface InvoiceSettings { /** * The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. @@ -461,6 +507,11 @@ declare module 'stripe' { */ billing_thresholds: Item.BillingThresholds | null; + /** + * The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. + */ + discounts: Array; + /** * 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. */ @@ -494,6 +545,23 @@ declare module 'stripe' { */ usage_gte: number | null; } + + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon: string | Stripe.Coupon | null; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount: string | Stripe.Discount | null; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code: string | Stripe.PromotionCode | null; + } } type ProrationBehavior = diff --git a/types/SubscriptionSchedulesResource.d.ts b/types/SubscriptionSchedulesResource.d.ts index 7839e5ab96..1441e08ed2 100644 --- a/types/SubscriptionSchedulesResource.d.ts +++ b/types/SubscriptionSchedulesResource.d.ts @@ -228,7 +228,7 @@ declare module 'stripe' { collection_method?: Phase.CollectionMethod; /** - * The identifier of the coupon to apply to this phase of the subscription schedule. + * The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; @@ -252,6 +252,11 @@ declare module 'stripe' { */ description?: Stripe.Emptyable; + /** + * The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts. + */ + discounts?: Stripe.Emptyable>; + /** * The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set. */ @@ -305,6 +310,11 @@ declare module 'stripe' { namespace Phase { interface AddInvoiceItem { + /** + * The coupons to redeem into discounts for the item. + */ + discounts?: Array; + /** * The ID of the price object. */ @@ -327,6 +337,23 @@ declare module 'stripe' { } namespace AddInvoiceItem { + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface PriceData { /** * 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). @@ -405,6 +432,23 @@ declare module 'stripe' { type CollectionMethod = 'charge_automatically' | 'send_invoice'; + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface InvoiceSettings { /** * The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. @@ -446,6 +490,11 @@ declare module 'stripe' { */ billing_thresholds?: Stripe.Emptyable; + /** + * The coupons to redeem into discounts for the subscription item. + */ + discounts?: Stripe.Emptyable>; + /** * 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`. */ @@ -485,6 +534,23 @@ declare module 'stripe' { usage_gte: number; } + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface PriceData { /** * 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). @@ -780,7 +846,7 @@ declare module 'stripe' { collection_method?: Phase.CollectionMethod; /** - * The identifier of the coupon to apply to this phase of the subscription schedule. + * The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; @@ -804,6 +870,11 @@ declare module 'stripe' { */ description?: Stripe.Emptyable; + /** + * The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts. + */ + discounts?: Stripe.Emptyable>; + /** * The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set. */ @@ -862,6 +933,11 @@ declare module 'stripe' { namespace Phase { interface AddInvoiceItem { + /** + * The coupons to redeem into discounts for the item. + */ + discounts?: Array; + /** * The ID of the price object. */ @@ -884,6 +960,23 @@ declare module 'stripe' { } namespace AddInvoiceItem { + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface PriceData { /** * 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). @@ -962,6 +1055,23 @@ declare module 'stripe' { type CollectionMethod = 'charge_automatically' | 'send_invoice'; + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface InvoiceSettings { /** * The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. @@ -1003,6 +1113,11 @@ declare module 'stripe' { */ billing_thresholds?: Stripe.Emptyable; + /** + * The coupons to redeem into discounts for the subscription item. + */ + discounts?: Stripe.Emptyable>; + /** * 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`. */ @@ -1042,6 +1157,23 @@ declare module 'stripe' { usage_gte: number; } + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface PriceData { /** * 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). diff --git a/types/Subscriptions.d.ts b/types/Subscriptions.d.ts index d439acde92..7d5eae609d 100644 --- a/types/Subscriptions.d.ts +++ b/types/Subscriptions.d.ts @@ -125,10 +125,15 @@ declare module 'stripe' { description: string | null; /** - * Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. + * Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ discount: Stripe.Discount | null; + /** + * The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. + */ + discounts: Array; + /** * If the subscription has ended, the date the subscription ended. */ diff --git a/types/SubscriptionsResource.d.ts b/types/SubscriptionsResource.d.ts index 667f239494..cc1f4817c6 100644 --- a/types/SubscriptionsResource.d.ts +++ b/types/SubscriptionsResource.d.ts @@ -61,7 +61,7 @@ declare module 'stripe' { collection_method?: SubscriptionCreateParams.CollectionMethod; /** - * The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. + * The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; @@ -95,6 +95,11 @@ declare module 'stripe' { */ description?: string; + /** + * The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer. + */ + discounts?: Stripe.Emptyable>; + /** * Specifies which fields in the response should be expanded. */ @@ -153,7 +158,7 @@ declare module 'stripe' { >; /** - * The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. + * The ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ promotion_code?: string; @@ -190,6 +195,11 @@ declare module 'stripe' { namespace SubscriptionCreateParams { interface AddInvoiceItem { + /** + * The coupons to redeem into discounts for the item. + */ + discounts?: Array; + /** * The ID of the price object. */ @@ -212,6 +222,23 @@ declare module 'stripe' { } namespace AddInvoiceItem { + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface PriceData { /** * 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). @@ -315,6 +342,23 @@ declare module 'stripe' { type CollectionMethod = 'charge_automatically' | 'send_invoice'; + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface InvoiceSettings { /** * The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription. @@ -351,6 +395,11 @@ declare module 'stripe' { */ billing_thresholds?: Stripe.Emptyable; + /** + * The coupons to redeem into discounts for the subscription item. + */ + discounts?: Stripe.Emptyable>; + /** * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ @@ -390,6 +439,23 @@ declare module 'stripe' { usage_gte: number; } + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface PriceData { /** * 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). @@ -820,7 +886,7 @@ declare module 'stripe' { collection_method?: SubscriptionUpdateParams.CollectionMethod; /** - * The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. + * The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; @@ -849,6 +915,11 @@ declare module 'stripe' { */ description?: Stripe.Emptyable; + /** + * The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer. + */ + discounts?: Stripe.Emptyable>; + /** * Specifies which fields in the response should be expanded. */ @@ -947,6 +1018,11 @@ declare module 'stripe' { namespace SubscriptionUpdateParams { interface AddInvoiceItem { + /** + * The coupons to redeem into discounts for the item. + */ + discounts?: Array; + /** * The ID of the price object. */ @@ -969,6 +1045,23 @@ declare module 'stripe' { } namespace AddInvoiceItem { + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface PriceData { /** * 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). @@ -1071,6 +1164,23 @@ declare module 'stripe' { type CollectionMethod = 'charge_automatically' | 'send_invoice'; + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface InvoiceSettings { /** * The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription. @@ -1117,6 +1227,11 @@ declare module 'stripe' { */ deleted?: boolean; + /** + * The coupons to redeem into discounts for the subscription item. + */ + discounts?: Stripe.Emptyable>; + /** * Subscription item to update. */ @@ -1161,6 +1276,23 @@ declare module 'stripe' { usage_gte: number; } + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + + /** + * ID of the promotion code to create a new discount for. + */ + promotion_code?: string; + } + interface PriceData { /** * 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). diff --git a/types/Terminal/Readers.d.ts b/types/Terminal/Readers.d.ts index 5685301100..15f312cbb2 100644 --- a/types/Terminal/Readers.d.ts +++ b/types/Terminal/Readers.d.ts @@ -55,7 +55,7 @@ declare module 'stripe' { device_sw_version: string | null; /** - * Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, or `simulated_wisepos_e`. + * Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`. */ device_type: Reader.DeviceType; @@ -331,6 +331,7 @@ declare module 'stripe' { | 'bbpos_chipper2x' | 'bbpos_wisepad3' | 'bbpos_wisepos_e' + | 'mobile_phone_reader' | 'simulated_wisepos_e' | 'stripe_m2' | 'verifone_P400'; diff --git a/types/Terminal/ReadersResource.d.ts b/types/Terminal/ReadersResource.d.ts index c52bf9f97a..243eccdc69 100644 --- a/types/Terminal/ReadersResource.d.ts +++ b/types/Terminal/ReadersResource.d.ts @@ -86,6 +86,7 @@ declare module 'stripe' { | 'bbpos_chipper2x' | 'bbpos_wisepad3' | 'bbpos_wisepos_e' + | 'mobile_phone_reader' | 'simulated_wisepos_e' | 'stripe_m2' | 'verifone_P400'; diff --git a/types/TokensResource.d.ts b/types/TokensResource.d.ts index b4b30411d3..b55d1d3020 100644 --- a/types/TokensResource.d.ts +++ b/types/TokensResource.d.ts @@ -62,7 +62,7 @@ declare module 'stripe' { individual?: Account.Individual; /** - * Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](https://stripe.com/docs/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`. + * Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](https://docs.stripe.com/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`. */ tos_shown_and_accepted?: boolean; } @@ -91,12 +91,12 @@ declare module 'stripe' { address_kanji?: Stripe.JapanAddressParam; /** - * Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided. + * 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/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided. */ directors_provided?: boolean; /** - * Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` requirement. + * 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/persons) for accounts with a `relationship.executive` requirement. */ executives_provided?: boolean; @@ -126,7 +126,7 @@ declare module 'stripe' { name_kanji?: string; /** - * Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.owner` requirement. + * 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/persons) for accounts with a `relationship.owner` requirement. */ owners_provided?: boolean; @@ -151,7 +151,7 @@ declare module 'stripe' { registration_number?: string; /** - * The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value. + * The category identifying the legal structure of the company or legal entity. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value. */ structure?: Stripe.Emptyable; @@ -293,12 +293,12 @@ declare module 'stripe' { gender?: string; /** - * The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + * The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number?: string; /** - * The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + * The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number_secondary?: string; @@ -642,12 +642,12 @@ declare module 'stripe' { gender?: string; /** - * The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + * The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number?: string; /** - * The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + * The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number_secondary?: string;