diff --git a/embedded/openapi/fixtures3.json b/embedded/openapi/fixtures3.json
index 308f4684..2e924b96 100644
--- a/embedded/openapi/fixtures3.json
+++ b/embedded/openapi/fixtures3.json
@@ -577,7 +577,8 @@
"status": "unavailable"
},
"three_d_secure": null,
- "wallet": null
+ "wallet": null,
+ "authorization_code": null
},
"type": "card"
},
@@ -664,7 +665,6 @@
"setup_intent": null,
"shipping_address_collection": null,
"shipping_cost": null,
- "shipping_details": null,
"shipping_options": [],
"status": "open",
"submit_type": null,
@@ -672,7 +672,8 @@
"success_url": "https://example.com/success",
"total_details": null,
"ui_mode": "hosted",
- "url": "https://checkout.stripe.com/pay/c/cs_test_a1YS1URlnyQCN5fUUduORoQ7Pw41PJqDWkIVQCpJPqkfIhd6tVY8XB1OLY"
+ "url": "https://checkout.stripe.com/pay/c/cs_test_a1YS1URlnyQCN5fUUduORoQ7Pw41PJqDWkIVQCpJPqkfIhd6tVY8XB1OLY",
+ "shipping_details": null
},
"climate.order": {
"amount_fees": 300,
@@ -3496,24 +3497,7 @@
"interval_start": 1522540800
},
"report_type": "balance.summary.1",
- "result": {
- "created": 1721948551,
- "expires_at": 1753484551,
- "filename": "file_1Pgag7B7WZ01zgkWZFBKk3TC",
- "id": "file_1Pgag7B7WZ01zgkWZFBKk3TC",
- "links": {
- "data": [],
- "has_more": false,
- "object": "list",
- "url": "/v1/file_links?file=file_1Pgag7B7WZ01zgkWZFBKk3TC"
- },
- "object": "file",
- "purpose": "finance_report_run",
- "size": 16890,
- "title": null,
- "type": "csv",
- "url": "https://sangeekp-15t6ai--upload-mydev.dev.stripe.me/v1/files/file_1Pgag7B7WZ01zgkWZFBKk3TC/contents"
- },
+ "result": null,
"status": "succeeded",
"succeeded_at": 1234567890
},
@@ -3551,24 +3535,7 @@
"scheduled_query_run": {
"created": 1234567890,
"data_load_time": 1234567890,
- "file": {
- "created": 1721948551,
- "expires_at": null,
- "filename": "path",
- "id": "file_1Pgag7B7WZ01zgkWJbdoNCXR",
- "links": {
- "data": [],
- "has_more": false,
- "object": "list",
- "url": "/v1/file_links?file=file_1Pgag7B7WZ01zgkWJbdoNCXR"
- },
- "object": "file",
- "purpose": "sigma_scheduled_query",
- "size": 500,
- "title": null,
- "type": "csv",
- "url": "https://sangeekp-15t6ai--upload-mydev.dev.stripe.me/v1/files/file_1Pgag7B7WZ01zgkWJbdoNCXR/contents"
- },
+ "file": null,
"id": "sqr_1Pgc7AB7WZ01zgkWvpIic1Di",
"livemode": false,
"object": "scheduled_query_run",
diff --git a/embedded/openapi/spec3.beta.sdk.json b/embedded/openapi/spec3.beta.sdk.json
index 2be88698..59ba1da3 100644
--- a/embedded/openapi/spec3.beta.sdk.json
+++ b/embedded/openapi/spec3.beta.sdk.json
@@ -100,6 +100,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"future_requirements": {
@@ -181,6 +187,19 @@
"tos_acceptance"
],
"x-resourceId": "account",
+ "x-stripeMostCommon": [
+ "business_type",
+ "capabilities",
+ "company",
+ "country",
+ "email",
+ "id",
+ "individual",
+ "metadata",
+ "requirements",
+ "tos_acceptance",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -409,7 +428,12 @@
],
"title": "AccountAnnualRevenue",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "fiscal_year_end"
+ ]
},
"account_bacs_debit_payments_settings": {
"description": "",
@@ -433,7 +457,11 @@
],
"title": "AccountBacsDebitPaymentsSettings",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "display_name",
+ "service_user_number"
+ ]
},
"account_branding_settings": {
"description": "",
@@ -502,6 +530,12 @@
"x-expandableFields": [
"icon",
"logo"
+ ],
+ "x-stripeMostCommon": [
+ "icon",
+ "logo",
+ "primary_color",
+ "secondary_color"
]
},
"account_business_profile": {
@@ -593,6 +627,19 @@
"annual_revenue",
"monthly_estimated_revenue",
"support_address"
+ ],
+ "x-stripeMostCommon": [
+ "annual_revenue",
+ "estimated_worker_count",
+ "mcc",
+ "monthly_estimated_revenue",
+ "name",
+ "product_description",
+ "support_address",
+ "support_email",
+ "support_phone",
+ "support_url",
+ "url"
]
},
"account_capabilities": {
@@ -841,6 +888,15 @@
],
"type": "string"
},
+ "mb_way_payments": {
+ "description": "The status of the MB WAY payments capability of the account, or whether the account can directly process MB WAY charges.",
+ "enum": [
+ "active",
+ "inactive",
+ "pending"
+ ],
+ "type": "string"
+ },
"mobilepay_payments": {
"description": "The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges.",
"enum": [
@@ -1051,7 +1107,60 @@
},
"title": "AccountCapabilities",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "acss_debit_payments",
+ "affirm_payments",
+ "afterpay_clearpay_payments",
+ "amazon_pay_payments",
+ "au_becs_debit_payments",
+ "bacs_debit_payments",
+ "bancontact_payments",
+ "bank_transfer_payments",
+ "blik_payments",
+ "boleto_payments",
+ "card_issuing",
+ "card_payments",
+ "cartes_bancaires_payments",
+ "cashapp_payments",
+ "eps_payments",
+ "fpx_payments",
+ "gb_bank_transfer_payments",
+ "giropay_payments",
+ "grabpay_payments",
+ "ideal_payments",
+ "india_international_payments",
+ "jcb_payments",
+ "jp_bank_transfer_payments",
+ "klarna_payments",
+ "konbini_payments",
+ "legacy_payments",
+ "link_payments",
+ "mb_way_payments",
+ "mobilepay_payments",
+ "multibanco_payments",
+ "mx_bank_transfer_payments",
+ "oxxo_payments",
+ "p24_payments",
+ "paynow_payments",
+ "paypal_payments",
+ "payto_payments",
+ "promptpay_payments",
+ "rechnung_payments",
+ "revolut_pay_payments",
+ "sepa_bank_transfer_payments",
+ "sepa_debit_payments",
+ "sofort_payments",
+ "swish_payments",
+ "tax_reporting_us_1099_k",
+ "tax_reporting_us_1099_misc",
+ "transfers",
+ "treasury",
+ "twint_payments",
+ "us_bank_account_ach_payments",
+ "us_bank_transfer_payments",
+ "zip_payments"
+ ]
},
"account_capability_future_requirements": {
"description": "",
@@ -1142,6 +1251,16 @@
"x-expandableFields": [
"alternatives",
"errors"
+ ],
+ "x-stripeMostCommon": [
+ "alternatives",
+ "current_deadline",
+ "currently_due",
+ "disabled_reason",
+ "errors",
+ "eventually_due",
+ "past_due",
+ "pending_verification"
]
},
"account_capability_requirements": {
@@ -1233,6 +1352,16 @@
"x-expandableFields": [
"alternatives",
"errors"
+ ],
+ "x-stripeMostCommon": [
+ "alternatives",
+ "current_deadline",
+ "currently_due",
+ "disabled_reason",
+ "errors",
+ "eventually_due",
+ "past_due",
+ "pending_verification"
]
},
"account_capital_settings": {
@@ -1260,7 +1389,11 @@
},
"title": "AccountCapitalSettings",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "payout_destination",
+ "payout_destination_selector"
+ ]
},
"account_card_issuing_settings": {
"description": "",
@@ -1273,6 +1406,9 @@
"type": "object",
"x-expandableFields": [
"tos_acceptance"
+ ],
+ "x-stripeMostCommon": [
+ "tos_acceptance"
]
},
"account_card_payments_settings": {
@@ -1309,6 +1445,12 @@
"type": "object",
"x-expandableFields": [
"decline_on"
+ ],
+ "x-stripeMostCommon": [
+ "decline_on",
+ "statement_descriptor_prefix",
+ "statement_descriptor_prefix_kana",
+ "statement_descriptor_prefix_kanji"
]
},
"account_dashboard_settings": {
@@ -1333,7 +1475,11 @@
],
"title": "AccountDashboardSettings",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "display_name",
+ "timezone"
+ ]
},
"account_decline_charge_on": {
"description": "",
@@ -1353,7 +1499,11 @@
],
"title": "AccountDeclineChargeOn",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "avs_failure",
+ "cvc_failure"
+ ]
},
"account_future_requirements": {
"description": "",
@@ -1438,6 +1588,16 @@
"x-expandableFields": [
"alternatives",
"errors"
+ ],
+ "x-stripeMostCommon": [
+ "alternatives",
+ "current_deadline",
+ "currently_due",
+ "disabled_reason",
+ "errors",
+ "eventually_due",
+ "past_due",
+ "pending_verification"
]
},
"account_invoices_settings": {
@@ -1474,6 +1634,9 @@
"type": "object",
"x-expandableFields": [
"default_account_tax_ids"
+ ],
+ "x-stripeMostCommon": [
+ "default_account_tax_ids"
]
},
"account_link": {
@@ -1512,6 +1675,10 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "account_link",
+ "x-stripeMostCommon": [
+ "expires_at",
+ "url"
+ ],
"x-stripeOperations": [
{
"method_name": "create",
@@ -1544,7 +1711,11 @@
],
"title": "AccountMonthlyEstimatedRevenue",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "currency"
+ ]
},
"account_notice": {
"description": "A notice to a Connected account. Notice can be sent by Stripe on your behalf or you can opt to send the notices yourself.\n\nSee the [guide to send notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) to your connected accounts.",
@@ -1648,6 +1819,15 @@
"linked_objects"
],
"x-resourceId": "account_notice",
+ "x-stripeMostCommon": [
+ "deadline",
+ "email",
+ "id",
+ "linked_objects",
+ "metadata",
+ "reason",
+ "sent_at"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -1752,7 +1932,14 @@
],
"title": "AccountPaymentsSettings",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "statement_descriptor",
+ "statement_descriptor_kana",
+ "statement_descriptor_kanji",
+ "statement_descriptor_prefix_kana",
+ "statement_descriptor_prefix_kanji"
+ ]
},
"account_payout_settings": {
"description": "",
@@ -1780,6 +1967,11 @@
"type": "object",
"x-expandableFields": [
"schedule"
+ ],
+ "x-stripeMostCommon": [
+ "debit_negative_balances",
+ "schedule",
+ "statement_descriptor"
]
},
"account_requirements": {
@@ -1865,6 +2057,16 @@
"x-expandableFields": [
"alternatives",
"errors"
+ ],
+ "x-stripeMostCommon": [
+ "alternatives",
+ "current_deadline",
+ "currently_due",
+ "disabled_reason",
+ "errors",
+ "eventually_due",
+ "past_due",
+ "pending_verification"
]
},
"account_requirements_alternative": {
@@ -1893,7 +2095,11 @@
],
"title": "AccountRequirementsAlternative",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "alternative_fields_due",
+ "original_fields_due"
+ ]
},
"account_requirements_error": {
"description": "",
@@ -2012,7 +2218,12 @@
],
"title": "AccountRequirementsError",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "code",
+ "reason",
+ "requirement"
+ ]
},
"account_sepa_debit_payments_settings": {
"description": "",
@@ -2025,7 +2236,10 @@
},
"title": "AccountSepaDebitPaymentsSettings",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "creditor_id"
+ ]
},
"account_session": {
"description": "An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.\n\nWe recommend that you create an AccountSession each time you need to display an embedded component\nto your user. Do not save AccountSessions to your database as they expire relatively\nquickly, and cannot be used more than once.\n\nRelated guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components)",
@@ -2074,6 +2288,12 @@
"components"
],
"x-resourceId": "account_session",
+ "x-stripeMostCommon": [
+ "account",
+ "client_secret",
+ "components",
+ "expires_at"
+ ],
"x-stripeOperations": [
{
"method_name": "create",
@@ -2149,6 +2369,20 @@
"sepa_debit_payments",
"tax_forms",
"treasury"
+ ],
+ "x-stripeMostCommon": [
+ "bacs_debit_payments",
+ "branding",
+ "capital",
+ "card_issuing",
+ "card_payments",
+ "dashboard",
+ "invoices",
+ "payments",
+ "payouts",
+ "sepa_debit_payments",
+ "tax_forms",
+ "treasury"
]
},
"account_terms_of_service": {
@@ -2177,7 +2411,12 @@
],
"title": "AccountTermsOfService",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
},
"account_tos_acceptance": {
"description": "",
@@ -2208,7 +2447,13 @@
},
"title": "AccountTOSAcceptance",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "service_agreement",
+ "user_agent"
+ ]
},
"account_treasury_settings": {
"description": "",
@@ -2221,6 +2466,9 @@
"type": "object",
"x-expandableFields": [
"tos_acceptance"
+ ],
+ "x-stripeMostCommon": [
+ "tos_acceptance"
]
},
"account_unification_account_controller": {
@@ -2273,6 +2521,16 @@
"fees",
"losses",
"stripe_dashboard"
+ ],
+ "x-stripeMostCommon": [
+ "application",
+ "dashboard",
+ "fees",
+ "is_controller",
+ "losses",
+ "requirement_collection",
+ "stripe_dashboard",
+ "type"
]
},
"account_unification_account_controller_application": {
@@ -2298,7 +2556,12 @@
],
"title": "AccountUnificationAccountControllerApplication",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "loss_liable",
+ "onboarding_owner",
+ "pricing_controls"
+ ]
},
"account_unification_account_controller_dashboard": {
"description": "",
@@ -2318,7 +2581,10 @@
],
"title": "AccountUnificationAccountControllerDashboard",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"account_unification_account_controller_fees": {
"description": "",
@@ -2340,7 +2606,10 @@
],
"title": "AccountUnificationAccountControllerFees",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "payer"
+ ]
},
"account_unification_account_controller_losses": {
"description": "",
@@ -2359,7 +2628,10 @@
],
"title": "AccountUnificationAccountControllerLosses",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "payments"
+ ]
},
"account_unification_account_controller_stripe_dashboard": {
"description": "",
@@ -2379,7 +2651,10 @@
],
"title": "AccountUnificationAccountControllerStripeDashboard",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"address": {
"description": "",
@@ -2432,6 +2707,14 @@
"title": "Address",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ],
"x-stripeResource": {
"class_name": "Address",
"in_package": ""
@@ -2612,6 +2895,7 @@
"taxes_calculation_failed",
"terminal_location_country_unsupported",
"terminal_reader_busy",
+ "terminal_reader_collected_data_invalid",
"terminal_reader_hardware_fault",
"terminal_reader_invalid_location_for_payment",
"terminal_reader_offline",
@@ -2692,6 +2976,14 @@
"setup_intent",
"source"
],
+ "x-stripeMostCommon": [
+ "code",
+ "decline_code",
+ "message",
+ "param",
+ "payment_intent",
+ "type"
+ ],
"x-stripeResource": {
"class_name": "StripeError",
"in_package": ""
@@ -2737,6 +3029,13 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "apple_pay_domain",
+ "x-stripeMostCommon": [
+ "created",
+ "domain_name",
+ "id",
+ "livemode",
+ "object"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -2803,6 +3102,11 @@
"title": "Application",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "id",
+ "name",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "Application",
"in_package": ""
@@ -2991,6 +3295,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
},
@@ -3023,6 +3333,23 @@
"refunds"
],
"x-resourceId": "application_fee",
+ "x-stripeMostCommon": [
+ "account",
+ "amount",
+ "amount_refunded",
+ "application",
+ "balance_transaction",
+ "charge",
+ "created",
+ "currency",
+ "fee_source",
+ "id",
+ "livemode",
+ "object",
+ "originating_transaction",
+ "refunded",
+ "refunds"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -3160,6 +3487,17 @@
"scope"
],
"x-resourceId": "apps.secret",
+ "x-stripeMostCommon": [
+ "created",
+ "deleted",
+ "expires_at",
+ "id",
+ "livemode",
+ "name",
+ "object",
+ "payload",
+ "scope"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -3232,6 +3570,11 @@
"type": "object",
"x-expandableFields": [
"liability"
+ ],
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability",
+ "status"
]
},
"balance": {
@@ -3296,6 +3639,10 @@
"pending"
],
"x-resourceId": "balance",
+ "x-stripeMostCommon": [
+ "available",
+ "pending"
+ ],
"x-stripeOperations": [
{
"method_name": "retrieve",
@@ -3349,6 +3696,11 @@
"type": "object",
"x-expandableFields": [
"source_types"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "source_types"
]
},
"balance_amount_by_source_type": {
@@ -3369,7 +3721,12 @@
},
"title": "BalanceAmountBySourceType",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bank_account",
+ "card",
+ "fpx"
+ ]
},
"balance_amount_net": {
"description": "",
@@ -3402,6 +3759,12 @@
"x-expandableFields": [
"net_available",
"source_types"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "net_available",
+ "source_types"
]
},
"balance_detail": {
@@ -3422,6 +3785,9 @@
"type": "object",
"x-expandableFields": [
"available"
+ ],
+ "x-stripeMostCommon": [
+ "available"
]
},
"balance_net_available": {
@@ -3448,6 +3814,11 @@
"type": "object",
"x-expandableFields": [
"source_types"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "destination",
+ "source_types"
]
},
"balance_transaction": {
@@ -3610,6 +3981,18 @@
"source"
],
"x-resourceId": "balance_transaction",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "fee",
+ "fee_details",
+ "id",
+ "net",
+ "source",
+ "status",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -3873,6 +4256,19 @@
"requirements"
],
"x-resourceId": "bank_account",
+ "x-stripeMostCommon": [
+ "account_holder_name",
+ "account_holder_type",
+ "bank_name",
+ "country",
+ "currency",
+ "customer",
+ "fingerprint",
+ "id",
+ "last4",
+ "metadata",
+ "routing_number"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -3979,6 +4375,11 @@
"x-expandableFields": [
"account",
"customer"
+ ],
+ "x-stripeMostCommon": [
+ "account",
+ "customer",
+ "type"
]
},
"bank_connections_resource_balance": {
@@ -4021,6 +4422,13 @@
"x-expandableFields": [
"cash",
"credit"
+ ],
+ "x-stripeMostCommon": [
+ "as_of",
+ "cash",
+ "credit",
+ "current",
+ "type"
]
},
"bank_connections_resource_balance_api_resource_cash_balance": {
@@ -4040,7 +4448,10 @@
],
"title": "BankConnectionsResourceBalanceAPIResourceCashBalance",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "available"
+ ]
},
"bank_connections_resource_balance_api_resource_credit_balance": {
"description": "",
@@ -4059,7 +4470,10 @@
],
"title": "BankConnectionsResourceBalanceAPIResourceCreditBalance",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "used"
+ ]
},
"bank_connections_resource_balance_refresh": {
"description": "",
@@ -4092,7 +4506,12 @@
],
"title": "BankConnectionsResourceBalanceRefresh",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "last_attempted_at",
+ "next_refresh_available_at",
+ "status"
+ ]
},
"bank_connections_resource_inferred_balances_refresh": {
"description": "",
@@ -4125,7 +4544,12 @@
],
"title": "BankConnectionsResourceInferredBalancesRefresh",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "last_attempted_at",
+ "next_refresh_available_at",
+ "status"
+ ]
},
"bank_connections_resource_institution_feature_support": {
"description": "",
@@ -4156,6 +4580,12 @@
"ownership",
"payment_method",
"transactions"
+ ],
+ "x-stripeMostCommon": [
+ "balances",
+ "ownership",
+ "payment_method",
+ "transactions"
]
},
"bank_connections_resource_institution_supported_feature": {
@@ -4171,7 +4601,10 @@
],
"title": "BankConnectionsResourceInstitutionSupportedFeature",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "supported"
+ ]
},
"bank_connections_resource_link_account_session_filters": {
"description": "",
@@ -4212,7 +4645,12 @@
],
"title": "BankConnectionsResourceLinkAccountSessionFilters",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_subcategories",
+ "countries",
+ "institution"
+ ]
},
"bank_connections_resource_link_account_session_limits": {
"description": "",
@@ -4227,7 +4665,10 @@
],
"title": "BankConnectionsResourceLinkAccountSessionLimits",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "accounts"
+ ]
},
"bank_connections_resource_link_account_session_manual_entry": {
"description": "",
@@ -4247,6 +4688,9 @@
"type": "object",
"x-expandableFields": [
"cancelled"
+ ],
+ "x-stripeMostCommon": [
+ "cancelled"
]
},
"bank_connections_resource_link_account_session_status_details_resource_cancelled_status_details": {
@@ -4266,7 +4710,10 @@
],
"title": "BankConnectionsResourceLinkAccountSessionStatusDetailsResourceCancelledStatusDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reason"
+ ]
},
"bank_connections_resource_ownership_refresh": {
"description": "",
@@ -4299,7 +4746,12 @@
],
"title": "BankConnectionsResourceOwnershipRefresh",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "last_attempted_at",
+ "next_refresh_available_at",
+ "status"
+ ]
},
"bank_connections_resource_transaction_refresh": {
"description": "",
@@ -4338,7 +4790,13 @@
],
"title": "BankConnectionsResourceTransactionRefresh",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "id",
+ "last_attempted_at",
+ "next_refresh_available_at",
+ "status"
+ ]
},
"bank_connections_resource_transaction_resource_status_transitions": {
"description": "",
@@ -4362,7 +4820,11 @@
],
"title": "BankConnectionsResourceTransactionResourceStatusTransitions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "posted_at",
+ "void_at"
+ ]
},
"billing.alert": {
"description": "A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.",
@@ -4372,7 +4834,8 @@
"enum": [
"usage_threshold"
],
- "type": "string"
+ "type": "string",
+ "x-stripeBypassValidation": true
},
"filter": {
"anyOf": [
@@ -4441,6 +4904,16 @@
"usage_threshold_config"
],
"x-resourceId": "billing.alert",
+ "x-stripeMostCommon": [
+ "alert_type",
+ "filter",
+ "id",
+ "livemode",
+ "object",
+ "status",
+ "title",
+ "usage_threshold_config"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -4552,6 +5025,14 @@
"x-expandableFields": [
"alert"
],
+ "x-stripeMostCommon": [
+ "alert",
+ "created",
+ "customer",
+ "livemode",
+ "object",
+ "value"
+ ],
"x-stripeResource": {
"class_name": "AlertTriggered",
"in_package": "Billing"
@@ -4650,6 +5131,21 @@
"value_settings"
],
"x-resourceId": "billing.meter",
+ "x-stripeMostCommon": [
+ "created",
+ "customer_mapping",
+ "default_aggregation",
+ "display_name",
+ "event_name",
+ "event_time_window",
+ "id",
+ "livemode",
+ "object",
+ "status",
+ "status_transitions",
+ "updated",
+ "value_settings"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -4700,6 +5196,131 @@
"in_package": "Billing"
}
},
+ "billing.meter_error_related_object": {
+ "description": "",
+ "properties": {
+ "id": {
+ "description": "Unique identifier for the object.",
+ "maxLength": 100,
+ "type": "string"
+ },
+ "object": {
+ "description": "The type of meter error related object. Should be 'meter'",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "url": {
+ "description": "The url of the meter object",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "object",
+ "url"
+ ],
+ "title": "BillingMeterResourceRelatedObject",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "id",
+ "object",
+ "url"
+ ],
+ "x-stripeResource": {
+ "class_name": "MeterErrorRelatedObject",
+ "in_package": "Billing"
+ }
+ },
+ "billing.meter_error_report": {
+ "description": "",
+ "properties": {
+ "id": {
+ "description": "Unique identifier for the object.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value.",
+ "enum": [
+ "billing.meter_error_report"
+ ],
+ "type": "string"
+ },
+ "reason": {
+ "$ref": "#/components/schemas/billing_meter_resource_meter_error_reason"
+ },
+ "related_object": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/billing.meter_error_related_object"
+ }
+ ],
+ "description": "The related objects about the error",
+ "nullable": true
+ },
+ "summary": {
+ "description": "Summary of invalid events",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "validation_end": {
+ "description": "Time when validation ended. Measured in seconds since the Unix epoch",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "validation_start": {
+ "description": "Time when validation started. Measured in seconds since the Unix epoch",
+ "format": "unix-time",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "object",
+ "reason",
+ "related_object",
+ "summary",
+ "validation_end",
+ "validation_start"
+ ],
+ "title": "BillingMeterResourceMeterErrorReportNotification",
+ "type": "object",
+ "x-expandableFields": [
+ "reason",
+ "related_object"
+ ],
+ "x-stripeMostCommon": [
+ "id",
+ "object",
+ "reason",
+ "related_object",
+ "summary",
+ "validation_end",
+ "validation_start"
+ ],
+ "x-stripeResource": {
+ "class_name": "MeterErrorReport",
+ "in_package": "Billing"
+ }
+ },
+ "billing.meter_error_report.triggered": {
+ "description": "Notifies of errors on a billing meter",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/billing.meter_error_report"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "billing.meter_error_report.triggered"
+ }
+ },
"billing.meter_event": {
"description": "A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage.\nMeter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing.",
"properties": {
@@ -4756,6 +5377,15 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "billing.meter_event",
+ "x-stripeMostCommon": [
+ "created",
+ "event_name",
+ "identifier",
+ "livemode",
+ "object",
+ "payload",
+ "timestamp"
+ ],
"x-stripeOperations": [
{
"method_name": "create",
@@ -4828,6 +5458,14 @@
"cancel"
],
"x-resourceId": "billing.meter_event_adjustment",
+ "x-stripeMostCommon": [
+ "cancel",
+ "event_name",
+ "livemode",
+ "object",
+ "status",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "create",
@@ -4894,6 +5532,15 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "billing.meter_event_summary",
+ "x-stripeMostCommon": [
+ "aggregated_value",
+ "end_time",
+ "id",
+ "livemode",
+ "meter",
+ "object",
+ "start_time"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -4909,6 +5556,41 @@
"in_package": "Billing"
}
},
+ "billing_clocks_resource_status_details_advancing_status_details": {
+ "description": "",
+ "properties": {
+ "target_frozen_time": {
+ "description": "The `frozen_time` that the Test Clock is advancing towards.",
+ "format": "unix-time",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "target_frozen_time"
+ ],
+ "title": "BillingClocksResourceStatusDetailsAdvancingStatusDetails",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "target_frozen_time"
+ ]
+ },
+ "billing_clocks_resource_status_details_status_details": {
+ "description": "",
+ "properties": {
+ "advancing": {
+ "$ref": "#/components/schemas/billing_clocks_resource_status_details_advancing_status_details"
+ }
+ },
+ "title": "BillingClocksResourceStatusDetailsStatusDetails",
+ "type": "object",
+ "x-expandableFields": [
+ "advancing"
+ ],
+ "x-stripeMostCommon": [
+ "advancing"
+ ]
+ },
"billing_details": {
"description": "",
"properties": {
@@ -4950,6 +5632,12 @@
"type": "object",
"x-expandableFields": [
"address"
+ ],
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
]
},
"billing_meter_resource_aggregation_settings": {
@@ -4969,7 +5657,10 @@
],
"title": "BillingMeterResourceAggregationSettings",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "formula"
+ ]
},
"billing_meter_resource_billing_meter_event_adjustment_cancel": {
"description": "",
@@ -4986,7 +5677,10 @@
],
"title": "BillingMeterResourceBillingMeterEventAdjustmentCancel",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "identifier"
+ ]
},
"billing_meter_resource_billing_meter_status_transitions": {
"description": "",
@@ -5003,7 +5697,10 @@
],
"title": "BillingMeterResourceBillingMeterStatusTransitions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "deactivated_at"
+ ]
},
"billing_meter_resource_billing_meter_value": {
"description": "",
@@ -5019,7 +5716,10 @@
],
"title": "BillingMeterResourceBillingMeterValue",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "event_payload_key"
+ ]
},
"billing_meter_resource_customer_mapping_settings": {
"description": "",
@@ -5043,7 +5743,119 @@
],
"title": "BillingMeterResourceCustomerMappingSettings",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "event_payload_key",
+ "type"
+ ]
+ },
+ "billing_meter_resource_meter_error_reason": {
+ "description": "",
+ "properties": {
+ "error_count": {
+ "description": "The number of errors generated",
+ "type": "integer"
+ },
+ "error_types": {
+ "description": "More information about errors",
+ "items": {
+ "$ref": "#/components/schemas/billing_meter_resource_meter_error_reason_error_type"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "error_count",
+ "error_types"
+ ],
+ "title": "BillingMeterResourceMeterErrorReason",
+ "type": "object",
+ "x-expandableFields": [
+ "error_types"
+ ],
+ "x-stripeMostCommon": [
+ "error_count",
+ "error_types"
+ ]
+ },
+ "billing_meter_resource_meter_error_reason_error_type": {
+ "description": "",
+ "properties": {
+ "sample_errors": {
+ "items": {
+ "$ref": "#/components/schemas/billing_meter_resource_meter_error_reason_sample_error"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "sample_errors"
+ ],
+ "title": "BillingMeterResourceMeterErrorReasonErrorType",
+ "type": "object",
+ "x-expandableFields": [
+ "sample_errors"
+ ],
+ "x-stripeMostCommon": [
+ "sample_errors"
+ ]
+ },
+ "billing_meter_resource_meter_error_reason_sample_error": {
+ "description": "",
+ "properties": {
+ "api_request": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/billing_meter_resource_meter_error_reason_sample_error_request"
+ }
+ ],
+ "nullable": true
+ },
+ "error_message": {
+ "description": "message of the error",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "api_request",
+ "error_message"
+ ],
+ "title": "BillingMeterResourceMeterErrorReasonSampleError",
+ "type": "object",
+ "x-expandableFields": [
+ "api_request"
+ ],
+ "x-stripeMostCommon": [
+ "api_request",
+ "error_message"
+ ]
+ },
+ "billing_meter_resource_meter_error_reason_sample_error_request": {
+ "description": "",
+ "properties": {
+ "id": {
+ "description": "Unique identifier for the object.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "idempotency_key": {
+ "description": "idempotency_key of the request",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "idempotency_key"
+ ],
+ "title": "BillingMeterResourceMeterErrorReasonSampleErrorRequest",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "id",
+ "idempotency_key"
+ ]
},
"billing_portal.configuration": {
"description": "A portal configuration describes the functionality and behavior of a portal session.",
@@ -5157,6 +5969,21 @@
"login_page"
],
"x-resourceId": "billing_portal.configuration",
+ "x-stripeMostCommon": [
+ "active",
+ "application",
+ "business_profile",
+ "created",
+ "default_return_url",
+ "features",
+ "id",
+ "is_default",
+ "livemode",
+ "login_page",
+ "metadata",
+ "object",
+ "updated"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -5374,6 +6201,19 @@
"flow"
],
"x-resourceId": "billing_portal.session",
+ "x-stripeMostCommon": [
+ "configuration",
+ "created",
+ "customer",
+ "flow",
+ "id",
+ "livemode",
+ "locale",
+ "object",
+ "on_behalf_of",
+ "return_url",
+ "url"
+ ],
"x-stripeOperations": [
{
"method_name": "create",
@@ -5446,7 +6286,12 @@
],
"title": "CancellationDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "comment",
+ "feedback",
+ "reason"
+ ]
},
"capability": {
"description": "This is an object representing a capability for a Stripe account.\n\nRelated guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)",
@@ -5526,6 +6371,13 @@
"requirements"
],
"x-resourceId": "capability",
+ "x-stripeMostCommon": [
+ "account",
+ "id",
+ "requested",
+ "requirements",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -5703,6 +6555,24 @@
"offered_terms"
],
"x-resourceId": "capital.financing_offer",
+ "x-stripeMostCommon": [
+ "accepted_terms",
+ "account",
+ "charged_off_at",
+ "created",
+ "expires_after",
+ "financing_type",
+ "id",
+ "livemode",
+ "metadata",
+ "object",
+ "offered_terms",
+ "product_type",
+ "replacement",
+ "replacement_for",
+ "status",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -5908,6 +6778,12 @@
"details"
],
"x-resourceId": "capital.financing_summary",
+ "x-stripeMostCommon": [
+ "details",
+ "financing_offer",
+ "object",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "retrieve",
@@ -5998,6 +6874,18 @@
"details"
],
"x-resourceId": "capital.financing_transaction",
+ "x-stripeMostCommon": [
+ "account",
+ "created_at",
+ "details",
+ "financing_offer",
+ "id",
+ "legacy_balance_transaction_source",
+ "livemode",
+ "object",
+ "type",
+ "user_facing_description"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -6071,7 +6959,14 @@
],
"title": "CapitalConnectConnectFinancingAcceptedTerms",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "advance_amount",
+ "currency",
+ "fee_amount",
+ "previous_financing_fee_discount_amount",
+ "withhold_rate"
+ ]
},
"capital_connect_connect_financing_offered_terms": {
"description": "This is an object representing the terms of an offer of financing from\nStripe Capital to a Connected account. This resource represents\nboth the terms offered to the Connected account.",
@@ -6118,7 +7013,15 @@
],
"title": "CapitalConnectConnectFinancingOfferedTerms",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "advance_amount",
+ "campaign_type",
+ "currency",
+ "fee_amount",
+ "previous_financing_fee_discount_rate",
+ "withhold_rate"
+ ]
},
"capital_connect_financing_summary_current_repayment_window": {
"description": "The current repayment interval for the Connected account.",
@@ -6144,7 +7047,12 @@
],
"title": "CapitalConnectFinancingSummaryCurrentRepaymentWindow",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "due_at",
+ "paid_amount",
+ "remaining_amount"
+ ]
},
"capital_connect_financing_summary_details": {
"description": "",
@@ -6209,6 +7117,17 @@
"type": "object",
"x-expandableFields": [
"current_repayment_interval"
+ ],
+ "x-stripeMostCommon": [
+ "advance_amount",
+ "advance_paid_out_at",
+ "currency",
+ "current_repayment_interval",
+ "fee_amount",
+ "paid_amount",
+ "remaining_amount",
+ "repayments_begin_at",
+ "withhold_rate"
]
},
"capital_connect_financing_transaction_details": {
@@ -6269,6 +7188,16 @@
"type": "object",
"x-expandableFields": [
"transaction"
+ ],
+ "x-stripeMostCommon": [
+ "advance_amount",
+ "currency",
+ "fee_amount",
+ "linked_payment",
+ "reason",
+ "reversed_transaction",
+ "total_amount",
+ "transaction"
]
},
"capital_connect_financing_transaction_details_transaction": {
@@ -6287,7 +7216,11 @@
},
"title": "CapitalConnectFinancingTransactionDetailsTransaction",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "charge",
+ "treasury_transaction"
+ ]
},
"card": {
"description": "You can store multiple cards on a customer in order to charge the customer\nlater. You can also store multiple debit cards on a recipient in order to\ntransfer to those cards later.\n\nRelated guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)",
@@ -6544,6 +7477,27 @@
"networks"
],
"x-resourceId": "card",
+ "x-stripeMostCommon": [
+ "address_city",
+ "address_country",
+ "address_line1",
+ "address_line2",
+ "address_state",
+ "address_zip",
+ "address_zip_check",
+ "brand",
+ "country",
+ "customer",
+ "cvc_check",
+ "exp_month",
+ "exp_year",
+ "fingerprint",
+ "funding",
+ "id",
+ "last4",
+ "metadata",
+ "name"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -6604,6 +7558,10 @@
"type": "object",
"x-expandableFields": [
"card_present"
+ ],
+ "x-stripeMostCommon": [
+ "card_present",
+ "type"
]
},
"card_issuing_account_terms_of_service": {
@@ -6632,7 +7590,12 @@
],
"title": "CardIssuingAccountTermsOfService",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
},
"card_mandate_payment_method_details": {
"description": "",
@@ -6685,6 +7648,13 @@
"settings"
],
"x-resourceId": "cash_balance",
+ "x-stripeMostCommon": [
+ "available",
+ "customer",
+ "livemode",
+ "object",
+ "settings"
+ ],
"x-stripeOperations": [
{
"method_name": "retrieve",
@@ -7084,6 +8054,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"review": {
@@ -7134,7 +8110,7 @@
"$ref": "#/components/schemas/transfer"
}
],
- "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.",
+ "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -7145,13 +8121,13 @@
}
},
"statement_descriptor": {
- "description": "For a non-card charge, text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors). This value overrides the account's default statement descriptor. For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
+ "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -7271,6 +8247,26 @@
"transfer_data"
],
"x-resourceId": "charge",
+ "x-stripeMostCommon": [
+ "amount",
+ "balance_transaction",
+ "billing_details",
+ "currency",
+ "customer",
+ "description",
+ "disputed",
+ "id",
+ "invoice",
+ "metadata",
+ "payment_intent",
+ "payment_method_details",
+ "receipt_email",
+ "refunded",
+ "shipping",
+ "statement_descriptor",
+ "statement_descriptor_suffix",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -7549,7 +8545,11 @@
},
"title": "ChargeFraudDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "stripe_report",
+ "user_report"
+ ]
},
"charge_outcome": {
"description": "",
@@ -7616,6 +8616,15 @@
"type": "object",
"x-expandableFields": [
"rule"
+ ],
+ "x-stripeMostCommon": [
+ "network_status",
+ "reason",
+ "risk_level",
+ "risk_score",
+ "rule",
+ "seller_message",
+ "type"
]
},
"charge_transfer_data": {
@@ -7654,6 +8663,10 @@
"type": "object",
"x-expandableFields": [
"destination"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "destination"
]
},
"checkout.session": {
@@ -7713,6 +8726,15 @@
"nullable": true,
"type": "string"
},
+ "collected_information": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_pages_checkout_session_collected_information"
+ }
+ ],
+ "description": "Information about the customer collected within the Checkout Session.",
+ "nullable": true
+ },
"consent": {
"anyOf": [
{
@@ -7886,6 +8908,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"livemode": {
@@ -8050,6 +9078,15 @@
],
"type": "string"
},
+ "permissions": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_pages_checkout_session_permissions"
+ }
+ ],
+ "description": "This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.\n\nFor specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.",
+ "nullable": true
+ },
"phone_number_collection": {
"$ref": "#/components/schemas/payment_pages_checkout_session_phone_number_collection"
},
@@ -8060,7 +9097,7 @@
"type": "string"
},
"redirect_on_completion": {
- "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`.",
+ "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.",
"enum": [
"always",
"if_required",
@@ -8269,6 +9306,7 @@
"x-expandableFields": [
"after_expiration",
"automatic_tax",
+ "collected_information",
"consent",
"consent_collection",
"currency_conversion",
@@ -8283,6 +9321,7 @@
"payment_link",
"payment_method_configuration_details",
"payment_method_options",
+ "permissions",
"phone_number_collection",
"saved_payment_method_options",
"setup_intent",
@@ -8295,6 +9334,22 @@
"total_details"
],
"x-resourceId": "checkout.session",
+ "x-stripeMostCommon": [
+ "client_reference_id",
+ "currency",
+ "customer",
+ "customer_email",
+ "id",
+ "line_items",
+ "metadata",
+ "mode",
+ "payment_intent",
+ "payment_status",
+ "return_url",
+ "status",
+ "success_url",
+ "url"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -8461,7 +9516,14 @@
],
"title": "CheckoutAcssDebitMandateOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "custom_mandate_url",
+ "default_for",
+ "interval_description",
+ "payment_schedule",
+ "transaction_type"
+ ]
},
"checkout_acss_debit_payment_method_options": {
"description": "",
@@ -8501,6 +9563,12 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
+ ],
+ "x-stripeMostCommon": [
+ "currency",
+ "mandate_options",
+ "setup_future_usage",
+ "verification_method"
]
},
"checkout_affirm_payment_method_options": {
@@ -8516,7 +9584,10 @@
},
"title": "CheckoutAffirmPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_afterpay_clearpay_payment_method_options": {
"description": "",
@@ -8532,6 +9603,9 @@
"title": "CheckoutAfterpayClearpayPaymentMethodOptions",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ],
"x-stripeResource": {
"class_name": "AfterpayClearpay",
"in_package": ""
@@ -8550,7 +9624,10 @@
},
"title": "CheckoutAlipayPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_amazon_pay_payment_method_options": {
"description": "",
@@ -8566,7 +9643,10 @@
},
"title": "CheckoutAmazonPayPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_au_becs_debit_payment_method_options": {
"description": "",
@@ -8581,7 +9661,10 @@
},
"title": "CheckoutAuBecsDebitPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_bacs_debit_payment_method_options": {
"description": "",
@@ -8598,7 +9681,10 @@
},
"title": "CheckoutBacsDebitPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_bancontact_payment_method_options": {
"description": "",
@@ -8613,7 +9699,10 @@
},
"title": "CheckoutBancontactPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_boleto_payment_method_options": {
"description": "",
@@ -8637,7 +9726,11 @@
],
"title": "CheckoutBoletoPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
"checkout_card_installments_options": {
"description": "",
@@ -8649,7 +9742,10 @@
},
"title": "CheckoutCardInstallmentsOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"checkout_card_payment_method_options": {
"description": "",
@@ -8694,6 +9790,13 @@
"type": "object",
"x-expandableFields": [
"installments"
+ ],
+ "x-stripeMostCommon": [
+ "installments",
+ "request_three_d_secure",
+ "setup_future_usage",
+ "statement_descriptor_suffix_kana",
+ "statement_descriptor_suffix_kanji"
]
},
"checkout_cashapp_payment_method_options": {
@@ -8709,7 +9812,10 @@
},
"title": "CheckoutCashappPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_customer_balance_bank_transfer_payment_method_options": {
"description": "",
@@ -8755,6 +9861,11 @@
"type": "object",
"x-expandableFields": [
"eu_bank_transfer"
+ ],
+ "x-stripeMostCommon": [
+ "eu_bank_transfer",
+ "requested_address_types",
+ "type"
]
},
"checkout_customer_balance_payment_method_options": {
@@ -8786,6 +9897,11 @@
"type": "object",
"x-expandableFields": [
"bank_transfer"
+ ],
+ "x-stripeMostCommon": [
+ "bank_transfer",
+ "funding_type",
+ "setup_future_usage"
]
},
"checkout_eps_payment_method_options": {
@@ -8801,7 +9917,10 @@
},
"title": "CheckoutEpsPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_fpx_payment_method_options": {
"description": "",
@@ -8816,7 +9935,10 @@
},
"title": "CheckoutFpxPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_giropay_payment_method_options": {
"description": "",
@@ -8831,7 +9953,10 @@
},
"title": "CheckoutGiropayPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_grab_pay_payment_method_options": {
"description": "",
@@ -8846,7 +9971,10 @@
},
"title": "CheckoutGrabPayPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_ideal_payment_method_options": {
"description": "",
@@ -8861,7 +9989,10 @@
},
"title": "CheckoutIdealPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_klarna_payment_method_options": {
"description": "",
@@ -8878,7 +10009,10 @@
},
"title": "CheckoutKlarnaPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_konbini_payment_method_options": {
"description": "",
@@ -8901,7 +10035,11 @@
],
"title": "CheckoutKonbiniPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
"checkout_link_payment_method_options": {
"description": "",
@@ -8917,7 +10055,10 @@
},
"title": "CheckoutLinkPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_mobilepay_payment_method_options": {
"description": "",
@@ -8932,7 +10073,10 @@
},
"title": "CheckoutMobilepayPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_multibanco_payment_method_options": {
"description": "",
@@ -8947,7 +10091,10 @@
},
"title": "CheckoutMultibancoPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_oxxo_payment_method_options": {
"description": "",
@@ -8969,7 +10116,11 @@
],
"title": "CheckoutOxxoPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
"checkout_p24_payment_method_options": {
"description": "",
@@ -8984,7 +10135,10 @@
},
"title": "CheckoutP24PaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_paynow_payment_method_options": {
"description": "",
@@ -8999,7 +10153,10 @@
},
"title": "CheckoutPaynowPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_paypal_payment_method_options": {
"description": "",
@@ -9046,7 +10203,14 @@
],
"title": "CheckoutPaypalPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "capture_method",
+ "preferred_locale",
+ "reference",
+ "setup_future_usage",
+ "subsellers"
+ ]
},
"checkout_payto_payment_method_options": {
"description": "",
@@ -9067,6 +10231,10 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
+ ],
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage"
]
},
"checkout_pix_payment_method_options": {
@@ -9083,7 +10251,10 @@
],
"title": "CheckoutPixPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "expires_after_seconds"
+ ]
},
"checkout_revolut_pay_payment_method_options": {
"description": "",
@@ -9099,7 +10270,10 @@
},
"title": "CheckoutRevolutPayPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_sepa_debit_payment_method_options": {
"description": "",
@@ -9116,7 +10290,10 @@
},
"title": "CheckoutSepaDebitPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_session_payment_method_options": {
"description": "",
@@ -9257,6 +10434,41 @@
"sofort",
"swish",
"us_bank_account"
+ ],
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "affirm",
+ "afterpay_clearpay",
+ "alipay",
+ "amazon_pay",
+ "au_becs_debit",
+ "bacs_debit",
+ "bancontact",
+ "boleto",
+ "card",
+ "cashapp",
+ "customer_balance",
+ "eps",
+ "fpx",
+ "giropay",
+ "grabpay",
+ "ideal",
+ "klarna",
+ "konbini",
+ "link",
+ "mobilepay",
+ "multibanco",
+ "oxxo",
+ "p24",
+ "paynow",
+ "paypal",
+ "payto",
+ "pix",
+ "revolut_pay",
+ "sepa_debit",
+ "sofort",
+ "swish",
+ "us_bank_account"
]
},
"checkout_sofort_payment_method_options": {
@@ -9272,7 +10484,10 @@
},
"title": "CheckoutSofortPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"checkout_swish_payment_method_options": {
"description": "",
@@ -9289,7 +10504,10 @@
],
"title": "CheckoutSwishPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reference"
+ ]
},
"checkout_us_bank_account_payment_method_options": {
"description": "",
@@ -9320,6 +10538,11 @@
"type": "object",
"x-expandableFields": [
"financial_connections"
+ ],
+ "x-stripeMostCommon": [
+ "financial_connections",
+ "setup_future_usage",
+ "verification_method"
]
},
"climate.order": {
@@ -9499,6 +10722,30 @@
"product"
],
"x-resourceId": "climate.order",
+ "x-stripeMostCommon": [
+ "amount_fees",
+ "amount_subtotal",
+ "amount_total",
+ "beneficiary",
+ "canceled_at",
+ "cancellation_reason",
+ "certificate",
+ "confirmed_at",
+ "created",
+ "currency",
+ "delayed_at",
+ "delivered_at",
+ "delivery_details",
+ "expected_delivery_year",
+ "id",
+ "livemode",
+ "metadata",
+ "metric_tons",
+ "object",
+ "product",
+ "product_substituted_at",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -9694,6 +10941,17 @@
"suppliers"
],
"x-resourceId": "climate.product",
+ "x-stripeMostCommon": [
+ "created",
+ "current_prices_per_metric_ton",
+ "delivery_year",
+ "id",
+ "livemode",
+ "metric_tons_available",
+ "name",
+ "object",
+ "suppliers"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -9809,6 +11067,15 @@
"locations"
],
"x-resourceId": "climate.supplier",
+ "x-stripeMostCommon": [
+ "id",
+ "info_url",
+ "livemode",
+ "locations",
+ "name",
+ "object",
+ "removal_pathway"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -9845,7 +11112,10 @@
],
"title": "ClimateRemovalsBeneficiary",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "public_name"
+ ]
},
"climate_removals_location": {
"description": "",
@@ -9887,7 +11157,14 @@
],
"title": "ClimateRemovalsLocation",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "latitude",
+ "longitude",
+ "region"
+ ]
},
"climate_removals_order_deliveries": {
"description": "The delivery of a specified quantity of carbon for an order.",
@@ -9933,6 +11210,13 @@
"x-expandableFields": [
"location",
"supplier"
+ ],
+ "x-stripeMostCommon": [
+ "delivered_at",
+ "location",
+ "metric_tons",
+ "registry_url",
+ "supplier"
]
},
"climate_removals_products_price": {
@@ -9958,7 +11242,12 @@
],
"title": "ClimateRemovalsProductsPrice",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount_fees",
+ "amount_subtotal",
+ "amount_total"
+ ]
},
"confirmation_token": {
"description": "ConfirmationTokens help transport client side data collected by Stripe JS over\nto your server for confirming a PaymentIntent or SetupIntent. If the confirmation\nis successful, values present on the ConfirmationToken are written onto the Intent.\n\nTo learn more about how to use ConfirmationToken, visit the related guides:\n- [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server)\n- [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation).",
@@ -10082,6 +11371,22 @@
"shipping"
],
"x-resourceId": "confirmation_token",
+ "x-stripeMostCommon": [
+ "created",
+ "expires_at",
+ "id",
+ "livemode",
+ "mandate_data",
+ "object",
+ "payment_intent",
+ "payment_method_options",
+ "payment_method_preview",
+ "return_url",
+ "setup_future_usage",
+ "setup_intent",
+ "shipping",
+ "use_stripe_sdk"
+ ],
"x-stripeOperations": [
{
"method_name": "retrieve",
@@ -10117,6 +11422,9 @@
"type": "object",
"x-expandableFields": [
"customer_acceptance"
+ ],
+ "x-stripeMostCommon": [
+ "customer_acceptance"
]
},
"confirmation_tokens_resource_mandate_data_resource_customer_acceptance": {
@@ -10145,6 +11453,10 @@
"type": "object",
"x-expandableFields": [
"online"
+ ],
+ "x-stripeMostCommon": [
+ "online",
+ "type"
]
},
"confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online": {
@@ -10169,7 +11481,11 @@
],
"title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "ip_address",
+ "user_agent"
+ ]
},
"confirmation_tokens_resource_payment_method_options": {
"description": "Payment-method-specific configuration",
@@ -10191,6 +11507,9 @@
"type": "object",
"x-expandableFields": [
"card"
+ ],
+ "x-stripeMostCommon": [
+ "card"
]
},
"confirmation_tokens_resource_payment_method_options_resource_card": {
@@ -10208,7 +11527,10 @@
],
"title": "ConfirmationTokensResourcePaymentMethodOptionsResourceCard",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "cvc_token"
+ ]
},
"confirmation_tokens_resource_payment_method_preview": {
"description": "Details of the PaymentMethod collected by Payment Element",
@@ -10314,6 +11636,9 @@
"link": {
"$ref": "#/components/schemas/payment_method_link"
},
+ "mb_way": {
+ "$ref": "#/components/schemas/payment_method_mb_way"
+ },
"mobilepay": {
"$ref": "#/components/schemas/payment_method_mobilepay"
},
@@ -10385,6 +11710,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -10450,6 +11776,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -10468,6 +11795,11 @@
"us_bank_account",
"wechat_pay",
"zip"
+ ],
+ "x-stripeMostCommon": [
+ "billing_details",
+ "customer",
+ "type"
]
},
"confirmation_tokens_resource_shipping": {
@@ -10497,6 +11829,11 @@
"type": "object",
"x-expandableFields": [
"address"
+ ],
+ "x-stripeMostCommon": [
+ "address",
+ "name",
+ "phone"
]
},
"connect_account_reference": {
@@ -10537,6 +11874,10 @@
"type": "object",
"x-expandableFields": [
"account"
+ ],
+ "x-stripeMostCommon": [
+ "account",
+ "type"
]
},
"connect_collection_transfer": {
@@ -10599,6 +11940,14 @@
"x-expandableFields": [
"destination"
],
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "destination",
+ "id",
+ "livemode",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "ConnectCollectionTransfer",
"in_package": "",
@@ -10627,6 +11976,10 @@
"x-expandableFields": [
"features"
],
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ],
"x-stripeResource": {
"class_name": "AccountConfig",
"in_package": ""
@@ -10646,6 +11999,9 @@
"title": "ConnectEmbeddedAccountFeaturesClaim",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "external_account_collection"
+ ],
"x-stripeResource": {
"class_name": "AccountFeatures",
"in_package": ""
@@ -10743,6 +12099,22 @@
"tax_registrations",
"tax_settings"
],
+ "x-stripeMostCommon": [
+ "account_management",
+ "account_onboarding",
+ "balances",
+ "capital_financing",
+ "capital_financing_application",
+ "capital_financing_promotion",
+ "documents",
+ "notification_banner",
+ "payment_details",
+ "payments",
+ "payouts",
+ "payouts_list",
+ "tax_registrations",
+ "tax_settings"
+ ],
"x-stripeResource": {
"class_name": "Components",
"in_package": ""
@@ -10768,6 +12140,10 @@
"x-expandableFields": [
"features"
],
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ],
"x-stripeResource": {
"class_name": "BaseConfig",
"in_package": ""
@@ -10793,6 +12169,10 @@
"x-expandableFields": [
"features"
],
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ],
"x-stripeResource": {
"class_name": "BaseConfig",
"in_package": ""
@@ -10829,6 +12209,10 @@
"x-expandableFields": [
"features"
],
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ],
"x-stripeResource": {
"class_name": "PaymentsConfig",
"in_package": ""
@@ -10863,6 +12247,12 @@
"title": "ConnectEmbeddedPaymentsFeatures",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "capture_payments",
+ "destination_on_behalf_of_charge_management",
+ "dispute_management",
+ "refund_management"
+ ],
"x-stripeResource": {
"class_name": "PaymentsFeatures",
"in_package": ""
@@ -10888,6 +12278,10 @@
"x-expandableFields": [
"features"
],
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ],
"x-stripeResource": {
"class_name": "PayoutsConfig",
"in_package": ""
@@ -10922,6 +12316,12 @@
"title": "ConnectEmbeddedPayoutsFeatures",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "edit_payout_schedule",
+ "external_account_collection",
+ "instant_payouts",
+ "standard_payouts"
+ ],
"x-stripeResource": {
"class_name": "PayoutsFeatures",
"in_package": ""
@@ -10940,7 +12340,10 @@
],
"title": "ConnectRiskAccountRiskControl",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "pause_requested"
+ ]
},
"connect_risk_account_risk_controls": {
"description": "",
@@ -10961,6 +12364,10 @@
"x-expandableFields": [
"charges",
"payouts"
+ ],
+ "x-stripeMostCommon": [
+ "charges",
+ "payouts"
]
},
"country_spec": {
@@ -11038,6 +12445,14 @@
"verification_fields"
],
"x-resourceId": "country_spec",
+ "x-stripeMostCommon": [
+ "default_currency",
+ "id",
+ "supported_bank_account_currencies",
+ "supported_payment_currencies",
+ "supported_payment_methods",
+ "supported_transfer_countries"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -11086,7 +12501,11 @@
],
"title": "CountrySpecVerificationFieldDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "additional",
+ "minimum"
+ ]
},
"country_spec_verification_fields": {
"description": "",
@@ -11107,6 +12526,10 @@
"x-expandableFields": [
"company",
"individual"
+ ],
+ "x-stripeMostCommon": [
+ "company",
+ "individual"
]
},
"coupon": {
@@ -11232,6 +12655,16 @@
"currency_options"
],
"x-resourceId": "coupon",
+ "x-stripeMostCommon": [
+ "amount_off",
+ "currency",
+ "duration",
+ "duration_in_months",
+ "id",
+ "metadata",
+ "name",
+ "percent_off"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -11340,7 +12773,10 @@
],
"title": "CouponAppliesTo",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "products"
+ ]
},
"coupon_currency_option": {
"description": "",
@@ -11355,7 +12791,10 @@
],
"title": "CouponCurrencyOption",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount_off"
+ ]
},
"credit_note": {
"description": "Issue a credit note to adjust an invoice's amount after the invoice is finalized.\n\nRelated guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)",
@@ -11500,6 +12939,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"livemode": {
@@ -11691,6 +13136,18 @@
"tax_amounts"
],
"x-resourceId": "credit_note",
+ "x-stripeMostCommon": [
+ "currency",
+ "id",
+ "invoice",
+ "lines",
+ "memo",
+ "metadata",
+ "reason",
+ "status",
+ "subtotal",
+ "total"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -11916,6 +13373,24 @@
"tax_rates"
],
"x-resourceId": "credit_note_line_item",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_excluding_tax",
+ "description",
+ "discount_amount",
+ "discount_amounts",
+ "id",
+ "invoice_line_item",
+ "livemode",
+ "object",
+ "quantity",
+ "tax_amounts",
+ "tax_rates",
+ "type",
+ "unit_amount",
+ "unit_amount_decimal",
+ "unit_amount_excluding_tax"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -11973,6 +13448,10 @@
"type": "object",
"x-expandableFields": [
"refund"
+ ],
+ "x-stripeMostCommon": [
+ "amount_refunded",
+ "refund"
]
},
"credit_note_tax_amount": {
@@ -12045,6 +13524,13 @@
"type": "object",
"x-expandableFields": [
"tax_rate"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "inclusive",
+ "tax_rate",
+ "taxability_reason",
+ "taxable_amount"
]
},
"currency_option": {
@@ -12099,6 +13585,9 @@
"x-expandableFields": [
"custom_unit_amount",
"tiers"
+ ],
+ "x-stripeMostCommon": [
+ "unit_amount"
]
},
"custom_unit_amount": {
@@ -12127,7 +13616,12 @@
],
"title": "CustomUnitAmount",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "maximum",
+ "minimum",
+ "preset"
+ ]
},
"customer": {
"description": "This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer.\n\nRelated guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment)",
@@ -12322,6 +13816,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"subscriptions": {
@@ -12361,6 +13861,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"tax": {
@@ -12413,6 +13919,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"test_clock": {
@@ -12462,6 +13974,16 @@
"test_clock"
],
"x-resourceId": "customer",
+ "x-stripeMostCommon": [
+ "address",
+ "description",
+ "email",
+ "id",
+ "metadata",
+ "name",
+ "phone",
+ "shipping"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -13025,6 +14547,12 @@
"x-expandableFields": [
"offline",
"online"
+ ],
+ "x-stripeMostCommon": [
+ "accepted_at",
+ "offline",
+ "online",
+ "type"
]
},
"customer_balance_customer_balance_settings": {
@@ -13049,7 +14577,11 @@
],
"title": "CustomerBalanceCustomerBalanceSettings",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reconciliation_mode",
+ "using_merchant_default"
+ ]
},
"customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft": {
"description": "",
@@ -13103,6 +14635,10 @@
"balance_transaction",
"linked_transaction"
],
+ "x-stripeMostCommon": [
+ "balance_transaction",
+ "linked_transaction"
+ ],
"x-stripeResource": {
"class_name": "AdjustedForOverdraft",
"in_package": ""
@@ -13138,6 +14674,9 @@
"type": "object",
"x-expandableFields": [
"payment_intent"
+ ],
+ "x-stripeMostCommon": [
+ "payment_intent"
]
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction": {
@@ -13154,6 +14693,9 @@
"type": "object",
"x-expandableFields": [
"bank_transfer"
+ ],
+ "x-stripeMostCommon": [
+ "bank_transfer"
]
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer": {
@@ -13201,6 +14743,14 @@
"gb_bank_transfer",
"jp_bank_transfer",
"us_bank_transfer"
+ ],
+ "x-stripeMostCommon": [
+ "eu_bank_transfer",
+ "gb_bank_transfer",
+ "jp_bank_transfer",
+ "reference",
+ "type",
+ "us_bank_transfer"
]
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer": {
@@ -13232,7 +14782,12 @@
],
"title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bic",
+ "iban_last4",
+ "sender_name"
+ ]
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer": {
"description": "",
@@ -13263,7 +14818,12 @@
],
"title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_number_last4",
+ "sender_name",
+ "sort_code"
+ ]
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer": {
"description": "",
@@ -13294,7 +14854,12 @@
],
"title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "sender_bank",
+ "sender_branch",
+ "sender_name"
+ ]
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer": {
"description": "",
@@ -13320,7 +14885,11 @@
],
"title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "network",
+ "sender_name"
+ ]
},
"customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction": {
"description": "",
@@ -13353,6 +14922,9 @@
"x-expandableFields": [
"refund"
],
+ "x-stripeMostCommon": [
+ "refund"
+ ],
"x-stripeResource": {
"class_name": "RefundedFromPayment",
"in_package": ""
@@ -13389,6 +14961,9 @@
"x-expandableFields": [
"balance_transaction"
],
+ "x-stripeMostCommon": [
+ "balance_transaction"
+ ],
"x-stripeResource": {
"class_name": "TransferredToBalance",
"in_package": ""
@@ -13425,6 +15000,9 @@
"x-expandableFields": [
"payment_intent"
],
+ "x-stripeMostCommon": [
+ "payment_intent"
+ ],
"x-stripeResource": {
"class_name": "UnappliedFromPayment",
"in_package": ""
@@ -13581,6 +15159,16 @@
"invoice"
],
"x-resourceId": "customer_balance_transaction",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "customer",
+ "description",
+ "ending_balance",
+ "id",
+ "metadata",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -13751,6 +15339,23 @@
"unapplied_from_payment"
],
"x-resourceId": "customer_cash_balance_transaction",
+ "x-stripeMostCommon": [
+ "adjusted_for_overdraft",
+ "applied_to_payment",
+ "created",
+ "currency",
+ "customer",
+ "ending_balance",
+ "funded",
+ "id",
+ "livemode",
+ "net_amount",
+ "object",
+ "refunded_from_payment",
+ "transferred_to_balance",
+ "type",
+ "unapplied_from_payment"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -13808,7 +15413,7 @@
}
},
"customer_session": {
- "description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.",
+ "description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.\n\nRelated guides: [Customer Session with the Payment Element](/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),\n[Customer Session with the Pricing Table](/payments/checkout/pricing-table#customer-session),\n[Customer Session with the Buy Button](/payment-links/buy-button#pass-an-existing-customer).",
"properties": {
"client_secret": {
"description": "The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.",
@@ -13874,6 +15479,12 @@
"customer"
],
"x-resourceId": "customer_session",
+ "x-stripeMostCommon": [
+ "client_secret",
+ "components",
+ "customer",
+ "expires_at"
+ ],
"x-stripeOperations": [
{
"method_name": "create",
@@ -13912,6 +15523,11 @@
"buy_button",
"payment_element",
"pricing_table"
+ ],
+ "x-stripeMostCommon": [
+ "buy_button",
+ "payment_element",
+ "pricing_table"
]
},
"customer_session_resource_components_resource_buy_button": {
@@ -13927,7 +15543,10 @@
],
"title": "CustomerSessionResourceComponentsResourceBuyButton",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"customer_session_resource_components_resource_payment_element": {
"description": "This hash contains whether the Payment Element is enabled and the features it supports.",
@@ -13954,6 +15573,10 @@
"type": "object",
"x-expandableFields": [
"features"
+ ],
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
]
},
"customer_session_resource_components_resource_payment_element_resource_features": {
@@ -14023,7 +15646,15 @@
],
"title": "CustomerSessionResourceComponentsResourcePaymentElementResourceFeatures",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "payment_method_allow_redisplay_filters",
+ "payment_method_redisplay",
+ "payment_method_redisplay_limit",
+ "payment_method_remove",
+ "payment_method_save",
+ "payment_method_save_usage"
+ ]
},
"customer_session_resource_components_resource_pricing_table": {
"description": "This hash contains whether the pricing table is enabled.",
@@ -14038,7 +15669,10 @@
],
"title": "CustomerSessionResourceComponentsResourcePricingTable",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"customer_tax": {
"description": "",
@@ -14078,6 +15712,11 @@
"type": "object",
"x-expandableFields": [
"location"
+ ],
+ "x-stripeMostCommon": [
+ "automatic_tax",
+ "ip_address",
+ "location"
]
},
"customer_tax_location": {
@@ -14112,7 +15751,12 @@
],
"title": "CustomerTaxLocation",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "country",
+ "source",
+ "state"
+ ]
},
"deleted_account": {
"description": "",
@@ -14146,6 +15790,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_account",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedAccount",
"in_package": ""
@@ -14183,6 +15832,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_apple_pay_domain",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedApplePayDomain",
"in_package": ""
@@ -14226,6 +15880,12 @@
"title": "DeletedApplication",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "name",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedApplication",
"in_package": ""
@@ -14268,6 +15928,12 @@
"title": "DeletedBankAccount",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "currency",
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedBankAccount",
"in_package": ""
@@ -14310,6 +15976,12 @@
"title": "DeletedCard",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "currency",
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedCard",
"in_package": ""
@@ -14347,6 +16019,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_coupon",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedCoupon",
"in_package": ""
@@ -14384,6 +16061,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_customer",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedCustomer",
"in_package": ""
@@ -14518,6 +16200,14 @@
"promotion_code"
],
"x-resourceId": "deleted_discount",
+ "x-stripeMostCommon": [
+ "coupon",
+ "customer",
+ "deleted",
+ "id",
+ "start",
+ "subscription"
+ ],
"x-stripeResource": {
"class_name": "DeletedDiscount",
"in_package": ""
@@ -14571,6 +16261,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_invoice",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedInvoice",
"in_package": ""
@@ -14608,6 +16303,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_invoiceitem",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedInvoiceItem",
"in_package": ""
@@ -14661,6 +16361,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_person",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedPerson",
"in_package": ""
@@ -14698,6 +16403,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_plan",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedPlan",
"in_package": ""
@@ -14734,6 +16444,11 @@
"title": "DeletedPrice",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedPrice",
"in_package": ""
@@ -14771,6 +16486,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_product",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedProduct",
"in_package": ""
@@ -14808,6 +16528,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_product_feature",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedProductFeature",
"in_package": ""
@@ -14845,6 +16570,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_radar.value_list",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedValueList",
"in_package": "Radar"
@@ -14882,6 +16612,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_radar.value_list_item",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedValueListItem",
"in_package": "Radar"
@@ -14919,6 +16654,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_subscription_item",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedSubscriptionItem",
"in_package": ""
@@ -14956,6 +16696,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_tax_id",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedTaxId",
"in_package": ""
@@ -14993,6 +16738,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_terminal.configuration",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedConfiguration",
"in_package": "Terminal"
@@ -15030,6 +16780,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_terminal.location",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedLocation",
"in_package": "Terminal"
@@ -15067,6 +16822,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_terminal.reader",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedReader",
"in_package": "Terminal"
@@ -15104,6 +16864,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_test_helpers.test_clock",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedTestClock",
"in_package": "TestHelpers"
@@ -15141,6 +16906,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "deleted_webhook_endpoint",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "DeletedWebhookEndpoint",
"in_package": ""
@@ -15280,6 +17050,14 @@
"customer",
"promotion_code"
],
+ "x-stripeMostCommon": [
+ "coupon",
+ "customer",
+ "end",
+ "id",
+ "start",
+ "subscription"
+ ],
"x-stripeResource": {
"class_name": "Discount",
"in_package": ""
@@ -15308,7 +17086,11 @@
],
"title": "DiscountEnd",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "timestamp",
+ "type"
+ ]
},
"discounts_resource_discount_amount": {
"description": "",
@@ -15351,6 +17133,10 @@
"type": "object",
"x-expandableFields": [
"discount"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "discount"
]
},
"discounts_resource_stackable_discount": {
@@ -15438,6 +17224,11 @@
"discount",
"discount_end",
"promotion_code"
+ ],
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "promotion_code"
]
},
"dispute": {
@@ -15603,6 +17394,17 @@
"payment_method_details"
],
"x-resourceId": "dispute",
+ "x-stripeMostCommon": [
+ "amount",
+ "charge",
+ "currency",
+ "evidence",
+ "id",
+ "metadata",
+ "payment_intent",
+ "reason",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -15653,6 +17455,9 @@
"type": "object",
"x-expandableFields": [
"visa_compelling_evidence_3"
+ ],
+ "x-stripeMostCommon": [
+ "visa_compelling_evidence_3"
]
},
"dispute_enhanced_eligibility_visa_compelling_evidence3": {
@@ -15675,12 +17480,9 @@
"status": {
"description": "Visa Compelling Evidence 3.0 eligibility status.",
"enum": [
- "accepted",
"not_qualified",
- "partner_rejected",
"qualified",
- "requires_action",
- "submitted"
+ "requires_action"
],
"type": "string"
}
@@ -15691,7 +17493,11 @@
],
"title": "DisputeEnhancedEligibilityVisaCompellingEvidence3",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "required_actions",
+ "status"
+ ]
},
"dispute_enhanced_evidence": {
"description": "",
@@ -15704,6 +17510,9 @@
"type": "object",
"x-expandableFields": [
"visa_compelling_evidence_3"
+ ],
+ "x-stripeMostCommon": [
+ "visa_compelling_evidence_3"
]
},
"dispute_enhanced_evidence_visa_compelling_evidence3": {
@@ -15735,6 +17544,10 @@
"x-expandableFields": [
"disputed_transaction",
"prior_undisputed_transactions"
+ ],
+ "x-stripeMostCommon": [
+ "disputed_transaction",
+ "prior_undisputed_transactions"
]
},
"dispute_evidence": {
@@ -16074,6 +17887,36 @@
"service_documentation",
"shipping_documentation",
"uncategorized_file"
+ ],
+ "x-stripeMostCommon": [
+ "access_activity_log",
+ "billing_address",
+ "cancellation_policy",
+ "cancellation_policy_disclosure",
+ "cancellation_rebuttal",
+ "customer_communication",
+ "customer_email_address",
+ "customer_name",
+ "customer_purchase_ip",
+ "customer_signature",
+ "duplicate_charge_documentation",
+ "duplicate_charge_explanation",
+ "duplicate_charge_id",
+ "enhanced_evidence",
+ "product_description",
+ "receipt",
+ "refund_policy",
+ "refund_policy_disclosure",
+ "refund_refusal_explanation",
+ "service_date",
+ "service_documentation",
+ "shipping_address",
+ "shipping_carrier",
+ "shipping_date",
+ "shipping_documentation",
+ "shipping_tracking_number",
+ "uncategorized_file",
+ "uncategorized_text"
]
},
"dispute_evidence_details": {
@@ -16111,6 +17954,13 @@
"type": "object",
"x-expandableFields": [
"enhanced_eligibility"
+ ],
+ "x-stripeMostCommon": [
+ "due_by",
+ "enhanced_eligibility",
+ "has_evidence",
+ "past_due",
+ "submission_count"
]
},
"dispute_payment_method_details": {
@@ -16144,6 +17994,12 @@
"card",
"klarna",
"paypal"
+ ],
+ "x-stripeMostCommon": [
+ "card",
+ "klarna",
+ "paypal",
+ "type"
]
},
"dispute_payment_method_details_card": {
@@ -16177,7 +18033,12 @@
],
"title": "DisputePaymentMethodDetailsCard",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "brand",
+ "case_type",
+ "network_reason_code"
+ ]
},
"dispute_payment_method_details_klarna": {
"description": "",
@@ -16194,7 +18055,10 @@
],
"title": "DisputePaymentMethodDetailsKlarna",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reason_code"
+ ]
},
"dispute_payment_method_details_paypal": {
"description": "",
@@ -16218,7 +18082,11 @@
],
"title": "DisputePaymentMethodDetailsPaypal",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "case_id",
+ "reason_code"
+ ]
},
"dispute_transaction_shipping_address": {
"description": "",
@@ -16270,7 +18138,15 @@
],
"title": "DisputeTransactionShippingAddress",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"dispute_visa_compelling_evidence3_disputed_transaction": {
"description": "",
@@ -16344,6 +18220,16 @@
"type": "object",
"x-expandableFields": [
"shipping_address"
+ ],
+ "x-stripeMostCommon": [
+ "customer_account_id",
+ "customer_device_fingerprint",
+ "customer_device_id",
+ "customer_email_address",
+ "customer_purchase_ip",
+ "merchandise_or_services",
+ "product_description",
+ "shipping_address"
]
},
"dispute_visa_compelling_evidence3_prior_undisputed_transaction": {
@@ -16414,6 +18300,16 @@
"type": "object",
"x-expandableFields": [
"shipping_address"
+ ],
+ "x-stripeMostCommon": [
+ "charge",
+ "customer_account_id",
+ "customer_device_fingerprint",
+ "customer_device_id",
+ "customer_email_address",
+ "customer_purchase_ip",
+ "product_description",
+ "shipping_address"
]
},
"email_sent": {
@@ -16436,7 +18332,11 @@
],
"title": "EmailSent",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "email_sent_at",
+ "email_sent_to"
+ ]
},
"entitlements.active_entitlement": {
"description": "An active entitlement describes access to a feature for a customer.",
@@ -16495,6 +18395,11 @@
"feature"
],
"x-resourceId": "entitlements.active_entitlement",
+ "x-stripeMostCommon": [
+ "feature",
+ "id",
+ "lookup_key"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -16561,6 +18466,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"livemode": {
@@ -16586,6 +18497,10 @@
"x-expandableFields": [
"entitlements"
],
+ "x-stripeMostCommon": [
+ "customer",
+ "entitlements"
+ ],
"x-stripeResource": {
"class_name": "ActiveEntitlementSummary",
"in_package": "Entitlements"
@@ -16662,6 +18577,12 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "entitlements.feature",
+ "x-stripeMostCommon": [
+ "id",
+ "lookup_key",
+ "metadata",
+ "name"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -16744,6 +18665,13 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "ephemeral_key",
+ "x-stripeMostCommon": [
+ "created",
+ "expires",
+ "id",
+ "livemode",
+ "object"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -16857,6 +18785,7 @@
"application_fee.refunded",
"balance.available",
"billing.alert.triggered",
+ "billing.meter_error_report.triggered",
"billing_portal.configuration.created",
"billing_portal.configuration.updated",
"billing_portal.session.created",
@@ -17132,6 +19061,13 @@
"request"
],
"x-resourceId": "event",
+ "x-stripeMostCommon": [
+ "api_version",
+ "data",
+ "id",
+ "request",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -17186,6 +19122,10 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "exchange_rate",
+ "x-stripeMostCommon": [
+ "id",
+ "rates"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -17332,6 +19272,12 @@
"type": "object",
"x-expandableFields": [
"errors"
+ ],
+ "x-stripeMostCommon": [
+ "currently_due",
+ "errors",
+ "past_due",
+ "pending_verification"
]
},
"fee": {
@@ -17372,7 +19318,14 @@
],
"title": "Fee",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "application",
+ "currency",
+ "description",
+ "type"
+ ]
},
"fee_refund": {
"description": "`Application Fee Refund` objects allow you to refund an application fee that\nhas previously been created but not yet refunded. Funds will be refunded to\nthe Stripe account from which the fee was originally collected.\n\nRelated guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee)",
@@ -17468,6 +19421,13 @@
"fee"
],
"x-resourceId": "fee_refund",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "fee",
+ "id",
+ "metadata"
+ ],
"x-stripeOperations": [
{
"method_name": "retrieve",
@@ -17592,6 +19552,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"object": {
@@ -17614,6 +19580,7 @@
"finance_report_run",
"identity_document",
"identity_document_downloadable",
+ "issuing_regulatory_reporting",
"pci_document",
"selfie",
"sigma_scheduled_query",
@@ -17664,6 +19631,11 @@
"links"
],
"x-resourceId": "file",
+ "x-stripeMostCommon": [
+ "id",
+ "purpose",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -17794,6 +19766,13 @@
"file"
],
"x-resourceId": "file_link",
+ "x-stripeMostCommon": [
+ "expires_at",
+ "file",
+ "id",
+ "metadata",
+ "url"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -18048,6 +20027,28 @@
"transaction_refresh"
],
"x-resourceId": "financial_connections.account",
+ "x-stripeMostCommon": [
+ "account_holder",
+ "balance",
+ "balance_refresh",
+ "category",
+ "created",
+ "display_name",
+ "id",
+ "inferred_balances_refresh",
+ "institution_name",
+ "last4",
+ "livemode",
+ "object",
+ "ownership",
+ "ownership_refresh",
+ "permissions",
+ "status",
+ "subcategory",
+ "subscriptions",
+ "supported_payment_method_types",
+ "transaction_refresh"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -18271,6 +20272,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "financial_connections.account_inferred_balance",
+ "x-stripeMostCommon": [
+ "as_of",
+ "current",
+ "id"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -18350,6 +20356,16 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "financial_connections.account_owner",
+ "x-stripeMostCommon": [
+ "email",
+ "id",
+ "name",
+ "object",
+ "ownership",
+ "phone",
+ "raw_address",
+ "refreshed_at"
+ ],
"x-stripeResource": {
"class_name": "AccountOwner",
"has_collection_class": true,
@@ -18413,6 +20429,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
},
@@ -18427,6 +20449,12 @@
"x-expandableFields": [
"owners"
],
+ "x-stripeMostCommon": [
+ "created",
+ "id",
+ "object",
+ "owners"
+ ],
"x-stripeResource": {
"class_name": "AccountOwnership",
"in_package": "FinancialConnections"
@@ -18499,6 +20527,16 @@
"features"
],
"x-resourceId": "financial_connections.institution",
+ "x-stripeMostCommon": [
+ "features",
+ "id",
+ "livemode",
+ "name",
+ "object",
+ "routing_numbers",
+ "status",
+ "url"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -18571,6 +20609,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"client_secret": {
@@ -18671,6 +20715,22 @@
"status_details"
],
"x-resourceId": "financial_connections.session",
+ "x-stripeMostCommon": [
+ "account_holder",
+ "accounts",
+ "client_secret",
+ "filters",
+ "id",
+ "limits",
+ "livemode",
+ "manual_entry",
+ "object",
+ "permissions",
+ "prefetch",
+ "return_url",
+ "status",
+ "status_details"
+ ],
"x-stripeOperations": [
{
"method_name": "retrieve",
@@ -18794,6 +20854,20 @@
"status_transitions"
],
"x-resourceId": "financial_connections.transaction",
+ "x-stripeMostCommon": [
+ "account",
+ "amount",
+ "currency",
+ "description",
+ "id",
+ "livemode",
+ "object",
+ "status",
+ "status_transitions",
+ "transacted_at",
+ "transaction_refresh",
+ "updated"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -18864,7 +20938,17 @@
},
"title": "FinancialReportingFinanceReportRunRunParameters",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "columns",
+ "connected_account",
+ "currency",
+ "interval_end",
+ "interval_start",
+ "payout",
+ "reporting_category",
+ "timezone"
+ ]
},
"forwarded_request_context": {
"description": "Metadata about the forwarded request.",
@@ -18885,7 +20969,11 @@
],
"title": "ForwardedRequestContext",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "destination_duration",
+ "destination_ip_address"
+ ]
},
"forwarded_request_details": {
"description": "Details about the request forwarded to the destination endpoint.",
@@ -18919,6 +21007,11 @@
"type": "object",
"x-expandableFields": [
"headers"
+ ],
+ "x-stripeMostCommon": [
+ "body",
+ "headers",
+ "http_method"
]
},
"forwarded_request_header": {
@@ -18941,7 +21034,11 @@
],
"title": "ForwardedRequestHeader",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "name",
+ "value"
+ ]
},
"forwarded_response_details": {
"description": "Details about the response from the destination endpoint.",
@@ -18972,6 +21069,11 @@
"type": "object",
"x-expandableFields": [
"headers"
+ ],
+ "x-stripeMostCommon": [
+ "body",
+ "headers",
+ "status"
]
},
"forwarding.request": {
@@ -19070,6 +21172,18 @@
"response_details"
],
"x-resourceId": "forwarding.request",
+ "x-stripeMostCommon": [
+ "created",
+ "id",
+ "livemode",
+ "object",
+ "payment_method",
+ "replacements",
+ "request_context",
+ "request_details",
+ "response_details",
+ "url"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -19142,6 +21256,11 @@
"bank_transfer"
],
"x-resourceId": "funding_instructions",
+ "x-stripeMostCommon": [
+ "bank_transfer",
+ "currency",
+ "funding_type"
+ ],
"x-stripeResource": {
"class_name": "FundingInstructions",
"in_package": ""
@@ -19182,6 +21301,11 @@
"x-expandableFields": [
"financial_addresses"
],
+ "x-stripeMostCommon": [
+ "country",
+ "financial_addresses",
+ "type"
+ ],
"x-stripeResource": {
"class_name": "BankTransfer",
"in_package": ""
@@ -19214,6 +21338,11 @@
"title": "FundingInstructionsBankTransferABARecord",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_number",
+ "bank_name",
+ "routing_number"
+ ],
"x-stripeResource": {
"class_name": "Aba",
"in_package": ""
@@ -19284,6 +21413,16 @@
"spei",
"swift",
"zengin"
+ ],
+ "x-stripeMostCommon": [
+ "aba",
+ "iban",
+ "sort_code",
+ "spei",
+ "supported_networks",
+ "swift",
+ "type",
+ "zengin"
]
},
"funding_instructions_bank_transfer_iban_record": {
@@ -19318,7 +21457,13 @@
],
"title": "FundingInstructionsBankTransferIbanRecord",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_holder_name",
+ "bic",
+ "country",
+ "iban"
+ ]
},
"funding_instructions_bank_transfer_sort_code_record": {
"description": "Sort Code Records contain U.K. bank account details per the sort code format.",
@@ -19347,6 +21492,11 @@
"title": "FundingInstructionsBankTransferSortCodeRecord",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_holder_name",
+ "account_number",
+ "sort_code"
+ ],
"x-stripeResource": {
"class_name": "SortCodeRecords",
"in_package": ""
@@ -19378,7 +21528,12 @@
],
"title": "FundingInstructionsBankTransferSpeiRecord",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bank_code",
+ "bank_name",
+ "clabe"
+ ]
},
"funding_instructions_bank_transfer_swift_record": {
"description": "SWIFT Records contain U.S. bank account details per the SWIFT format.",
@@ -19406,7 +21561,12 @@
],
"title": "FundingInstructionsBankTransferSwiftRecord",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_number",
+ "bank_name",
+ "swift_code"
+ ]
},
"funding_instructions_bank_transfer_zengin_record": {
"description": "Zengin Records contain Japan bank account details per the Zengin format.",
@@ -19465,7 +21625,16 @@
],
"title": "FundingInstructionsBankTransferZenginRecord",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_holder_name",
+ "account_number",
+ "account_type",
+ "bank_code",
+ "bank_name",
+ "branch_code",
+ "branch_name"
+ ]
},
"gelato_data_document_report_date_of_birth": {
"description": "Point in Time",
@@ -19493,7 +21662,12 @@
],
"title": "GelatoDataDocumentReportDateOfBirth",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
"gelato_data_document_report_expiration_date": {
"description": "Point in Time",
@@ -19521,7 +21695,12 @@
],
"title": "GelatoDataDocumentReportExpirationDate",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
"gelato_data_document_report_issued_date": {
"description": "Point in Time",
@@ -19549,7 +21728,12 @@
],
"title": "GelatoDataDocumentReportIssuedDate",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
"gelato_data_id_number_report_date": {
"description": "Point in Time",
@@ -19577,7 +21761,12 @@
],
"title": "GelatoDataIdNumberReportDate",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
"gelato_data_verified_outputs_date": {
"description": "Point in Time",
@@ -19605,7 +21794,12 @@
],
"title": "GelatoDataVerifiedOutputsDate",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
"gelato_document_report": {
"description": "Result from a document check",
@@ -19727,6 +21921,20 @@
"error",
"expiration_date",
"issued_date"
+ ],
+ "x-stripeMostCommon": [
+ "address",
+ "dob",
+ "error",
+ "expiration_date",
+ "files",
+ "first_name",
+ "issued_date",
+ "issuing_country",
+ "last_name",
+ "number",
+ "status",
+ "type"
]
},
"gelato_document_report_error": {
@@ -19756,7 +21964,11 @@
],
"title": "GelatoDocumentReportError",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "code",
+ "reason"
+ ]
},
"gelato_email_report": {
"description": "Result from a email check",
@@ -19795,6 +22007,11 @@
"type": "object",
"x-expandableFields": [
"error"
+ ],
+ "x-stripeMostCommon": [
+ "email",
+ "error",
+ "status"
]
},
"gelato_email_report_error": {
@@ -19822,7 +22039,11 @@
],
"title": "GelatoEmailReportError",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "code",
+ "reason"
+ ]
},
"gelato_id_number_report": {
"description": "Result from an id_number check",
@@ -19895,6 +22116,15 @@
"x-expandableFields": [
"dob",
"error"
+ ],
+ "x-stripeMostCommon": [
+ "dob",
+ "error",
+ "first_name",
+ "id_number",
+ "id_number_type",
+ "last_name",
+ "status"
]
},
"gelato_id_number_report_error": {
@@ -19923,7 +22153,11 @@
],
"title": "GelatoIdNumberReportError",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "code",
+ "reason"
+ ]
},
"gelato_phone_report": {
"description": "Result from a phone check",
@@ -19962,6 +22196,11 @@
"type": "object",
"x-expandableFields": [
"error"
+ ],
+ "x-stripeMostCommon": [
+ "error",
+ "phone",
+ "status"
]
},
"gelato_phone_report_error": {
@@ -19989,7 +22228,11 @@
],
"title": "GelatoPhoneReportError",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "code",
+ "reason"
+ ]
},
"gelato_provided_details": {
"description": "",
@@ -20007,7 +22250,11 @@
},
"title": "GelatoProvidedDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "email",
+ "phone"
+ ]
},
"gelato_report_document_options": {
"description": "",
@@ -20039,7 +22286,13 @@
},
"title": "GelatoReportDocumentOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "allowed_types",
+ "require_id_number",
+ "require_live_capture",
+ "require_matching_selfie"
+ ]
},
"gelato_report_id_number_options": {
"description": "",
@@ -20092,6 +22345,12 @@
"type": "object",
"x-expandableFields": [
"error"
+ ],
+ "x-stripeMostCommon": [
+ "document",
+ "error",
+ "selfie",
+ "status"
]
},
"gelato_selfie_report_error": {
@@ -20121,7 +22380,11 @@
],
"title": "GelatoSelfieReportError",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "code",
+ "reason"
+ ]
},
"gelato_session_document_options": {
"description": "",
@@ -20153,7 +22416,13 @@
},
"title": "GelatoSessionDocumentOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "allowed_types",
+ "require_id_number",
+ "require_live_capture",
+ "require_matching_selfie"
+ ]
},
"gelato_session_email_options": {
"description": "",
@@ -20165,7 +22434,10 @@
},
"title": "GelatoSessionEmailOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "require_verification"
+ ]
},
"gelato_session_id_number_options": {
"description": "",
@@ -20217,7 +22489,11 @@
],
"title": "GelatoSessionLastError",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "code",
+ "reason"
+ ]
},
"gelato_session_phone_options": {
"description": "",
@@ -20229,7 +22505,10 @@
},
"title": "GelatoSessionPhoneOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "require_verification"
+ ]
},
"gelato_verification_report_options": {
"description": "",
@@ -20246,6 +22525,10 @@
"x-expandableFields": [
"document",
"id_number"
+ ],
+ "x-stripeMostCommon": [
+ "document",
+ "id_number"
]
},
"gelato_verification_session_options": {
@@ -20271,6 +22554,12 @@
"email",
"id_number",
"phone"
+ ],
+ "x-stripeMostCommon": [
+ "document",
+ "email",
+ "id_number",
+ "phone"
]
},
"gelato_verified_outputs": {
@@ -20348,6 +22637,16 @@
"x-expandableFields": [
"address",
"dob"
+ ],
+ "x-stripeMostCommon": [
+ "address",
+ "dob",
+ "email",
+ "first_name",
+ "id_number",
+ "id_number_type",
+ "last_name",
+ "phone"
]
},
"gift_card_resource_created_by": {
@@ -20381,6 +22680,12 @@
"checkout",
"order",
"payment"
+ ],
+ "x-stripeMostCommon": [
+ "checkout",
+ "order",
+ "payment",
+ "type"
]
},
"gift_card_resource_created_by_resource_checkout": {
@@ -20404,7 +22709,11 @@
],
"title": "GiftCardResourceCreatedByResourceCheckout",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "checkout_session",
+ "line_item"
+ ]
},
"gift_card_resource_created_by_resource_order": {
"description": "",
@@ -20427,7 +22736,11 @@
],
"title": "GiftCardResourceCreatedByResourceOrder",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "line_item",
+ "order"
+ ]
},
"gift_card_resource_created_by_resource_payment": {
"description": "",
@@ -20443,7 +22756,10 @@
],
"title": "GiftCardResourceCreatedByResourcePayment",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "payment_intent"
+ ]
},
"gift_cards.card": {
"description": "A gift card represents a single gift card owned by a customer, including the\nremaining balance, gift card code, and whether or not it is active.",
@@ -20543,6 +22859,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
},
@@ -20564,6 +22886,19 @@
"transactions"
],
"x-resourceId": "gift_cards.card",
+ "x-stripeMostCommon": [
+ "active",
+ "amount_available",
+ "amount_held",
+ "code",
+ "created",
+ "created_by",
+ "currency",
+ "id",
+ "metadata",
+ "object",
+ "transactions"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -20713,6 +23048,20 @@
"created_by"
],
"x-resourceId": "gift_cards.transaction",
+ "x-stripeMostCommon": [
+ "amount",
+ "confirmed_at",
+ "created",
+ "created_by",
+ "currency",
+ "description",
+ "gift_card",
+ "id",
+ "metadata",
+ "object",
+ "status",
+ "transfer_group"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -20853,6 +23202,22 @@
"selfie"
],
"x-resourceId": "identity.verification_report",
+ "x-stripeMostCommon": [
+ "client_reference_id",
+ "created",
+ "document",
+ "email",
+ "id",
+ "id_number",
+ "livemode",
+ "object",
+ "options",
+ "phone",
+ "selfie",
+ "type",
+ "verification_flow",
+ "verification_session"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -21050,6 +23415,26 @@
"verified_outputs"
],
"x-resourceId": "identity.verification_session",
+ "x-stripeMostCommon": [
+ "client_reference_id",
+ "client_secret",
+ "created",
+ "id",
+ "last_error",
+ "last_verification_report",
+ "livemode",
+ "metadata",
+ "object",
+ "options",
+ "provided_details",
+ "redaction",
+ "related_customer",
+ "status",
+ "type",
+ "url",
+ "verification_flow",
+ "verified_outputs"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -21223,6 +23608,11 @@
"x-expandableFields": [
"billing_details",
"us_bank_account"
+ ],
+ "x-stripeMostCommon": [
+ "billing_details",
+ "type",
+ "us_bank_account"
]
},
"inbound_transfers_payment_method_details_us_bank_account": {
@@ -21311,6 +23701,16 @@
"x-expandableFields": [
"mandate"
],
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "account_type",
+ "bank_name",
+ "fingerprint",
+ "last4",
+ "mandate",
+ "network",
+ "routing_number"
+ ],
"x-stripeResource": {
"class_name": "UsBankAccount",
"in_package": ""
@@ -21357,7 +23757,14 @@
],
"title": "internal_card",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "brand",
+ "country",
+ "exp_month",
+ "exp_year",
+ "last4"
+ ]
},
"invoice": {
"description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)",
@@ -21845,6 +24252,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"livemode": {
@@ -21967,6 +24380,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"period_end": {
@@ -22304,6 +24723,24 @@
"transfer_data"
],
"x-resourceId": "invoice",
+ "x-stripeMostCommon": [
+ "auto_advance",
+ "charge",
+ "collection_method",
+ "currency",
+ "customer",
+ "description",
+ "hosted_invoice_url",
+ "id",
+ "lines",
+ "metadata",
+ "payment_intent",
+ "period_end",
+ "period_start",
+ "status",
+ "subscription",
+ "total"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -22716,7 +25153,10 @@
],
"title": "invoice_installments_card",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"invoice_item_threshold_reason": {
"description": "",
@@ -22740,7 +25180,11 @@
],
"title": "InvoiceItemThresholdReason",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "line_item_ids",
+ "usage_gte"
+ ]
},
"invoice_line_item_period": {
"description": "",
@@ -22762,7 +25206,11 @@
],
"title": "InvoiceLineItemPeriod",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "end",
+ "start"
+ ]
},
"invoice_mandate_options_card": {
"description": "",
@@ -22795,7 +25243,12 @@
],
"title": "invoice_mandate_options_card",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "description"
+ ]
},
"invoice_payment": {
"description": "The invoice payment object",
@@ -22905,6 +25358,15 @@
"status_transitions"
],
"x-resourceId": "invoice_payment",
+ "x-stripeMostCommon": [
+ "amount_paid",
+ "amount_requested",
+ "id",
+ "invoice",
+ "is_default",
+ "payment",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -22962,6 +25424,10 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
+ ],
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "verification_method"
]
},
"invoice_payment_method_options_acss_debit_mandate_options": {
@@ -22982,7 +25448,10 @@
],
"title": "invoice_payment_method_options_acss_debit_mandate_options",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "transaction_type"
+ ]
},
"invoice_payment_method_options_bancontact": {
"description": "",
@@ -23003,7 +25472,10 @@
],
"title": "invoice_payment_method_options_bancontact",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "preferred_language"
+ ]
},
"invoice_payment_method_options_card": {
"description": "",
@@ -23029,6 +25501,10 @@
"type": "object",
"x-expandableFields": [
"installments"
+ ],
+ "x-stripeMostCommon": [
+ "installments",
+ "request_three_d_secure"
]
},
"invoice_payment_method_options_customer_balance": {
@@ -23053,6 +25529,10 @@
"type": "object",
"x-expandableFields": [
"bank_transfer"
+ ],
+ "x-stripeMostCommon": [
+ "bank_transfer",
+ "funding_type"
]
},
"invoice_payment_method_options_customer_balance_bank_transfer": {
@@ -23074,6 +25554,10 @@
"type": "object",
"x-expandableFields": [
"eu_bank_transfer"
+ ],
+ "x-stripeMostCommon": [
+ "eu_bank_transfer",
+ "type"
]
},
"invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer": {
@@ -23097,7 +25581,10 @@
],
"title": "invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"invoice_payment_method_options_konbini": {
"description": "",
@@ -23134,6 +25621,10 @@
"type": "object",
"x-expandableFields": [
"financial_connections"
+ ],
+ "x-stripeMostCommon": [
+ "financial_connections",
+ "verification_method"
]
},
"invoice_payment_method_options_us_bank_account_linked_account_options": {
@@ -23177,6 +25668,11 @@
"type": "object",
"x-expandableFields": [
"filters"
+ ],
+ "x-stripeMostCommon": [
+ "filters",
+ "permissions",
+ "prefetch"
]
},
"invoice_payment_method_options_us_bank_account_linked_account_options_filters": {
@@ -23201,7 +25697,11 @@
},
"title": "invoice_payment_method_options_us_bank_account_linked_account_options_filters",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_subcategories",
+ "institution"
+ ]
},
"invoice_rendering_pdf": {
"description": "",
@@ -23222,7 +25722,10 @@
],
"title": "InvoiceRenderingPdf",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "page_size"
+ ]
},
"invoice_setting_custom_field": {
"description": "",
@@ -23244,7 +25747,11 @@
],
"title": "InvoiceSettingCustomField",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "name",
+ "value"
+ ]
},
"invoice_setting_customer_rendering_options": {
"description": "",
@@ -23261,7 +25768,10 @@
],
"title": "InvoiceSettingCustomerRenderingOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount_tax_display"
+ ]
},
"invoice_setting_customer_setting": {
"description": "",
@@ -23322,6 +25832,12 @@
"custom_fields",
"default_payment_method",
"rendering_options"
+ ],
+ "x-stripeMostCommon": [
+ "custom_fields",
+ "default_payment_method",
+ "footer",
+ "rendering_options"
]
},
"invoice_setting_quote_phase_setting": {
@@ -23338,7 +25854,10 @@
],
"title": "InvoiceSettingQuotePhaseSetting",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "days_until_due"
+ ]
},
"invoice_setting_quote_setting": {
"description": "",
@@ -23360,6 +25879,10 @@
"type": "object",
"x-expandableFields": [
"issuer"
+ ],
+ "x-stripeMostCommon": [
+ "days_until_due",
+ "issuer"
]
},
"invoice_setting_rendering_options": {
@@ -23377,7 +25900,10 @@
],
"title": "InvoiceSettingRenderingOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount_tax_display"
+ ]
},
"invoice_setting_subscription_schedule_phase_setting": {
"description": "",
@@ -23436,6 +25962,11 @@
"x-expandableFields": [
"account_tax_ids",
"issuer"
+ ],
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "days_until_due",
+ "issuer"
]
},
"invoice_setting_subscription_schedule_setting": {
@@ -23489,6 +26020,11 @@
"x-expandableFields": [
"account_tax_ids",
"issuer"
+ ],
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "days_until_due",
+ "issuer"
]
},
"invoice_tax_amount": {
@@ -23561,6 +26097,13 @@
"type": "object",
"x-expandableFields": [
"tax_rate"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "inclusive",
+ "tax_rate",
+ "taxability_reason",
+ "taxable_amount"
]
},
"invoice_threshold_reason": {
@@ -23587,6 +26130,10 @@
"type": "object",
"x-expandableFields": [
"item_reasons"
+ ],
+ "x-stripeMostCommon": [
+ "amount_gte",
+ "item_reasons"
]
},
"invoice_transfer_data": {
@@ -23625,6 +26172,10 @@
"type": "object",
"x-expandableFields": [
"destination"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "destination"
]
},
"invoiceitem": {
@@ -23902,6 +26453,17 @@
"test_clock"
],
"x-resourceId": "invoiceitem",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "customer",
+ "description",
+ "id",
+ "metadata",
+ "period",
+ "price",
+ "proration"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -24063,6 +26625,15 @@
"konbini",
"sepa_debit",
"us_bank_account"
+ ],
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "bancontact",
+ "card",
+ "customer_balance",
+ "konbini",
+ "sepa_debit",
+ "us_bank_account"
]
},
"invoices_payment_settings": {
@@ -24134,6 +26705,11 @@
"type": "object",
"x-expandableFields": [
"payment_method_options"
+ ],
+ "x-stripeMostCommon": [
+ "default_mandate",
+ "payment_method_options",
+ "payment_method_types"
]
},
"invoices_payments_invoice_payment_associated_payment": {
@@ -24199,6 +26775,11 @@
"charge",
"out_of_band_payment",
"payment_intent"
+ ],
+ "x-stripeMostCommon": [
+ "out_of_band_payment",
+ "payment_intent",
+ "type"
]
},
"invoices_payments_invoice_payment_status_transitions": {
@@ -24223,7 +26804,11 @@
],
"title": "InvoicesPaymentsInvoicePaymentStatusTransitions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "canceled_at",
+ "paid_at"
+ ]
},
"invoices_payments_out_of_band_payment": {
"description": "",
@@ -24274,7 +26859,13 @@
],
"title": "InvoicesPaymentsOutOfBandPayment",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "money_movement_type",
+ "payment_reference"
+ ]
},
"invoices_resource_from_invoice": {
"description": "",
@@ -24312,6 +26903,10 @@
"type": "object",
"x-expandableFields": [
"invoice"
+ ],
+ "x-stripeMostCommon": [
+ "action",
+ "invoice"
]
},
"invoices_resource_invoice_rendering": {
@@ -24341,13 +26936,17 @@
"type": "object",
"x-expandableFields": [
"pdf"
+ ],
+ "x-stripeMostCommon": [
+ "amount_tax_display",
+ "pdf"
]
},
"invoices_resource_invoice_tax_id": {
"description": "",
"properties": {
"type": {
- "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
+ "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -24381,6 +26980,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -24439,7 +27039,11 @@
],
"title": "InvoicesResourceInvoiceTaxID",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "type",
+ "value"
+ ]
},
"invoices_resource_line_items_credited_items": {
"description": "",
@@ -24464,7 +27068,11 @@
],
"title": "InvoicesResourceLineItemsCreditedItems",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "invoice",
+ "invoice_line_items"
+ ]
},
"invoices_resource_line_items_proration_details": {
"description": "",
@@ -24486,6 +27094,9 @@
"type": "object",
"x-expandableFields": [
"credited_items"
+ ],
+ "x-stripeMostCommon": [
+ "credited_items"
]
},
"invoices_resource_pause_collection": {
@@ -24513,7 +27124,11 @@
],
"title": "InvoicesResourcePauseCollection",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "behavior",
+ "resumes_at"
+ ]
},
"invoices_resource_shipping_cost": {
"description": "",
@@ -24569,6 +27184,13 @@
"x-expandableFields": [
"shipping_rate",
"taxes"
+ ],
+ "x-stripeMostCommon": [
+ "amount_subtotal",
+ "amount_tax",
+ "amount_total",
+ "shipping_rate",
+ "taxes"
]
},
"invoices_resource_status_transitions": {
@@ -24607,7 +27229,13 @@
],
"title": "InvoicesResourceStatusTransitions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "finalized_at",
+ "marked_uncollectible_at",
+ "paid_at",
+ "voided_at"
+ ]
},
"issuing.authorization": {
"description": "When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`\nobject is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the\npurchase to be completed successfully.\n\nRelated guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations)",
@@ -24858,6 +27486,16 @@
"verification_data"
],
"x-resourceId": "issuing.authorization",
+ "x-stripeMostCommon": [
+ "amount",
+ "approved",
+ "card",
+ "cardholder",
+ "currency",
+ "id",
+ "metadata",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -25177,6 +27815,18 @@
"wallets"
],
"x-resourceId": "issuing.card",
+ "x-stripeMostCommon": [
+ "cancellation_reason",
+ "cardholder",
+ "currency",
+ "exp_month",
+ "exp_year",
+ "id",
+ "last4",
+ "metadata",
+ "status",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -25385,6 +28035,14 @@
"spending_controls"
],
"x-resourceId": "issuing.cardholder",
+ "x-stripeMostCommon": [
+ "billing",
+ "email",
+ "id",
+ "metadata",
+ "name",
+ "phone_number"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -25495,6 +28153,12 @@
],
"type": "string"
},
+ "regulatory_reporting_file": {
+ "description": "File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
"underwriting_exception": {
"anyOf": [
{
@@ -25517,6 +28181,7 @@
"livemode",
"metadata",
"object",
+ "regulatory_reporting_file",
"underwriting_exception"
],
"title": "IssuingComplianceCreditUnderwritingRecord",
@@ -25528,6 +28193,15 @@
"underwriting_exception"
],
"x-resourceId": "issuing.credit_underwriting_record",
+ "x-stripeMostCommon": [
+ "application",
+ "credit_user",
+ "decided_at",
+ "decision",
+ "decision_deadline",
+ "id",
+ "metadata"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -25716,6 +28390,16 @@
"treasury"
],
"x-resourceId": "issuing.dispute",
+ "x-stripeMostCommon": [
+ "amount",
+ "balance_transactions",
+ "currency",
+ "evidence",
+ "id",
+ "metadata",
+ "status",
+ "transaction"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -25896,6 +28580,21 @@
"rejection_reasons"
],
"x-resourceId": "issuing.personalization_design",
+ "x-stripeMostCommon": [
+ "card_logo",
+ "carrier_text",
+ "created",
+ "id",
+ "livemode",
+ "lookup_key",
+ "metadata",
+ "name",
+ "object",
+ "physical_bundle",
+ "preferences",
+ "rejection_reasons",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -26013,6 +28712,15 @@
"features"
],
"x-resourceId": "issuing.physical_bundle",
+ "x-stripeMostCommon": [
+ "features",
+ "id",
+ "livemode",
+ "name",
+ "object",
+ "status",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -26143,6 +28851,20 @@
"network_data"
],
"x-resourceId": "issuing.token",
+ "x-stripeMostCommon": [
+ "card",
+ "created",
+ "device_fingerprint",
+ "id",
+ "last4",
+ "livemode",
+ "network",
+ "network_data",
+ "network_updated_at",
+ "object",
+ "status",
+ "wallet_provider"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -26435,6 +29157,16 @@
"treasury"
],
"x-resourceId": "issuing.transaction",
+ "x-stripeMostCommon": [
+ "amount",
+ "authorization",
+ "card",
+ "cardholder",
+ "currency",
+ "id",
+ "metadata",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -26556,7 +29288,11 @@
],
"title": "IssuingAuthorizationAmountDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "atm_fee",
+ "cashback_amount"
+ ]
},
"issuing_authorization_authentication_exemption": {
"description": "",
@@ -26586,7 +29322,11 @@
],
"title": "IssuingAuthorizationAuthenticationExemption",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "claimed_by",
+ "type"
+ ]
},
"issuing_authorization_fleet_cardholder_prompt_data": {
"description": "",
@@ -26637,7 +29377,15 @@
],
"title": "IssuingAuthorizationFleetCardholderPromptData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "alphanumeric_id",
+ "driver_id",
+ "odometer",
+ "unspecified_id",
+ "user_id",
+ "vehicle_number"
+ ]
},
"issuing_authorization_fleet_data": {
"description": "",
@@ -26692,6 +29440,12 @@
"x-expandableFields": [
"cardholder_prompt_data",
"reported_breakdown"
+ ],
+ "x-stripeMostCommon": [
+ "cardholder_prompt_data",
+ "purchase_type",
+ "reported_breakdown",
+ "service_type"
]
},
"issuing_authorization_fleet_fuel_price_data": {
@@ -26709,7 +29463,10 @@
],
"title": "IssuingAuthorizationFleetFuelPriceData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "gross_amount_decimal"
+ ]
},
"issuing_authorization_fleet_non_fuel_price_data": {
"description": "",
@@ -26726,7 +29483,10 @@
],
"title": "IssuingAuthorizationFleetNonFuelPriceData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "gross_amount_decimal"
+ ]
},
"issuing_authorization_fleet_reported_breakdown": {
"description": "",
@@ -26770,6 +29530,11 @@
"fuel",
"non_fuel",
"tax"
+ ],
+ "x-stripeMostCommon": [
+ "fuel",
+ "non_fuel",
+ "tax"
]
},
"issuing_authorization_fleet_tax_data": {
@@ -26794,7 +29559,11 @@
],
"title": "IssuingAuthorizationFleetTaxData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "local_amount_decimal",
+ "national_amount_decimal"
+ ]
},
"issuing_authorization_fuel_data": {
"description": "",
@@ -26854,7 +29623,14 @@
],
"title": "IssuingAuthorizationFuelData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "industry_product_code",
+ "quantity_decimal",
+ "type",
+ "unit",
+ "unit_cost_decimal"
+ ]
},
"issuing_authorization_merchant_data": {
"description": "",
@@ -26931,7 +29707,19 @@
],
"title": "IssuingAuthorizationMerchantData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "category",
+ "category_code",
+ "city",
+ "country",
+ "name",
+ "network_id",
+ "postal_code",
+ "state",
+ "terminal_id",
+ "url"
+ ]
},
"issuing_authorization_network_data": {
"description": "",
@@ -26962,7 +29750,12 @@
],
"title": "IssuingAuthorizationNetworkData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "acquiring_institution_id",
+ "system_trace_audit_number",
+ "transaction_id"
+ ]
},
"issuing_authorization_pending_request": {
"description": "",
@@ -27015,6 +29808,15 @@
"type": "object",
"x-expandableFields": [
"amount_details"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_details",
+ "currency",
+ "is_amount_controllable",
+ "merchant_amount",
+ "merchant_currency",
+ "network_risk_score"
]
},
"issuing_authorization_request": {
@@ -27124,6 +29926,20 @@
"type": "object",
"x-expandableFields": [
"amount_details"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_details",
+ "approved",
+ "authorization_code",
+ "created",
+ "currency",
+ "merchant_amount",
+ "merchant_currency",
+ "network_risk_score",
+ "reason",
+ "reason_message",
+ "requested_at"
]
},
"issuing_authorization_three_d_secure": {
@@ -27146,7 +29962,10 @@
],
"title": "IssuingAuthorizationThreeDSecure",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "result"
+ ]
},
"issuing_authorization_treasury": {
"description": "",
@@ -27181,7 +30000,12 @@
],
"title": "IssuingAuthorizationTreasury",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "received_credits",
+ "received_debits",
+ "transaction"
+ ]
},
"issuing_authorization_verification_data": {
"description": "",
@@ -27261,6 +30085,15 @@
"x-expandableFields": [
"authentication_exemption",
"three_d_secure"
+ ],
+ "x-stripeMostCommon": [
+ "address_line1_check",
+ "address_postal_code_check",
+ "authentication_exemption",
+ "cvc_check",
+ "expiry_check",
+ "postal_code",
+ "three_d_secure"
]
},
"issuing_card.created": {
@@ -27319,7 +30152,11 @@
],
"title": "IssuingCardApplePay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "eligible",
+ "ineligible_reason"
+ ]
},
"issuing_card_authorization_controls": {
"description": "",
@@ -27978,6 +30815,14 @@
"type": "object",
"x-expandableFields": [
"spending_limits"
+ ],
+ "x-stripeMostCommon": [
+ "allowed_categories",
+ "allowed_merchant_countries",
+ "blocked_categories",
+ "blocked_merchant_countries",
+ "spending_limits",
+ "spending_limits_currency"
]
},
"issuing_card_google_pay": {
@@ -28004,7 +30849,11 @@
],
"title": "IssuingCardGooglePay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "eligible",
+ "ineligible_reason"
+ ]
},
"issuing_card_shipping": {
"description": "",
@@ -28109,6 +30958,7 @@
},
"required": [
"address",
+ "address_validation",
"carrier",
"customs",
"eta",
@@ -28127,6 +30977,21 @@
"address",
"address_validation",
"customs"
+ ],
+ "x-stripeMostCommon": [
+ "address",
+ "address_validation",
+ "carrier",
+ "customs",
+ "eta",
+ "name",
+ "phone_number",
+ "require_signature",
+ "service",
+ "status",
+ "tracking_number",
+ "tracking_url",
+ "type"
]
},
"issuing_card_shipping_address_validation": {
@@ -28170,6 +31035,11 @@
"type": "object",
"x-expandableFields": [
"normalized_address"
+ ],
+ "x-stripeMostCommon": [
+ "mode",
+ "normalized_address",
+ "result"
]
},
"issuing_card_shipping_customs": {
@@ -28187,7 +31057,10 @@
],
"title": "IssuingCardShippingCustoms",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "eori_number"
+ ]
},
"issuing_card_spending_limit": {
"description": "",
@@ -28521,7 +31394,12 @@
],
"title": "IssuingCardSpendingLimit",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "categories",
+ "interval"
+ ]
},
"issuing_card_wallets": {
"description": "",
@@ -28549,6 +31427,11 @@
"x-expandableFields": [
"apple_pay",
"google_pay"
+ ],
+ "x-stripeMostCommon": [
+ "apple_pay",
+ "google_pay",
+ "primary_account_identifier"
]
},
"issuing_cardholder.created": {
@@ -28597,6 +31480,9 @@
"type": "object",
"x-expandableFields": [
"address"
+ ],
+ "x-stripeMostCommon": [
+ "address"
]
},
"issuing_cardholder_authorization_controls": {
@@ -29256,6 +32142,14 @@
"type": "object",
"x-expandableFields": [
"spending_limits"
+ ],
+ "x-stripeMostCommon": [
+ "allowed_categories",
+ "allowed_merchant_countries",
+ "blocked_categories",
+ "blocked_merchant_countries",
+ "spending_limits",
+ "spending_limits_currency"
]
},
"issuing_cardholder_card_issuing": {
@@ -29278,6 +32172,9 @@
"type": "object",
"x-expandableFields": [
"user_terms_acceptance"
+ ],
+ "x-stripeMostCommon": [
+ "user_terms_acceptance"
]
},
"issuing_cardholder_company": {
@@ -29293,7 +32190,10 @@
],
"title": "IssuingCardholderCompany",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "tax_id_provided"
+ ]
},
"issuing_cardholder_id_document": {
"description": "",
@@ -29348,6 +32248,10 @@
"x-expandableFields": [
"back",
"front"
+ ],
+ "x-stripeMostCommon": [
+ "back",
+ "front"
]
},
"issuing_cardholder_individual": {
@@ -29405,6 +32309,13 @@
"card_issuing",
"dob",
"verification"
+ ],
+ "x-stripeMostCommon": [
+ "card_issuing",
+ "dob",
+ "first_name",
+ "last_name",
+ "verification"
]
},
"issuing_cardholder_individual_dob": {
@@ -29433,7 +32344,12 @@
],
"title": "IssuingCardholderIndividualDOB",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
"issuing_cardholder_requirements": {
"description": "",
@@ -29476,7 +32392,11 @@
],
"title": "IssuingCardholderRequirements",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "disabled_reason",
+ "past_due"
+ ]
},
"issuing_cardholder_spending_limit": {
"description": "",
@@ -29810,7 +32730,12 @@
],
"title": "IssuingCardholderSpendingLimit",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "categories",
+ "interval"
+ ]
},
"issuing_cardholder_user_terms_acceptance": {
"description": "",
@@ -29841,7 +32766,12 @@
],
"title": "IssuingCardholderUserTermsAcceptance",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
},
"issuing_cardholder_verification": {
"description": "",
@@ -29863,6 +32793,9 @@
"type": "object",
"x-expandableFields": [
"document"
+ ],
+ "x-stripeMostCommon": [
+ "document"
]
},
"issuing_compliance_credit_underwriting_record_application": {
@@ -29899,7 +32832,11 @@
],
"title": "IssuingComplianceCreditUnderwritingRecordApplication",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "purpose",
+ "submitted_at"
+ ]
},
"issuing_compliance_credit_underwriting_record_credit_user": {
"description": "",
@@ -29921,7 +32858,11 @@
],
"title": "IssuingComplianceCreditUnderwritingRecordCreditUser",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "email",
+ "name"
+ ]
},
"issuing_compliance_credit_underwriting_record_decision": {
"description": "",
@@ -29990,6 +32931,13 @@
"credit_limit_approved",
"credit_limit_decreased",
"credit_line_closed"
+ ],
+ "x-stripeMostCommon": [
+ "application_rejected",
+ "credit_limit_approved",
+ "credit_limit_decreased",
+ "credit_line_closed",
+ "type"
]
},
"issuing_compliance_credit_underwriting_record_decision_type_application_rejected": {
@@ -30080,7 +33028,11 @@
],
"title": "IssuingComplianceCreditUnderwritingRecordDecisionTypeApplicationRejected",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reason_other_explanation",
+ "reasons"
+ ]
},
"issuing_compliance_credit_underwriting_record_decision_type_credit_limit_approved": {
"description": "",
@@ -30100,7 +33052,11 @@
],
"title": "IssuingComplianceCreditUnderwritingRecordDecisionTypeCreditLimitApproved",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "currency"
+ ]
},
"issuing_compliance_credit_underwriting_record_decision_type_credit_limit_decreased": {
"description": "",
@@ -30208,7 +33164,13 @@
],
"title": "IssuingComplianceCreditUnderwritingRecordDecisionTypeCreditLimitDecreased",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "reason_other_explanation",
+ "reasons"
+ ]
},
"issuing_compliance_credit_underwriting_record_decision_type_credit_line_closed": {
"description": "",
@@ -30306,7 +33268,11 @@
],
"title": "IssuingComplianceCreditUnderwritingRecordDecisionTypeCreditLineClosed",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reason_other_explanation",
+ "reasons"
+ ]
},
"issuing_compliance_credit_underwriting_record_underwriting_exception": {
"description": "",
@@ -30336,7 +33302,11 @@
],
"title": "IssuingComplianceCreditUnderwritingRecordUnderwritingException",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "explanation",
+ "original_decision_type"
+ ]
},
"issuing_compliance_notice_email": {
"description": "",
@@ -30364,7 +33334,12 @@
],
"title": "IssuingComplianceNoticeEmail",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "plain_text",
+ "recipient",
+ "subject"
+ ]
},
"issuing_compliance_notice_linked_objects": {
"description": "",
@@ -30394,7 +33369,12 @@
],
"title": "IssuingComplianceNoticeLinkedObjects",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "capability",
+ "issuing_credit_underwriting_record",
+ "issuing_dispute"
+ ]
},
"issuing_dispute.closed": {
"description": "Occurs whenever a dispute is won, lost or expired.",
@@ -30591,6 +33571,18 @@
"type": "object",
"x-expandableFields": [
"additional_documentation"
+ ],
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "canceled_at",
+ "cancellation_policy_provided",
+ "cancellation_reason",
+ "expected_at",
+ "explanation",
+ "product_description",
+ "product_type",
+ "return_status",
+ "returned_at"
]
},
"issuing_dispute_duplicate_evidence": {
@@ -30704,6 +33696,14 @@
"card_statement",
"cash_receipt",
"check_image"
+ ],
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "card_statement",
+ "cash_receipt",
+ "check_image",
+ "explanation",
+ "original_transaction"
]
},
"issuing_dispute_evidence": {
@@ -30763,6 +33763,17 @@
"not_received",
"other",
"service_not_as_described"
+ ],
+ "x-stripeMostCommon": [
+ "canceled",
+ "duplicate",
+ "fraudulent",
+ "merchandise_not_as_described",
+ "no_valid_authorization",
+ "not_received",
+ "other",
+ "reason",
+ "service_not_as_described"
]
},
"issuing_dispute_fraudulent_evidence": {
@@ -30803,6 +33814,10 @@
"type": "object",
"x-expandableFields": [
"additional_documentation"
+ ],
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "explanation"
]
},
"issuing_dispute_merchandise_not_as_described_evidence": {
@@ -30874,6 +33889,14 @@
"type": "object",
"x-expandableFields": [
"additional_documentation"
+ ],
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "explanation",
+ "received_at",
+ "return_description",
+ "return_status",
+ "returned_at"
]
},
"issuing_dispute_no_valid_authorization_evidence": {
@@ -30914,6 +33937,10 @@
"type": "object",
"x-expandableFields": [
"additional_documentation"
+ ],
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "explanation"
]
},
"issuing_dispute_not_received_evidence": {
@@ -30978,6 +34005,13 @@
"type": "object",
"x-expandableFields": [
"additional_documentation"
+ ],
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "expected_at",
+ "explanation",
+ "product_description",
+ "product_type"
]
},
"issuing_dispute_other_evidence": {
@@ -31035,6 +34069,12 @@
"type": "object",
"x-expandableFields": [
"additional_documentation"
+ ],
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "explanation",
+ "product_description",
+ "product_type"
]
},
"issuing_dispute_service_not_as_described_evidence": {
@@ -31096,6 +34136,13 @@
"type": "object",
"x-expandableFields": [
"additional_documentation"
+ ],
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "canceled_at",
+ "cancellation_reason",
+ "explanation",
+ "received_at"
]
},
"issuing_dispute_treasury": {
@@ -31119,7 +34166,11 @@
],
"title": "IssuingDisputeTreasury",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "debit_reversal",
+ "received_debit"
+ ]
},
"issuing_network_token_address": {
"description": "",
@@ -31141,7 +34192,11 @@
],
"title": "IssuingNetworkTokenAddress",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "line1",
+ "postal_code"
+ ]
},
"issuing_network_token_device": {
"description": "",
@@ -31183,7 +34238,15 @@
},
"title": "IssuingNetworkTokenDevice",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "device_fingerprint",
+ "ip_address",
+ "location",
+ "name",
+ "phone_number",
+ "type"
+ ]
},
"issuing_network_token_mastercard": {
"description": "",
@@ -31215,7 +34278,13 @@
],
"title": "IssuingNetworkTokenMastercard",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "card_reference_id",
+ "token_reference_id",
+ "token_requestor_id",
+ "token_requestor_name"
+ ]
},
"issuing_network_token_network_data": {
"description": "",
@@ -31251,6 +34320,13 @@
"mastercard",
"visa",
"wallet_provider"
+ ],
+ "x-stripeMostCommon": [
+ "device",
+ "mastercard",
+ "type",
+ "visa",
+ "wallet_provider"
]
},
"issuing_network_token_visa": {
@@ -31284,7 +34360,13 @@
],
"title": "IssuingNetworkTokenVisa",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "card_reference_id",
+ "token_reference_id",
+ "token_requestor_id",
+ "token_risk_score"
+ ]
},
"issuing_network_token_wallet_provider": {
"description": "",
@@ -31381,6 +34463,18 @@
"type": "object",
"x-expandableFields": [
"cardholder_address"
+ ],
+ "x-stripeMostCommon": [
+ "account_id",
+ "account_trust_score",
+ "card_number_source",
+ "cardholder_address",
+ "cardholder_name",
+ "device_trust_score",
+ "hashed_account_email_address",
+ "reason_codes",
+ "suggested_decision",
+ "suggested_decision_version"
]
},
"issuing_personalization_design.activated": {
@@ -31483,7 +34577,13 @@
],
"title": "IssuingPersonalizationDesignCarrierText",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "footer_body",
+ "footer_title",
+ "header_body",
+ "header_title"
+ ]
},
"issuing_personalization_design_preferences": {
"description": "",
@@ -31504,7 +34604,11 @@
],
"title": "IssuingPersonalizationDesignPreferences",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "is_default",
+ "is_platform_default"
+ ]
},
"issuing_personalization_design_rejection_reasons": {
"description": "",
@@ -31551,7 +34655,11 @@
],
"title": "IssuingPersonalizationDesignRejectionReasons",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "card_logo",
+ "carrier_text"
+ ]
},
"issuing_physical_bundle_features": {
"description": "",
@@ -31591,7 +34699,12 @@
],
"title": "IssuingPhysicalBundleFeatures",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "card_logo",
+ "carrier_text",
+ "second_line"
+ ]
},
"issuing_token.created": {
"description": "Occurs whenever an issuing digital wallet token is created.",
@@ -31677,7 +34790,11 @@
],
"title": "IssuingTransactionAmountDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "atm_fee",
+ "cashback_amount"
+ ]
},
"issuing_transaction_fleet_cardholder_prompt_data": {
"description": "",
@@ -31721,7 +34838,14 @@
],
"title": "IssuingTransactionFleetCardholderPromptData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "driver_id",
+ "odometer",
+ "unspecified_id",
+ "user_id",
+ "vehicle_number"
+ ]
},
"issuing_transaction_fleet_data": {
"description": "",
@@ -31768,6 +34892,12 @@
"x-expandableFields": [
"cardholder_prompt_data",
"reported_breakdown"
+ ],
+ "x-stripeMostCommon": [
+ "cardholder_prompt_data",
+ "purchase_type",
+ "reported_breakdown",
+ "service_type"
]
},
"issuing_transaction_fleet_fuel_price_data": {
@@ -31785,7 +34915,10 @@
],
"title": "IssuingTransactionFleetFuelPriceData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "gross_amount_decimal"
+ ]
},
"issuing_transaction_fleet_non_fuel_price_data": {
"description": "",
@@ -31802,7 +34935,10 @@
],
"title": "IssuingTransactionFleetNonFuelPriceData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "gross_amount_decimal"
+ ]
},
"issuing_transaction_fleet_reported_breakdown": {
"description": "",
@@ -31846,6 +34982,11 @@
"fuel",
"non_fuel",
"tax"
+ ],
+ "x-stripeMostCommon": [
+ "fuel",
+ "non_fuel",
+ "tax"
]
},
"issuing_transaction_fleet_tax_data": {
@@ -31870,7 +35011,11 @@
],
"title": "IssuingTransactionFleetTaxData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "local_amount_decimal",
+ "national_amount_decimal"
+ ]
},
"issuing_transaction_flight_data": {
"description": "",
@@ -31917,6 +35062,13 @@
"type": "object",
"x-expandableFields": [
"segments"
+ ],
+ "x-stripeMostCommon": [
+ "departure_at",
+ "passenger_name",
+ "refundable",
+ "segments",
+ "travel_agency"
]
},
"issuing_transaction_flight_data_leg": {
@@ -31968,7 +35120,15 @@
],
"title": "IssuingTransactionFlightDataLeg",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "arrival_airport_code",
+ "carrier",
+ "departure_airport_code",
+ "flight_number",
+ "service_class",
+ "stopover_allowed"
+ ]
},
"issuing_transaction_fuel_data": {
"description": "",
@@ -32010,7 +35170,14 @@
],
"title": "IssuingTransactionFuelData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "industry_product_code",
+ "quantity_decimal",
+ "type",
+ "unit",
+ "unit_cost_decimal"
+ ]
},
"issuing_transaction_lodging_data": {
"description": "",
@@ -32032,7 +35199,11 @@
],
"title": "IssuingTransactionLodgingData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "check_in_at",
+ "nights"
+ ]
},
"issuing_transaction_network_data": {
"description": "",
@@ -32063,7 +35234,12 @@
],
"title": "IssuingTransactionNetworkData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "authorization_code",
+ "processing_date",
+ "transaction_id"
+ ]
},
"issuing_transaction_purchase_details": {
"description": "",
@@ -32135,6 +35311,14 @@
"fuel",
"lodging",
"receipt"
+ ],
+ "x-stripeMostCommon": [
+ "fleet",
+ "flight",
+ "fuel",
+ "lodging",
+ "receipt",
+ "reference"
]
},
"issuing_transaction_receipt_data": {
@@ -32170,7 +35354,13 @@
],
"title": "IssuingTransactionReceiptData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "description",
+ "quantity",
+ "total",
+ "unit_cost"
+ ]
},
"issuing_transaction_treasury": {
"description": "",
@@ -32194,7 +35384,11 @@
],
"title": "IssuingTransactionTreasury",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "received_credit",
+ "received_debit"
+ ]
},
"item": {
"description": "A line item.",
@@ -32296,7 +35490,6 @@
"amount_tax",
"amount_total",
"currency",
- "description",
"id",
"object",
"price",
@@ -32311,6 +35504,20 @@
"taxes"
],
"x-resourceId": "item",
+ "x-stripeMostCommon": [
+ "amount_discount",
+ "amount_subtotal",
+ "amount_tax",
+ "amount_total",
+ "currency",
+ "description",
+ "discounts",
+ "id",
+ "object",
+ "price",
+ "quantity",
+ "taxes"
+ ],
"x-stripeResource": {
"class_name": "LineItem",
"has_collection_class": true,
@@ -32457,6 +35664,26 @@
"address_kanji",
"ownership_declaration",
"verification"
+ ],
+ "x-stripeMostCommon": [
+ "address",
+ "address_kana",
+ "address_kanji",
+ "directors_provided",
+ "executives_provided",
+ "export_license_id",
+ "export_purpose_code",
+ "name",
+ "name_kana",
+ "name_kanji",
+ "owners_provided",
+ "ownership_declaration",
+ "phone",
+ "structure",
+ "tax_id_provided",
+ "tax_id_registrar",
+ "vat_id_provided",
+ "verification"
]
},
"legal_entity_company_verification": {
@@ -32473,6 +35700,9 @@
"type": "object",
"x-expandableFields": [
"document"
+ ],
+ "x-stripeMostCommon": [
+ "document"
]
},
"legal_entity_company_verification_document": {
@@ -32542,6 +35772,12 @@
"x-expandableFields": [
"back",
"front"
+ ],
+ "x-stripeMostCommon": [
+ "back",
+ "details",
+ "details_code",
+ "front"
]
},
"legal_entity_dob": {
@@ -32570,7 +35806,12 @@
],
"title": "LegalEntityDOB",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
"legal_entity_japan_address": {
"description": "",
@@ -32629,7 +35870,16 @@
],
"title": "LegalEntityJapanAddress",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"legal_entity_person_verification": {
"description": "",
@@ -32672,6 +35922,13 @@
"x-expandableFields": [
"additional_document",
"document"
+ ],
+ "x-stripeMostCommon": [
+ "additional_document",
+ "details",
+ "details_code",
+ "document",
+ "status"
]
},
"legal_entity_person_verification_document": {
@@ -32741,6 +35998,12 @@
"x-expandableFields": [
"back",
"front"
+ ],
+ "x-stripeMostCommon": [
+ "back",
+ "details",
+ "details_code",
+ "front"
]
},
"legal_entity_ubo_declaration": {
@@ -32772,7 +36035,12 @@
],
"title": "LegalEntityUBODeclaration",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
},
"level3": {
"description": "",
@@ -32811,6 +36079,14 @@
"type": "object",
"x-expandableFields": [
"line_items"
+ ],
+ "x-stripeMostCommon": [
+ "customer_reference",
+ "line_items",
+ "merchant_reference",
+ "shipping_address_zip",
+ "shipping_amount",
+ "shipping_from_zip"
]
},
"level3_line_items": {
@@ -32851,10 +36127,18 @@
],
"title": "Level3LineItems",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "discount_amount",
+ "product_code",
+ "product_description",
+ "quantity",
+ "tax_amount",
+ "unit_cost"
+ ]
},
"line_item": {
- "description": "",
+ "description": "Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice.\n\nEach line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items).",
"properties": {
"amount": {
"description": "The amount, in cents (or local equivalent).",
@@ -33116,6 +36400,8 @@
"proration_details",
"quantity",
"subscription",
+ "tax_amounts",
+ "tax_rates",
"type",
"unit_amount_excluding_tax"
],
@@ -33137,6 +36423,19 @@
"tax_rates"
],
"x-resourceId": "line_item",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "id",
+ "invoice",
+ "metadata",
+ "period",
+ "price",
+ "proration",
+ "quantity",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -33185,6 +36484,10 @@
"type": "object",
"x-expandableFields": [
"discount"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "discount"
]
},
"line_items_tax_amount": {
@@ -33236,6 +36539,12 @@
"type": "object",
"x-expandableFields": [
"rate"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "rate",
+ "taxability_reason",
+ "taxable_amount"
]
},
"linked_account_options_us_bank_account": {
@@ -33288,6 +36597,13 @@
"x-expandableFields": [
"filters",
"manual_entry"
+ ],
+ "x-stripeMostCommon": [
+ "filters",
+ "manual_entry",
+ "permissions",
+ "prefetch",
+ "return_url"
]
},
"login_link": {
@@ -33320,6 +36636,9 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "login_link",
+ "x-stripeMostCommon": [
+ "url"
+ ],
"x-stripeOperations": [
{
"method_name": "create",
@@ -33427,6 +36746,14 @@
"single_use"
],
"x-resourceId": "mandate",
+ "x-stripeMostCommon": [
+ "customer_acceptance",
+ "id",
+ "payment_method",
+ "payment_method_details",
+ "status",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "retrieve",
@@ -33503,6 +36830,12 @@
"title": "mandate_acss_debit",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "default_for",
+ "interval_description",
+ "payment_schedule",
+ "transaction_type"
+ ],
"x-stripeResource": {
"class_name": "AcssDebit",
"in_package": ""
@@ -33533,7 +36866,10 @@
],
"title": "mandate_au_becs_debit",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "url"
+ ]
},
"mandate_bacs_debit": {
"description": "",
@@ -33579,7 +36915,13 @@
],
"title": "mandate_bacs_debit",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "network_status",
+ "reference",
+ "revocation_reason",
+ "url"
+ ]
},
"mandate_cashapp": {
"description": "",
@@ -33686,6 +37028,15 @@
"title": "mandate_options_payto",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "end_date",
+ "payment_schedule",
+ "payments_per_period",
+ "purpose",
+ "start_date"
+ ],
"x-stripeResource": {
"class_name": "Payto",
"in_package": ""
@@ -33754,6 +37105,21 @@
"revolut_pay",
"sepa_debit",
"us_bank_account"
+ ],
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "amazon_pay",
+ "au_becs_debit",
+ "bacs_debit",
+ "card",
+ "cashapp",
+ "link",
+ "paypal",
+ "payto",
+ "revolut_pay",
+ "sepa_debit",
+ "type",
+ "us_bank_account"
]
},
"mandate_paypal": {
@@ -33790,7 +37156,13 @@
],
"title": "mandate_paypal",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "billing_agreement_id",
+ "fingerprint",
+ "payer_id",
+ "verified_email"
+ ]
},
"mandate_payto": {
"description": "",
@@ -33870,6 +37242,15 @@
"title": "mandate_payto",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "end_date",
+ "payment_schedule",
+ "payments_per_period",
+ "purpose",
+ "start_date"
+ ],
"x-stripeResource": {
"class_name": "Payto",
"in_package": ""
@@ -33907,6 +37288,10 @@
"title": "mandate_sepa_debit",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reference",
+ "url"
+ ],
"x-stripeResource": {
"class_name": "SepaDebit",
"in_package": ""
@@ -33930,7 +37315,11 @@
],
"title": "mandate_single_use",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "currency"
+ ]
},
"mandate_us_bank_account": {
"description": "",
@@ -33947,6 +37336,9 @@
"title": "mandate_us_bank_account",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "collection_method"
+ ],
"x-stripeResource": {
"class_name": "UsBankAccount",
"in_package": ""
@@ -34020,6 +37412,17 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "margin",
+ "x-stripeMostCommon": [
+ "active",
+ "created",
+ "id",
+ "livemode",
+ "metadata",
+ "name",
+ "object",
+ "percent_off",
+ "updated"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -34091,6 +37494,10 @@
"type": "object",
"x-expandableFields": [
"margin"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "margin"
]
},
"migrate_to": {
@@ -34121,7 +37528,12 @@
],
"title": "MigrateTo",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "behavior",
+ "effective_after",
+ "price"
+ ]
},
"networks": {
"description": "",
@@ -34147,7 +37559,11 @@
],
"title": "networks",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "available",
+ "preferred"
+ ]
},
"notification_event_automation_action": {
"description": "",
@@ -34176,6 +37592,11 @@
"type": "object",
"x-expandableFields": [
"stripe_send_webhook_custom_event"
+ ],
+ "x-stripeMostCommon": [
+ "stripe_send_webhook_custom_event",
+ "trigger",
+ "type"
]
},
"notification_event_automation_action_resource_send_webhook_custom_event": {
@@ -34196,7 +37617,10 @@
],
"title": "NotificationEventAutomationActionResourceSendWebhookCustomEvent",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "custom_data"
+ ]
},
"notification_event_data": {
"description": "",
@@ -34216,6 +37640,10 @@
"title": "NotificationEventData",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "object",
+ "previous_attributes"
+ ],
"x-stripeResource": {
"class_name": "EventData",
"in_package": ""
@@ -34247,6 +37675,11 @@
"x-expandableFields": [
"automation_action",
"request"
+ ],
+ "x-stripeMostCommon": [
+ "automation_action",
+ "request",
+ "type"
]
},
"notification_event_request": {
@@ -34271,7 +37704,11 @@
],
"title": "NotificationEventRequest",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "id",
+ "idempotency_key"
+ ]
},
"offline_acceptance": {
"description": "",
@@ -34302,7 +37739,11 @@
],
"title": "online_acceptance",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "ip_address",
+ "user_agent"
+ ]
},
"order": {
"description": "An Order describes a purchase being made by a customer, including the\nproducts & quantities being purchased, the order status, the payment information,\nand the billing/shipping details.\n\nRelated guide: [Orders overview](https://stripe.com/docs/orders)",
@@ -34475,6 +37916,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"livemode": {
@@ -34575,6 +38022,18 @@
"total_details"
],
"x-resourceId": "order",
+ "x-stripeMostCommon": [
+ "amount_total",
+ "client_secret",
+ "currency",
+ "customer",
+ "description",
+ "id",
+ "line_items",
+ "metadata",
+ "payment",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -34670,7 +38129,12 @@
],
"title": "orders_payment_method_options_afterpay_clearpay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "capture_method",
+ "reference",
+ "setup_future_usage"
+ ]
},
"orders_v2_resource_automatic_payment_methods": {
"description": "",
@@ -34685,7 +38149,10 @@
],
"title": "OrdersV2ResourceAutomaticPaymentMethods",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"orders_v2_resource_automatic_tax": {
"description": "",
@@ -34711,7 +38178,11 @@
],
"title": "OrdersV2ResourceAutomaticTax",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enabled",
+ "status"
+ ]
},
"orders_v2_resource_billing_details": {
"description": "",
@@ -34754,6 +38225,12 @@
"type": "object",
"x-expandableFields": [
"address"
+ ],
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
]
},
"orders_v2_resource_card_payment_method_options": {
@@ -34783,7 +38260,11 @@
],
"title": "OrdersV2ResourceCardPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "capture_method",
+ "setup_future_usage"
+ ]
},
"orders_v2_resource_credit": {
"description": "",
@@ -34828,6 +38309,12 @@
"type": "object",
"x-expandableFields": [
"gift_card"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "gift_card",
+ "ineligible_line_items",
+ "type"
]
},
"orders_v2_resource_gift_card_details": {
@@ -34844,7 +38331,10 @@
],
"title": "OrdersV2ResourceGiftCardDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "card"
+ ]
},
"orders_v2_resource_payment": {
"description": "",
@@ -34904,6 +38394,11 @@
"x-expandableFields": [
"payment_intent",
"settings"
+ ],
+ "x-stripeMostCommon": [
+ "payment_intent",
+ "settings",
+ "status"
]
},
"orders_v2_resource_payment_method_options": {
@@ -34973,6 +38468,23 @@
"sepa_debit",
"sofort",
"wechat_pay"
+ ],
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "afterpay_clearpay",
+ "alipay",
+ "bancontact",
+ "card",
+ "customer_balance",
+ "ideal",
+ "klarna",
+ "link",
+ "oxxo",
+ "p24",
+ "paypal",
+ "sepa_debit",
+ "sofort",
+ "wechat_pay"
]
},
"orders_v2_resource_payment_settings": {
@@ -35076,6 +38588,16 @@
"automatic_payment_methods",
"payment_method_options",
"transfer_data"
+ ],
+ "x-stripeMostCommon": [
+ "application_fee_amount",
+ "automatic_payment_methods",
+ "payment_method_options",
+ "payment_method_types",
+ "return_url",
+ "statement_descriptor",
+ "statement_descriptor_suffix",
+ "transfer_data"
]
},
"orders_v2_resource_shipping_cost": {
@@ -35132,6 +38654,13 @@
"x-expandableFields": [
"shipping_rate",
"taxes"
+ ],
+ "x-stripeMostCommon": [
+ "amount_subtotal",
+ "amount_tax",
+ "amount_total",
+ "shipping_rate",
+ "taxes"
]
},
"orders_v2_resource_shipping_details": {
@@ -35169,6 +38698,11 @@
"x-expandableFields": [
"address"
],
+ "x-stripeMostCommon": [
+ "address",
+ "name",
+ "phone"
+ ],
"x-stripeResource": {
"class_name": "ShippingDetails",
"in_package": ""
@@ -35202,13 +38736,17 @@
"type": "object",
"x-expandableFields": [
"tax_ids"
+ ],
+ "x-stripeMostCommon": [
+ "tax_exempt",
+ "tax_ids"
]
},
"orders_v2_resource_tax_details_resource_tax_id": {
"description": "",
"properties": {
"type": {
- "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
+ "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -35242,6 +38780,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -35300,7 +38839,11 @@
],
"title": "OrdersV2ResourceTaxDetailsResourceTaxID",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "type",
+ "value"
+ ]
},
"orders_v2_resource_total_details": {
"description": "",
@@ -35334,6 +38877,12 @@
"type": "object",
"x-expandableFields": [
"breakdown"
+ ],
+ "x-stripeMostCommon": [
+ "amount_discount",
+ "amount_shipping",
+ "amount_tax",
+ "breakdown"
]
},
"orders_v2_resource_total_details_api_resource_breakdown": {
@@ -35363,6 +38912,10 @@
"x-expandableFields": [
"discounts",
"taxes"
+ ],
+ "x-stripeMostCommon": [
+ "discounts",
+ "taxes"
]
},
"orders_v2_resource_transfer_data": {
@@ -35401,6 +38954,10 @@
"type": "object",
"x-expandableFields": [
"destination"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "destination"
]
},
"outbound_payments_payment_method_details": {
@@ -35434,6 +38991,12 @@
"billing_details",
"financial_account",
"us_bank_account"
+ ],
+ "x-stripeMostCommon": [
+ "billing_details",
+ "financial_account",
+ "type",
+ "us_bank_account"
]
},
"outbound_payments_payment_method_details_financial_account": {
@@ -35459,6 +39022,10 @@
"title": "outbound_payments_payment_method_details_financial_account",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "id",
+ "network"
+ ],
"x-stripeResource": {
"class_name": "FinancialAccount",
"in_package": ""
@@ -35551,6 +39118,16 @@
"x-expandableFields": [
"mandate"
],
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "account_type",
+ "bank_name",
+ "fingerprint",
+ "last4",
+ "mandate",
+ "network",
+ "routing_number"
+ ],
"x-stripeResource": {
"class_name": "UsBankAccount",
"in_package": ""
@@ -35584,6 +39161,11 @@
"billing_details",
"us_bank_account"
],
+ "x-stripeMostCommon": [
+ "billing_details",
+ "type",
+ "us_bank_account"
+ ],
"x-stripeResource": {
"class_name": "DestinationPaymentMethodDetails",
"in_package": ""
@@ -35676,6 +39258,16 @@
"x-expandableFields": [
"mandate"
],
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "account_type",
+ "bank_name",
+ "fingerprint",
+ "last4",
+ "mandate",
+ "network",
+ "routing_number"
+ ],
"x-stripeResource": {
"class_name": "UsBankAccount",
"in_package": ""
@@ -35709,7 +39301,13 @@
],
"title": "PackageDimensions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "height",
+ "length",
+ "weight",
+ "width"
+ ]
},
"payment_flows_amount_details": {
"description": "",
@@ -35722,6 +39320,9 @@
"type": "object",
"x-expandableFields": [
"tip"
+ ],
+ "x-stripeMostCommon": [
+ "tip"
]
},
"payment_flows_amount_details_resource_tip": {
@@ -35734,7 +39335,10 @@
},
"title": "PaymentFlowsAmountDetailsResourceTip",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount"
+ ]
},
"payment_flows_automatic_payment_methods_payment_intent": {
"description": "",
@@ -35757,7 +39361,11 @@
],
"title": "PaymentFlowsAutomaticPaymentMethodsPaymentIntent",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "allow_redirects",
+ "enabled"
+ ]
},
"payment_flows_automatic_payment_methods_setup_intent": {
"description": "",
@@ -35781,7 +39389,11 @@
],
"title": "PaymentFlowsAutomaticPaymentMethodsSetupIntent",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "allow_redirects",
+ "enabled"
+ ]
},
"payment_flows_installment_options": {
"description": "",
@@ -35801,6 +39413,10 @@
"x-expandableFields": [
"plan"
],
+ "x-stripeMostCommon": [
+ "enabled",
+ "plan"
+ ],
"x-stripeResource": {
"class_name": "Installments",
"in_package": ""
@@ -35825,6 +39441,11 @@
"car_rental",
"event_details",
"subscription"
+ ],
+ "x-stripeMostCommon": [
+ "car_rental",
+ "event_details",
+ "subscription"
]
},
"payment_flows_payment_details_resource_affiliate": {
@@ -35838,7 +39459,10 @@
},
"title": "PaymentFlowsPaymentDetailsResourceAffiliate",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"payment_flows_payment_details_resource_billing_interval": {
"description": "",
@@ -35860,7 +39484,11 @@
},
"title": "PaymentFlowsPaymentDetailsResourceBillingInterval",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "count",
+ "interval"
+ ]
},
"payment_flows_payment_details_resource_car_rental": {
"description": "",
@@ -35983,6 +39611,28 @@
"drivers",
"pickup_address",
"return_address"
+ ],
+ "x-stripeMostCommon": [
+ "affiliate",
+ "booking_number",
+ "car_class_code",
+ "car_make",
+ "car_model",
+ "company",
+ "customer_service_phone_number",
+ "days_rented",
+ "delivery",
+ "drivers",
+ "extra_charges",
+ "no_show",
+ "pickup_address",
+ "pickup_at",
+ "rate_amount",
+ "rate_interval",
+ "renter_name",
+ "return_address",
+ "return_at",
+ "tax_exempt"
]
},
"payment_flows_payment_details_resource_car_rental_driver": {
@@ -35996,7 +39646,10 @@
},
"title": "PaymentFlowsPaymentDetailsResourceCarRentalDriver",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"payment_flows_payment_details_resource_delivery": {
"description": "",
@@ -36019,6 +39672,10 @@
"type": "object",
"x-expandableFields": [
"recipient"
+ ],
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
]
},
"payment_flows_payment_details_resource_delivery_recipient": {
@@ -36042,7 +39699,12 @@
},
"title": "PaymentFlowsPaymentDetailsResourceDeliveryRecipient",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
},
"payment_flows_payment_details_resource_event": {
"description": "",
@@ -36092,6 +39754,17 @@
"address",
"affiliate",
"delivery"
+ ],
+ "x-stripeMostCommon": [
+ "access_controlled_venue",
+ "address",
+ "affiliate",
+ "company",
+ "delivery",
+ "ends_at",
+ "genre",
+ "name",
+ "starts_at"
]
},
"payment_flows_payment_details_resource_subscription": {
@@ -36128,6 +39801,14 @@
"x-expandableFields": [
"affiliate",
"billing_interval"
+ ],
+ "x-stripeMostCommon": [
+ "affiliate",
+ "auto_renewal",
+ "billing_interval",
+ "ends_at",
+ "name",
+ "starts_at"
]
},
"payment_flows_payment_intent_async_workflows": {
@@ -36141,6 +39822,9 @@
"type": "object",
"x-expandableFields": [
"inputs"
+ ],
+ "x-stripeMostCommon": [
+ "inputs"
]
},
"payment_flows_payment_intent_async_workflows_resource_inputs": {
@@ -36154,6 +39838,9 @@
"type": "object",
"x-expandableFields": [
"tax"
+ ],
+ "x-stripeMostCommon": [
+ "tax"
]
},
"payment_flows_payment_intent_async_workflows_resource_inputs_resource_tax": {
@@ -36170,7 +39857,10 @@
],
"title": "PaymentFlowsPaymentIntentAsyncWorkflowsResourceInputsResourceTax",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "calculation"
+ ]
},
"payment_flows_private_payment_methods_alipay": {
"description": "",
@@ -36206,7 +39896,12 @@
],
"title": "PaymentFlowsPrivatePaymentMethodsAlipayDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "buyer_id",
+ "fingerprint",
+ "transaction_id"
+ ]
},
"payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_decremental_authorization_decremental_authorization": {
"description": "",
@@ -36226,6 +39921,9 @@
"title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesDecrementalAuthorizationDecrementalAuthorization",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "status"
+ ],
"x-stripeResource": {
"class_name": "DecrementalAuthorizationRequest",
"in_package": ""
@@ -36248,7 +39946,10 @@
],
"title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "status"
+ ]
},
"payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization": {
"description": "",
@@ -36267,7 +39968,10 @@
],
"title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "status"
+ ]
},
"payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture": {
"description": "",
@@ -36291,7 +39995,11 @@
],
"title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesOvercaptureOvercapture",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "maximum_amount_capturable",
+ "status"
+ ]
},
"payment_flows_private_payment_methods_card_details_api_resource_multicapture": {
"description": "",
@@ -36310,7 +40018,10 @@
],
"title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceMulticapture",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "status"
+ ]
},
"payment_flows_private_payment_methods_card_options_statement_details": {
"description": "",
@@ -36328,6 +40039,10 @@
"type": "object",
"x-expandableFields": [
"address"
+ ],
+ "x-stripeMostCommon": [
+ "address",
+ "phone"
]
},
"payment_flows_private_payment_methods_card_options_statement_details_resource_address": {
@@ -36367,11 +40082,43 @@
"title": "PaymentFlowsPrivatePaymentMethodsCardOptionsStatementDetailsResourceAddress",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ],
"x-stripeResource": {
"class_name": "StatementDetailsAddress",
"in_package": ""
}
},
+ "payment_flows_private_payment_methods_card_present_common_wallet": {
+ "description": "",
+ "properties": {
+ "type": {
+ "description": "The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.",
+ "enum": [
+ "apple_pay",
+ "google_pay",
+ "samsung_pay",
+ "unknown"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "type"
+ ]
+ },
"payment_flows_private_payment_methods_klarna_dob": {
"description": "",
"properties": {
@@ -36398,7 +40145,12 @@
],
"title": "PaymentFlowsPrivatePaymentMethodsKlarnaDOB",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
"payment_flows_private_payment_methods_rechnung_dob": {
"description": "",
@@ -36423,7 +40175,12 @@
],
"title": "PaymentFlowsPrivatePaymentMethodsRechnungDOB",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
"payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters": {
"description": "",
@@ -36447,7 +40204,11 @@
},
"title": "PaymentFlowsPrivatePaymentMethodsUsBankAccountLinkedAccountOptionsFilters",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_subcategories",
+ "institution"
+ ]
},
"payment_flows_private_payment_methods_us_bank_account_linked_account_options_manual_entry": {
"description": "",
@@ -36463,7 +40224,10 @@
},
"title": "PaymentFlowsPrivatePaymentMethodsUsBankAccountLinkedAccountOptionsManualEntry",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "mode"
+ ]
},
"payment_intent": {
"description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)",
@@ -36585,7 +40349,7 @@
"$ref": "#/components/schemas/deleted_customer"
}
],
- "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
+ "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -36843,13 +40607,13 @@
}
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -36948,6 +40712,26 @@
"transfer_data"
],
"x-resourceId": "payment_intent",
+ "x-stripeMostCommon": [
+ "amount",
+ "automatic_payment_methods",
+ "client_secret",
+ "currency",
+ "customer",
+ "description",
+ "id",
+ "last_payment_error",
+ "latest_charge",
+ "metadata",
+ "next_action",
+ "payment_method",
+ "receipt_email",
+ "setup_future_usage",
+ "shipping",
+ "statement_descriptor",
+ "statement_descriptor_suffix",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -37181,6 +40965,9 @@
"x-expandableFields": [
"customer_notification"
],
+ "x-stripeMostCommon": [
+ "customer_notification"
+ ],
"x-stripeResource": {
"class_name": "Card",
"in_package": ""
@@ -37273,6 +41060,27 @@
"wechat_pay_display_qr_code",
"wechat_pay_redirect_to_android_app",
"wechat_pay_redirect_to_ios_app"
+ ],
+ "x-stripeMostCommon": [
+ "alipay_handle_redirect",
+ "boleto_display_details",
+ "card_await_notification",
+ "cashapp_handle_redirect_or_display_qr_code",
+ "display_bank_transfer_instructions",
+ "konbini_display_details",
+ "multibanco_display_details",
+ "oxxo_display_details",
+ "paynow_display_qr_code",
+ "pix_display_qr_code",
+ "promptpay_display_qr_code",
+ "redirect_to_url",
+ "swish_handle_redirect_or_display_qr_code",
+ "type",
+ "use_stripe_sdk",
+ "verify_with_microdeposits",
+ "wechat_pay_display_qr_code",
+ "wechat_pay_redirect_to_android_app",
+ "wechat_pay_redirect_to_ios_app"
]
},
"payment_intent_next_action_alipay_handle_redirect": {
@@ -37312,6 +41120,12 @@
"title": "PaymentIntentNextActionAlipayHandleRedirect",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "native_data",
+ "native_url",
+ "return_url",
+ "url"
+ ],
"x-stripeResource": {
"class_name": "NextActionAlipayHandleRedirect",
"in_package": ""
@@ -37354,6 +41168,12 @@
"title": "payment_intent_next_action_boleto",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "expires_at",
+ "hosted_voucher_url",
+ "number",
+ "pdf"
+ ],
"x-stripeResource": {
"class_name": "NextActionDisplayBoletoDetails",
"in_package": ""
@@ -37381,6 +41201,10 @@
"title": "PaymentIntentNextActionCardAwaitNotification",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "charge_attempt_at",
+ "customer_approval_required"
+ ],
"x-stripeResource": {
"class_name": "NextActionCardAwaitNotification",
"in_package": ""
@@ -37413,6 +41237,11 @@
"x-expandableFields": [
"qr_code"
],
+ "x-stripeMostCommon": [
+ "hosted_instructions_url",
+ "mobile_auth_url",
+ "qr_code"
+ ],
"x-stripeResource": {
"class_name": "CashappHandleRedirectOrDisplayQrCode",
"in_package": ""
@@ -37445,6 +41274,11 @@
"title": "PaymentIntentNextActionCashappQRCode",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "expires_at",
+ "image_url_png",
+ "image_url_svg"
+ ],
"x-stripeResource": {
"class_name": "CashappQrCode",
"in_package": ""
@@ -37507,6 +41341,14 @@
"x-expandableFields": [
"financial_addresses"
],
+ "x-stripeMostCommon": [
+ "amount_remaining",
+ "currency",
+ "financial_addresses",
+ "hosted_instructions_url",
+ "reference",
+ "type"
+ ],
"x-stripeResource": {
"class_name": "NextActionDisplayBankTransferInstructions",
"in_package": ""
@@ -37549,6 +41391,12 @@
"title": "PaymentIntentNextActionDisplayMultibancoDetails",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "entity",
+ "expires_at",
+ "hosted_voucher_url",
+ "reference"
+ ],
"x-stripeResource": {
"class_name": "NextActionMultibancoDisplayDetails",
"in_package": ""
@@ -37584,6 +41432,11 @@
"title": "PaymentIntentNextActionDisplayOxxoDetails",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "expires_after",
+ "hosted_voucher_url",
+ "number"
+ ],
"x-stripeResource": {
"class_name": "NextActionOxxoDisplayDetails",
"in_package": ""
@@ -37617,6 +41470,11 @@
"x-expandableFields": [
"stores"
],
+ "x-stripeMostCommon": [
+ "expires_at",
+ "hosted_voucher_url",
+ "stores"
+ ],
"x-stripeResource": {
"class_name": "NextActionKonbiniDisplayDetails",
"in_package": ""
@@ -37642,6 +41500,10 @@
"title": "payment_intent_next_action_konbini_familymart",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "confirmation_number",
+ "payment_code"
+ ],
"x-stripeResource": {
"class_name": "Familymart",
"in_package": ""
@@ -37667,6 +41529,10 @@
"title": "payment_intent_next_action_konbini_lawson",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "confirmation_number",
+ "payment_code"
+ ],
"x-stripeResource": {
"class_name": "Lawson",
"in_package": ""
@@ -37692,6 +41558,10 @@
"title": "payment_intent_next_action_konbini_ministop",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "confirmation_number",
+ "payment_code"
+ ],
"x-stripeResource": {
"class_name": "Ministop",
"in_package": ""
@@ -37717,6 +41587,10 @@
"title": "payment_intent_next_action_konbini_seicomart",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "confirmation_number",
+ "payment_code"
+ ],
"x-stripeResource": {
"class_name": "Seicomart",
"in_package": ""
@@ -37776,6 +41650,12 @@
"ministop",
"seicomart"
],
+ "x-stripeMostCommon": [
+ "familymart",
+ "lawson",
+ "ministop",
+ "seicomart"
+ ],
"x-stripeResource": {
"class_name": "Stores",
"in_package": ""
@@ -37815,6 +41695,12 @@
"title": "PaymentIntentNextActionPaynowDisplayQrCode",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "data",
+ "hosted_instructions_url",
+ "image_url_png",
+ "image_url_svg"
+ ],
"x-stripeResource": {
"class_name": "PaynowDisplayQrCode",
"in_package": ""
@@ -37851,6 +41737,13 @@
"title": "PaymentIntentNextActionPixDisplayQrCode",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "data",
+ "expires_at",
+ "hosted_instructions_url",
+ "image_url_png",
+ "image_url_svg"
+ ],
"x-stripeResource": {
"class_name": "PixDisplayQrCode",
"in_package": ""
@@ -37889,6 +41782,12 @@
"title": "PaymentIntentNextActionPromptpayDisplayQrCode",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "data",
+ "hosted_instructions_url",
+ "image_url_png",
+ "image_url_svg"
+ ],
"x-stripeResource": {
"class_name": "PromptpayDisplayQrCode",
"in_package": ""
@@ -37917,6 +41816,10 @@
"title": "PaymentIntentNextActionRedirectToUrl",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "return_url",
+ "url"
+ ],
"x-stripeResource": {
"class_name": "NextActionRedirectToUrl",
"in_package": ""
@@ -37949,6 +41852,11 @@
"x-expandableFields": [
"qr_code"
],
+ "x-stripeMostCommon": [
+ "hosted_instructions_url",
+ "mobile_auth_url",
+ "qr_code"
+ ],
"x-stripeResource": {
"class_name": "SwishHandleRedirectOrDisplayQrCode",
"in_package": ""
@@ -37981,6 +41889,11 @@
"title": "PaymentIntentNextActionSwishQRCode",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "data",
+ "image_url_png",
+ "image_url_svg"
+ ],
"x-stripeResource": {
"class_name": "SwishQrCode",
"in_package": ""
@@ -38016,7 +41929,12 @@
],
"title": "PaymentIntentNextActionVerifyWithMicrodeposits",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "arrival_date",
+ "hosted_verification_url",
+ "microdeposit_type"
+ ]
},
"payment_intent_next_action_wechat_pay_display_qr_code": {
"description": "",
@@ -38057,6 +41975,13 @@
"title": "PaymentIntentNextActionWechatPayDisplayQrCode",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "data",
+ "hosted_instructions_url",
+ "image_data_url",
+ "image_url_png",
+ "image_url_svg"
+ ],
"x-stripeResource": {
"class_name": "WechatPayDisplayQrCode",
"in_package": ""
@@ -38113,6 +42038,15 @@
"title": "PaymentIntentNextActionWechatPayRedirectToAndroidApp",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "app_id",
+ "nonce_str",
+ "package",
+ "partner_id",
+ "prepay_id",
+ "sign",
+ "timestamp"
+ ],
"x-stripeResource": {
"class_name": "WechatPayRedirectToAndroidApp",
"in_package": ""
@@ -38133,6 +42067,9 @@
"title": "PaymentIntentNextActionWechatPayRedirectToIOSApp",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "native_url"
+ ],
"x-stripeResource": {
"class_name": "WechatPayRedirectToIosApp",
"in_package": ""
@@ -38210,6 +42147,9 @@
"link": {
"$ref": "#/components/schemas/payment_intent_payment_method_options_link"
},
+ "mb_way": {
+ "$ref": "#/components/schemas/payment_method_options_mb_way"
+ },
"mobilepay": {
"$ref": "#/components/schemas/payment_intent_payment_method_options_mobilepay"
},
@@ -38291,6 +42231,51 @@
"klarna",
"konbini",
"link",
+ "mb_way",
+ "mobilepay",
+ "multibanco",
+ "oxxo",
+ "p24",
+ "paynow",
+ "paypal",
+ "payto",
+ "pix",
+ "promptpay",
+ "rechnung",
+ "revolut_pay",
+ "sepa_debit",
+ "sofort",
+ "swish",
+ "twint",
+ "us_bank_account",
+ "wechat_pay",
+ "zip"
+ ],
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "affirm",
+ "afterpay_clearpay",
+ "alipay",
+ "amazon_pay",
+ "au_becs_debit",
+ "bacs_debit",
+ "bancontact",
+ "blik",
+ "boleto",
+ "card",
+ "card_present",
+ "cashapp",
+ "customer_balance",
+ "eps",
+ "fpx",
+ "giropay",
+ "grabpay",
+ "ideal",
+ "interac_present",
+ "klarna",
+ "konbini",
+ "link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -38341,6 +42326,11 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
+ ],
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage",
+ "verification_method"
]
},
"payment_intent_payment_method_options_au_becs_debit": {
@@ -38358,7 +42348,10 @@
},
"title": "payment_intent_payment_method_options_au_becs_debit",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"payment_intent_payment_method_options_bacs_debit": {
"description": "",
@@ -38380,6 +42373,10 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
+ ],
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage"
]
},
"payment_intent_payment_method_options_blik": {
@@ -38396,7 +42393,10 @@
},
"title": "payment_intent_payment_method_options_blik",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"payment_intent_payment_method_options_card": {
"description": "",
@@ -38535,6 +42535,23 @@
"installments",
"mandate_options",
"statement_details"
+ ],
+ "x-stripeMostCommon": [
+ "capture_method",
+ "installments",
+ "mandate_options",
+ "network",
+ "request_decremental_authorization",
+ "request_extended_authorization",
+ "request_incremental_authorization",
+ "request_multicapture",
+ "request_overcapture",
+ "request_three_d_secure",
+ "require_cvc_recollection",
+ "setup_future_usage",
+ "statement_descriptor_suffix_kana",
+ "statement_descriptor_suffix_kanji",
+ "statement_details"
]
},
"payment_intent_payment_method_options_eps": {
@@ -38550,7 +42567,10 @@
},
"title": "payment_intent_payment_method_options_eps",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"payment_intent_payment_method_options_link": {
"description": "",
@@ -38582,7 +42602,12 @@
],
"title": "payment_intent_payment_method_options_link",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "capture_method",
+ "persistent_token",
+ "setup_future_usage"
+ ]
},
"payment_intent_payment_method_options_mandate_options_acss_debit": {
"description": "",
@@ -38625,7 +42650,13 @@
],
"title": "payment_intent_payment_method_options_mandate_options_acss_debit",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "custom_mandate_url",
+ "interval_description",
+ "payment_schedule",
+ "transaction_type"
+ ]
},
"payment_intent_payment_method_options_mandate_options_bacs_debit": {
"description": "",
@@ -38710,7 +42741,15 @@
],
"title": "payment_intent_payment_method_options_mandate_options_payto",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "end_date",
+ "payment_schedule",
+ "payments_per_period",
+ "purpose"
+ ]
},
"payment_intent_payment_method_options_mandate_options_sepa_debit": {
"description": "",
@@ -38743,7 +42782,11 @@
},
"title": "payment_intent_payment_method_options_mobilepay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "capture_method",
+ "setup_future_usage"
+ ]
},
"payment_intent_payment_method_options_payto": {
"description": "",
@@ -38764,6 +42807,10 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
+ ],
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage"
]
},
"payment_intent_payment_method_options_rechnung": {
@@ -38793,6 +42840,10 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
+ ],
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage"
]
},
"payment_intent_payment_method_options_swish": {
@@ -38817,7 +42868,11 @@
],
"title": "payment_intent_payment_method_options_swish",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reference",
+ "setup_future_usage"
+ ]
},
"payment_intent_payment_method_options_us_bank_account": {
"description": "",
@@ -38861,6 +42916,13 @@
"x-expandableFields": [
"financial_connections",
"mandate_options"
+ ],
+ "x-stripeMostCommon": [
+ "financial_connections",
+ "mandate_options",
+ "preferred_settlement_speed",
+ "setup_future_usage",
+ "verification_method"
]
},
"payment_intent_processing": {
@@ -38884,6 +42946,10 @@
"type": "object",
"x-expandableFields": [
"card"
+ ],
+ "x-stripeMostCommon": [
+ "card",
+ "type"
]
},
"payment_intent_processing_customer_notification": {
@@ -38908,6 +42974,10 @@
"title": "PaymentIntentProcessingCustomerNotification",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "approval_requested",
+ "completes_at"
+ ],
"x-stripeResource": {
"class_name": "CustomerNotification",
"in_package": ""
@@ -38963,6 +43033,15 @@
"x-expandableFields": [
"installments",
"routing"
+ ],
+ "x-stripeMostCommon": [
+ "capture_method",
+ "installments",
+ "request_incremental_authorization_support",
+ "require_cvc_recollection",
+ "routing",
+ "setup_future_usage",
+ "verification_method"
]
},
"payment_link": {
@@ -39114,6 +43193,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"livemode": {
@@ -39194,6 +43279,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -39338,6 +43424,13 @@
"transfer_data"
],
"x-resourceId": "payment_link",
+ "x-stripeMostCommon": [
+ "active",
+ "id",
+ "line_items",
+ "metadata",
+ "url"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -39439,6 +43532,11 @@
"x-expandableFields": [
"hosted_confirmation",
"redirect"
+ ],
+ "x-stripeMostCommon": [
+ "hosted_confirmation",
+ "redirect",
+ "type"
]
},
"payment_links_resource_automatic_tax": {
@@ -39466,6 +43564,10 @@
"type": "object",
"x-expandableFields": [
"liability"
+ ],
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
]
},
"payment_links_resource_completed_sessions": {
@@ -39486,7 +43588,11 @@
],
"title": "PaymentLinksResourceCompletedSessions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "count",
+ "limit"
+ ]
},
"payment_links_resource_completion_behavior_confirmation_page": {
"description": "",
@@ -39503,7 +43609,10 @@
],
"title": "PaymentLinksResourceCompletionBehaviorConfirmationPage",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "custom_message"
+ ]
},
"payment_links_resource_completion_behavior_redirect": {
"description": "",
@@ -39519,7 +43628,10 @@
],
"title": "PaymentLinksResourceCompletionBehaviorRedirect",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "url"
+ ]
},
"payment_links_resource_consent_collection": {
"description": "",
@@ -39561,6 +43673,11 @@
"type": "object",
"x-expandableFields": [
"payment_method_reuse_agreement"
+ ],
+ "x-stripeMostCommon": [
+ "payment_method_reuse_agreement",
+ "promotions",
+ "terms_of_service"
]
},
"payment_links_resource_custom_fields": {
@@ -39610,6 +43727,15 @@
"label",
"numeric",
"text"
+ ],
+ "x-stripeMostCommon": [
+ "dropdown",
+ "key",
+ "label",
+ "numeric",
+ "optional",
+ "text",
+ "type"
]
},
"payment_links_resource_custom_fields_dropdown": {
@@ -39630,6 +43756,9 @@
"type": "object",
"x-expandableFields": [
"options"
+ ],
+ "x-stripeMostCommon": [
+ "options"
]
},
"payment_links_resource_custom_fields_dropdown_option": {
@@ -39653,6 +43782,10 @@
"title": "PaymentLinksResourceCustomFieldsDropdownOption",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "label",
+ "value"
+ ],
"x-stripeResource": {
"class_name": "CustomFieldDropdownOption",
"in_package": ""
@@ -39681,7 +43814,11 @@
],
"title": "PaymentLinksResourceCustomFieldsLabel",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "custom",
+ "type"
+ ]
},
"payment_links_resource_custom_fields_numeric": {
"description": "",
@@ -39703,7 +43840,11 @@
],
"title": "PaymentLinksResourceCustomFieldsNumeric",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "maximum_length",
+ "minimum_length"
+ ]
},
"payment_links_resource_custom_fields_text": {
"description": "",
@@ -39725,7 +43866,11 @@
],
"title": "PaymentLinksResourceCustomFieldsText",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "maximum_length",
+ "minimum_length"
+ ]
},
"payment_links_resource_custom_text": {
"description": "",
@@ -39780,6 +43925,12 @@
"shipping_address",
"submit",
"terms_of_service_acceptance"
+ ],
+ "x-stripeMostCommon": [
+ "after_submit",
+ "shipping_address",
+ "submit",
+ "terms_of_service_acceptance"
]
},
"payment_links_resource_custom_text_position": {
@@ -39796,7 +43947,10 @@
],
"title": "PaymentLinksResourceCustomTextPosition",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "message"
+ ]
},
"payment_links_resource_invoice_creation": {
"description": "",
@@ -39823,6 +43977,10 @@
"type": "object",
"x-expandableFields": [
"invoice_data"
+ ],
+ "x-stripeMostCommon": [
+ "enabled",
+ "invoice_data"
]
},
"payment_links_resource_invoice_settings": {
@@ -39921,6 +44079,15 @@
"custom_fields",
"issuer",
"rendering_options"
+ ],
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "custom_fields",
+ "description",
+ "footer",
+ "issuer",
+ "metadata",
+ "rendering_options"
]
},
"payment_links_resource_payment_intent_data": {
@@ -39989,7 +44156,16 @@
],
"title": "PaymentLinksResourcePaymentIntentData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "capture_method",
+ "description",
+ "metadata",
+ "setup_future_usage",
+ "statement_descriptor",
+ "statement_descriptor_suffix",
+ "transfer_group"
+ ]
},
"payment_links_resource_payment_method_reuse_agreement": {
"description": "",
@@ -40008,7 +44184,10 @@
],
"title": "PaymentLinksResourcePaymentMethodReuseAgreement",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "position"
+ ]
},
"payment_links_resource_phone_number_collection": {
"description": "",
@@ -40023,7 +44202,10 @@
],
"title": "PaymentLinksResourcePhoneNumberCollection",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"payment_links_resource_restrictions": {
"description": "",
@@ -40039,6 +44221,9 @@
"type": "object",
"x-expandableFields": [
"completed_sessions"
+ ],
+ "x-stripeMostCommon": [
+ "completed_sessions"
]
},
"payment_links_resource_shipping_address_collection": {
@@ -40296,7 +44481,10 @@
],
"title": "PaymentLinksResourceShippingAddressCollection",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "allowed_countries"
+ ]
},
"payment_links_resource_shipping_option": {
"description": "",
@@ -40333,6 +44521,10 @@
"type": "object",
"x-expandableFields": [
"shipping_rate"
+ ],
+ "x-stripeMostCommon": [
+ "shipping_amount",
+ "shipping_rate"
]
},
"payment_links_resource_subscription_data": {
@@ -40382,6 +44574,13 @@
"x-expandableFields": [
"invoice_settings",
"trial_settings"
+ ],
+ "x-stripeMostCommon": [
+ "description",
+ "invoice_settings",
+ "metadata",
+ "trial_period_days",
+ "trial_settings"
]
},
"payment_links_resource_subscription_data_invoice_settings": {
@@ -40398,6 +44597,9 @@
"type": "object",
"x-expandableFields": [
"issuer"
+ ],
+ "x-stripeMostCommon": [
+ "issuer"
]
},
"payment_links_resource_tax_id_collection": {
@@ -40413,7 +44615,10 @@
],
"title": "PaymentLinksResourceTaxIdCollection",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"payment_links_resource_transfer_data": {
"description": "",
@@ -40451,6 +44656,10 @@
"type": "object",
"x-expandableFields": [
"destination"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "destination"
]
},
"payment_method": {
@@ -40571,6 +44780,9 @@
"description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
"type": "boolean"
},
+ "mb_way": {
+ "$ref": "#/components/schemas/payment_method_mb_way"
+ },
"metadata": {
"additionalProperties": {
"maxLength": 500,
@@ -40661,6 +44873,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -40731,6 +44944,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -40752,6 +44966,13 @@
"zip"
],
"x-resourceId": "payment_method",
+ "x-stripeMostCommon": [
+ "billing_details",
+ "customer",
+ "id",
+ "metadata",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -40909,7 +45130,14 @@
],
"title": "payment_method_acss_debit",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bank_name",
+ "fingerprint",
+ "institution_number",
+ "last4",
+ "transit_number"
+ ]
},
"payment_method_affirm": {
"description": "",
@@ -40961,7 +45189,12 @@
],
"title": "payment_method_au_becs_debit",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bsb_number",
+ "fingerprint",
+ "last4"
+ ]
},
"payment_method_bacs_debit": {
"description": "",
@@ -40992,7 +45225,12 @@
],
"title": "payment_method_bacs_debit",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "fingerprint",
+ "last4",
+ "sort_code"
+ ]
},
"payment_method_bancontact": {
"description": "",
@@ -41022,7 +45260,10 @@
],
"title": "payment_method_boleto",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"payment_method_card": {
"description": "",
@@ -41154,6 +45395,24 @@
"networks",
"three_d_secure_usage",
"wallet"
+ ],
+ "x-stripeMostCommon": [
+ "brand",
+ "checks",
+ "country",
+ "description",
+ "display_brand",
+ "exp_month",
+ "exp_year",
+ "fingerprint",
+ "funding",
+ "generated_from",
+ "iin",
+ "issuer",
+ "last4",
+ "networks",
+ "three_d_secure_usage",
+ "wallet"
]
},
"payment_method_card_checks": {
@@ -41185,7 +45444,12 @@
],
"title": "payment_method_card_checks",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "address_line1_check",
+ "address_postal_code_check",
+ "cvc_check"
+ ]
},
"payment_method_card_generated_card": {
"description": "",
@@ -41236,6 +45500,11 @@
"x-expandableFields": [
"payment_method_details",
"setup_attempt"
+ ],
+ "x-stripeMostCommon": [
+ "charge",
+ "payment_method_details",
+ "setup_attempt"
]
},
"payment_method_card_present": {
@@ -41347,6 +45616,9 @@
],
"nullable": true,
"type": "string"
+ },
+ "wallet": {
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet"
}
},
"required": [
@@ -41368,7 +45640,27 @@
"type": "object",
"x-expandableFields": [
"networks",
- "offline"
+ "offline",
+ "wallet"
+ ],
+ "x-stripeMostCommon": [
+ "brand",
+ "brand_product",
+ "cardholder_name",
+ "country",
+ "description",
+ "exp_month",
+ "exp_year",
+ "fingerprint",
+ "funding",
+ "iin",
+ "issuer",
+ "last4",
+ "networks",
+ "offline",
+ "preferred_locales",
+ "read_method",
+ "wallet"
]
},
"payment_method_card_present_networks": {
@@ -41395,7 +45687,11 @@
],
"title": "payment_method_card_present_networks",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "available",
+ "preferred"
+ ]
},
"payment_method_card_wallet": {
"description": "",
@@ -41455,6 +45751,17 @@
"masterpass",
"samsung_pay",
"visa_checkout"
+ ],
+ "x-stripeMostCommon": [
+ "amex_express_checkout",
+ "apple_pay",
+ "dynamic_last4",
+ "google_pay",
+ "link",
+ "masterpass",
+ "samsung_pay",
+ "type",
+ "visa_checkout"
]
},
"payment_method_card_wallet_amex_express_checkout": {
@@ -41530,6 +45837,12 @@
"x-expandableFields": [
"billing_address",
"shipping_address"
+ ],
+ "x-stripeMostCommon": [
+ "billing_address",
+ "email",
+ "name",
+ "shipping_address"
]
},
"payment_method_card_wallet_samsung_pay": {
@@ -41584,6 +45897,12 @@
"x-expandableFields": [
"billing_address",
"shipping_address"
+ ],
+ "x-stripeMostCommon": [
+ "billing_address",
+ "email",
+ "name",
+ "shipping_address"
]
},
"payment_method_cashapp": {
@@ -41608,7 +45927,11 @@
],
"title": "payment_method_cashapp",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "buyer_id",
+ "cashtag"
+ ]
},
"payment_method_config_biz_payment_method_configuration_details": {
"description": "",
@@ -41631,7 +45954,11 @@
],
"title": "PaymentMethodConfigBizPaymentMethodConfigurationDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "id",
+ "parent"
+ ]
},
"payment_method_config_resource_display_preference": {
"description": "",
@@ -41666,7 +45993,12 @@
],
"title": "PaymentMethodConfigResourceDisplayPreference",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "overridable",
+ "preference",
+ "value"
+ ]
},
"payment_method_config_resource_payment_method_properties": {
"description": "",
@@ -41687,6 +46019,10 @@
"type": "object",
"x-expandableFields": [
"display_preference"
+ ],
+ "x-stripeMostCommon": [
+ "available",
+ "display_preference"
]
},
"payment_method_configuration": {
@@ -41913,6 +46249,15 @@
"zip"
],
"x-resourceId": "payment_method_configuration",
+ "x-stripeMostCommon": [
+ "active",
+ "application",
+ "id",
+ "is_default",
+ "name",
+ "object",
+ "parent"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -42034,6 +46379,9 @@
"link": {
"$ref": "#/components/schemas/payment_method_details_link"
},
+ "mb_way": {
+ "$ref": "#/components/schemas/payment_method_details_mb_way"
+ },
"mobilepay": {
"$ref": "#/components/schemas/payment_method_details_mobilepay"
},
@@ -42134,6 +46482,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -42155,6 +46504,56 @@
"wechat",
"wechat_pay",
"zip"
+ ],
+ "x-stripeMostCommon": [
+ "ach_credit_transfer",
+ "ach_debit",
+ "acss_debit",
+ "affirm",
+ "afterpay_clearpay",
+ "alipay",
+ "amazon_pay",
+ "au_becs_debit",
+ "bacs_debit",
+ "bancontact",
+ "blik",
+ "boleto",
+ "card",
+ "card_present",
+ "cashapp",
+ "customer_balance",
+ "eps",
+ "fpx",
+ "giropay",
+ "grabpay",
+ "ideal",
+ "interac_present",
+ "klarna",
+ "konbini",
+ "link",
+ "mb_way",
+ "mobilepay",
+ "multibanco",
+ "oxxo",
+ "p24",
+ "paynow",
+ "paypal",
+ "payto",
+ "pix",
+ "promptpay",
+ "rechnung",
+ "revolut_pay",
+ "sepa_credit_transfer",
+ "sepa_debit",
+ "sofort",
+ "stripe_account",
+ "swish",
+ "twint",
+ "type",
+ "us_bank_account",
+ "wechat",
+ "wechat_pay",
+ "zip"
]
},
"payment_method_details_ach_credit_transfer": {
@@ -42193,7 +46592,13 @@
],
"title": "payment_method_details_ach_credit_transfer",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_number",
+ "bank_name",
+ "routing_number",
+ "swift_code"
+ ]
},
"payment_method_details_ach_debit": {
"description": "",
@@ -42248,7 +46653,15 @@
],
"title": "payment_method_details_ach_debit",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "bank_name",
+ "country",
+ "fingerprint",
+ "last4",
+ "routing_number"
+ ]
},
"payment_method_details_acss_debit": {
"description": "",
@@ -42298,7 +46711,15 @@
],
"title": "payment_method_details_acss_debit",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bank_name",
+ "fingerprint",
+ "institution_number",
+ "last4",
+ "mandate",
+ "transit_number"
+ ]
},
"payment_method_details_affirm": {
"description": "",
@@ -42315,7 +46736,10 @@
],
"title": "payment_method_details_affirm",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "transaction_id"
+ ]
},
"payment_method_details_afterpay_clearpay": {
"description": "",
@@ -42339,7 +46763,11 @@
],
"title": "payment_method_details_afterpay_clearpay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "order_id",
+ "reference"
+ ]
},
"payment_method_details_amazon_pay": {
"description": "",
@@ -42382,7 +46810,13 @@
],
"title": "payment_method_details_au_becs_debit",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bsb_number",
+ "fingerprint",
+ "last4",
+ "mandate"
+ ]
},
"payment_method_details_bacs_debit": {
"description": "",
@@ -42420,7 +46854,13 @@
],
"title": "payment_method_details_bacs_debit",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "fingerprint",
+ "last4",
+ "mandate",
+ "sort_code"
+ ]
},
"payment_method_details_bancontact": {
"description": "",
@@ -42522,6 +46962,16 @@
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
+ ],
+ "x-stripeMostCommon": [
+ "bank_code",
+ "bank_name",
+ "bic",
+ "generated_sepa_debit",
+ "generated_sepa_debit_mandate",
+ "iban_last4",
+ "preferred_language",
+ "verified_name"
]
},
"payment_method_details_blik": {
@@ -42539,7 +46989,10 @@
],
"title": "payment_method_details_blik",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "buyer_id"
+ ]
},
"payment_method_details_boleto": {
"description": "",
@@ -42555,7 +47008,10 @@
],
"title": "payment_method_details_boleto",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"payment_method_details_card": {
"description": "",
@@ -42739,6 +47195,34 @@
"overcapture",
"three_d_secure",
"wallet"
+ ],
+ "x-stripeMostCommon": [
+ "amount_authorized",
+ "authorization_code",
+ "brand",
+ "capture_before",
+ "checks",
+ "country",
+ "decremental_authorization",
+ "description",
+ "exp_month",
+ "exp_year",
+ "extended_authorization",
+ "fingerprint",
+ "funding",
+ "iin",
+ "incremental_authorization",
+ "installments",
+ "issuer",
+ "last4",
+ "mandate",
+ "moto",
+ "multicapture",
+ "network",
+ "network_token",
+ "overcapture",
+ "three_d_secure",
+ "wallet"
]
},
"payment_method_details_card_checks": {
@@ -42770,7 +47254,12 @@
],
"title": "payment_method_details_card_checks",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "address_line1_check",
+ "address_postal_code_check",
+ "cvc_check"
+ ]
},
"payment_method_details_card_installments": {
"description": "",
@@ -42792,6 +47281,9 @@
"type": "object",
"x-expandableFields": [
"plan"
+ ],
+ "x-stripeMostCommon": [
+ "plan"
]
},
"payment_method_details_card_installments_plan": {
@@ -42826,7 +47318,12 @@
],
"title": "payment_method_details_card_installments_plan",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "count",
+ "interval",
+ "type"
+ ]
},
"payment_method_details_card_network_token": {
"description": "",
@@ -42841,7 +47338,10 @@
],
"title": "payment_method_details_card_network_token",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "used"
+ ]
},
"payment_method_details_card_present": {
"description": "",
@@ -42947,7 +47447,7 @@
"type": "string"
},
"network_transaction_id": {
- "description": "This is used by the financial networks to identify a transaction.\nVisa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.\nThe first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD).\nThis field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
+ "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -42994,6 +47494,9 @@
],
"description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.",
"nullable": true
+ },
+ "wallet": {
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet"
}
},
"required": [
@@ -43022,7 +47525,35 @@
"type": "object",
"x-expandableFields": [
"offline",
- "receipt"
+ "receipt",
+ "wallet"
+ ],
+ "x-stripeMostCommon": [
+ "amount_authorized",
+ "brand",
+ "brand_product",
+ "capture_before",
+ "cardholder_name",
+ "country",
+ "description",
+ "emv_auth_data",
+ "exp_month",
+ "exp_year",
+ "fingerprint",
+ "funding",
+ "generated_card",
+ "iin",
+ "incremental_authorization_supported",
+ "issuer",
+ "last4",
+ "network",
+ "network_transaction_id",
+ "offline",
+ "overcapture_supported",
+ "preferred_locales",
+ "read_method",
+ "receipt",
+ "wallet"
]
},
"payment_method_details_card_present_offline": {
@@ -43050,6 +47581,10 @@
"title": "payment_method_details_card_present_offline",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "stored_at",
+ "type"
+ ],
"x-stripeResource": {
"class_name": "Offline",
"in_package": ""
@@ -43130,7 +47665,18 @@
],
"title": "payment_method_details_card_present_receipt",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_type",
+ "application_cryptogram",
+ "application_preferred_name",
+ "authorization_code",
+ "authorization_response_code",
+ "cardholder_verification_method",
+ "dedicated_file_name",
+ "terminal_verification_results",
+ "transaction_status_information"
+ ]
},
"payment_method_details_card_wallet": {
"description": "",
@@ -43190,6 +47736,17 @@
"masterpass",
"samsung_pay",
"visa_checkout"
+ ],
+ "x-stripeMostCommon": [
+ "amex_express_checkout",
+ "apple_pay",
+ "dynamic_last4",
+ "google_pay",
+ "link",
+ "masterpass",
+ "samsung_pay",
+ "type",
+ "visa_checkout"
]
},
"payment_method_details_card_wallet_amex_express_checkout": {
@@ -43265,6 +47822,12 @@
"x-expandableFields": [
"billing_address",
"shipping_address"
+ ],
+ "x-stripeMostCommon": [
+ "billing_address",
+ "email",
+ "name",
+ "shipping_address"
]
},
"payment_method_details_card_wallet_samsung_pay": {
@@ -43319,6 +47882,12 @@
"x-expandableFields": [
"billing_address",
"shipping_address"
+ ],
+ "x-stripeMostCommon": [
+ "billing_address",
+ "email",
+ "name",
+ "shipping_address"
]
},
"payment_method_details_cashapp": {
@@ -43343,7 +47912,11 @@
],
"title": "payment_method_details_cashapp",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "buyer_id",
+ "cashtag"
+ ]
},
"payment_method_details_customer_balance": {
"description": "",
@@ -43403,7 +47976,11 @@
],
"title": "payment_method_details_eps",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bank",
+ "verified_name"
+ ]
},
"payment_method_details_fpx": {
"description": "",
@@ -43459,7 +48036,12 @@
],
"title": "payment_method_details_fpx",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "bank",
+ "transaction_id"
+ ]
},
"payment_method_details_giropay": {
"description": "",
@@ -43497,7 +48079,13 @@
],
"title": "payment_method_details_giropay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bank_code",
+ "bank_name",
+ "bic",
+ "verified_name"
+ ]
},
"payment_method_details_grabpay": {
"description": "",
@@ -43514,7 +48102,10 @@
],
"title": "payment_method_details_grabpay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "transaction_id"
+ ]
},
"payment_method_details_ideal": {
"description": "",
@@ -43632,6 +48223,14 @@
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
+ ],
+ "x-stripeMostCommon": [
+ "bank",
+ "bic",
+ "generated_sepa_debit",
+ "generated_sepa_debit_mandate",
+ "iban_last4",
+ "verified_name"
]
},
"payment_method_details_interac_present": {
@@ -43718,7 +48317,7 @@
"type": "string"
},
"network_transaction_id": {
- "description": "This is used by the financial networks to identify a transaction.\nVisa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.\nThe first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD).\nThis field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
+ "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -43775,6 +48374,26 @@
"type": "object",
"x-expandableFields": [
"receipt"
+ ],
+ "x-stripeMostCommon": [
+ "brand",
+ "cardholder_name",
+ "country",
+ "description",
+ "emv_auth_data",
+ "exp_month",
+ "exp_year",
+ "fingerprint",
+ "funding",
+ "generated_card",
+ "iin",
+ "issuer",
+ "last4",
+ "network",
+ "network_transaction_id",
+ "preferred_locales",
+ "read_method",
+ "receipt"
]
},
"payment_method_details_interac_present_receipt": {
@@ -43852,6 +48471,17 @@
"title": "payment_method_details_interac_present_receipt",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_type",
+ "application_cryptogram",
+ "application_preferred_name",
+ "authorization_code",
+ "authorization_response_code",
+ "cardholder_verification_method",
+ "dedicated_file_name",
+ "terminal_verification_results",
+ "transaction_status_information"
+ ],
"x-stripeResource": {
"class_name": "Receipt",
"in_package": ""
@@ -43879,7 +48509,11 @@
],
"title": "payment_method_details_klarna",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "payment_method_category",
+ "preferred_locale"
+ ]
},
"payment_method_details_konbini": {
"description": "",
@@ -43901,6 +48535,9 @@
"type": "object",
"x-expandableFields": [
"store"
+ ],
+ "x-stripeMostCommon": [
+ "store"
]
},
"payment_method_details_konbini_store": {
@@ -43923,7 +48560,10 @@
],
"title": "payment_method_details_konbini_store",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "chain"
+ ]
},
"payment_method_details_link": {
"description": "",
@@ -43940,7 +48580,21 @@
],
"title": "payment_method_details_link",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "country"
+ ]
+ },
+ "payment_method_details_mb_way": {
+ "description": "",
+ "properties": {},
+ "title": "payment_method_details_mb_way",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "MbWay",
+ "in_package": ""
+ }
},
"payment_method_details_mobilepay": {
"description": "",
@@ -43962,6 +48616,9 @@
"type": "object",
"x-expandableFields": [
"card"
+ ],
+ "x-stripeMostCommon": [
+ "card"
]
},
"payment_method_details_multibanco": {
@@ -43986,7 +48643,11 @@
],
"title": "payment_method_details_multibanco",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "entity",
+ "reference"
+ ]
},
"payment_method_details_oxxo": {
"description": "",
@@ -44003,7 +48664,10 @@
],
"title": "payment_method_details_oxxo",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "number"
+ ]
},
"payment_method_details_p24": {
"description": "",
@@ -44061,7 +48725,12 @@
],
"title": "payment_method_details_p24",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bank",
+ "reference",
+ "verified_name"
+ ]
},
"payment_method_details_paynow": {
"description": "",
@@ -44078,7 +48747,10 @@
],
"title": "payment_method_details_paynow",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reference"
+ ]
},
"payment_method_details_paypal": {
"description": "",
@@ -44160,6 +48832,17 @@
"seller_protection",
"shipping",
"verified_address"
+ ],
+ "x-stripeMostCommon": [
+ "payer_email",
+ "payer_id",
+ "payer_name",
+ "seller_protection",
+ "shipping",
+ "transaction_id",
+ "verified_address",
+ "verified_email",
+ "verified_name"
]
},
"payment_method_details_payto": {
@@ -44196,7 +48879,13 @@
],
"title": "payment_method_details_payto",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bsb_number",
+ "last4",
+ "mandate",
+ "pay_id"
+ ]
},
"payment_method_details_pix": {
"description": "",
@@ -44210,7 +48899,10 @@
},
"title": "payment_method_details_pix",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bank_transaction_id"
+ ]
},
"payment_method_details_promptpay": {
"description": "",
@@ -44227,7 +48919,10 @@
],
"title": "payment_method_details_promptpay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reference"
+ ]
},
"payment_method_details_rechnung": {
"description": "",
@@ -44276,7 +48971,12 @@
],
"title": "payment_method_details_sepa_credit_transfer",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bank_name",
+ "bic",
+ "iban"
+ ]
},
"payment_method_details_sepa_debit": {
"description": "",
@@ -44328,7 +49028,15 @@
],
"title": "payment_method_details_sepa_debit",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bank_code",
+ "branch_code",
+ "country",
+ "fingerprint",
+ "last4",
+ "mandate"
+ ]
},
"payment_method_details_sofort": {
"description": "",
@@ -44440,6 +49148,17 @@
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
+ ],
+ "x-stripeMostCommon": [
+ "bank_code",
+ "bank_name",
+ "bic",
+ "country",
+ "generated_sepa_debit",
+ "generated_sepa_debit_mandate",
+ "iban_last4",
+ "preferred_language",
+ "verified_name"
]
},
"payment_method_details_stripe_account": {
@@ -44478,7 +49197,12 @@
],
"title": "payment_method_details_swish",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "fingerprint",
+ "payment_reference",
+ "verified_phone_last4"
+ ]
},
"payment_method_details_twint": {
"description": "",
@@ -44571,6 +49295,16 @@
"type": "object",
"x-expandableFields": [
"mandate"
+ ],
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "account_type",
+ "bank_name",
+ "fingerprint",
+ "last4",
+ "mandate",
+ "payment_reference",
+ "routing_number"
]
},
"payment_method_details_wechat": {
@@ -44602,7 +49336,11 @@
],
"title": "payment_method_details_wechat_pay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "fingerprint",
+ "transaction_id"
+ ]
},
"payment_method_details_zip": {
"description": "",
@@ -44678,6 +49416,11 @@
"paypal"
],
"x-resourceId": "payment_method_domain",
+ "x-stripeMostCommon": [
+ "domain_name",
+ "enabled",
+ "id"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -44743,6 +49486,9 @@
"type": "object",
"x-expandableFields": [
"status_details"
+ ],
+ "x-stripeMostCommon": [
+ "status"
]
},
"payment_method_domain_resource_payment_method_status_details": {
@@ -44759,7 +49505,10 @@
],
"title": "PaymentMethodDomainResourcePaymentMethodStatusDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "error_message"
+ ]
},
"payment_method_eps": {
"description": "",
@@ -44805,7 +49554,10 @@
],
"title": "payment_method_eps",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"payment_method_fpx": {
"description": "",
@@ -44854,7 +49606,11 @@
],
"title": "payment_method_fpx",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "bank"
+ ]
},
"payment_method_giropay": {
"description": "",
@@ -44927,7 +49683,11 @@
],
"title": "payment_method_ideal",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bank",
+ "bic"
+ ]
},
"payment_method_interac_present": {
"description": "",
@@ -45042,6 +49802,22 @@
"type": "object",
"x-expandableFields": [
"networks"
+ ],
+ "x-stripeMostCommon": [
+ "brand",
+ "cardholder_name",
+ "country",
+ "description",
+ "exp_month",
+ "exp_year",
+ "fingerprint",
+ "funding",
+ "iin",
+ "issuer",
+ "last4",
+ "networks",
+ "preferred_locales",
+ "read_method"
]
},
"payment_method_klarna": {
@@ -45061,6 +49837,9 @@
"type": "object",
"x-expandableFields": [
"dob"
+ ],
+ "x-stripeMostCommon": [
+ "dob"
]
},
"payment_method_konbini": {
@@ -45090,7 +49869,22 @@
],
"title": "payment_method_link",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "email",
+ "persistent_token"
+ ]
+ },
+ "payment_method_mb_way": {
+ "description": "",
+ "properties": {},
+ "title": "payment_method_mb_way",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "MbWay",
+ "in_package": ""
+ }
},
"payment_method_mobilepay": {
"description": "",
@@ -45131,7 +49925,12 @@
},
"title": "payment_method_options_affirm",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "capture_method",
+ "preferred_locale",
+ "setup_future_usage"
+ ]
},
"payment_method_options_afterpay_clearpay": {
"description": "",
@@ -45163,7 +49962,12 @@
],
"title": "payment_method_options_afterpay_clearpay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "capture_method",
+ "reference",
+ "setup_future_usage"
+ ]
},
"payment_method_options_alipay": {
"description": "",
@@ -45179,7 +49983,10 @@
},
"title": "payment_method_options_alipay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"payment_method_options_amazon_pay": {
"description": "",
@@ -45202,7 +50009,11 @@
},
"title": "payment_method_options_amazon_pay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "capture_method",
+ "setup_future_usage"
+ ]
},
"payment_method_options_bancontact": {
"description": "",
@@ -45231,7 +50042,11 @@
],
"title": "payment_method_options_bancontact",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "preferred_language",
+ "setup_future_usage"
+ ]
},
"payment_method_options_boleto": {
"description": "",
@@ -45255,7 +50070,11 @@
],
"title": "payment_method_options_boleto",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
"payment_method_options_card_installments": {
"description": "",
@@ -45292,6 +50111,11 @@
"x-expandableFields": [
"available_plans",
"plan"
+ ],
+ "x-stripeMostCommon": [
+ "available_plans",
+ "enabled",
+ "plan"
]
},
"payment_method_options_card_mandate_options": {
@@ -45373,6 +50197,17 @@
"title": "payment_method_options_card_mandate_options",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "description",
+ "end_date",
+ "interval",
+ "interval_count",
+ "reference",
+ "start_date",
+ "supported_types"
+ ],
"x-stripeResource": {
"class_name": "MandateOptions",
"in_package": ""
@@ -45403,6 +50238,11 @@
"type": "object",
"x-expandableFields": [
"routing"
+ ],
+ "x-stripeMostCommon": [
+ "request_extended_authorization",
+ "request_incremental_authorization_support",
+ "routing"
]
},
"payment_method_options_card_present_routing": {
@@ -45424,6 +50264,9 @@
"title": "payment_method_options_card_present_routing",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "requested_priority"
+ ],
"x-stripeResource": {
"class_name": "Routing",
"in_package": ""
@@ -45451,7 +50294,11 @@
},
"title": "payment_method_options_cashapp",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "capture_method",
+ "setup_future_usage"
+ ]
},
"payment_method_options_customer_balance": {
"description": "",
@@ -45482,6 +50329,11 @@
"type": "object",
"x-expandableFields": [
"bank_transfer"
+ ],
+ "x-stripeMostCommon": [
+ "bank_transfer",
+ "funding_type",
+ "setup_future_usage"
]
},
"payment_method_options_customer_balance_bank_transfer": {
@@ -45528,6 +50380,11 @@
"type": "object",
"x-expandableFields": [
"eu_bank_transfer"
+ ],
+ "x-stripeMostCommon": [
+ "eu_bank_transfer",
+ "requested_address_types",
+ "type"
]
},
"payment_method_options_customer_balance_eu_bank_account": {
@@ -45551,7 +50408,10 @@
],
"title": "payment_method_options_customer_balance_eu_bank_account",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"payment_method_options_fpx": {
"description": "",
@@ -45566,7 +50426,10 @@
},
"title": "payment_method_options_fpx",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"payment_method_options_giropay": {
"description": "",
@@ -45581,7 +50444,10 @@
},
"title": "payment_method_options_giropay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"payment_method_options_grabpay": {
"description": "",
@@ -45596,7 +50462,10 @@
},
"title": "payment_method_options_grabpay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"payment_method_options_ideal": {
"description": "",
@@ -45612,7 +50481,10 @@
},
"title": "payment_method_options_ideal",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"payment_method_options_interac_present": {
"description": "",
@@ -45651,7 +50523,12 @@
],
"title": "payment_method_options_klarna",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "capture_method",
+ "preferred_locale",
+ "setup_future_usage"
+ ]
},
"payment_method_options_konbini": {
"description": "",
@@ -45695,7 +50572,32 @@
],
"title": "payment_method_options_konbini",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "confirmation_number",
+ "expires_after_days",
+ "expires_at",
+ "product_description",
+ "setup_future_usage"
+ ]
+ },
+ "payment_method_options_mb_way": {
+ "description": "",
+ "properties": {
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
+ "enum": [
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "payment_method_options_mb_way",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"payment_method_options_multibanco": {
"description": "",
@@ -45710,7 +50612,10 @@
},
"title": "payment_method_options_multibanco",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"payment_method_options_oxxo": {
"description": "",
@@ -45732,7 +50637,11 @@
],
"title": "payment_method_options_oxxo",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
"payment_method_options_p24": {
"description": "",
@@ -45747,7 +50656,10 @@
},
"title": "payment_method_options_p24",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"payment_method_options_paynow": {
"description": "",
@@ -45762,7 +50674,10 @@
},
"title": "payment_method_options_paynow",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"payment_method_options_paypal": {
"description": "",
@@ -45815,7 +50730,15 @@
],
"title": "payment_method_options_paypal",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "capture_method",
+ "preferred_locale",
+ "reference",
+ "reference_id",
+ "setup_future_usage",
+ "subsellers"
+ ]
},
"payment_method_options_pix": {
"description": "",
@@ -45844,7 +50767,12 @@
],
"title": "payment_method_options_pix",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "expires_after_seconds",
+ "expires_at",
+ "setup_future_usage"
+ ]
},
"payment_method_options_promptpay": {
"description": "",
@@ -45859,7 +50787,10 @@
},
"title": "payment_method_options_promptpay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"payment_method_options_revolut_pay": {
"description": "",
@@ -45882,7 +50813,11 @@
},
"title": "payment_method_options_revolut_pay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "capture_method",
+ "setup_future_usage"
+ ]
},
"payment_method_options_sofort": {
"description": "",
@@ -45915,7 +50850,11 @@
],
"title": "payment_method_options_sofort",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "preferred_language",
+ "setup_future_usage"
+ ]
},
"payment_method_options_twint": {
"description": "",
@@ -45930,7 +50869,10 @@
},
"title": "payment_method_options_twint",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"payment_method_options_us_bank_account_mandate_options": {
"description": "",
@@ -45946,7 +50888,10 @@
},
"title": "payment_method_options_us_bank_account_mandate_options",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "collection_method"
+ ]
},
"payment_method_options_wechat_pay": {
"description": "",
@@ -45982,7 +50927,12 @@
],
"title": "payment_method_options_wechat_pay",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "app_id",
+ "client",
+ "setup_future_usage"
+ ]
},
"payment_method_options_zip": {
"description": "",
@@ -45997,7 +50947,10 @@
},
"title": "payment_method_options_zip",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"payment_method_oxxo": {
"description": "",
@@ -46049,7 +51002,10 @@
],
"title": "payment_method_p24",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"payment_method_paynow": {
"description": "",
@@ -46092,7 +51048,13 @@
],
"title": "payment_method_paypal",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "fingerprint",
+ "payer_email",
+ "payer_id",
+ "verified_email"
+ ]
},
"payment_method_payto": {
"description": "",
@@ -46123,7 +51085,12 @@
],
"title": "payment_method_payto",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bsb_number",
+ "last4",
+ "pay_id"
+ ]
},
"payment_method_pix": {
"description": "",
@@ -46151,6 +51118,9 @@
"x-expandableFields": [
"dob"
],
+ "x-stripeMostCommon": [
+ "dob"
+ ],
"x-stripeResource": {
"class_name": "Rechnung",
"in_package": ""
@@ -46218,6 +51188,14 @@
"type": "object",
"x-expandableFields": [
"generated_from"
+ ],
+ "x-stripeMostCommon": [
+ "bank_code",
+ "branch_code",
+ "country",
+ "fingerprint",
+ "generated_from",
+ "last4"
]
},
"payment_method_sofort": {
@@ -46235,7 +51213,10 @@
],
"title": "payment_method_sofort",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"payment_method_swish": {
"description": "",
@@ -46343,6 +51324,18 @@
"x-expandableFields": [
"networks",
"status_details"
+ ],
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "account_number",
+ "account_type",
+ "bank_name",
+ "financial_connections_account",
+ "fingerprint",
+ "last4",
+ "networks",
+ "routing_number",
+ "status_details"
]
},
"payment_method_us_bank_account_blocked": {
@@ -46387,7 +51380,11 @@
],
"title": "payment_method_us_bank_account_blocked",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "network_code",
+ "reason"
+ ]
},
"payment_method_us_bank_account_status_details": {
"description": "",
@@ -46400,6 +51397,9 @@
"type": "object",
"x-expandableFields": [
"blocked"
+ ],
+ "x-stripeMostCommon": [
+ "blocked"
]
},
"payment_method_wechat_pay": {
@@ -46436,6 +51436,9 @@
"type": "object",
"x-expandableFields": [
"recovery"
+ ],
+ "x-stripeMostCommon": [
+ "recovery"
]
},
"payment_pages_checkout_session_after_expiration_recovery": {
@@ -46470,7 +51473,13 @@
],
"title": "PaymentPagesCheckoutSessionAfterExpirationRecovery",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "allow_promotion_codes",
+ "enabled",
+ "expires_at",
+ "url"
+ ]
},
"payment_pages_checkout_session_automatic_tax": {
"description": "",
@@ -46508,6 +51517,71 @@
"type": "object",
"x-expandableFields": [
"liability"
+ ],
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability",
+ "status"
+ ]
+ },
+ "payment_pages_checkout_session_collected_information": {
+ "description": "",
+ "properties": {
+ "business_name": {
+ "description": "Customer’s business name for this Checkout Session",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "email": {
+ "description": "Customer’s email for this Checkout Session",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "phone": {
+ "description": "Customer’s phone number for this Checkout Session",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "shipping_details": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/shipping"
+ }
+ ],
+ "description": "Shipping information for this Checkout Session.",
+ "nullable": true
+ },
+ "tax_ids": {
+ "description": "Customer’s tax ids for this Checkout Session.",
+ "items": {
+ "$ref": "#/components/schemas/payment_pages_checkout_session_tax_id"
+ },
+ "nullable": true,
+ "type": "array"
+ }
+ },
+ "required": [
+ "business_name",
+ "email",
+ "phone",
+ "shipping_details",
+ "tax_ids"
+ ],
+ "title": "PaymentPagesCheckoutSessionCollectedInformation",
+ "type": "object",
+ "x-expandableFields": [
+ "shipping_details",
+ "tax_ids"
+ ],
+ "x-stripeMostCommon": [
+ "business_name",
+ "email",
+ "phone",
+ "shipping_details",
+ "tax_ids"
]
},
"payment_pages_checkout_session_consent": {
@@ -46538,7 +51612,11 @@
],
"title": "PaymentPagesCheckoutSessionConsent",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "promotions",
+ "terms_of_service"
+ ]
},
"payment_pages_checkout_session_consent_collection": {
"description": "",
@@ -46580,6 +51658,11 @@
"type": "object",
"x-expandableFields": [
"payment_method_reuse_agreement"
+ ],
+ "x-stripeMostCommon": [
+ "payment_method_reuse_agreement",
+ "promotions",
+ "terms_of_service"
]
},
"payment_pages_checkout_session_currency_conversion": {
@@ -46612,7 +51695,13 @@
],
"title": "PaymentPagesCheckoutSessionCurrencyConversion",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount_subtotal",
+ "amount_total",
+ "fx_rate",
+ "source_currency"
+ ]
},
"payment_pages_checkout_session_custom_fields": {
"description": "",
@@ -46661,6 +51750,15 @@
"label",
"numeric",
"text"
+ ],
+ "x-stripeMostCommon": [
+ "dropdown",
+ "key",
+ "label",
+ "numeric",
+ "optional",
+ "text",
+ "type"
]
},
"payment_pages_checkout_session_custom_fields_dropdown": {
@@ -46696,6 +51794,11 @@
"x-expandableFields": [
"options"
],
+ "x-stripeMostCommon": [
+ "default_value",
+ "options",
+ "value"
+ ],
"x-stripeResource": {
"class_name": "CustomFieldDropdown",
"in_package": ""
@@ -46724,7 +51827,11 @@
],
"title": "PaymentPagesCheckoutSessionCustomFieldsLabel",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "custom",
+ "type"
+ ]
},
"payment_pages_checkout_session_custom_fields_numeric": {
"description": "",
@@ -46761,6 +51868,12 @@
"title": "PaymentPagesCheckoutSessionCustomFieldsNumeric",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "default_value",
+ "maximum_length",
+ "minimum_length",
+ "value"
+ ],
"x-stripeResource": {
"class_name": "CustomFieldNumeric",
"in_package": ""
@@ -46787,6 +51900,10 @@
"title": "PaymentPagesCheckoutSessionCustomFieldsOption",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "label",
+ "value"
+ ],
"x-stripeResource": {
"class_name": "CustomFieldDropdownOption",
"in_package": ""
@@ -46826,7 +51943,13 @@
],
"title": "PaymentPagesCheckoutSessionCustomFieldsText",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "default_value",
+ "maximum_length",
+ "minimum_length",
+ "value"
+ ]
},
"payment_pages_checkout_session_custom_text": {
"description": "",
@@ -46881,6 +52004,12 @@
"shipping_address",
"submit",
"terms_of_service_acceptance"
+ ],
+ "x-stripeMostCommon": [
+ "after_submit",
+ "shipping_address",
+ "submit",
+ "terms_of_service_acceptance"
]
},
"payment_pages_checkout_session_custom_text_position": {
@@ -46897,7 +52026,10 @@
],
"title": "PaymentPagesCheckoutSessionCustomTextPosition",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "message"
+ ]
},
"payment_pages_checkout_session_customer_details": {
"description": "",
@@ -46961,6 +52093,14 @@
"x-expandableFields": [
"address",
"tax_ids"
+ ],
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone",
+ "tax_exempt",
+ "tax_ids"
]
},
"payment_pages_checkout_session_invoice_creation": {
@@ -46982,6 +52122,10 @@
"type": "object",
"x-expandableFields": [
"invoice_data"
+ ],
+ "x-stripeMostCommon": [
+ "enabled",
+ "invoice_data"
]
},
"payment_pages_checkout_session_invoice_settings": {
@@ -47080,6 +52224,15 @@
"custom_fields",
"issuer",
"rendering_options"
+ ],
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "custom_fields",
+ "description",
+ "footer",
+ "issuer",
+ "metadata",
+ "rendering_options"
]
},
"payment_pages_checkout_session_payment_method_reuse_agreement": {
@@ -47099,7 +52252,39 @@
],
"title": "PaymentPagesCheckoutSessionPaymentMethodReuseAgreement",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "position"
+ ]
+ },
+ "payment_pages_checkout_session_permissions": {
+ "description": "",
+ "properties": {
+ "update": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_pages_checkout_session_update_permission"
+ }
+ ],
+ "description": "Permissions for updating the Checkout Session.",
+ "nullable": true
+ }
+ },
+ "required": [
+ "update"
+ ],
+ "title": "PaymentPagesCheckoutSessionPermissions",
+ "type": "object",
+ "x-expandableFields": [
+ "update"
+ ],
+ "x-stripeMostCommon": [
+ "update"
+ ],
+ "x-stripeResource": {
+ "class_name": "Permissions",
+ "in_package": ""
+ }
},
"payment_pages_checkout_session_phone_number_collection": {
"description": "",
@@ -47114,7 +52299,10 @@
],
"title": "PaymentPagesCheckoutSessionPhoneNumberCollection",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"payment_pages_checkout_session_saved_payment_method_options": {
"description": "",
@@ -47158,7 +52346,12 @@
],
"title": "PaymentPagesCheckoutSessionSavedPaymentMethodOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "allow_redisplay_filters",
+ "payment_method_remove",
+ "payment_method_save"
+ ]
},
"payment_pages_checkout_session_shipping_address_collection": {
"description": "",
@@ -47416,6 +52609,9 @@
"title": "PaymentPagesCheckoutSessionShippingAddressCollection",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "allowed_countries"
+ ],
"x-stripeResource": {
"class_name": "ShippingAddressCollection",
"in_package": ""
@@ -47475,6 +52671,13 @@
"x-expandableFields": [
"shipping_rate",
"taxes"
+ ],
+ "x-stripeMostCommon": [
+ "amount_subtotal",
+ "amount_tax",
+ "amount_total",
+ "shipping_rate",
+ "taxes"
]
},
"payment_pages_checkout_session_shipping_option": {
@@ -47512,13 +52715,17 @@
"type": "object",
"x-expandableFields": [
"shipping_rate"
+ ],
+ "x-stripeMostCommon": [
+ "shipping_amount",
+ "shipping_rate"
]
},
"payment_pages_checkout_session_tax_id": {
"description": "",
"properties": {
"type": {
- "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
+ "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -47552,6 +52759,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -47610,7 +52818,11 @@
],
"title": "PaymentPagesCheckoutSessionTaxID",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "type",
+ "value"
+ ]
},
"payment_pages_checkout_session_tax_id_collection": {
"description": "",
@@ -47625,7 +52837,10 @@
],
"title": "PaymentPagesCheckoutSessionTaxIDCollection",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"payment_pages_checkout_session_total_details": {
"description": "",
@@ -47656,6 +52871,12 @@
"type": "object",
"x-expandableFields": [
"breakdown"
+ ],
+ "x-stripeMostCommon": [
+ "amount_discount",
+ "amount_shipping",
+ "amount_tax",
+ "breakdown"
]
},
"payment_pages_checkout_session_total_details_resource_breakdown": {
@@ -47685,8 +52906,39 @@
"x-expandableFields": [
"discounts",
"taxes"
+ ],
+ "x-stripeMostCommon": [
+ "discounts",
+ "taxes"
]
},
+ "payment_pages_checkout_session_update_permission": {
+ "description": "",
+ "properties": {
+ "shipping_details": {
+ "description": "Determines which entity is allowed to update the shipping details.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.\n\nWhen set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.",
+ "enum": [
+ "client_only",
+ "server_only"
+ ],
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "shipping_details"
+ ],
+ "title": "PaymentPagesCheckoutSessionUpdatePermission",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "shipping_details"
+ ],
+ "x-stripeResource": {
+ "class_name": "UpdatePermission",
+ "in_package": ""
+ }
+ },
"payment_plan_amount": {
"description": "",
"properties": {
@@ -47747,7 +52999,17 @@
],
"title": "PaymentPlanAmount",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_paid",
+ "amount_remaining",
+ "days_until_due",
+ "description",
+ "due_date",
+ "paid_at",
+ "status"
+ ]
},
"payment_source": {
"anyOf": [
@@ -48093,6 +53355,16 @@
"reversed_by"
],
"x-resourceId": "payout",
+ "x-stripeMostCommon": [
+ "amount",
+ "arrival_date",
+ "currency",
+ "description",
+ "id",
+ "metadata",
+ "statement_descriptor",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -48274,7 +53546,11 @@
],
"title": "paypal_seller_protection",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "dispute_categories",
+ "status"
+ ]
},
"period": {
"description": "",
@@ -48298,7 +53574,11 @@
],
"title": "Period",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "end",
+ "start"
+ ]
},
"person": {
"description": "This is an object representing a person associated with a Stripe account.\n\nA platform cannot access a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.\n\nSee the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information).",
@@ -48501,6 +53781,19 @@
"verification"
],
"x-resourceId": "person",
+ "x-stripeMostCommon": [
+ "account",
+ "address",
+ "dob",
+ "email",
+ "first_name",
+ "id",
+ "last_name",
+ "metadata",
+ "phone",
+ "relationship",
+ "requirements"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -48642,7 +53935,12 @@
],
"title": "PersonAdditionalTOSAcceptance",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
},
"person_additional_tos_acceptances": {
"description": "",
@@ -48664,6 +53962,9 @@
"type": "object",
"x-expandableFields": [
"account"
+ ],
+ "x-stripeMostCommon": [
+ "account"
]
},
"person_future_requirements": {
@@ -48730,6 +54031,14 @@
"x-expandableFields": [
"alternatives",
"errors"
+ ],
+ "x-stripeMostCommon": [
+ "alternatives",
+ "currently_due",
+ "errors",
+ "eventually_due",
+ "past_due",
+ "pending_verification"
]
},
"person_relationship": {
@@ -48783,7 +54092,16 @@
],
"title": "PersonRelationship",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "director",
+ "executive",
+ "legal_guardian",
+ "owner",
+ "percent_ownership",
+ "representative",
+ "title"
+ ]
},
"person_requirements": {
"description": "",
@@ -48849,6 +54167,14 @@
"x-expandableFields": [
"alternatives",
"errors"
+ ],
+ "x-stripeMostCommon": [
+ "alternatives",
+ "currently_due",
+ "errors",
+ "eventually_due",
+ "past_due",
+ "pending_verification"
]
},
"plan": {
@@ -49043,6 +54369,16 @@
"transform_usage"
],
"x-resourceId": "plan",
+ "x-stripeMostCommon": [
+ "active",
+ "amount",
+ "currency",
+ "id",
+ "interval",
+ "metadata",
+ "nickname",
+ "product"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -49174,7 +54510,14 @@
],
"title": "PlanTier",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "flat_amount",
+ "flat_amount_decimal",
+ "unit_amount",
+ "unit_amount_decimal",
+ "up_to"
+ ]
},
"platform_earning_fee_source": {
"description": "",
@@ -49203,7 +54546,12 @@
],
"title": "PlatformEarningFeeSource",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "charge",
+ "payout",
+ "type"
+ ]
},
"portal_business_profile": {
"description": "",
@@ -49234,7 +54582,12 @@
],
"title": "PortalBusinessProfile",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "headline",
+ "privacy_policy_url",
+ "terms_of_service_url"
+ ]
},
"portal_customer_update": {
"description": "",
@@ -49265,7 +54618,11 @@
],
"title": "PortalCustomerUpdate",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "allowed_updates",
+ "enabled"
+ ]
},
"portal_features": {
"description": "",
@@ -49301,6 +54658,13 @@
"payment_method_update",
"subscription_cancel",
"subscription_update"
+ ],
+ "x-stripeMostCommon": [
+ "customer_update",
+ "invoice_history",
+ "payment_method_update",
+ "subscription_cancel",
+ "subscription_update"
]
},
"portal_flows_after_completion_hosted_confirmation": {
@@ -49318,7 +54682,10 @@
],
"title": "PortalFlowsAfterCompletionHostedConfirmation",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "custom_message"
+ ]
},
"portal_flows_after_completion_redirect": {
"description": "",
@@ -49334,7 +54701,10 @@
],
"title": "PortalFlowsAfterCompletionRedirect",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "return_url"
+ ]
},
"portal_flows_coupon_offer": {
"description": "",
@@ -49350,7 +54720,10 @@
],
"title": "PortalFlowsCouponOffer",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"portal_flows_flow": {
"description": "",
@@ -49410,6 +54783,13 @@
"subscription_cancel",
"subscription_update",
"subscription_update_confirm"
+ ],
+ "x-stripeMostCommon": [
+ "after_completion",
+ "subscription_cancel",
+ "subscription_update",
+ "subscription_update_confirm",
+ "type"
]
},
"portal_flows_flow_after_completion": {
@@ -49453,6 +54833,11 @@
"x-expandableFields": [
"hosted_confirmation",
"redirect"
+ ],
+ "x-stripeMostCommon": [
+ "hosted_confirmation",
+ "redirect",
+ "type"
]
},
"portal_flows_flow_subscription_cancel": {
@@ -49481,6 +54866,10 @@
"type": "object",
"x-expandableFields": [
"retention"
+ ],
+ "x-stripeMostCommon": [
+ "retention",
+ "subscription"
]
},
"portal_flows_flow_subscription_update": {
@@ -49497,7 +54886,10 @@
],
"title": "PortalFlowsFlowSubscriptionUpdate",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "subscription"
+ ]
},
"portal_flows_flow_subscription_update_confirm": {
"description": "",
@@ -49533,6 +54925,11 @@
"x-expandableFields": [
"discounts",
"items"
+ ],
+ "x-stripeMostCommon": [
+ "discounts",
+ "items",
+ "subscription"
]
},
"portal_flows_retention": {
@@ -49563,6 +54960,10 @@
"type": "object",
"x-expandableFields": [
"coupon_offer"
+ ],
+ "x-stripeMostCommon": [
+ "coupon_offer",
+ "type"
]
},
"portal_flows_subscription_update_confirm_discount": {
@@ -49587,7 +54988,11 @@
],
"title": "PortalFlowsSubscriptionUpdateConfirmDiscount",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "coupon",
+ "promotion_code"
+ ]
},
"portal_flows_subscription_update_confirm_item": {
"description": "",
@@ -49615,7 +55020,12 @@
],
"title": "PortalFlowsSubscriptionUpdateConfirmItem",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "id",
+ "price",
+ "quantity"
+ ]
},
"portal_invoice_list": {
"description": "",
@@ -49630,7 +55040,10 @@
],
"title": "PortalInvoiceList",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"portal_login_page": {
"description": "",
@@ -49652,7 +55065,11 @@
],
"title": "PortalLoginPage",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enabled",
+ "url"
+ ]
},
"portal_payment_method_update": {
"description": "",
@@ -49667,7 +55084,10 @@
],
"title": "PortalPaymentMethodUpdate",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"portal_subscription_cancel": {
"description": "",
@@ -49707,6 +55127,12 @@
"type": "object",
"x-expandableFields": [
"cancellation_reason"
+ ],
+ "x-stripeMostCommon": [
+ "cancellation_reason",
+ "enabled",
+ "mode",
+ "proration_behavior"
]
},
"portal_subscription_cancellation_reason": {
@@ -49740,7 +55166,11 @@
],
"title": "PortalSubscriptionCancellationReason",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enabled",
+ "options"
+ ]
},
"portal_subscription_update": {
"description": "",
@@ -49788,6 +55218,12 @@
"type": "object",
"x-expandableFields": [
"products"
+ ],
+ "x-stripeMostCommon": [
+ "default_allowed_updates",
+ "enabled",
+ "products",
+ "proration_behavior"
]
},
"portal_subscription_update_product": {
@@ -49813,7 +55249,11 @@
],
"title": "PortalSubscriptionUpdateProduct",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "prices",
+ "product"
+ ]
},
"price": {
"description": "Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.\n[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has prices for $10/month, $100/year, and €9 once.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).",
@@ -50022,6 +55462,17 @@
"transform_quantity"
],
"x-resourceId": "price",
+ "x-stripeMostCommon": [
+ "active",
+ "currency",
+ "id",
+ "metadata",
+ "nickname",
+ "product",
+ "recurring",
+ "type",
+ "unit_amount"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -50154,7 +55605,14 @@
],
"title": "PriceTier",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "flat_amount",
+ "flat_amount_decimal",
+ "unit_amount",
+ "unit_amount_decimal",
+ "up_to"
+ ]
},
"product": {
"description": "Products describe the specific goods or services you offer to your customers.\nFor example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.\nThey can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription),\n[share a Payment Link](https://stripe.com/docs/payment-links),\n[accept payments with Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront),\nand more about [Products and Prices](https://stripe.com/docs/products-prices/overview)",
@@ -50341,6 +55799,14 @@
"tax_code"
],
"x-resourceId": "product",
+ "x-stripeMostCommon": [
+ "active",
+ "default_price",
+ "description",
+ "id",
+ "metadata",
+ "name"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -50475,6 +55941,10 @@
"entitlement_feature"
],
"x-resourceId": "product_feature",
+ "x-stripeMostCommon": [
+ "entitlement_feature",
+ "id"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -50522,7 +55992,10 @@
},
"title": "ProductMarketingFeature",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"products_resource_provisioning_api_resource_provisioning_gift_card": {
"description": "",
@@ -50551,6 +56024,10 @@
"type": "object",
"x-expandableFields": [
"fixed_amount"
+ ],
+ "x-stripeMostCommon": [
+ "fixed_amount",
+ "type"
]
},
"products_resource_provisioning_api_resource_provisioning_gift_card_fixed_amount": {
@@ -50572,7 +56049,11 @@
],
"title": "ProductsResourceProvisioningAPIResourceProvisioningGiftCardFixedAmount",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "currency"
+ ]
},
"promotion_code": {
"description": "A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons). It can be used to\ncreate multiple codes for a single coupon.",
@@ -50687,6 +56168,12 @@
"restrictions"
],
"x-resourceId": "promotion_code",
+ "x-stripeMostCommon": [
+ "code",
+ "coupon",
+ "id",
+ "metadata"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -50768,7 +56255,10 @@
],
"title": "PromotionCodeCurrencyOption",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "minimum_amount"
+ ]
},
"promotion_codes_resource_restrictions": {
"description": "",
@@ -50805,6 +56295,12 @@
"type": "object",
"x-expandableFields": [
"currency_options"
+ ],
+ "x-stripeMostCommon": [
+ "currency_options",
+ "first_time_transaction",
+ "minimum_amount",
+ "minimum_amount_currency"
]
},
"provisioning": {
@@ -50834,6 +56330,10 @@
"type": "object",
"x-expandableFields": [
"gift_card"
+ ],
+ "x-stripeMostCommon": [
+ "gift_card",
+ "type"
]
},
"quote": {
@@ -51086,6 +56586,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"lines": {
@@ -51319,6 +56825,11 @@
"transfer_data"
],
"x-resourceId": "quote",
+ "x-stripeMostCommon": [
+ "id",
+ "line_items",
+ "metadata"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -51713,6 +57224,20 @@
"trial_settings"
],
"x-resourceId": "quote_line",
+ "x-stripeMostCommon": [
+ "actions",
+ "applies_to",
+ "billing_cycle_anchor",
+ "cancel_subscription_schedule",
+ "ends_at",
+ "id",
+ "object",
+ "proration_behavior",
+ "set_pause_collection",
+ "set_schedule_end",
+ "starts_at",
+ "trial_settings"
+ ],
"x-stripeResource": {
"class_name": "QuoteLine",
"has_collection_class": true,
@@ -51840,6 +57365,18 @@
"remove_item",
"set_discounts",
"set_items"
+ ],
+ "x-stripeMostCommon": [
+ "add_discount",
+ "add_item",
+ "add_metadata",
+ "remove_discount",
+ "remove_item",
+ "remove_metadata",
+ "set_discounts",
+ "set_items",
+ "set_metadata",
+ "type"
]
},
"quote_line_discount_end": {
@@ -51858,7 +57395,10 @@
],
"title": "QuoteLineDiscountEnd",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"quote_phase": {
"description": "A quote phase describes the line items, coupons, and trialing status of a subscription for a predefined time period.",
@@ -51994,6 +57534,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"metadata": {
@@ -52063,6 +57609,25 @@
"total_details"
],
"x-resourceId": "quote_phase",
+ "x-stripeMostCommon": [
+ "amount_subtotal",
+ "amount_total",
+ "billing_cycle_anchor",
+ "collection_method",
+ "default_tax_rates",
+ "discounts",
+ "end_date",
+ "id",
+ "invoice_settings",
+ "iterations",
+ "line_items",
+ "metadata",
+ "object",
+ "proration_behavior",
+ "total_details",
+ "trial",
+ "trial_end"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -52526,6 +58091,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"livemode": {
@@ -52648,6 +58219,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"period_end": {
@@ -52983,6 +58560,21 @@
"transfer_data"
],
"x-resourceId": "quote_preview_invoice",
+ "x-stripeMostCommon": [
+ "applies_to",
+ "collection_method",
+ "currency",
+ "description",
+ "id",
+ "lines",
+ "metadata",
+ "payment_intent",
+ "period_end",
+ "period_start",
+ "status",
+ "subscription",
+ "total"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -53259,6 +58851,16 @@
"test_clock"
],
"x-resourceId": "quote_preview_subscription_schedule",
+ "x-stripeMostCommon": [
+ "applies_to",
+ "current_phase",
+ "customer",
+ "id",
+ "metadata",
+ "phases",
+ "status",
+ "subscription"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -53305,6 +58907,10 @@
"x-expandableFields": [
"failed"
],
+ "x-stripeMostCommon": [
+ "failed",
+ "status"
+ ],
"x-stripeResource": {
"class_name": "LastReestimateDetails",
"in_package": ""
@@ -53342,6 +58948,11 @@
"title": "QuotesCoreApiResourceReestimateFailure",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "failure_code",
+ "message",
+ "reason"
+ ],
"x-stripeResource": {
"class_name": "ReeestimateFailure",
"in_package": ""
@@ -53383,6 +58994,11 @@
"type": "object",
"x-expandableFields": [
"liability"
+ ],
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability",
+ "status"
]
},
"quotes_resource_computed": {
@@ -53426,6 +59042,12 @@
"last_reestimation_details",
"recurring",
"upfront"
+ ],
+ "x-stripeMostCommon": [
+ "last_reestimation_details",
+ "recurring",
+ "updated_at",
+ "upfront"
]
},
"quotes_resource_from_quote": {
@@ -53463,6 +59085,10 @@
"type": "object",
"x-expandableFields": [
"quote"
+ ],
+ "x-stripeMostCommon": [
+ "is_revision",
+ "quote"
]
},
"quotes_resource_prebilling": {
@@ -53477,7 +59103,10 @@
],
"title": "QuotesResourcePrebilling",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "iterations"
+ ]
},
"quotes_resource_quote_lines_actions_configuration_item": {
"description": "",
@@ -53557,6 +59186,14 @@
"price",
"tax_rates",
"trial"
+ ],
+ "x-stripeMostCommon": [
+ "discounts",
+ "metadata",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
]
},
"quotes_resource_quote_lines_actions_remove_item": {
@@ -53595,6 +59232,9 @@
"type": "object",
"x-expandableFields": [
"price"
+ ],
+ "x-stripeMostCommon": [
+ "price"
]
},
"quotes_resource_quote_lines_applies_to": {
@@ -53628,7 +59268,12 @@
],
"title": "QuotesResourceQuoteLinesAppliesTo",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "new_reference",
+ "subscription_schedule",
+ "type"
+ ]
},
"quotes_resource_quote_lines_cancel_subscription_schedule": {
"description": "Configures the immediate cancellation settings for a subscription schedule via quotes.",
@@ -53658,7 +59303,12 @@
],
"title": "QuotesResourceQuoteLinesCancelSubscriptionSchedule",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "cancel_at",
+ "invoice_now",
+ "prorate"
+ ]
},
"quotes_resource_quote_lines_end_behavior": {
"description": "Defines how the scheduled subscription behaves when a trial ends.",
@@ -53678,7 +59328,10 @@
],
"title": "QuotesResourceQuoteLinesEndBehavior",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "prorate_up_front"
+ ]
},
"quotes_resource_quote_lines_set_pause_collection": {
"description": "Configures the pause collection settings for a subscription during a phase.",
@@ -53708,6 +59361,10 @@
"type": "object",
"x-expandableFields": [
"set"
+ ],
+ "x-stripeMostCommon": [
+ "set",
+ "type"
]
},
"quotes_resource_quote_lines_timestamp_helpers_discount_end": {
@@ -53724,7 +59381,10 @@
],
"title": "QuotesResourceQuoteLinesTimestampHelpersDiscountEnd",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "discount"
+ ]
},
"quotes_resource_quote_lines_timestamp_helpers_duration": {
"description": "",
@@ -53750,7 +59410,11 @@
],
"title": "QuotesResourceQuoteLinesTimestampHelpersDuration",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"quotes_resource_quote_lines_timestamp_helpers_ends_at": {
"description": "",
@@ -53810,6 +59474,13 @@
"x-expandableFields": [
"discount_end",
"duration"
+ ],
+ "x-stripeMostCommon": [
+ "computed",
+ "discount_end",
+ "duration",
+ "timestamp",
+ "type"
]
},
"quotes_resource_quote_lines_timestamp_helpers_line_id": {
@@ -53826,7 +59497,10 @@
],
"title": "QuotesResourceQuoteLinesTimestampHelpersLineId",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "id"
+ ]
},
"quotes_resource_quote_lines_timestamp_helpers_starts_at": {
"description": "",
@@ -53886,6 +59560,13 @@
"x-expandableFields": [
"discount_end",
"line_ends_at"
+ ],
+ "x-stripeMostCommon": [
+ "computed",
+ "discount_end",
+ "line_ends_at",
+ "timestamp",
+ "type"
]
},
"quotes_resource_quote_lines_trial": {
@@ -53914,7 +59595,11 @@
],
"title": "QuotesResourceQuoteLinesTrial",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
},
"quotes_resource_quote_lines_trial_settings": {
"description": "Configures how the scheduled subscription behaves during the trial period.",
@@ -53936,6 +59621,9 @@
"type": "object",
"x-expandableFields": [
"end_behavior"
+ ],
+ "x-stripeMostCommon": [
+ "end_behavior"
]
},
"quotes_resource_recurring": {
@@ -53978,6 +59666,13 @@
"type": "object",
"x-expandableFields": [
"total_details"
+ ],
+ "x-stripeMostCommon": [
+ "amount_subtotal",
+ "amount_total",
+ "interval",
+ "interval_count",
+ "total_details"
]
},
"quotes_resource_status_details_canceled_status_details": {
@@ -54008,7 +59703,11 @@
],
"title": "QuotesResourceStatusDetailsCanceledStatusDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reason",
+ "transitioned_at"
+ ]
},
"quotes_resource_status_details_lines_invalid": {
"description": "",
@@ -54033,7 +59732,11 @@
],
"title": "QuotesResourceStatusDetailsLinesInvalid",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "invalid_at",
+ "lines"
+ ]
},
"quotes_resource_status_details_stale_reason": {
"description": "",
@@ -54110,6 +59813,18 @@
"lines_invalid",
"subscription_changed",
"subscription_schedule_changed"
+ ],
+ "x-stripeMostCommon": [
+ "line_invalid",
+ "lines_invalid",
+ "marked_stale",
+ "subscription_canceled",
+ "subscription_changed",
+ "subscription_expired",
+ "subscription_schedule_canceled",
+ "subscription_schedule_changed",
+ "subscription_schedule_released",
+ "type"
]
},
"quotes_resource_status_details_stale_status_details": {
@@ -54153,6 +59868,12 @@
"type": "object",
"x-expandableFields": [
"last_reason"
+ ],
+ "x-stripeMostCommon": [
+ "expires_at",
+ "last_reason",
+ "last_updated_at",
+ "transitioned_at"
]
},
"quotes_resource_status_details_status_details": {
@@ -54170,6 +59891,10 @@
"x-expandableFields": [
"canceled",
"stale"
+ ],
+ "x-stripeMostCommon": [
+ "canceled",
+ "stale"
]
},
"quotes_resource_status_details_subscription_changed": {
@@ -54192,6 +59917,9 @@
"type": "object",
"x-expandableFields": [
"previous_subscription"
+ ],
+ "x-stripeMostCommon": [
+ "previous_subscription"
]
},
"quotes_resource_status_details_subscription_schedule_changed": {
@@ -54215,6 +59943,9 @@
"x-expandableFields": [
"previous_subscription_schedule"
],
+ "x-stripeMostCommon": [
+ "previous_subscription_schedule"
+ ],
"x-stripeResource": {
"class_name": "SubscriptionScheduleChanged",
"in_package": ""
@@ -54249,7 +59980,12 @@
],
"title": "QuotesResourceStatusTransitions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "accepted_at",
+ "canceled_at",
+ "finalized_at"
+ ]
},
"quotes_resource_subscription_data_bill_from": {
"description": "",
@@ -54297,6 +60033,12 @@
"type": "object",
"x-expandableFields": [
"line_starts_at"
+ ],
+ "x-stripeMostCommon": [
+ "computed",
+ "line_starts_at",
+ "timestamp",
+ "type"
]
},
"quotes_resource_subscription_data_bill_on_acceptance": {
@@ -54330,6 +60072,10 @@
"x-expandableFields": [
"bill_from",
"bill_until"
+ ],
+ "x-stripeMostCommon": [
+ "bill_from",
+ "bill_until"
]
},
"quotes_resource_subscription_data_bill_until": {
@@ -54389,6 +60135,13 @@
"x-expandableFields": [
"duration",
"line_ends_at"
+ ],
+ "x-stripeMostCommon": [
+ "computed",
+ "duration",
+ "line_ends_at",
+ "timestamp",
+ "type"
]
},
"quotes_resource_subscription_data_subscription_data": {
@@ -54526,6 +60279,20 @@
"from_schedule",
"from_subscription",
"prebilling"
+ ],
+ "x-stripeMostCommon": [
+ "bill_on_acceptance",
+ "billing_behavior",
+ "billing_cycle_anchor",
+ "description",
+ "effective_date",
+ "end_behavior",
+ "from_schedule",
+ "from_subscription",
+ "metadata",
+ "prebilling",
+ "proration_behavior",
+ "trial_period_days"
]
},
"quotes_resource_subscription_data_subscription_data_overrides": {
@@ -54594,6 +60361,15 @@
"x-expandableFields": [
"applies_to",
"bill_on_acceptance"
+ ],
+ "x-stripeMostCommon": [
+ "applies_to",
+ "bill_on_acceptance",
+ "billing_behavior",
+ "customer",
+ "description",
+ "end_behavior",
+ "proration_behavior"
]
},
"quotes_resource_subscription_schedule_with_applies_to": {
@@ -54616,6 +60392,10 @@
"type": "object",
"x-expandableFields": [
"applies_to"
+ ],
+ "x-stripeMostCommon": [
+ "applies_to",
+ "subscription_schedule"
]
},
"quotes_resource_total_details": {
@@ -54647,6 +60427,12 @@
"type": "object",
"x-expandableFields": [
"breakdown"
+ ],
+ "x-stripeMostCommon": [
+ "amount_discount",
+ "amount_shipping",
+ "amount_tax",
+ "breakdown"
]
},
"quotes_resource_total_details_resource_breakdown": {
@@ -54676,6 +60462,10 @@
"x-expandableFields": [
"discounts",
"taxes"
+ ],
+ "x-stripeMostCommon": [
+ "discounts",
+ "taxes"
]
},
"quotes_resource_transfer_data": {
@@ -54720,6 +60510,11 @@
"type": "object",
"x-expandableFields": [
"destination"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_percent",
+ "destination"
]
},
"quotes_resource_upfront": {
@@ -54770,6 +60565,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"total_details": {
@@ -54786,6 +60587,12 @@
"x-expandableFields": [
"line_items",
"total_details"
+ ],
+ "x-stripeMostCommon": [
+ "amount_subtotal",
+ "amount_total",
+ "line_items",
+ "total_details"
]
},
"radar.early_fraud_warning": {
@@ -54876,6 +60683,16 @@
"payment_intent"
],
"x-resourceId": "radar.early_fraud_warning",
+ "x-stripeMostCommon": [
+ "actionable",
+ "charge",
+ "created",
+ "fraud_type",
+ "id",
+ "livemode",
+ "object",
+ "payment_intent"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -55006,6 +60823,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"livemode": {
@@ -55051,6 +60874,14 @@
"list_items"
],
"x-resourceId": "radar.value_list",
+ "x-stripeMostCommon": [
+ "alias",
+ "id",
+ "item_type",
+ "list_items",
+ "metadata",
+ "name"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -55147,6 +60978,11 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "radar.value_list_item",
+ "x-stripeMostCommon": [
+ "id",
+ "value",
+ "value_list"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -55194,7 +61030,10 @@
},
"title": "RadarRadarOptions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "session"
+ ]
},
"radar_review_resource_location": {
"description": "",
@@ -55237,7 +61076,14 @@
],
"title": "RadarReviewResourceLocation",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "latitude",
+ "longitude",
+ "region"
+ ]
},
"radar_review_resource_session": {
"description": "",
@@ -55275,7 +61121,13 @@
],
"title": "RadarReviewResourceSession",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "browser",
+ "device",
+ "platform",
+ "version"
+ ]
},
"received_payment_method_details_financial_account": {
"description": "",
@@ -55300,6 +61152,10 @@
"title": "received_payment_method_details_financial_account",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "id",
+ "network"
+ ],
"x-stripeResource": {
"class_name": "FinancialAccount",
"in_package": ""
@@ -55363,7 +61219,10 @@
],
"title": "Recurring",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"refund": {
"description": "Refund objects allow you to refund a previously created charge that isn't\nrefunded yet. Funds are refunded to the credit or debit card that's\ninitially charged.\n\nRelated guide: [Refunds](https://stripe.com/docs/refunds)",
@@ -55596,6 +61455,17 @@
"transfer_reversal"
],
"x-resourceId": "refund",
+ "x-stripeMostCommon": [
+ "amount",
+ "charge",
+ "currency",
+ "description",
+ "id",
+ "metadata",
+ "payment_intent",
+ "reason",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -55830,6 +61700,39 @@
"us_bank_transfer",
"wechat_pay",
"zip"
+ ],
+ "x-stripeMostCommon": [
+ "affirm",
+ "afterpay_clearpay",
+ "alipay",
+ "amazon_pay",
+ "au_bank_transfer",
+ "blik",
+ "br_bank_transfer",
+ "card",
+ "cashapp",
+ "customer_cash_balance",
+ "eps",
+ "eu_bank_transfer",
+ "gb_bank_transfer",
+ "giropay",
+ "grabpay",
+ "jp_bank_transfer",
+ "klarna",
+ "multibanco",
+ "mx_bank_transfer",
+ "p24",
+ "paynow",
+ "paypal",
+ "pix",
+ "revolut",
+ "sofort",
+ "swish",
+ "th_bank_transfer",
+ "type",
+ "us_bank_transfer",
+ "wechat_pay",
+ "zip"
]
},
"refund_destination_details_card": {
@@ -55865,7 +61768,13 @@
],
"title": "refund_destination_details_card",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reference",
+ "reference_status",
+ "reference_type",
+ "type"
+ ]
},
"refund_destination_details_generic": {
"description": "",
@@ -55889,7 +61798,11 @@
],
"title": "refund_destination_details_generic",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reference",
+ "reference_status"
+ ]
},
"refund_next_action": {
"description": "",
@@ -55917,6 +61830,10 @@
"type": "object",
"x-expandableFields": [
"display_details"
+ ],
+ "x-stripeMostCommon": [
+ "display_details",
+ "type"
]
},
"refund_next_action_display_details": {
@@ -55939,6 +61856,10 @@
"type": "object",
"x-expandableFields": [
"email_sent"
+ ],
+ "x-stripeMostCommon": [
+ "email_sent",
+ "expires_at"
]
},
"reporting.report_run": {
@@ -56019,6 +61940,13 @@
"result"
],
"x-resourceId": "reporting.report_run",
+ "x-stripeMostCommon": [
+ "id",
+ "parameters",
+ "report_type",
+ "result",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -56148,6 +62076,12 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "reporting.report_type",
+ "x-stripeMostCommon": [
+ "data_available_end",
+ "data_available_start",
+ "id",
+ "name"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -56225,6 +62159,13 @@
"title": "ReserveTransaction",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "id",
+ "object"
+ ],
"x-stripeResource": {
"class_name": "ReserveTransaction",
"in_package": "",
@@ -56380,6 +62321,13 @@
"session"
],
"x-resourceId": "review",
+ "x-stripeMostCommon": [
+ "charge",
+ "id",
+ "open",
+ "payment_intent",
+ "reason"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -56468,6 +62416,11 @@
"title": "RadarRule",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "action",
+ "id",
+ "predicate"
+ ],
"x-stripeResource": {
"class_name": "Rule",
"in_package": "Radar"
@@ -56554,6 +62507,14 @@
"file"
],
"x-resourceId": "scheduled_query_run",
+ "x-stripeMostCommon": [
+ "data_load_time",
+ "file",
+ "id",
+ "sql",
+ "status",
+ "title"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -56601,6 +62562,10 @@
"type": "object",
"x-expandableFields": [
"liability"
+ ],
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
]
},
"secret_service_resource_scope": {
@@ -56625,7 +62590,11 @@
],
"title": "SecretServiceResourceScope",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "type",
+ "user"
+ ]
},
"sepa_debit_generated_from": {
"description": "",
@@ -56680,6 +62649,10 @@
"x-expandableFields": [
"charge",
"setup_attempt"
+ ],
+ "x-stripeMostCommon": [
+ "charge",
+ "setup_attempt"
]
},
"setup_attempt": {
@@ -56877,6 +62850,23 @@
"setup_intent"
],
"x-resourceId": "setup_attempt",
+ "x-stripeMostCommon": [
+ "application",
+ "attach_to_self",
+ "created",
+ "customer",
+ "flow_directions",
+ "id",
+ "livemode",
+ "object",
+ "on_behalf_of",
+ "payment_method",
+ "payment_method_details",
+ "setup_error",
+ "setup_intent",
+ "status",
+ "usage"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -56979,6 +62969,27 @@
"sepa_debit",
"sofort",
"us_bank_account"
+ ],
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "amazon_pay",
+ "au_becs_debit",
+ "bacs_debit",
+ "bancontact",
+ "boleto",
+ "card",
+ "card_present",
+ "cashapp",
+ "ideal",
+ "klarna",
+ "link",
+ "paypal",
+ "payto",
+ "revolut_pay",
+ "sepa_debit",
+ "sofort",
+ "type",
+ "us_bank_account"
]
},
"setup_attempt_payment_method_details_acss_debit": {
@@ -57114,6 +63125,16 @@
"generated_sepa_debit",
"generated_sepa_debit_mandate"
],
+ "x-stripeMostCommon": [
+ "bank_code",
+ "bank_name",
+ "bic",
+ "generated_sepa_debit",
+ "generated_sepa_debit_mandate",
+ "iban_last4",
+ "preferred_language",
+ "verified_name"
+ ],
"x-stripeResource": {
"class_name": "Bancontact",
"in_package": ""
@@ -57239,6 +63260,22 @@
"checks",
"three_d_secure",
"wallet"
+ ],
+ "x-stripeMostCommon": [
+ "brand",
+ "checks",
+ "country",
+ "description",
+ "exp_month",
+ "exp_year",
+ "fingerprint",
+ "funding",
+ "iin",
+ "issuer",
+ "last4",
+ "network",
+ "three_d_secure",
+ "wallet"
]
},
"setup_attempt_payment_method_details_card_checks": {
@@ -57270,7 +63307,12 @@
],
"title": "setup_attempt_payment_method_details_card_checks",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "address_line1_check",
+ "address_postal_code_check",
+ "cvc_check"
+ ]
},
"setup_attempt_payment_method_details_card_present": {
"description": "",
@@ -57315,6 +63357,10 @@
"generated_card",
"offline"
],
+ "x-stripeMostCommon": [
+ "generated_card",
+ "offline"
+ ],
"x-stripeResource": {
"class_name": "CardPresent",
"in_package": ""
@@ -57347,6 +63393,11 @@
"x-expandableFields": [
"apple_pay",
"google_pay"
+ ],
+ "x-stripeMostCommon": [
+ "apple_pay",
+ "google_pay",
+ "type"
]
},
"setup_attempt_payment_method_details_cashapp": {
@@ -57472,6 +63523,14 @@
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
+ ],
+ "x-stripeMostCommon": [
+ "bank",
+ "bic",
+ "generated_sepa_debit",
+ "generated_sepa_debit_mandate",
+ "iban_last4",
+ "verified_name"
]
},
"setup_attempt_payment_method_details_klarna": {
@@ -57620,6 +63679,16 @@
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
+ ],
+ "x-stripeMostCommon": [
+ "bank_code",
+ "bank_name",
+ "bic",
+ "generated_sepa_debit",
+ "generated_sepa_debit_mandate",
+ "iban_last4",
+ "preferred_language",
+ "verified_name"
]
},
"setup_attempt_payment_method_details_us_bank_account": {
@@ -57847,7 +63916,7 @@
"$ref": "#/components/schemas/payment_method"
}
],
- "description": "ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.corp.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.",
+ "description": "ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -57964,6 +64033,19 @@
"single_use_mandate"
],
"x-resourceId": "setup_intent",
+ "x-stripeMostCommon": [
+ "automatic_payment_methods",
+ "client_secret",
+ "customer",
+ "description",
+ "id",
+ "last_setup_error",
+ "metadata",
+ "next_action",
+ "payment_method",
+ "status",
+ "usage"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -58132,6 +64214,13 @@
"cashapp_handle_redirect_or_display_qr_code",
"redirect_to_url",
"verify_with_microdeposits"
+ ],
+ "x-stripeMostCommon": [
+ "cashapp_handle_redirect_or_display_qr_code",
+ "redirect_to_url",
+ "type",
+ "use_stripe_sdk",
+ "verify_with_microdeposits"
]
},
"setup_intent_next_action_redirect_to_url": {
@@ -58157,6 +64246,10 @@
"title": "SetupIntentNextActionRedirectToUrl",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "return_url",
+ "url"
+ ],
"x-stripeResource": {
"class_name": "NextActionRedirectToUrl",
"in_package": ""
@@ -58192,7 +64285,12 @@
],
"title": "SetupIntentNextActionVerifyWithMicrodeposits",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "arrival_date",
+ "hosted_verification_url",
+ "microdeposit_type"
+ ]
},
"setup_intent_payment_method_options": {
"description": "",
@@ -58241,6 +64339,18 @@
"payto",
"sepa_debit",
"us_bank_account"
+ ],
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "amazon_pay",
+ "bacs_debit",
+ "card",
+ "card_present",
+ "link",
+ "paypal",
+ "payto",
+ "sepa_debit",
+ "us_bank_account"
]
},
"setup_intent_payment_method_options_acss_debit": {
@@ -58276,6 +64386,11 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
+ ],
+ "x-stripeMostCommon": [
+ "currency",
+ "mandate_options",
+ "verification_method"
]
},
"setup_intent_payment_method_options_amazon_pay": {
@@ -58296,6 +64411,9 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
+ ],
+ "x-stripeMostCommon": [
+ "mandate_options"
]
},
"setup_intent_payment_method_options_card": {
@@ -58350,6 +64468,11 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
+ ],
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "network",
+ "request_three_d_secure"
]
},
"setup_intent_payment_method_options_card_mandate_options": {
@@ -58436,6 +64559,18 @@
"title": "setup_intent_payment_method_options_card_mandate_options",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "currency",
+ "description",
+ "end_date",
+ "interval",
+ "interval_count",
+ "reference",
+ "start_date",
+ "supported_types"
+ ],
"x-stripeResource": {
"class_name": "MandateOptions",
"in_package": ""
@@ -58463,7 +64598,10 @@
],
"title": "setup_intent_payment_method_options_link",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "persistent_token"
+ ]
},
"setup_intent_payment_method_options_mandate_options_acss_debit": {
"description": "",
@@ -58517,7 +64655,14 @@
],
"title": "setup_intent_payment_method_options_mandate_options_acss_debit",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "custom_mandate_url",
+ "default_for",
+ "interval_description",
+ "payment_schedule",
+ "transaction_type"
+ ]
},
"setup_intent_payment_method_options_mandate_options_bacs_debit": {
"description": "",
@@ -58609,7 +64754,16 @@
],
"title": "setup_intent_payment_method_options_mandate_options_payto",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "end_date",
+ "payment_schedule",
+ "payments_per_period",
+ "purpose",
+ "start_date"
+ ]
},
"setup_intent_payment_method_options_mandate_options_sepa_debit": {
"description": "",
@@ -58651,7 +64805,12 @@
],
"title": "setup_intent_payment_method_options_paypal",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "billing_agreement_id",
+ "currency",
+ "subsellers"
+ ]
},
"setup_intent_payment_method_options_payto": {
"description": "",
@@ -58664,6 +64823,9 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
+ ],
+ "x-stripeMostCommon": [
+ "mandate_options"
]
},
"setup_intent_payment_method_options_sepa_debit": {
@@ -58677,6 +64839,9 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
+ ],
+ "x-stripeMostCommon": [
+ "mandate_options"
]
},
"setup_intent_payment_method_options_us_bank_account": {
@@ -58704,6 +64869,11 @@
"x-expandableFields": [
"financial_connections",
"mandate_options"
+ ],
+ "x-stripeMostCommon": [
+ "financial_connections",
+ "mandate_options",
+ "verification_method"
]
},
"setup_intent_type_specific_payment_method_options_client": {
@@ -58722,7 +64892,10 @@
},
"title": "SetupIntentTypeSpecificPaymentMethodOptionsClient",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "verification_method"
+ ]
},
"shipping": {
"description": "",
@@ -58759,6 +64932,13 @@
"x-expandableFields": [
"address"
],
+ "x-stripeMostCommon": [
+ "address",
+ "carrier",
+ "name",
+ "phone",
+ "tracking_number"
+ ],
"x-stripeResource": {
"class_name": "ShippingDetails",
"in_package": ""
@@ -58877,6 +65057,14 @@
"tax_code"
],
"x-resourceId": "shipping_rate",
+ "x-stripeMostCommon": [
+ "active",
+ "display_name",
+ "fixed_amount",
+ "id",
+ "metadata",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -58936,7 +65124,11 @@
],
"title": "ShippingRateCurrencyOption",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "tax_behavior"
+ ]
},
"shipping_rate_delivery_estimate": {
"description": "",
@@ -58969,6 +65161,10 @@
"x-expandableFields": [
"maximum",
"minimum"
+ ],
+ "x-stripeMostCommon": [
+ "maximum",
+ "minimum"
]
},
"shipping_rate_delivery_estimate_bound": {
@@ -58996,7 +65192,11 @@
],
"title": "ShippingRateDeliveryEstimateBound",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "unit",
+ "value"
+ ]
},
"shipping_rate_fixed_amount": {
"description": "",
@@ -59025,6 +65225,11 @@
"type": "object",
"x-expandableFields": [
"currency_options"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "currency_options"
]
},
"sigma.scheduled_query_run.created": {
@@ -59057,7 +65262,10 @@
],
"title": "SigmaScheduledQueryRunError",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "message"
+ ]
},
"source": {
"description": "`Source` objects allow you to accept a variety of payment methods. They\nrepresent a customer's payment instrument, and can be used with the Stripe API\njust like a `Card` object: once chargeable, they can be charged, or can be\nattached to customers.\n\nStripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).\nWe recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).\nThis newer API provides access to our latest features and payment method types.\n\nRelated guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).",
@@ -59269,6 +65477,18 @@
"source_order"
],
"x-resourceId": "source",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "customer",
+ "id",
+ "metadata",
+ "owner",
+ "redirect",
+ "statement_descriptor",
+ "status",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "detach",
@@ -59453,7 +65673,11 @@
],
"title": "SourceCodeVerificationFlow",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "attempts_remaining",
+ "status"
+ ]
},
"source_mandate_notification": {
"description": "Source mandate notifications should be created when a notification related to\na source mandate must be sent to the payer. They will trigger a webhook or\ndeliver an email to the customer.",
@@ -59531,6 +65755,20 @@
"sepa_debit",
"source"
],
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "amount",
+ "bacs_debit",
+ "created",
+ "id",
+ "livemode",
+ "object",
+ "reason",
+ "sepa_debit",
+ "source",
+ "status",
+ "type"
+ ],
"x-stripeResource": {
"class_name": "SourceMandateNotification",
"in_package": ""
@@ -59547,7 +65785,10 @@
},
"title": "SourceMandateNotificationAcssDebitData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "statement_descriptor"
+ ]
},
"source_mandate_notification_bacs_debit_data": {
"description": "",
@@ -59560,7 +65801,10 @@
},
"title": "SourceMandateNotificationBacsDebitData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "last4"
+ ]
},
"source_mandate_notification_sepa_debit_data": {
"description": "",
@@ -59583,7 +65827,12 @@
},
"title": "SourceMandateNotificationSepaDebitData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "creditor_identifier",
+ "last4",
+ "mandate_reference"
+ ]
},
"source_order": {
"description": "",
@@ -59623,6 +65872,13 @@
"x-expandableFields": [
"items",
"shipping"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "email",
+ "items",
+ "shipping"
]
},
"source_order_item": {
@@ -59671,7 +65927,15 @@
],
"title": "SourceOrderItem",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "parent",
+ "quantity",
+ "type"
+ ]
},
"source_owner": {
"description": "",
@@ -59746,6 +66010,16 @@
"x-expandableFields": [
"address",
"verified_address"
+ ],
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone",
+ "verified_address",
+ "verified_email",
+ "verified_name",
+ "verified_phone"
]
},
"source_receiver_flow": {
@@ -59790,7 +66064,15 @@
],
"title": "SourceReceiverFlow",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "address",
+ "amount_charged",
+ "amount_received",
+ "amount_returned",
+ "refund_attributes_method",
+ "refund_attributes_status"
+ ]
},
"source_redirect_flow": {
"description": "",
@@ -59825,7 +66107,13 @@
],
"title": "SourceRedirectFlow",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "failure_reason",
+ "return_url",
+ "status",
+ "url"
+ ]
},
"source_transaction": {
"description": "Some payment methods have no required amount that a customer must send.\nCustomers can be instructed to send any amount, and it can be made up of\nmultiple transactions. As such, sources can have multiple associated\ntransactions.",
@@ -59928,6 +66216,22 @@
"sepa_credit_transfer"
],
"x-resourceId": "source_transaction",
+ "x-stripeMostCommon": [
+ "ach_credit_transfer",
+ "amount",
+ "chf_credit_transfer",
+ "created",
+ "currency",
+ "gbp_credit_transfer",
+ "id",
+ "livemode",
+ "object",
+ "paper_check",
+ "sepa_credit_transfer",
+ "source",
+ "status",
+ "type"
+ ],
"x-stripeResource": {
"class_name": "SourceTransaction",
"has_collection_class": true,
@@ -59960,7 +66264,13 @@
},
"title": "SourceTransactionAchCreditTransferData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "customer_data",
+ "fingerprint",
+ "last4",
+ "routing_number"
+ ]
},
"source_transaction_chf_credit_transfer_data": {
"description": "",
@@ -59993,7 +66303,14 @@
},
"title": "SourceTransactionChfCreditTransferData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reference",
+ "sender_address_country",
+ "sender_address_line1",
+ "sender_iban",
+ "sender_name"
+ ]
},
"source_transaction_gbp_credit_transfer_data": {
"description": "",
@@ -60036,7 +66353,16 @@
},
"title": "SourceTransactionGbpCreditTransferData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "fingerprint",
+ "funding_method",
+ "last4",
+ "reference",
+ "sender_account_number",
+ "sender_name",
+ "sender_sort_code"
+ ]
},
"source_transaction_paper_check_data": {
"description": "",
@@ -60054,7 +66380,11 @@
},
"title": "SourceTransactionPaperCheckData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "available_at",
+ "invoices"
+ ]
},
"source_transaction_sepa_credit_transfer_data": {
"description": "",
@@ -60077,7 +66407,12 @@
},
"title": "SourceTransactionSepaCreditTransferData",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reference",
+ "sender_iban",
+ "sender_name"
+ ]
},
"source_type_ach_credit_transfer": {
"properties": {
@@ -61008,6 +67343,13 @@
"discount",
"discount_end",
"promotion_code"
+ ],
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "discount_end",
+ "index",
+ "promotion_code"
]
},
"subscription": {
@@ -61288,6 +67630,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"last_price_migration_error": {
@@ -61597,6 +67945,22 @@
"trial_settings"
],
"x-resourceId": "subscription",
+ "x-stripeMostCommon": [
+ "cancel_at_period_end",
+ "currency",
+ "current_period_end",
+ "current_period_start",
+ "customer",
+ "default_payment_method",
+ "description",
+ "id",
+ "items",
+ "latest_invoice",
+ "metadata",
+ "pending_setup_intent",
+ "pending_update",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "cancel",
@@ -61687,6 +68051,10 @@
"type": "object",
"x-expandableFields": [
"liability"
+ ],
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
]
},
"subscription_billing_thresholds": {
@@ -61709,7 +68077,11 @@
],
"title": "SubscriptionBillingThresholds",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount_gte",
+ "reset_billing_cycle_anchor"
+ ]
},
"subscription_details_data": {
"description": "",
@@ -61740,6 +68112,10 @@
"type": "object",
"x-expandableFields": [
"pause_collection"
+ ],
+ "x-stripeMostCommon": [
+ "metadata",
+ "pause_collection"
]
},
"subscription_item": {
@@ -61856,6 +68232,13 @@
"trial"
],
"x-resourceId": "subscription_item",
+ "x-stripeMostCommon": [
+ "id",
+ "metadata",
+ "price",
+ "quantity",
+ "subscription"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -61920,7 +68303,10 @@
],
"title": "SubscriptionItemBillingThresholds",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "usage_gte"
+ ]
},
"subscription_payment_method_options_card": {
"description": "",
@@ -61966,6 +68352,11 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
+ ],
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "network",
+ "request_three_d_secure"
]
},
"subscription_pending_invoice_item_interval": {
@@ -61992,7 +68383,11 @@
],
"title": "SubscriptionPendingInvoiceItemInterval",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"subscription_prebilling_data": {
"description": "Prebilling stores the time period and invoice for a Subscription billed in advance.",
@@ -62044,6 +68439,12 @@
"type": "object",
"x-expandableFields": [
"invoice"
+ ],
+ "x-stripeMostCommon": [
+ "invoice",
+ "period_end",
+ "period_start",
+ "update_behavior"
]
},
"subscription_schedule": {
@@ -62295,6 +68696,15 @@
"test_clock"
],
"x-resourceId": "subscription_schedule",
+ "x-stripeMostCommon": [
+ "current_phase",
+ "customer",
+ "id",
+ "metadata",
+ "phases",
+ "status",
+ "subscription"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -62540,6 +68950,12 @@
"discounts",
"price",
"tax_rates"
+ ],
+ "x-stripeMostCommon": [
+ "discounts",
+ "price",
+ "quantity",
+ "tax_rates"
]
},
"subscription_schedule_configuration_item": {
@@ -62658,6 +69074,16 @@
"price",
"tax_rates",
"trial"
+ ],
+ "x-stripeMostCommon": [
+ "billing_thresholds",
+ "discounts",
+ "metadata",
+ "plan",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
]
},
"subscription_schedule_current_phase": {
@@ -62680,7 +69106,11 @@
],
"title": "SubscriptionScheduleCurrentPhase",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "end_date",
+ "start_date"
+ ]
},
"subscription_schedule_phase_configuration": {
"description": "A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.",
@@ -62942,6 +69372,32 @@
"pause_collection",
"transfer_data",
"trial_settings"
+ ],
+ "x-stripeMostCommon": [
+ "add_invoice_items",
+ "application_fee_percent",
+ "automatic_tax",
+ "billing_cycle_anchor",
+ "billing_thresholds",
+ "collection_method",
+ "coupon",
+ "currency",
+ "default_payment_method",
+ "default_tax_rates",
+ "description",
+ "discounts",
+ "end_date",
+ "invoice_settings",
+ "items",
+ "metadata",
+ "on_behalf_of",
+ "pause_collection",
+ "proration_behavior",
+ "start_date",
+ "transfer_data",
+ "trial_continuation",
+ "trial_end",
+ "trial_settings"
]
},
"subscription_schedules_resource_default_settings": {
@@ -63060,6 +69516,18 @@
"invoice_settings",
"on_behalf_of",
"transfer_data"
+ ],
+ "x-stripeMostCommon": [
+ "application_fee_percent",
+ "automatic_tax",
+ "billing_cycle_anchor",
+ "billing_thresholds",
+ "collection_method",
+ "default_payment_method",
+ "description",
+ "invoice_settings",
+ "on_behalf_of",
+ "transfer_data"
]
},
"subscription_schedules_resource_default_settings_automatic_tax": {
@@ -63087,6 +69555,10 @@
"type": "object",
"x-expandableFields": [
"liability"
+ ],
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
]
},
"subscription_schedules_resource_end_behavior": {
@@ -63107,7 +69579,10 @@
],
"title": "SubscriptionSchedulesResourceEndBehavior",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "prorate_up_front"
+ ]
},
"subscription_schedules_resource_pause_collection": {
"description": "The Pause Collection settings specify how to pause collection for a subscription during a phase by modifying\nthe behavior of the invoices that are generated during the paused period.",
@@ -63127,7 +69602,10 @@
],
"title": "SubscriptionSchedulesResourcePauseCollection",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "behavior"
+ ]
},
"subscription_schedules_resource_trial_settings": {
"description": "Configures how the scheduled subscription behaves during the trial period.",
@@ -63149,6 +69627,9 @@
"type": "object",
"x-expandableFields": [
"end_behavior"
+ ],
+ "x-stripeMostCommon": [
+ "end_behavior"
]
},
"subscription_transfer_data": {
@@ -63187,6 +69668,10 @@
"type": "object",
"x-expandableFields": [
"destination"
+ ],
+ "x-stripeMostCommon": [
+ "amount_percent",
+ "destination"
]
},
"subscriptions_resource_billing_cycle_anchor_config": {
@@ -63226,7 +69711,14 @@
],
"title": "SubscriptionsResourceBillingCycleAnchorConfig",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "day_of_month",
+ "hour",
+ "minute",
+ "month",
+ "second"
+ ]
},
"subscriptions_resource_pause_collection": {
"description": "The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription\nshould be paused.",
@@ -63253,7 +69745,11 @@
],
"title": "SubscriptionsResourcePauseCollection",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "behavior",
+ "resumes_at"
+ ]
},
"subscriptions_resource_payment_method_options": {
"description": "",
@@ -63341,6 +69837,15 @@
"konbini",
"sepa_debit",
"us_bank_account"
+ ],
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "bancontact",
+ "card",
+ "customer_balance",
+ "konbini",
+ "sepa_debit",
+ "us_bank_account"
]
},
"subscriptions_resource_payment_settings": {
@@ -63415,6 +69920,11 @@
"type": "object",
"x-expandableFields": [
"payment_method_options"
+ ],
+ "x-stripeMostCommon": [
+ "payment_method_options",
+ "payment_method_types",
+ "save_default_payment_method"
]
},
"subscriptions_resource_pending_update": {
@@ -63467,6 +69977,14 @@
"type": "object",
"x-expandableFields": [
"subscription_items"
+ ],
+ "x-stripeMostCommon": [
+ "billing_cycle_anchor",
+ "expires_at",
+ "prebilling_iterations",
+ "subscription_items",
+ "trial_end",
+ "trial_from_plan"
]
},
"subscriptions_resource_price_migration_error": {
@@ -63501,6 +70019,11 @@
"type": "object",
"x-expandableFields": [
"failed_transitions"
+ ],
+ "x-stripeMostCommon": [
+ "errored_at",
+ "failed_transitions",
+ "type"
]
},
"subscriptions_resource_price_migration_error_failed_transition": {
@@ -63523,7 +70046,11 @@
],
"title": "SubscriptionsResourcePriceMigrationErrorFailedTransition",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "source_price",
+ "target_price"
+ ]
},
"subscriptions_resource_subscription_invoice_settings": {
"description": "",
@@ -63570,6 +70097,10 @@
"x-expandableFields": [
"account_tax_ids",
"issuer"
+ ],
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "issuer"
]
},
"subscriptions_trials_resource_end_behavior": {
@@ -63590,7 +70121,10 @@
],
"title": "SubscriptionsTrialsResourceEndBehavior",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "missing_payment_method"
+ ]
},
"subscriptions_trials_resource_trial": {
"description": "",
@@ -63618,7 +70152,11 @@
],
"title": "SubscriptionsTrialsResourceTrial",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
},
"subscriptions_trials_resource_trial_settings": {
"description": "Configures how this subscription behaves during the trial period.",
@@ -63634,6 +70172,9 @@
"type": "object",
"x-expandableFields": [
"end_behavior"
+ ],
+ "x-stripeMostCommon": [
+ "end_behavior"
]
},
"tax.association": {
@@ -63687,6 +70228,13 @@
"status_details"
],
"x-resourceId": "tax.association",
+ "x-stripeMostCommon": [
+ "calculation",
+ "id",
+ "payment_intent",
+ "status",
+ "status_details"
+ ],
"x-stripeOperations": [
{
"method_name": "find",
@@ -63773,6 +70321,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"livemode": {
@@ -63851,6 +70405,19 @@
"tax_breakdown"
],
"x-resourceId": "tax.calculation",
+ "x-stripeMostCommon": [
+ "amount_total",
+ "currency",
+ "customer_details",
+ "expires_at",
+ "id",
+ "line_items",
+ "object",
+ "shipping_cost",
+ "tax_amount_exclusive",
+ "tax_amount_inclusive",
+ "tax_breakdown"
+ ],
"x-stripeOperations": [
{
"method_name": "retrieve",
@@ -63962,6 +70529,19 @@
"tax_breakdown"
],
"x-resourceId": "tax.calculation_line_item",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_tax",
+ "id",
+ "livemode",
+ "object",
+ "product",
+ "quantity",
+ "reference",
+ "tax_behavior",
+ "tax_breakdown",
+ "tax_code"
+ ],
"x-stripeResource": {
"class_name": "CalculationLineItem",
"has_collection_class": true,
@@ -64062,6 +70642,13 @@
"us_1099_nec"
],
"x-resourceId": "tax.form",
+ "x-stripeMostCommon": [
+ "corrected_by",
+ "filing_statuses",
+ "id",
+ "payee",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -64177,6 +70764,17 @@
"country_options"
],
"x-resourceId": "tax.registration",
+ "x-stripeMostCommon": [
+ "active_from",
+ "country",
+ "country_options",
+ "created",
+ "expires_at",
+ "id",
+ "livemode",
+ "object",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -64267,6 +70865,14 @@
"status_details"
],
"x-resourceId": "tax.settings",
+ "x-stripeMostCommon": [
+ "defaults",
+ "head_office",
+ "livemode",
+ "object",
+ "status",
+ "status_details"
+ ],
"x-stripeOperations": [
{
"method_name": "retrieve",
@@ -64370,6 +70976,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"livemode": {
@@ -64470,6 +71082,16 @@
"shipping_cost"
],
"x-resourceId": "tax.transaction",
+ "x-stripeMostCommon": [
+ "currency",
+ "customer_details",
+ "id",
+ "line_items",
+ "metadata",
+ "object",
+ "reference",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "retrieve",
@@ -64608,6 +71230,21 @@
"reversal"
],
"x-resourceId": "tax.transaction_line_item",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_tax",
+ "id",
+ "livemode",
+ "metadata",
+ "object",
+ "product",
+ "quantity",
+ "reference",
+ "reversal",
+ "tax_behavior",
+ "tax_code",
+ "type"
+ ],
"x-stripeResource": {
"class_name": "TransactionLineItem",
"has_collection_class": true,
@@ -64650,6 +71287,12 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "tax_code",
+ "x-stripeMostCommon": [
+ "description",
+ "id",
+ "name",
+ "object"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -64713,6 +71356,13 @@
"title": "TaxDeductedAtSource",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "id",
+ "object",
+ "period_end",
+ "period_start",
+ "tax_deduction_account_number"
+ ],
"x-stripeResource": {
"class_name": "TaxDeductedAtSource",
"in_package": "",
@@ -64801,6 +71451,12 @@
"account",
"application",
"customer"
+ ],
+ "x-stripeMostCommon": [
+ "account",
+ "application",
+ "customer",
+ "type"
]
},
"tax_id": {
@@ -64863,7 +71519,7 @@
"nullable": true
},
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -64897,6 +71553,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -64977,6 +71634,13 @@
"verification"
],
"x-resourceId": "tax_id",
+ "x-stripeMostCommon": [
+ "country",
+ "customer",
+ "id",
+ "type",
+ "value"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -65097,7 +71761,12 @@
],
"title": "tax_id_verification",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "status",
+ "verified_address",
+ "verified_name"
+ ]
},
"tax_product_registrations_resource_country_options": {
"description": "",
@@ -65330,6 +71999,64 @@
"us",
"vn",
"za"
+ ],
+ "x-stripeMostCommon": [
+ "ae",
+ "at",
+ "au",
+ "be",
+ "bg",
+ "bh",
+ "ca",
+ "ch",
+ "cl",
+ "co",
+ "cy",
+ "cz",
+ "de",
+ "dk",
+ "ee",
+ "eg",
+ "es",
+ "fi",
+ "fr",
+ "gb",
+ "ge",
+ "gr",
+ "hr",
+ "hu",
+ "id",
+ "ie",
+ "is",
+ "it",
+ "jp",
+ "ke",
+ "kr",
+ "kz",
+ "lt",
+ "lu",
+ "lv",
+ "mt",
+ "mx",
+ "my",
+ "ng",
+ "nl",
+ "no",
+ "nz",
+ "om",
+ "pl",
+ "pt",
+ "ro",
+ "sa",
+ "se",
+ "sg",
+ "si",
+ "sk",
+ "th",
+ "tr",
+ "us",
+ "vn",
+ "za"
]
},
"tax_product_registrations_resource_country_options_ca_province_standard": {
@@ -65346,7 +72073,10 @@
],
"title": "TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "province"
+ ]
},
"tax_product_registrations_resource_country_options_canada": {
"description": "",
@@ -65371,6 +72101,10 @@
"type": "object",
"x-expandableFields": [
"province_standard"
+ ],
+ "x-stripeMostCommon": [
+ "province_standard",
+ "type"
]
},
"tax_product_registrations_resource_country_options_default": {
@@ -65389,7 +72123,10 @@
],
"title": "TaxProductRegistrationsResourceCountryOptionsDefault",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"tax_product_registrations_resource_country_options_eu_standard": {
"description": "",
@@ -65408,7 +72145,10 @@
],
"title": "TaxProductRegistrationsResourceCountryOptionsEuStandard",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"tax_product_registrations_resource_country_options_europe": {
"description": "",
@@ -65434,6 +72174,10 @@
"type": "object",
"x-expandableFields": [
"standard"
+ ],
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
]
},
"tax_product_registrations_resource_country_options_simplified": {
@@ -65452,7 +72196,10 @@
],
"title": "TaxProductRegistrationsResourceCountryOptionsSimplified",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"tax_product_registrations_resource_country_options_united_states": {
"description": "",
@@ -65489,6 +72236,12 @@
"x-expandableFields": [
"local_amusement_tax",
"local_lease_tax"
+ ],
+ "x-stripeMostCommon": [
+ "local_amusement_tax",
+ "local_lease_tax",
+ "state",
+ "type"
]
},
"tax_product_registrations_resource_country_options_us_local_amusement_tax": {
@@ -65505,7 +72258,10 @@
],
"title": "TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "jurisdiction"
+ ]
},
"tax_product_registrations_resource_country_options_us_local_lease_tax": {
"description": "",
@@ -65521,7 +72277,10 @@
],
"title": "TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "jurisdiction"
+ ]
},
"tax_product_resource_customer_details": {
"description": "",
@@ -65579,13 +72338,20 @@
"x-expandableFields": [
"address",
"tax_ids"
+ ],
+ "x-stripeMostCommon": [
+ "address",
+ "address_source",
+ "ip_address",
+ "tax_ids",
+ "taxability_override"
]
},
"tax_product_resource_customer_details_resource_tax_id": {
"description": "",
"properties": {
"type": {
- "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
+ "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -65619,6 +72385,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -65676,7 +72443,11 @@
],
"title": "TaxProductResourceCustomerDetailsResourceTaxId",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "type",
+ "value"
+ ]
},
"tax_product_resource_jurisdiction": {
"description": "",
@@ -65717,7 +72488,13 @@
],
"title": "TaxProductResourceJurisdiction",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "country",
+ "display_name",
+ "level",
+ "state"
+ ]
},
"tax_product_resource_line_item_tax_breakdown": {
"description": "",
@@ -65785,6 +72562,14 @@
"x-expandableFields": [
"jurisdiction",
"tax_rate_details"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "jurisdiction",
+ "sourcing",
+ "tax_rate_details",
+ "taxability_reason",
+ "taxable_amount"
]
},
"tax_product_resource_line_item_tax_rate_details": {
@@ -65827,7 +72612,12 @@
],
"title": "TaxProductResourceLineItemTaxRateDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "display_name",
+ "percentage_decimal",
+ "tax_type"
+ ]
},
"tax_product_resource_postal_address": {
"description": "",
@@ -65878,7 +72668,15 @@
],
"title": "TaxProductResourcePostalAddress",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"tax_product_resource_ship_from_details": {
"description": "",
@@ -65894,6 +72692,9 @@
"type": "object",
"x-expandableFields": [
"address"
+ ],
+ "x-stripeMostCommon": [
+ "address"
]
},
"tax_product_resource_tax_association_status_details": {
@@ -65911,6 +72712,10 @@
"x-expandableFields": [
"committed",
"errored"
+ ],
+ "x-stripeMostCommon": [
+ "committed",
+ "errored"
]
},
"tax_product_resource_tax_association_status_details_resource_committed": {
@@ -65937,6 +72742,10 @@
"type": "object",
"x-expandableFields": [
"reversals"
+ ],
+ "x-stripeMostCommon": [
+ "reversals",
+ "transaction"
]
},
"tax_product_resource_tax_association_status_details_resource_errored": {
@@ -65958,7 +72767,10 @@
],
"title": "TaxProductResourceTaxAssociationStatusDetailsResourceErrored",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reason"
+ ]
},
"tax_product_resource_tax_association_status_details_resource_tax_association_reversal_committed": {
"description": "",
@@ -65974,7 +72786,10 @@
],
"title": "TaxProductResourceTaxAssociationStatusDetailsResourceTaxAssociationReversalCommitted",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "transaction"
+ ]
},
"tax_product_resource_tax_association_status_details_resource_tax_association_reversal_errored": {
"description": "",
@@ -65999,7 +72814,11 @@
],
"title": "TaxProductResourceTaxAssociationStatusDetailsResourceTaxAssociationReversalErrored",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reason",
+ "refund_id"
+ ]
},
"tax_product_resource_tax_association_status_details_resource_tax_association_reversal_tax_association_reversal": {
"description": "",
@@ -66024,6 +72843,10 @@
"type": "object",
"x-expandableFields": [
"status_details"
+ ],
+ "x-stripeMostCommon": [
+ "status",
+ "status_details"
]
},
"tax_product_resource_tax_association_status_details_resource_tax_association_reversal_tax_association_reversal_status_details": {
@@ -66041,6 +72864,10 @@
"x-expandableFields": [
"committed",
"errored"
+ ],
+ "x-stripeMostCommon": [
+ "committed",
+ "errored"
]
},
"tax_product_resource_tax_breakdown": {
@@ -66094,6 +72921,13 @@
"type": "object",
"x-expandableFields": [
"tax_rate_details"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "inclusive",
+ "tax_rate_details",
+ "taxability_reason",
+ "taxable_amount"
]
},
"tax_product_resource_tax_calculation_shipping_cost": {
@@ -66143,6 +72977,14 @@
"type": "object",
"x-expandableFields": [
"tax_breakdown"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_tax",
+ "shipping_rate",
+ "tax_behavior",
+ "tax_breakdown",
+ "tax_code"
]
},
"tax_product_resource_tax_rate_details": {
@@ -66194,7 +73036,13 @@
],
"title": "TaxProductResourceTaxRateDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "country",
+ "percentage_decimal",
+ "state",
+ "tax_type"
+ ]
},
"tax_product_resource_tax_settings_defaults": {
"description": "",
@@ -66222,7 +73070,11 @@
],
"title": "TaxProductResourceTaxSettingsDefaults",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "tax_behavior",
+ "tax_code"
+ ]
},
"tax_product_resource_tax_settings_head_office": {
"description": "",
@@ -66238,6 +73090,9 @@
"type": "object",
"x-expandableFields": [
"address"
+ ],
+ "x-stripeMostCommon": [
+ "address"
]
},
"tax_product_resource_tax_settings_status_details": {
@@ -66255,6 +73110,10 @@
"x-expandableFields": [
"active",
"pending"
+ ],
+ "x-stripeMostCommon": [
+ "active",
+ "pending"
]
},
"tax_product_resource_tax_settings_status_details_resource_active": {
@@ -66282,7 +73141,10 @@
],
"title": "TaxProductResourceTaxSettingsStatusDetailsResourcePending",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "missing_fields"
+ ]
},
"tax_product_resource_tax_transaction_line_item_resource_reversal": {
"description": "",
@@ -66298,7 +73160,10 @@
],
"title": "TaxProductResourceTaxTransactionLineItemResourceReversal",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "original_line_item"
+ ]
},
"tax_product_resource_tax_transaction_resource_reversal": {
"description": "",
@@ -66315,7 +73180,10 @@
],
"title": "TaxProductResourceTaxTransactionResourceReversal",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "original_transaction"
+ ]
},
"tax_product_resource_tax_transaction_shipping_cost": {
"description": "",
@@ -66364,6 +73232,14 @@
"type": "object",
"x-expandableFields": [
"tax_breakdown"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_tax",
+ "shipping_rate",
+ "tax_behavior",
+ "tax_breakdown",
+ "tax_code"
]
},
"tax_rate": {
@@ -66501,6 +73377,18 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "tax_rate",
+ "x-stripeMostCommon": [
+ "active",
+ "country",
+ "description",
+ "display_name",
+ "id",
+ "inclusive",
+ "jurisdiction",
+ "metadata",
+ "percentage",
+ "state"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -66582,7 +73470,10 @@
],
"title": "TaxReportingAccountSettingsResourceTaxFormSettings",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "consented_to_paperless_delivery"
+ ]
},
"tax_reporting_resource_tax_form_filing_status": {
"description": "",
@@ -66614,6 +73505,11 @@
"type": "object",
"x-expandableFields": [
"jurisdiction"
+ ],
+ "x-stripeMostCommon": [
+ "effective_at",
+ "jurisdiction",
+ "value"
]
},
"tax_reporting_resource_tax_form_filing_status_resource_jurisdiction": {
@@ -66646,7 +73542,12 @@
],
"title": "TaxReportingResourceTaxFormFilingStatusResourceJurisdiction",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "country",
+ "level",
+ "state"
+ ]
},
"tax_reporting_resource_tax_form_payee": {
"description": "",
@@ -66687,6 +73588,10 @@
"type": "object",
"x-expandableFields": [
"account"
+ ],
+ "x-stripeMostCommon": [
+ "account",
+ "type"
]
},
"tax_reporting_resource_tax_form_us1099_k": {
@@ -66702,7 +73607,10 @@
],
"title": "TaxReportingResourceTaxFormUS1099K",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reporting_year"
+ ]
},
"tax_reporting_resource_tax_form_us1099_misc": {
"description": "",
@@ -66717,7 +73625,10 @@
],
"title": "TaxReportingResourceTaxFormUS1099MISC",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reporting_year"
+ ]
},
"tax_reporting_resource_tax_form_us1099_nec": {
"description": "",
@@ -66732,7 +73643,10 @@
],
"title": "TaxReportingResourceTaxFormUS1099NEC",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reporting_year"
+ ]
},
"terminal.configuration": {
"description": "A Configurations object represents how features should be configured for terminal readers.",
@@ -66801,6 +73715,14 @@
"verifone_p400"
],
"x-resourceId": "terminal.configuration",
+ "x-stripeMostCommon": [
+ "bbpos_wisepos_e",
+ "id",
+ "is_account_default",
+ "stripe_s700",
+ "tipping",
+ "verifone_p400"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -66873,6 +73795,10 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "terminal.connection_token",
+ "x-stripeMostCommon": [
+ "location",
+ "secret"
+ ],
"x-stripeOperations": [
{
"method_name": "create",
@@ -66942,6 +73868,12 @@
"address"
],
"x-resourceId": "terminal.location",
+ "x-stripeMostCommon": [
+ "address",
+ "display_name",
+ "id",
+ "metadata"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -67108,6 +74040,15 @@
"location"
],
"x-resourceId": "terminal.reader",
+ "x-stripeMostCommon": [
+ "device_type",
+ "id",
+ "label",
+ "location",
+ "metadata",
+ "serial_number",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -67262,6 +74203,80 @@
"type": "terminal.reader.action_updated"
}
},
+ "terminal.reader_collected_data": {
+ "description": "Returns data collected by Terminal readers. This data is only stored for 24 hours.",
+ "properties": {
+ "created": {
+ "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Unique identifier for the object.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "livemode": {
+ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
+ "type": "boolean"
+ },
+ "magstripe": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/terminal_reader_collected_data_resource_magstripe_data"
+ }
+ ],
+ "description": "The magstripe data collected by the reader.",
+ "nullable": true
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value.",
+ "enum": [
+ "terminal.reader_collected_data"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of data collected by the reader.",
+ "enum": [
+ "magstripe"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "created",
+ "id",
+ "livemode",
+ "magstripe",
+ "object",
+ "type"
+ ],
+ "title": "TerminalReaderCollectedData",
+ "type": "object",
+ "x-expandableFields": [
+ "magstripe"
+ ],
+ "x-resourceId": "terminal.reader_collected_data",
+ "x-stripeMostCommon": [
+ "id",
+ "magstripe",
+ "type"
+ ],
+ "x-stripeOperations": [
+ {
+ "method_name": "retrieve",
+ "method_on": "service",
+ "method_type": "retrieve",
+ "operation": "get",
+ "path": "/v1/terminal/reader_collected_data/{reader_collected_data}"
+ }
+ ],
+ "x-stripeResource": {
+ "class_name": "ReaderCollectedData",
+ "in_package": "Terminal"
+ }
+ },
"terminal_configuration_configuration_resource_currency_specific_config": {
"description": "",
"properties": {
@@ -67288,7 +74303,12 @@
},
"title": "TerminalConfigurationConfigurationResourceCurrencySpecificConfig",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"terminal_configuration_configuration_resource_device_type_specific_config": {
"description": "",
@@ -67317,6 +74337,9 @@
"type": "object",
"x-expandableFields": [
"splashscreen"
+ ],
+ "x-stripeMostCommon": [
+ "splashscreen"
]
},
"terminal_configuration_configuration_resource_offline_config": {
@@ -67333,7 +74356,10 @@
],
"title": "TerminalConfigurationConfigurationResourceOfflineConfig",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"terminal_configuration_configuration_resource_reboot_window": {
"description": "",
@@ -67353,7 +74379,11 @@
],
"title": "TerminalConfigurationConfigurationResourceRebootWindow",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "end_hour",
+ "start_hour"
+ ]
},
"terminal_configuration_configuration_resource_tipping": {
"description": "",
@@ -67418,6 +74448,42 @@
"sek",
"sgd",
"usd"
+ ],
+ "x-stripeMostCommon": [
+ "aud",
+ "cad",
+ "chf",
+ "czk",
+ "dkk",
+ "eur",
+ "gbp",
+ "hkd",
+ "myr",
+ "nok",
+ "nzd",
+ "sek",
+ "sgd",
+ "usd"
+ ]
+ },
+ "terminal_reader_collected_data_resource_magstripe_data": {
+ "description": "Represents magstripe data collected by the reader.",
+ "properties": {
+ "data": {
+ "description": "The raw magstripe data collected by the reader.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "data"
+ ],
+ "title": "TerminalReaderCollectedDataResourceMagstripeData",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "data"
]
},
"terminal_reader_reader_resource_cart": {
@@ -67454,6 +74520,12 @@
"type": "object",
"x-expandableFields": [
"line_items"
+ ],
+ "x-stripeMostCommon": [
+ "currency",
+ "line_items",
+ "tax",
+ "total"
]
},
"terminal_reader_reader_resource_choice": {
@@ -67480,7 +74552,11 @@
],
"title": "TerminalReaderReaderResourceChoice",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "style",
+ "value"
+ ]
},
"terminal_reader_reader_resource_collect_config": {
"description": "Represents a per-transaction override of a reader configuration",
@@ -67501,6 +74577,11 @@
"type": "object",
"x-expandableFields": [
"tipping"
+ ],
+ "x-stripeMostCommon": [
+ "enable_customer_cancellation",
+ "skip_tipping",
+ "tipping"
]
},
"terminal_reader_reader_resource_collect_inputs_action": {
@@ -67531,6 +74612,10 @@
"type": "object",
"x-expandableFields": [
"inputs"
+ ],
+ "x-stripeMostCommon": [
+ "inputs",
+ "metadata"
]
},
"terminal_reader_reader_resource_collect_payment_method_action": {
@@ -67575,6 +74660,9 @@
"collect_config",
"payment_intent",
"payment_method"
+ ],
+ "x-stripeMostCommon": [
+ "payment_intent"
]
},
"terminal_reader_reader_resource_confirm_payment_intent_action": {
@@ -67611,6 +74699,9 @@
"type": "object",
"x-expandableFields": [
"payment_intent"
+ ],
+ "x-stripeMostCommon": [
+ "payment_intent"
]
},
"terminal_reader_reader_resource_custom_text": {
@@ -67649,7 +74740,13 @@
],
"title": "TerminalReaderReaderResourceCustomText",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "description",
+ "skip_button",
+ "submit_button",
+ "title"
+ ]
},
"terminal_reader_reader_resource_email": {
"description": "Information about a email being collected using a reader",
@@ -67666,7 +74763,10 @@
],
"title": "TerminalReaderReaderResourceEmail",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "value"
+ ]
},
"terminal_reader_reader_resource_input": {
"description": "Represents an input to be collected using the reader",
@@ -67745,6 +74845,11 @@
"signature",
"text",
"toggles"
+ ],
+ "x-stripeMostCommon": [
+ "required",
+ "skipped",
+ "type"
]
},
"terminal_reader_reader_resource_line_item": {
@@ -67771,7 +74876,12 @@
],
"title": "TerminalReaderReaderResourceLineItem",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount",
+ "description",
+ "quantity"
+ ]
},
"terminal_reader_reader_resource_numeric": {
"description": "Information about a number being collected using a reader",
@@ -67788,7 +74898,10 @@
],
"title": "TerminalReaderReaderResourceNumeric",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "value"
+ ]
},
"terminal_reader_reader_resource_phone": {
"description": "Information about a phone number being collected using a reader",
@@ -67805,7 +74918,10 @@
],
"title": "TerminalReaderReaderResourcePhone",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "value"
+ ]
},
"terminal_reader_reader_resource_process_config": {
"description": "Represents a per-transaction override of a reader configuration",
@@ -67826,6 +74942,11 @@
"type": "object",
"x-expandableFields": [
"tipping"
+ ],
+ "x-stripeMostCommon": [
+ "enable_customer_cancellation",
+ "skip_tipping",
+ "tipping"
]
},
"terminal_reader_reader_resource_process_payment_intent_action": {
@@ -67866,6 +74987,9 @@
"x-expandableFields": [
"payment_intent",
"process_config"
+ ],
+ "x-stripeMostCommon": [
+ "payment_intent"
]
},
"terminal_reader_reader_resource_process_setup_config": {
@@ -67878,7 +75002,10 @@
},
"title": "TerminalReaderReaderResourceProcessSetupConfig",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enable_customer_cancellation"
+ ]
},
"terminal_reader_reader_resource_process_setup_intent_action": {
"description": "Represents a reader action to process a setup intent",
@@ -67919,6 +75046,9 @@
"x-expandableFields": [
"process_config",
"setup_intent"
+ ],
+ "x-stripeMostCommon": [
+ "setup_intent"
]
},
"terminal_reader_reader_resource_reader_action": {
@@ -67996,6 +75126,19 @@
"process_setup_intent",
"refund_payment",
"set_reader_display"
+ ],
+ "x-stripeMostCommon": [
+ "collect_inputs",
+ "collect_payment_method",
+ "confirm_payment_intent",
+ "failure_code",
+ "failure_message",
+ "process_payment_intent",
+ "process_setup_intent",
+ "refund_payment",
+ "set_reader_display",
+ "status",
+ "type"
]
},
"terminal_reader_reader_resource_refund_payment_action": {
@@ -68102,6 +75245,17 @@
"payment_intent",
"refund",
"refund_payment_config"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "charge",
+ "metadata",
+ "payment_intent",
+ "reason",
+ "refund",
+ "refund_application_fee",
+ "refund_payment_config",
+ "reverse_transfer"
]
},
"terminal_reader_reader_resource_refund_payment_config": {
@@ -68114,7 +75268,10 @@
},
"title": "TerminalReaderReaderResourceRefundPaymentConfig",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "enable_customer_cancellation"
+ ]
},
"terminal_reader_reader_resource_selection": {
"description": "Information about a selection being collected using a reader",
@@ -68141,6 +75298,10 @@
"type": "object",
"x-expandableFields": [
"choices"
+ ],
+ "x-stripeMostCommon": [
+ "choices",
+ "value"
]
},
"terminal_reader_reader_resource_set_reader_display_action": {
@@ -68171,6 +75332,10 @@
"type": "object",
"x-expandableFields": [
"cart"
+ ],
+ "x-stripeMostCommon": [
+ "cart",
+ "type"
]
},
"terminal_reader_reader_resource_signature": {
@@ -68188,7 +75353,10 @@
],
"title": "TerminalReaderReaderResourceSignature",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "value"
+ ]
},
"terminal_reader_reader_resource_text": {
"description": "Information about text being collected using a reader",
@@ -68205,7 +75373,10 @@
],
"title": "TerminalReaderReaderResourceText",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "value"
+ ]
},
"terminal_reader_reader_resource_tipping_config": {
"description": "Represents a per-transaction tipping configuration",
@@ -68217,7 +75388,10 @@
},
"title": "TerminalReaderReaderResourceTippingConfig",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "amount_eligible"
+ ]
},
"terminal_reader_reader_resource_toggle": {
"description": "Information about an input's toggle",
@@ -68261,7 +75435,13 @@
],
"title": "TerminalReaderReaderResourceToggle",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "default_value",
+ "description",
+ "title",
+ "value"
+ ]
},
"test_helpers.test_clock": {
"description": "A test clock enables deterministic control over objects in testmode. With a test clock, you can create\nobjects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,\nyou can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.",
@@ -68311,6 +75491,9 @@
"ready"
],
"type": "string"
+ },
+ "status_details": {
+ "$ref": "#/components/schemas/billing_clocks_resource_status_details_status_details"
}
},
"required": [
@@ -68325,8 +75508,21 @@
],
"title": "TestClock",
"type": "object",
- "x-expandableFields": [],
+ "x-expandableFields": [
+ "status_details"
+ ],
"x-resourceId": "test_helpers.test_clock",
+ "x-stripeMostCommon": [
+ "created",
+ "deletes_after",
+ "frozen_time",
+ "id",
+ "livemode",
+ "name",
+ "object",
+ "status",
+ "status_details"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -68530,7 +75726,15 @@
],
"title": "three_d_secure_details",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "authentication_flow",
+ "electronic_commerce_indicator",
+ "result",
+ "result_reason",
+ "transaction_id",
+ "version"
+ ]
},
"three_d_secure_details_charge": {
"description": "",
@@ -68626,7 +75830,17 @@
],
"title": "three_d_secure_details_charge",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "authentication_flow",
+ "electronic_commerce_indicator",
+ "exemption_indicator",
+ "exemption_indicator_applied",
+ "result",
+ "result_reason",
+ "transaction_id",
+ "version"
+ ]
},
"three_d_secure_usage": {
"description": "",
@@ -68641,7 +75855,10 @@
],
"title": "three_d_secure_usage",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "supported"
+ ]
},
"thresholds_resource_alert_filter": {
"description": "",
@@ -68674,6 +75891,9 @@
"type": "object",
"x-expandableFields": [
"customer"
+ ],
+ "x-stripeMostCommon": [
+ "customer"
]
},
"thresholds_resource_usage_threshold_config": {
@@ -68720,6 +75940,11 @@
"type": "object",
"x-expandableFields": [
"meter"
+ ],
+ "x-stripeMostCommon": [
+ "gte",
+ "meter",
+ "recurrence"
]
},
"token": {
@@ -68784,6 +76009,10 @@
"card"
],
"x-resourceId": "token",
+ "x-stripeMostCommon": [
+ "card",
+ "id"
+ ],
"x-stripeOperations": [
{
"method_name": "retrieve",
@@ -68820,7 +76049,10 @@
],
"title": "token_card_networks",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "preferred"
+ ]
},
"topup": {
"description": "To top up your Stripe balance, you create a top-up object. You can retrieve\nindividual top-ups, as well as list all top-ups. Top-ups are identified by a\nunique, random ID.\n\nRelated guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups)",
@@ -68964,6 +76196,14 @@
"source"
],
"x-resourceId": "topup",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "id",
+ "metadata",
+ "status"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -69236,6 +76476,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"reversed": {
@@ -69252,7 +76498,7 @@
"$ref": "#/components/schemas/charge"
}
],
- "description": "ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.",
+ "description": "ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -69301,6 +76547,14 @@
"source_transaction"
],
"x-resourceId": "transfer",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "destination",
+ "id",
+ "metadata"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -69422,6 +76676,10 @@
"type": "object",
"x-expandableFields": [
"destination"
+ ],
+ "x-stripeMostCommon": [
+ "amount",
+ "destination"
]
},
"transfer_reversal": {
@@ -69562,6 +76820,13 @@
"transfer"
],
"x-resourceId": "transfer_reversal",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "id",
+ "metadata",
+ "transfer"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -69650,7 +76915,13 @@
],
"title": "TransferSchedule",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "delay_days",
+ "interval",
+ "monthly_anchor",
+ "weekly_anchor"
+ ]
},
"transform_quantity": {
"description": "",
@@ -69674,7 +76945,11 @@
],
"title": "TransformQuantity",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "divide_by",
+ "round"
+ ]
},
"transform_usage": {
"description": "",
@@ -69698,7 +76973,11 @@
],
"title": "TransformUsage",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "divide_by",
+ "round"
+ ]
},
"treasury.credit_reversal": {
"description": "You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.",
@@ -69820,6 +77099,22 @@
"transaction"
],
"x-resourceId": "treasury.credit_reversal",
+ "x-stripeMostCommon": [
+ "amount",
+ "created",
+ "currency",
+ "financial_account",
+ "hosted_regulatory_receipt_url",
+ "id",
+ "livemode",
+ "metadata",
+ "network",
+ "object",
+ "received_credit",
+ "status",
+ "status_transitions",
+ "transaction"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -70013,6 +77308,23 @@
"transaction"
],
"x-resourceId": "treasury.debit_reversal",
+ "x-stripeMostCommon": [
+ "amount",
+ "created",
+ "currency",
+ "financial_account",
+ "hosted_regulatory_receipt_url",
+ "id",
+ "linked_flows",
+ "livemode",
+ "metadata",
+ "network",
+ "object",
+ "received_debit",
+ "status",
+ "status_transitions",
+ "transaction"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -70262,6 +77574,25 @@
"status_details"
],
"x-resourceId": "treasury.financial_account",
+ "x-stripeMostCommon": [
+ "active_features",
+ "balance",
+ "country",
+ "created",
+ "display_name",
+ "features",
+ "financial_addresses",
+ "id",
+ "livemode",
+ "metadata",
+ "object",
+ "pending_features",
+ "platform_restrictions",
+ "restricted_features",
+ "status",
+ "status_details",
+ "supported_currencies"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -70407,13 +77738,23 @@
"outbound_transfers"
],
"x-resourceId": "treasury.financial_account_features",
+ "x-stripeMostCommon": [
+ "card_issuing",
+ "deposit_insurance",
+ "financial_addresses",
+ "inbound_transfers",
+ "intra_stripe_flows",
+ "object",
+ "outbound_payments",
+ "outbound_transfers"
+ ],
"x-stripeResource": {
"class_name": "FinancialAccountFeatures",
"in_package": "Treasury"
}
},
"treasury.inbound_transfer": {
- "description": "Use [InboundTransfers](https://stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.",
+ "description": "Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.\n\nRelated guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)",
"properties": {
"amount": {
"description": "Amount (in cents) transferred.",
@@ -70575,6 +77916,28 @@
"transaction"
],
"x-resourceId": "treasury.inbound_transfer",
+ "x-stripeMostCommon": [
+ "amount",
+ "cancelable",
+ "created",
+ "currency",
+ "description",
+ "failure_details",
+ "financial_account",
+ "hosted_regulatory_receipt_url",
+ "id",
+ "linked_flows",
+ "livemode",
+ "metadata",
+ "object",
+ "origin_payment_method",
+ "origin_payment_method_details",
+ "returned",
+ "statement_descriptor",
+ "status",
+ "status_transitions",
+ "transaction"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -70697,7 +78060,7 @@
}
},
"treasury.outbound_payment": {
- "description": "Use OutboundPayments to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.",
+ "description": "Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)",
"properties": {
"amount": {
"description": "Amount (in cents) transferred.",
@@ -70884,6 +78247,30 @@
"transaction"
],
"x-resourceId": "treasury.outbound_payment",
+ "x-stripeMostCommon": [
+ "amount",
+ "cancelable",
+ "created",
+ "currency",
+ "customer",
+ "description",
+ "destination_payment_method",
+ "destination_payment_method_details",
+ "end_user_details",
+ "expected_arrival_date",
+ "financial_account",
+ "hosted_regulatory_receipt_url",
+ "id",
+ "livemode",
+ "metadata",
+ "object",
+ "returned_details",
+ "statement_descriptor",
+ "status",
+ "status_transitions",
+ "tracking_details",
+ "transaction"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -71061,7 +78448,7 @@
}
},
"treasury.outbound_transfer": {
- "description": "Use OutboundTransfers to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.",
+ "description": "Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)",
"properties": {
"amount": {
"description": "Amount (in cents) transferred.",
@@ -71234,6 +78621,29 @@
"transaction"
],
"x-resourceId": "treasury.outbound_transfer",
+ "x-stripeMostCommon": [
+ "amount",
+ "cancelable",
+ "created",
+ "currency",
+ "description",
+ "destination_payment_method",
+ "destination_payment_method_details",
+ "expected_arrival_date",
+ "financial_account",
+ "hosted_regulatory_receipt_url",
+ "id",
+ "livemode",
+ "metadata",
+ "network_details",
+ "object",
+ "returned_details",
+ "statement_descriptor",
+ "status",
+ "status_transitions",
+ "tracking_details",
+ "transaction"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -71563,6 +78973,25 @@
"transaction"
],
"x-resourceId": "treasury.received_credit",
+ "x-stripeMostCommon": [
+ "amount",
+ "created",
+ "currency",
+ "description",
+ "failure_code",
+ "financial_account",
+ "hosted_regulatory_receipt_url",
+ "id",
+ "initiating_payment_method_details",
+ "linked_flows",
+ "livemode",
+ "network",
+ "network_details",
+ "object",
+ "reversal_details",
+ "status",
+ "transaction"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -71791,6 +79220,25 @@
"transaction"
],
"x-resourceId": "treasury.received_debit",
+ "x-stripeMostCommon": [
+ "amount",
+ "created",
+ "currency",
+ "description",
+ "failure_code",
+ "financial_account",
+ "hosted_regulatory_receipt_url",
+ "id",
+ "initiating_payment_method_details",
+ "linked_flows",
+ "livemode",
+ "network",
+ "network_details",
+ "object",
+ "reversal_details",
+ "status",
+ "transaction"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -71899,6 +79347,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
},
"financial_account": {
@@ -71989,6 +79443,23 @@
"status_transitions"
],
"x-resourceId": "treasury.transaction",
+ "x-stripeMostCommon": [
+ "amount",
+ "balance_impact",
+ "created",
+ "currency",
+ "description",
+ "entries",
+ "financial_account",
+ "flow",
+ "flow_details",
+ "flow_type",
+ "id",
+ "livemode",
+ "object",
+ "status",
+ "status_transitions"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -72150,6 +79621,21 @@
"transaction"
],
"x-resourceId": "treasury.transaction_entry",
+ "x-stripeMostCommon": [
+ "balance_impact",
+ "created",
+ "currency",
+ "effective_at",
+ "financial_account",
+ "flow",
+ "flow_details",
+ "flow_type",
+ "id",
+ "livemode",
+ "object",
+ "transaction",
+ "type"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -72211,6 +79697,13 @@
"title": "TreasuryFinancialAccountsResourceABARecord",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "account_holder_name",
+ "account_number",
+ "account_number_last4",
+ "bank_name",
+ "routing_number"
+ ],
"x-stripeResource": {
"class_name": "Aba",
"in_package": ""
@@ -72250,6 +79743,11 @@
"x-expandableFields": [
"status_details"
],
+ "x-stripeMostCommon": [
+ "requested",
+ "status",
+ "status_details"
+ ],
"x-stripeResource": {
"class_name": "AbaToggleSettings",
"in_package": ""
@@ -72289,6 +79787,11 @@
"x-expandableFields": [
"status_details"
],
+ "x-stripeMostCommon": [
+ "requested",
+ "status",
+ "status_details"
+ ],
"x-stripeResource": {
"class_name": "AchToggleSettings",
"in_package": ""
@@ -72327,6 +79830,11 @@
"title": "TreasuryFinancialAccountsResourceBalance",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "cash",
+ "inbound_pending",
+ "outbound_pending"
+ ],
"x-stripeResource": {
"class_name": "Balance",
"in_package": ""
@@ -72354,6 +79862,9 @@
"title": "TreasuryFinancialAccountsResourceClosedStatusDetails",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "reasons"
+ ],
"x-stripeResource": {
"class_name": "Closed",
"in_package": ""
@@ -72393,6 +79904,11 @@
"type": "object",
"x-expandableFields": [
"aba"
+ ],
+ "x-stripeMostCommon": [
+ "aba",
+ "supported_networks",
+ "type"
]
},
"treasury_financial_accounts_resource_financial_addresses_features": {
@@ -72407,6 +79923,9 @@
"x-expandableFields": [
"aba"
],
+ "x-stripeMostCommon": [
+ "aba"
+ ],
"x-stripeResource": {
"class_name": "FinancialAddresses",
"in_package": ""
@@ -72424,6 +79943,9 @@
"x-expandableFields": [
"ach"
],
+ "x-stripeMostCommon": [
+ "ach"
+ ],
"x-stripeResource": {
"class_name": "InboundTransfers",
"in_package": ""
@@ -72445,6 +79967,10 @@
"ach",
"us_domestic_wire"
],
+ "x-stripeMostCommon": [
+ "ach",
+ "us_domestic_wire"
+ ],
"x-stripeResource": {
"class_name": "OutboundPayments",
"in_package": ""
@@ -72466,6 +79992,10 @@
"ach",
"us_domestic_wire"
],
+ "x-stripeMostCommon": [
+ "ach",
+ "us_domestic_wire"
+ ],
"x-stripeResource": {
"class_name": "OutboundTransfers",
"in_package": ""
@@ -72500,6 +80030,10 @@
"title": "TreasuryFinancialAccountsResourcePlatformRestrictions",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "inbound_flows",
+ "outbound_flows"
+ ],
"x-stripeResource": {
"class_name": "PlatformRestriction",
"in_package": ""
@@ -72526,6 +80060,9 @@
"x-expandableFields": [
"closed"
],
+ "x-stripeMostCommon": [
+ "closed"
+ ],
"x-stripeResource": {
"class_name": "StatusDetails",
"in_package": ""
@@ -72565,6 +80102,11 @@
"x-expandableFields": [
"status_details"
],
+ "x-stripeMostCommon": [
+ "requested",
+ "status",
+ "status_details"
+ ],
"x-stripeResource": {
"class_name": "ToggleSettings",
"in_package": ""
@@ -72617,6 +80159,11 @@
"title": "TreasuryFinancialAccountsResourceTogglesSettingStatusDetails",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "code",
+ "resolution",
+ "restriction"
+ ],
"x-stripeResource": {
"class_name": "StatusDetails",
"in_package": ""
@@ -72650,7 +80197,10 @@
],
"title": "TreasuryInboundTransfersResourceFailureDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "code"
+ ]
},
"treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows": {
"description": "",
@@ -72667,7 +80217,10 @@
],
"title": "TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "received_debit"
+ ]
},
"treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions": {
"description": "",
@@ -72698,6 +80251,11 @@
"title": "TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "canceled_at",
+ "failed_at",
+ "succeeded_at"
+ ],
"x-stripeResource": {
"class_name": "StatusTransitions",
"in_package": ""
@@ -72717,7 +80275,10 @@
],
"title": "TreasuryOutboundPaymentsResourceACHTrackingDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "trace_id"
+ ]
},
"treasury_outbound_payments_resource_outbound_payment_resource_end_user_details": {
"description": "",
@@ -72739,7 +80300,11 @@
],
"title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "ip_address",
+ "present"
+ ]
},
"treasury_outbound_payments_resource_outbound_payment_resource_status_transitions": {
"description": "",
@@ -72778,6 +80343,12 @@
"title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "canceled_at",
+ "failed_at",
+ "posted_at",
+ "returned_at"
+ ],
"x-stripeResource": {
"class_name": "StatusTransitions",
"in_package": ""
@@ -72809,6 +80380,11 @@
"x-expandableFields": [
"ach",
"us_domestic_wire"
+ ],
+ "x-stripeMostCommon": [
+ "ach",
+ "type",
+ "us_domestic_wire"
]
},
"treasury_outbound_payments_resource_returned_status": {
@@ -72858,6 +80434,10 @@
"type": "object",
"x-expandableFields": [
"transaction"
+ ],
+ "x-stripeMostCommon": [
+ "code",
+ "transaction"
]
},
"treasury_outbound_payments_resource_us_domestic_wire_tracking_details": {
@@ -72889,7 +80469,12 @@
],
"title": "TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "chips",
+ "imad",
+ "omad"
+ ]
},
"treasury_outbound_transfers_resource_ach_network_details": {
"description": "",
@@ -72906,7 +80491,10 @@
],
"title": "TreasuryOutboundTransfersResourceACHNetworkDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "addenda"
+ ]
},
"treasury_outbound_transfers_resource_ach_tracking_details": {
"description": "",
@@ -72922,7 +80510,10 @@
],
"title": "TreasuryOutboundTransfersResourceACHTrackingDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "trace_id"
+ ]
},
"treasury_outbound_transfers_resource_network_details": {
"description": "",
@@ -72952,6 +80543,10 @@
"x-expandableFields": [
"ach"
],
+ "x-stripeMostCommon": [
+ "ach",
+ "type"
+ ],
"x-stripeResource": {
"class_name": "NetworkDetails",
"in_package": ""
@@ -72983,6 +80578,11 @@
"x-expandableFields": [
"ach",
"us_domestic_wire"
+ ],
+ "x-stripeMostCommon": [
+ "ach",
+ "type",
+ "us_domestic_wire"
]
},
"treasury_outbound_transfers_resource_returned_details": {
@@ -73033,6 +80633,10 @@
"x-expandableFields": [
"transaction"
],
+ "x-stripeMostCommon": [
+ "code",
+ "transaction"
+ ],
"x-stripeResource": {
"class_name": "ReturnedDetails",
"in_package": ""
@@ -73075,6 +80679,12 @@
"title": "TreasuryOutboundTransfersResourceStatusTransitions",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "canceled_at",
+ "failed_at",
+ "posted_at",
+ "returned_at"
+ ],
"x-stripeResource": {
"class_name": "StatusTransitions",
"in_package": ""
@@ -73109,7 +80719,12 @@
],
"title": "TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "chips",
+ "imad",
+ "omad"
+ ]
},
"treasury_received_credits_resource_ach_network_details": {
"description": "",
@@ -73126,7 +80741,10 @@
],
"title": "TreasuryReceivedCreditsResourceACHNetworkDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "addenda"
+ ]
},
"treasury_received_credits_resource_linked_flows": {
"description": "",
@@ -73182,6 +80800,14 @@
"type": "object",
"x-expandableFields": [
"source_flow_details"
+ ],
+ "x-stripeMostCommon": [
+ "credit_reversal",
+ "issuing_authorization",
+ "issuing_transaction",
+ "source_flow",
+ "source_flow_details",
+ "source_flow_type"
]
},
"treasury_received_credits_resource_network_details": {
@@ -73211,6 +80837,10 @@
"type": "object",
"x-expandableFields": [
"ach"
+ ],
+ "x-stripeMostCommon": [
+ "ach",
+ "type"
]
},
"treasury_received_credits_resource_reversal_details": {
@@ -73241,7 +80871,11 @@
],
"title": "TreasuryReceivedCreditsResourceReversalDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "deadline",
+ "restricted_reason"
+ ]
},
"treasury_received_credits_resource_source_flows_details": {
"description": "",
@@ -73276,6 +80910,12 @@
"credit_reversal",
"outbound_payment",
"payout"
+ ],
+ "x-stripeMostCommon": [
+ "credit_reversal",
+ "outbound_payment",
+ "payout",
+ "type"
]
},
"treasury_received_credits_resource_status_transitions": {
@@ -73293,7 +80933,10 @@
],
"title": "TreasuryReceivedCreditsResourceStatusTransitions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "posted_at"
+ ]
},
"treasury_received_debits_resource_ach_network_details": {
"description": "",
@@ -73310,7 +80953,10 @@
],
"title": "TreasuryReceivedDebitsResourceACHNetworkDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "addenda"
+ ]
},
"treasury_received_debits_resource_debit_reversal_linked_flows": {
"description": "",
@@ -73327,7 +80973,10 @@
],
"title": "TreasuryReceivedDebitsResourceDebitReversalLinkedFlows",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "issuing_dispute"
+ ]
},
"treasury_received_debits_resource_linked_flows": {
"description": "",
@@ -73378,7 +81027,15 @@
],
"title": "TreasuryReceivedDebitsResourceLinkedFlows",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "debit_reversal",
+ "inbound_transfer",
+ "issuing_authorization",
+ "issuing_transaction",
+ "payout",
+ "received_credit_capital_withholding"
+ ]
},
"treasury_received_debits_resource_network_details": {
"description": "",
@@ -73408,6 +81065,10 @@
"type": "object",
"x-expandableFields": [
"ach"
+ ],
+ "x-stripeMostCommon": [
+ "ach",
+ "type"
]
},
"treasury_received_debits_resource_reversal_details": {
@@ -73438,7 +81099,11 @@
],
"title": "TreasuryReceivedDebitsResourceReversalDetails",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "deadline",
+ "restricted_reason"
+ ]
},
"treasury_received_debits_resource_status_transitions": {
"description": "",
@@ -73455,7 +81120,10 @@
],
"title": "TreasuryReceivedDebitsResourceStatusTransitions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "completed_at"
+ ]
},
"treasury_shared_resource_billing_details": {
"description": "",
@@ -73486,6 +81154,11 @@
"x-expandableFields": [
"address"
],
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name"
+ ],
"x-stripeResource": {
"class_name": "BillingDetails",
"in_package": ""
@@ -73538,6 +81211,14 @@
"billing_details",
"financial_account",
"us_bank_account"
+ ],
+ "x-stripeMostCommon": [
+ "balance",
+ "billing_details",
+ "financial_account",
+ "issuing_card",
+ "type",
+ "us_bank_account"
]
},
"treasury_shared_resource_initiating_payment_method_details_us_bank_account": {
@@ -73570,6 +81251,11 @@
"title": "TreasurySharedResourceInitiatingPaymentMethodDetailsUSBankAccount",
"type": "object",
"x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "bank_name",
+ "last4",
+ "routing_number"
+ ],
"x-stripeResource": {
"class_name": "UsBankAccount",
"in_package": ""
@@ -73597,7 +81283,11 @@
],
"title": "TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitions",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "posted_at",
+ "void_at"
+ ]
},
"treasury_transactions_resource_balance_impact": {
"description": "Change to a FinancialAccount's balance",
@@ -73622,7 +81312,12 @@
],
"title": "TreasuryTransactionsResourceBalanceImpact",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "cash",
+ "inbound_pending",
+ "outbound_pending"
+ ]
},
"treasury_transactions_resource_flow_details": {
"description": "",
@@ -73681,6 +81376,17 @@
"outbound_transfer",
"received_credit",
"received_debit"
+ ],
+ "x-stripeMostCommon": [
+ "credit_reversal",
+ "debit_reversal",
+ "inbound_transfer",
+ "issuing_authorization",
+ "outbound_payment",
+ "outbound_transfer",
+ "received_credit",
+ "received_debit",
+ "type"
]
},
"us_bank_account_networks": {
@@ -73710,7 +81416,11 @@
],
"title": "us_bank_account_networks",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "preferred",
+ "supported"
+ ]
},
"usage_record": {
"description": "Usage records allow you to report customer usage and metrics to Stripe for\nmetered billing of subscription prices.\n\nRelated guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)\n\nThis is our legacy usage-based billing API. See the [updated usage-based billing docs](https://docs.stripe.com/billing/subscriptions/usage-based).",
@@ -73758,6 +81468,12 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "usage_record",
+ "x-stripeMostCommon": [
+ "id",
+ "quantity",
+ "subscription_item",
+ "timestamp"
+ ],
"x-stripeOperations": [
{
"method_name": "create",
@@ -73825,6 +81541,15 @@
"period"
],
"x-resourceId": "usage_record_summary",
+ "x-stripeMostCommon": [
+ "id",
+ "invoice",
+ "livemode",
+ "object",
+ "period",
+ "subscription_item",
+ "total_usage"
+ ],
"x-stripeOperations": [
{
"method_name": "list",
@@ -73857,7 +81582,10 @@
],
"title": "verification_session_redaction",
"type": "object",
- "x-expandableFields": []
+ "x-expandableFields": [],
+ "x-stripeMostCommon": [
+ "status"
+ ]
},
"webhook_endpoint": {
"description": "You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure)",
@@ -73950,6 +81678,15 @@
"type": "object",
"x-expandableFields": [],
"x-resourceId": "webhook_endpoint",
+ "x-stripeMostCommon": [
+ "api_version",
+ "description",
+ "enabled_events",
+ "id",
+ "metadata",
+ "status",
+ "url"
+ ],
"x-stripeOperations": [
{
"method_name": "delete",
@@ -74017,7 +81754,7 @@
"description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.",
"termsOfService": "https://stripe.com/us/terms/",
"title": "Stripe API",
- "version": "2024-06-20; embedded_connect_beta=v2; server_side_confirmation_beta=v1; orders_beta=v4; gift_cards_beta=v1; unified_accounts_beta=v1; terminal_collect_inputs_beta=v1; terminal_collect_confirm_beta=v1; retrieve_tax_forms_beta=v1; financial_connections_transactions_beta=v1; invoice_partial_payments_beta=v2; invoice_payment_plans_beta=v1; payment_intent_with_tax_api_beta=v1; custom_checkout_beta=v1",
+ "version": "2024-06-20; embedded_connect_beta=v2; server_side_confirmation_beta=v1; orders_beta=v4; gift_cards_beta=v1; unified_accounts_beta=v1; terminal_collect_inputs_beta=v1; terminal_collect_confirm_beta=v1; retrieve_tax_forms_beta=v1; checkout_server_update_beta=v1; financial_connections_transactions_beta=v1; invoice_partial_payments_beta=v2; invoice_payment_plans_beta=v1; payment_intent_with_tax_api_beta=v1; custom_checkout_beta=v1",
"x-stripeSpecFilename": "spec3.beta.sdk"
},
"openapi": "3.0.0",
@@ -74133,11 +81870,12 @@
"type": "string"
}
},
- "required": [
- "fields"
- ],
"title": "collection_options_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fields",
+ "future_requirements"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -74171,7 +81909,13 @@
"account",
"type"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "refresh_url",
+ "return_url",
+ "type"
+ ]
}
}
},
@@ -74318,6 +82062,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -74463,7 +82213,12 @@
"subject"
],
"title": "email_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "plain_text",
+ "recipient",
+ "subject"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -74490,7 +82245,12 @@
"email",
"sent_at"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "metadata",
+ "sent_at"
+ ]
}
}
},
@@ -74563,14 +82323,21 @@
}
},
"title": "account_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "external_account_collection"
+ ]
}
},
"required": [
"enabled"
],
"title": "account_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"account_onboarding": {
"description": "Configuration for the account onboarding embedded component.",
@@ -74588,14 +82355,21 @@
}
},
"title": "account_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "external_account_collection"
+ ]
}
},
"required": [
"enabled"
],
"title": "account_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"app_install": {
"description": "Configuration for the app install component.",
@@ -74627,14 +82401,21 @@
}
},
"title": "app_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allowed_apps"
+ ]
}
},
"required": [
"enabled"
],
"title": "app_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"app_viewport": {
"description": "Configuration for the app viewport component.",
@@ -74666,14 +82447,21 @@
}
},
"title": "app_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allowed_apps"
+ ]
}
},
"required": [
"enabled"
],
"title": "app_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"balances": {
"description": "Configuration for the balances embedded component.",
@@ -74703,16 +82491,75 @@
}
},
"title": "payouts_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "edit_payout_schedule",
+ "external_account_collection",
+ "instant_payouts",
+ "standard_payouts"
+ ]
}
},
"required": [
"enabled"
],
"title": "payouts_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
+ },
+ "capital_financing": {
+ "description": "Configuration for the capital financing embedded component.",
+ "properties": {
+ "enabled": {
+ "description": "Whether the embedded component is enabled.",
+ "type": "boolean"
+ },
+ "features": {
+ "description": "The list of features enabled in the embedded component.",
+ "properties": {},
+ "title": "base_features_param",
+ "type": "object"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "base_config_param",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
+ },
+ "capital_financing_application": {
+ "description": "Configuration for the capital financing application embedded component.",
+ "properties": {
+ "enabled": {
+ "description": "Whether the embedded component is enabled.",
+ "type": "boolean"
+ },
+ "features": {
+ "description": "The list of features enabled in the embedded component.",
+ "properties": {},
+ "title": "base_features_param",
+ "type": "object"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "base_config_param",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"capital_financing_promotion": {
+ "description": "Configuration for the capital financing promotion embedded component.",
"properties": {
"enabled": {
"description": "Whether the embedded component is enabled.",
@@ -74729,7 +82576,11 @@
"enabled"
],
"title": "base_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"capital_overview": {
"description": "Configuration for the capital overview embedded component.",
@@ -74749,7 +82600,11 @@
"enabled"
],
"title": "base_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"documents": {
"description": "Configuration for the documents embedded component.",
@@ -74769,7 +82624,11 @@
"enabled"
],
"title": "base_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"financial_account": {
"description": "Configuration for the financial account component.",
@@ -74790,14 +82649,22 @@
}
},
"title": "financial_account_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "external_account_collection",
+ "money_movement"
+ ]
}
},
"required": [
"enabled"
],
"title": "financial_account_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"financial_account_transactions": {
"description": "Configuration for the financial account transactions component.",
@@ -74814,14 +82681,21 @@
}
},
"title": "financial_account_transactions_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "card_spend_dispute_management"
+ ]
}
},
"required": [
"enabled"
],
"title": "financial_account_transactions_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"issuing_card": {
"description": "Configuration for the issuing card component.",
@@ -74833,15 +82707,19 @@
"features": {
"description": "The list of features enabled in the embedded component.",
"properties": {},
- "title": "base_features_param",
+ "title": "issuing_card_features_param",
"type": "object"
}
},
"required": [
"enabled"
],
- "title": "base_config_param",
- "type": "object"
+ "title": "issuing_card_config_param",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"issuing_cards_list": {
"description": "Configuration for the issuing cards list component.",
@@ -74863,14 +82741,22 @@
}
},
"title": "issuing_cards_list_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "card_management",
+ "cardholder_management"
+ ]
}
},
"required": [
"enabled"
],
"title": "issuing_cards_list_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"notification_banner": {
"description": "Configuration for the notification banner embedded component.",
@@ -74888,14 +82774,21 @@
}
},
"title": "account_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "external_account_collection"
+ ]
}
},
"required": [
"enabled"
],
"title": "account_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"payment_details": {
"description": "Configuration for the payment details embedded component.",
@@ -74925,14 +82818,24 @@
}
},
"title": "payments_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_payments",
+ "destination_on_behalf_of_charge_management",
+ "dispute_management",
+ "refund_management"
+ ]
}
},
"required": [
"enabled"
],
"title": "payments_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"payment_method_settings": {
"description": "Configuration for the payment method settings embedded component.",
@@ -74952,7 +82855,11 @@
"enabled"
],
"title": "base_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"payments": {
"description": "Configuration for the payments embedded component.",
@@ -74982,14 +82889,24 @@
}
},
"title": "payments_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_payments",
+ "destination_on_behalf_of_charge_management",
+ "dispute_management",
+ "refund_management"
+ ]
}
},
"required": [
"enabled"
],
"title": "payments_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"payouts": {
"description": "Configuration for the payouts embedded component.",
@@ -75019,14 +82936,24 @@
}
},
"title": "payouts_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "edit_payout_schedule",
+ "external_account_collection",
+ "instant_payouts",
+ "standard_payouts"
+ ]
}
},
"required": [
"enabled"
],
"title": "payouts_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"payouts_list": {
"description": "Configuration for the payouts list embedded component.",
@@ -75046,7 +82973,34 @@
"enabled"
],
"title": "base_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
+ },
+ "recipients": {
+ "properties": {
+ "enabled": {
+ "description": "Whether the embedded component is enabled.",
+ "type": "boolean"
+ },
+ "features": {
+ "description": "The list of features enabled in the embedded component.",
+ "properties": {},
+ "title": "base_features_param",
+ "type": "object"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "base_config_param",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"tax_registrations": {
"description": "Configuration for the tax registrations embedded component.",
@@ -75066,7 +83020,11 @@
"enabled"
],
"title": "base_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"tax_settings": {
"description": "Configuration for the tax settings embedded component.",
@@ -75086,11 +83044,40 @@
"enabled"
],
"title": "base_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
}
},
"title": "account_session_create_components_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_management",
+ "account_onboarding",
+ "app_install",
+ "app_viewport",
+ "balances",
+ "capital_financing",
+ "capital_financing_application",
+ "capital_financing_promotion",
+ "capital_overview",
+ "documents",
+ "financial_account",
+ "financial_account_transactions",
+ "issuing_card",
+ "issuing_cards_list",
+ "notification_banner",
+ "payment_details",
+ "payment_method_settings",
+ "payments",
+ "payouts",
+ "payouts_list",
+ "recipients",
+ "tax_registrations",
+ "tax_settings"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -75105,7 +83092,11 @@
"account",
"components"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "components"
+ ]
}
}
},
@@ -75168,7 +83159,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -75277,6 +83274,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -75381,7 +83384,12 @@
"fiscal_year_end"
],
"title": "annual_revenue_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "fiscal_year_end"
+ ]
},
"estimated_worker_count": {
"description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.",
@@ -75409,7 +83417,11 @@
"currency"
],
"title": "monthly_estimated_revenue_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency"
+ ]
},
"name": {
"description": "The customer-facing business name.",
@@ -75456,7 +83468,15 @@
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"support_email": {
"description": "A publicly available email address for sending support issues to.",
@@ -75487,7 +83507,26 @@
}
},
"title": "business_profile_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "annual_revenue",
+ "estimated_worker_count",
+ "industry",
+ "mcc",
+ "monthly_estimated_revenue",
+ "name",
+ "payment_collection_methods",
+ "privacy_policy_url",
+ "product_description",
+ "singapore_account_activity_survey",
+ "specified_commercial_transactions_act_url",
+ "support_address",
+ "support_email",
+ "support_phone",
+ "support_url",
+ "terms_of_service_url",
+ "url"
+ ]
},
"business_type": {
"description": "The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
@@ -75512,7 +83551,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"affirm_payments": {
"description": "The affirm_payments capability.",
@@ -75523,7 +83565,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"afterpay_clearpay_payments": {
"description": "The afterpay_clearpay_payments capability.",
@@ -75534,7 +83579,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"amazon_pay_payments": {
"description": "The amazon_pay_payments capability.",
@@ -75545,7 +83593,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"au_becs_debit_payments": {
"description": "The au_becs_debit_payments capability.",
@@ -75556,7 +83607,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"bacs_debit_payments": {
"description": "The bacs_debit_payments capability.",
@@ -75567,7 +83621,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"bancontact_payments": {
"description": "The bancontact_payments capability.",
@@ -75578,7 +83635,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"bank_transfer_payments": {
"description": "The bank_transfer_payments capability.",
@@ -75589,7 +83649,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"blik_payments": {
"description": "The blik_payments capability.",
@@ -75600,7 +83663,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"boleto_payments": {
"description": "The boleto_payments capability.",
@@ -75611,7 +83677,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"card_issuing": {
"description": "The card_issuing capability.",
@@ -75622,7 +83691,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"card_payments": {
"description": "The card_payments capability.",
@@ -75633,7 +83705,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"cartes_bancaires_payments": {
"description": "The cartes_bancaires_payments capability.",
@@ -75644,7 +83719,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"cashapp_payments": {
"description": "The cashapp_payments capability.",
@@ -75655,7 +83733,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"eps_payments": {
"description": "The eps_payments capability.",
@@ -75666,7 +83747,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"fpx_payments": {
"description": "The fpx_payments capability.",
@@ -75677,7 +83761,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"gb_bank_transfer_payments": {
"description": "The gb_bank_transfer_payments capability.",
@@ -75688,7 +83775,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"giropay_payments": {
"description": "The giropay_payments capability.",
@@ -75699,7 +83789,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"grabpay_payments": {
"description": "The grabpay_payments capability.",
@@ -75710,7 +83803,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"ideal_payments": {
"description": "The ideal_payments capability.",
@@ -75721,7 +83817,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"india_international_payments": {
"description": "The india_international_payments capability.",
@@ -75732,7 +83831,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"jcb_payments": {
"description": "The jcb_payments capability.",
@@ -75743,7 +83845,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"jp_bank_transfer_payments": {
"description": "The jp_bank_transfer_payments capability.",
@@ -75754,7 +83859,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"klarna_payments": {
"description": "The klarna_payments capability.",
@@ -75765,7 +83873,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"konbini_payments": {
"description": "The konbini_payments capability.",
@@ -75776,7 +83887,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"legacy_payments": {
"description": "The legacy_payments capability.",
@@ -75787,7 +83901,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"link_payments": {
"description": "The link_payments capability.",
@@ -75798,7 +83915,24 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
+ },
+ "mb_way_payments": {
+ "description": "The mb_way_payments capability.",
+ "properties": {
+ "requested": {
+ "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
+ "type": "boolean"
+ }
+ },
+ "title": "capability_param",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"mobilepay_payments": {
"description": "The mobilepay_payments capability.",
@@ -75809,7 +83943,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"multibanco_payments": {
"description": "The multibanco_payments capability.",
@@ -75820,7 +83957,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"mx_bank_transfer_payments": {
"description": "The mx_bank_transfer_payments capability.",
@@ -75831,7 +83971,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"oxxo_payments": {
"description": "The oxxo_payments capability.",
@@ -75842,7 +83985,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"p24_payments": {
"description": "The p24_payments capability.",
@@ -75853,7 +83999,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"paynow_payments": {
"description": "The paynow_payments capability.",
@@ -75864,7 +84013,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"paypal_payments": {
"description": "The paypal_payments capability.",
@@ -75875,7 +84027,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"payto_payments": {
"description": "The payto_payments capability.",
@@ -75886,7 +84041,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"promptpay_payments": {
"description": "The promptpay_payments capability.",
@@ -75897,7 +84055,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"rechnung_payments": {
"description": "The rechnung_payments capability.",
@@ -75908,7 +84069,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"revolut_pay_payments": {
"description": "The revolut_pay_payments capability.",
@@ -75919,7 +84083,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"sepa_bank_transfer_payments": {
"description": "The sepa_bank_transfer_payments capability.",
@@ -75930,7 +84097,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"sepa_debit_payments": {
"description": "The sepa_debit_payments capability.",
@@ -75941,7 +84111,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"sofort_payments": {
"description": "The sofort_payments capability.",
@@ -75952,7 +84125,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"swish_payments": {
"description": "The swish_payments capability.",
@@ -75963,7 +84139,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"tax_reporting_us_1099_k": {
"description": "The tax_reporting_us_1099_k capability.",
@@ -75974,7 +84153,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"tax_reporting_us_1099_misc": {
"description": "The tax_reporting_us_1099_misc capability.",
@@ -75985,7 +84167,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"transfers": {
"description": "The transfers capability.",
@@ -75996,7 +84181,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"treasury": {
"description": "The treasury capability.",
@@ -76007,7 +84195,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"twint_payments": {
"description": "The twint_payments capability.",
@@ -76018,7 +84209,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"us_bank_account_ach_payments": {
"description": "The us_bank_account_ach_payments capability.",
@@ -76029,7 +84223,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"us_bank_transfer_payments": {
"description": "The us_bank_transfer_payments capability.",
@@ -76040,7 +84237,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"zip_payments": {
"description": "The zip_payments capability.",
@@ -76051,11 +84251,125 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
}
},
"title": "capabilities_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach_debit_payments",
+ "acss_debit_payments",
+ "affirm_payments",
+ "afterpay_clearpay_payments",
+ "alipay_payments",
+ "alma_payments",
+ "amazon_pay_payments",
+ "apple_pay_later_payments",
+ "au_bank_transfer_payments",
+ "au_becs_debit_payments",
+ "bacs_debit_payments",
+ "bacs_debit_stripe_sun_payments",
+ "bancontact_payments",
+ "bank_transfer_payments",
+ "beneficiary_transfers",
+ "billie_payments",
+ "bizum_payments",
+ "blik_payments",
+ "boleto_payments",
+ "ca_bank_transfer_payments",
+ "capchase_pay_payments",
+ "card_issuing",
+ "card_issuing_charge_card",
+ "card_issuing_charge_card_stripe",
+ "card_issuing_spend_card_cross_river",
+ "card_payments",
+ "cartes_bancaires_payments",
+ "cash_advances",
+ "cashapp_payments",
+ "crypto_payments",
+ "crypto_transfers",
+ "demo_pay_payments",
+ "duitnow_payments",
+ "dummy_passthrough_card_payments",
+ "eps_payments",
+ "fpx_payments",
+ "funding_credit",
+ "gb_bank_transfer_payments",
+ "giropay_payments",
+ "gopay_payments",
+ "grabpay_payments",
+ "id_bank_transfer_payments",
+ "id_bank_transfer_payments_bca",
+ "id_credit_transfer_payments",
+ "ideal_payments",
+ "india_international_payments",
+ "jcb_payments",
+ "jp_bank_transfer_payments",
+ "kakao_pay_payments",
+ "klarna_payments",
+ "konbini_payments",
+ "kr_card_payments",
+ "kr_market_payments",
+ "kriya_payments",
+ "legacy_payments",
+ "link_payments",
+ "loans",
+ "mb_way_payments",
+ "meta_pay_payments",
+ "mobilepay_payments",
+ "mondu_payments",
+ "multibanco_payments",
+ "mx_bank_transfer_payments",
+ "naver_pay_payments",
+ "netbanking_payments",
+ "ng_bank_payments",
+ "ng_bank_transfer_payments",
+ "ng_card_payments",
+ "ng_market_payments",
+ "ng_ussd_payments",
+ "nz_bank_account_becs_debit_payments",
+ "nz_bank_transfer_payments",
+ "oxxo_payments",
+ "p24_payments",
+ "pay_by_bank_payments",
+ "payco_payments",
+ "payments",
+ "paynow_payments",
+ "paypal_payments",
+ "payto_payments",
+ "pix_payments",
+ "promptpay_payments",
+ "qris_payments",
+ "rechnung_payments",
+ "revolut_pay_payments",
+ "samsung_pay_payments",
+ "satispay_payments",
+ "sepa_bank_transfer_payments",
+ "sepa_debit_payments",
+ "sequra_payments",
+ "shopeepay_payments",
+ "sofort_payments",
+ "south_korea_market_payments",
+ "submerchant_payments",
+ "sunbit_payments",
+ "swish_payments",
+ "tax_reporting_us_1099_k",
+ "tax_reporting_us_1099_misc",
+ "transfers",
+ "treasury",
+ "treasury_evolve",
+ "treasury_fifth_third",
+ "treasury_goldman_sachs",
+ "twint_payments",
+ "upi_payments",
+ "us_bank_account_ach_payments",
+ "us_bank_transfer_payments",
+ "wechat_pay_payments",
+ "zip_payments"
+ ]
},
"company": {
"description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
@@ -76095,7 +84409,15 @@
}
},
"title": "legal_entity_and_kyc_address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"address_kana": {
"description": "The Kana variation of the company's primary address (Japan only).",
@@ -76137,7 +84459,17 @@
}
},
"title": "japan_address_kana_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"address_kanji": {
"description": "The Kanji variation of the company's primary address (Japan only).",
@@ -76179,7 +84511,17 @@
}
},
"title": "japan_address_kanji_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"directors_provided": {
"description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/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.",
@@ -76237,7 +84579,12 @@
}
},
"title": "company_ownership_declaration",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
},
"phone": {
"description": "The company's phone number (used for verification).",
@@ -76313,15 +84660,53 @@
}
},
"title": "verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
}
},
"title": "verification_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "document"
+ ]
}
},
"title": "company_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "address_kana",
+ "address_kanji",
+ "contact_point_verification_address",
+ "cross_border_transaction_classifications",
+ "directors_provided",
+ "executives_provided",
+ "export_license_id",
+ "export_purpose_code",
+ "fiscal_code",
+ "invoicing_recipient_code",
+ "name",
+ "name_kana",
+ "name_kanji",
+ "owners_provided",
+ "ownership_declaration",
+ "pan",
+ "phone",
+ "registered_email",
+ "registration_date",
+ "registration_number",
+ "stock_data",
+ "structure",
+ "tax_deduction_account_number",
+ "tax_id",
+ "tax_id_registrar",
+ "vat_id",
+ "vat_registration_status",
+ "verification"
+ ]
},
"controller": {
"description": "A hash of configuration describing the account controller's attributes.",
@@ -76346,7 +84731,12 @@
"loss_liable"
],
"title": "controller_application_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "loss_liable",
+ "onboarding_owner",
+ "pricing_controls"
+ ]
},
"dashboard": {
"description": "Properties of the account's dashboard.",
@@ -76362,7 +84752,10 @@
}
},
"title": "controller_dashboard_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"fees": {
"description": "A hash of configuration for who pays Stripe fees for product usage on this account.",
@@ -76377,7 +84770,10 @@
}
},
"title": "controller_fees_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payer"
+ ]
},
"losses": {
"description": "A hash of configuration for products that have negative balance liability, and whether Stripe or a Connect application is responsible for them.",
@@ -76392,7 +84788,10 @@
}
},
"title": "controller_losses_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payments"
+ ]
},
"requirement_collection": {
"description": "A value indicating responsibility for collecting updated information when requirements on the account are due or change. Defaults to `stripe`.",
@@ -76416,11 +84815,22 @@
}
},
"title": "controller_dashboard_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
}
},
"title": "controller_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "application",
+ "dashboard",
+ "fees",
+ "losses",
+ "requirement_collection",
+ "stripe_dashboard"
+ ]
},
"country": {
"description": "The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported.",
@@ -76435,7 +84845,7 @@
"description": "Documents that may be submitted to satisfy various informational requests.",
"properties": {
"bank_account_ownership_verification": {
- "description": "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a voided check.",
+ "description": "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.",
"properties": {
"files": {
"description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.",
@@ -76447,7 +84857,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"company_license": {
"description": "One or more documents that demonstrate proof of a company's license to operate.",
@@ -76462,7 +84875,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"company_memorandum_of_association": {
"description": "One or more documents showing the company's Memorandum of Association.",
@@ -76477,7 +84893,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"company_ministerial_decree": {
"description": "(Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.",
@@ -76492,7 +84911,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"company_registration_verification": {
"description": "One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.",
@@ -76507,7 +84929,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"company_tax_id_verification": {
"description": "One or more documents that demonstrate proof of a company's tax ID.",
@@ -76522,7 +84947,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"proof_of_registration": {
"description": "One or more documents showing the company’s proof of registration with the national business registry.",
@@ -76537,11 +84965,25 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
}
},
"title": "documents_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank_account_ownership_verification",
+ "company_address_verification",
+ "company_license",
+ "company_memorandum_of_association",
+ "company_ministerial_decree",
+ "company_registration_verification",
+ "company_tax_id_verification",
+ "company_vat_id_verification",
+ "proof_of_registration"
+ ]
},
"email": {
"description": "The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.",
@@ -76599,7 +85041,15 @@
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"address_kana": {
"description": "The Kana variation of the individual's primary address (Japan only).",
@@ -76641,7 +85091,17 @@
}
},
"title": "japan_address_kana_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"address_kanji": {
"description": "The Kanji variation of the individual's primary address (Japan only).",
@@ -76683,7 +85143,17 @@
}
},
"title": "japan_address_kanji_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"dob": {
"anyOf": [
@@ -76708,7 +85178,12 @@
"year"
],
"title": "date_of_birth_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
{
"enum": [
@@ -76854,7 +85329,15 @@
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"relationship": {
"description": "Describes the person’s relationship to the account.",
@@ -76892,7 +85375,17 @@
}
},
"title": "individual_relationship_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "controller",
+ "director",
+ "executive",
+ "officer",
+ "owner",
+ "partner",
+ "percent_ownership",
+ "title"
+ ]
},
"ssn_last_4": {
"description": "The last four digits of the individual's Social Security Number (U.S. only).",
@@ -76917,7 +85410,11 @@
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
},
"document": {
"description": "An identifying document, either a passport or local ID card.",
@@ -76934,15 +85431,50 @@
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
}
},
"title": "person_verification_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_document",
+ "document"
+ ]
}
},
"title": "individual_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "address_kana",
+ "address_kanji",
+ "birth_city",
+ "birth_country",
+ "dob",
+ "email",
+ "first_name",
+ "first_name_kana",
+ "first_name_kanji",
+ "full_name_aliases",
+ "gender",
+ "id_number",
+ "id_number_secondary",
+ "last_name",
+ "last_name_kana",
+ "last_name_kanji",
+ "maiden_name",
+ "metadata",
+ "phone",
+ "political_exposure",
+ "registered_address",
+ "relationship",
+ "ssn_last_4",
+ "verification"
+ ]
},
"metadata": {
"anyOf": [
@@ -76973,7 +85505,10 @@
}
},
"title": "risk_control_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "pause_requested"
+ ]
},
"payouts": {
"description": "Represents the risk control status of payouts. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).",
@@ -76984,11 +85519,18 @@
}
},
"title": "risk_control_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "pause_requested"
+ ]
}
},
"title": "risk_controls_hash_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "charges",
+ "payouts"
+ ]
},
"settings": {
"description": "Options for customizing how the account functions within Stripe.",
@@ -77002,7 +85544,10 @@
}
},
"title": "bacs_debit_payments_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_name"
+ ]
},
"branding": {
"description": "Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.",
@@ -77029,7 +85574,14 @@
}
},
"title": "branding_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "icon",
+ "logo",
+ "primary_color",
+ "secondary_color",
+ "show_support_phone"
+ ]
},
"capital": {
"description": "Settings specific to the account's use of the Capital product.",
@@ -77055,7 +85607,11 @@
}
},
"title": "capital_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payout_destination",
+ "payout_destination_selector"
+ ]
},
"card_issuing": {
"description": "Settings specific to the account's use of the Card Issuing product.",
@@ -77089,11 +85645,20 @@
}
},
"title": "settings_terms_of_service_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
}
},
"title": "card_issuing_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tos_acceptance",
+ "tos_acceptances"
+ ]
},
"card_payments": {
"description": "Settings specific to card charging on the account.",
@@ -77111,7 +85676,11 @@
}
},
"title": "decline_charge_on_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "avs_failure",
+ "cvc_failure"
+ ]
},
"statement_descriptor_prefix": {
"description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.",
@@ -77150,7 +85719,14 @@
}
},
"title": "card_payments_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "decline_on",
+ "onboarding_policy",
+ "statement_descriptor_prefix",
+ "statement_descriptor_prefix_kana",
+ "statement_descriptor_prefix_kanji"
+ ]
},
"payments": {
"description": "Settings that apply across payment methods for charging on the account.",
@@ -77172,7 +85748,12 @@
}
},
"title": "payments_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "statement_descriptor",
+ "statement_descriptor_kana",
+ "statement_descriptor_kanji"
+ ]
},
"payouts": {
"description": "Settings specific to the account's payouts.",
@@ -77231,7 +85812,15 @@
}
},
"title": "transfer_schedule_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "automatic",
+ "delay_days",
+ "interval",
+ "monthly_anchor",
+ "timezone",
+ "weekly_anchor"
+ ]
},
"statement_descriptor": {
"description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.",
@@ -77240,7 +85829,12 @@
}
},
"title": "payout_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "debit_negative_balances",
+ "schedule",
+ "statement_descriptor"
+ ]
},
"tax_forms": {
"description": "Settings specific to the account's tax forms.",
@@ -77251,7 +85845,10 @@
}
},
"title": "tax_form_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "consented_to_paperless_delivery"
+ ]
},
"treasury": {
"description": "Settings specific to the account's Treasury FinancialAccounts.",
@@ -77285,15 +85882,41 @@
}
},
"title": "settings_terms_of_service_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
}
},
"title": "treasury_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tos_acceptance"
+ ]
}
},
"title": "settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affirm_payments",
+ "apply_future_requirements",
+ "bacs_debit_payments",
+ "bank_bca_onboarding",
+ "branding",
+ "capital",
+ "card_issuing",
+ "card_issuing_charge_card",
+ "card_issuing_payout",
+ "card_payments",
+ "funding_credit",
+ "konbini_payments",
+ "payments",
+ "payouts",
+ "tax_forms",
+ "treasury"
+ ]
},
"tos_acceptance": {
"description": "Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.",
@@ -77319,7 +85942,13 @@
}
},
"title": "tos_acceptance_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "service_agreement",
+ "user_agent"
+ ]
},
"type": {
"description": "The type of Stripe account to create. May be one of `custom`, `express` or `standard`.",
@@ -77331,7 +85960,19 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "business_type",
+ "capabilities",
+ "company",
+ "controller",
+ "country",
+ "email",
+ "individual",
+ "metadata",
+ "tos_acceptance",
+ "type"
+ ]
}
}
},
@@ -77573,7 +86214,12 @@
"fiscal_year_end"
],
"title": "annual_revenue_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "fiscal_year_end"
+ ]
},
"estimated_worker_count": {
"description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.",
@@ -77601,7 +86247,11 @@
"currency"
],
"title": "monthly_estimated_revenue_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency"
+ ]
},
"name": {
"description": "The customer-facing business name.",
@@ -77648,7 +86298,15 @@
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"support_email": {
"description": "A publicly available email address for sending support issues to.",
@@ -77679,7 +86337,26 @@
}
},
"title": "business_profile_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "annual_revenue",
+ "estimated_worker_count",
+ "industry",
+ "mcc",
+ "monthly_estimated_revenue",
+ "name",
+ "payment_collection_methods",
+ "privacy_policy_url",
+ "product_description",
+ "singapore_account_activity_survey",
+ "specified_commercial_transactions_act_url",
+ "support_address",
+ "support_email",
+ "support_phone",
+ "support_url",
+ "terms_of_service_url",
+ "url"
+ ]
},
"business_type": {
"description": "The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
@@ -77704,7 +86381,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"affirm_payments": {
"description": "The affirm_payments capability.",
@@ -77715,7 +86395,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"afterpay_clearpay_payments": {
"description": "The afterpay_clearpay_payments capability.",
@@ -77726,7 +86409,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"amazon_pay_payments": {
"description": "The amazon_pay_payments capability.",
@@ -77737,7 +86423,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"au_becs_debit_payments": {
"description": "The au_becs_debit_payments capability.",
@@ -77748,7 +86437,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"bacs_debit_payments": {
"description": "The bacs_debit_payments capability.",
@@ -77759,7 +86451,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"bancontact_payments": {
"description": "The bancontact_payments capability.",
@@ -77770,7 +86465,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"bank_transfer_payments": {
"description": "The bank_transfer_payments capability.",
@@ -77781,7 +86479,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"blik_payments": {
"description": "The blik_payments capability.",
@@ -77792,7 +86493,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"boleto_payments": {
"description": "The boleto_payments capability.",
@@ -77803,7 +86507,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"card_issuing": {
"description": "The card_issuing capability.",
@@ -77814,7 +86521,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"card_payments": {
"description": "The card_payments capability.",
@@ -77825,7 +86535,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"cartes_bancaires_payments": {
"description": "The cartes_bancaires_payments capability.",
@@ -77836,7 +86549,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"cashapp_payments": {
"description": "The cashapp_payments capability.",
@@ -77847,7 +86563,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"eps_payments": {
"description": "The eps_payments capability.",
@@ -77858,7 +86577,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"fpx_payments": {
"description": "The fpx_payments capability.",
@@ -77869,7 +86591,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"gb_bank_transfer_payments": {
"description": "The gb_bank_transfer_payments capability.",
@@ -77880,7 +86605,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"giropay_payments": {
"description": "The giropay_payments capability.",
@@ -77891,7 +86619,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"grabpay_payments": {
"description": "The grabpay_payments capability.",
@@ -77902,7 +86633,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"ideal_payments": {
"description": "The ideal_payments capability.",
@@ -77913,7 +86647,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"india_international_payments": {
"description": "The india_international_payments capability.",
@@ -77924,7 +86661,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"jcb_payments": {
"description": "The jcb_payments capability.",
@@ -77935,7 +86675,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"jp_bank_transfer_payments": {
"description": "The jp_bank_transfer_payments capability.",
@@ -77946,7 +86689,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"klarna_payments": {
"description": "The klarna_payments capability.",
@@ -77957,7 +86703,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"konbini_payments": {
"description": "The konbini_payments capability.",
@@ -77968,7 +86717,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"legacy_payments": {
"description": "The legacy_payments capability.",
@@ -77979,7 +86731,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"link_payments": {
"description": "The link_payments capability.",
@@ -77990,7 +86745,24 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
+ },
+ "mb_way_payments": {
+ "description": "The mb_way_payments capability.",
+ "properties": {
+ "requested": {
+ "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
+ "type": "boolean"
+ }
+ },
+ "title": "capability_param",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"mobilepay_payments": {
"description": "The mobilepay_payments capability.",
@@ -78001,7 +86773,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"multibanco_payments": {
"description": "The multibanco_payments capability.",
@@ -78012,7 +86787,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"mx_bank_transfer_payments": {
"description": "The mx_bank_transfer_payments capability.",
@@ -78023,7 +86801,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"oxxo_payments": {
"description": "The oxxo_payments capability.",
@@ -78034,7 +86815,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"p24_payments": {
"description": "The p24_payments capability.",
@@ -78045,7 +86829,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"paynow_payments": {
"description": "The paynow_payments capability.",
@@ -78056,7 +86843,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"paypal_payments": {
"description": "The paypal_payments capability.",
@@ -78067,7 +86857,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"payto_payments": {
"description": "The payto_payments capability.",
@@ -78078,7 +86871,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"promptpay_payments": {
"description": "The promptpay_payments capability.",
@@ -78089,7 +86885,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"rechnung_payments": {
"description": "The rechnung_payments capability.",
@@ -78100,7 +86899,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"revolut_pay_payments": {
"description": "The revolut_pay_payments capability.",
@@ -78111,7 +86913,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"sepa_bank_transfer_payments": {
"description": "The sepa_bank_transfer_payments capability.",
@@ -78122,7 +86927,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"sepa_debit_payments": {
"description": "The sepa_debit_payments capability.",
@@ -78133,7 +86941,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"sofort_payments": {
"description": "The sofort_payments capability.",
@@ -78144,7 +86955,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"swish_payments": {
"description": "The swish_payments capability.",
@@ -78155,7 +86969,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"tax_reporting_us_1099_k": {
"description": "The tax_reporting_us_1099_k capability.",
@@ -78166,7 +86983,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"tax_reporting_us_1099_misc": {
"description": "The tax_reporting_us_1099_misc capability.",
@@ -78177,7 +86997,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"transfers": {
"description": "The transfers capability.",
@@ -78188,7 +87011,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"treasury": {
"description": "The treasury capability.",
@@ -78199,7 +87025,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"twint_payments": {
"description": "The twint_payments capability.",
@@ -78210,7 +87039,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"us_bank_account_ach_payments": {
"description": "The us_bank_account_ach_payments capability.",
@@ -78221,7 +87053,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"us_bank_transfer_payments": {
"description": "The us_bank_transfer_payments capability.",
@@ -78232,7 +87067,10 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"zip_payments": {
"description": "The zip_payments capability.",
@@ -78243,11 +87081,125 @@
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
}
},
"title": "capabilities_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach_debit_payments",
+ "acss_debit_payments",
+ "affirm_payments",
+ "afterpay_clearpay_payments",
+ "alipay_payments",
+ "alma_payments",
+ "amazon_pay_payments",
+ "apple_pay_later_payments",
+ "au_bank_transfer_payments",
+ "au_becs_debit_payments",
+ "bacs_debit_payments",
+ "bacs_debit_stripe_sun_payments",
+ "bancontact_payments",
+ "bank_transfer_payments",
+ "beneficiary_transfers",
+ "billie_payments",
+ "bizum_payments",
+ "blik_payments",
+ "boleto_payments",
+ "ca_bank_transfer_payments",
+ "capchase_pay_payments",
+ "card_issuing",
+ "card_issuing_charge_card",
+ "card_issuing_charge_card_stripe",
+ "card_issuing_spend_card_cross_river",
+ "card_payments",
+ "cartes_bancaires_payments",
+ "cash_advances",
+ "cashapp_payments",
+ "crypto_payments",
+ "crypto_transfers",
+ "demo_pay_payments",
+ "duitnow_payments",
+ "dummy_passthrough_card_payments",
+ "eps_payments",
+ "fpx_payments",
+ "funding_credit",
+ "gb_bank_transfer_payments",
+ "giropay_payments",
+ "gopay_payments",
+ "grabpay_payments",
+ "id_bank_transfer_payments",
+ "id_bank_transfer_payments_bca",
+ "id_credit_transfer_payments",
+ "ideal_payments",
+ "india_international_payments",
+ "jcb_payments",
+ "jp_bank_transfer_payments",
+ "kakao_pay_payments",
+ "klarna_payments",
+ "konbini_payments",
+ "kr_card_payments",
+ "kr_market_payments",
+ "kriya_payments",
+ "legacy_payments",
+ "link_payments",
+ "loans",
+ "mb_way_payments",
+ "meta_pay_payments",
+ "mobilepay_payments",
+ "mondu_payments",
+ "multibanco_payments",
+ "mx_bank_transfer_payments",
+ "naver_pay_payments",
+ "netbanking_payments",
+ "ng_bank_payments",
+ "ng_bank_transfer_payments",
+ "ng_card_payments",
+ "ng_market_payments",
+ "ng_ussd_payments",
+ "nz_bank_account_becs_debit_payments",
+ "nz_bank_transfer_payments",
+ "oxxo_payments",
+ "p24_payments",
+ "pay_by_bank_payments",
+ "payco_payments",
+ "payments",
+ "paynow_payments",
+ "paypal_payments",
+ "payto_payments",
+ "pix_payments",
+ "promptpay_payments",
+ "qris_payments",
+ "rechnung_payments",
+ "revolut_pay_payments",
+ "samsung_pay_payments",
+ "satispay_payments",
+ "sepa_bank_transfer_payments",
+ "sepa_debit_payments",
+ "sequra_payments",
+ "shopeepay_payments",
+ "sofort_payments",
+ "south_korea_market_payments",
+ "submerchant_payments",
+ "sunbit_payments",
+ "swish_payments",
+ "tax_reporting_us_1099_k",
+ "tax_reporting_us_1099_misc",
+ "transfers",
+ "treasury",
+ "treasury_evolve",
+ "treasury_fifth_third",
+ "treasury_goldman_sachs",
+ "twint_payments",
+ "upi_payments",
+ "us_bank_account_ach_payments",
+ "us_bank_transfer_payments",
+ "wechat_pay_payments",
+ "zip_payments"
+ ]
},
"company": {
"description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
@@ -78287,7 +87239,15 @@
}
},
"title": "legal_entity_and_kyc_address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"address_kana": {
"description": "The Kana variation of the company's primary address (Japan only).",
@@ -78329,7 +87289,17 @@
}
},
"title": "japan_address_kana_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"address_kanji": {
"description": "The Kanji variation of the company's primary address (Japan only).",
@@ -78371,7 +87341,17 @@
}
},
"title": "japan_address_kanji_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"directors_provided": {
"description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/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.",
@@ -78429,7 +87409,12 @@
}
},
"title": "company_ownership_declaration",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
},
"phone": {
"description": "The company's phone number (used for verification).",
@@ -78505,15 +87490,53 @@
}
},
"title": "verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
}
},
"title": "verification_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "document"
+ ]
}
},
"title": "company_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "address_kana",
+ "address_kanji",
+ "contact_point_verification_address",
+ "cross_border_transaction_classifications",
+ "directors_provided",
+ "executives_provided",
+ "export_license_id",
+ "export_purpose_code",
+ "fiscal_code",
+ "invoicing_recipient_code",
+ "name",
+ "name_kana",
+ "name_kanji",
+ "owners_provided",
+ "ownership_declaration",
+ "pan",
+ "phone",
+ "registered_email",
+ "registration_date",
+ "registration_number",
+ "stock_data",
+ "structure",
+ "tax_deduction_account_number",
+ "tax_id",
+ "tax_id_registrar",
+ "vat_id",
+ "vat_registration_status",
+ "verification"
+ ]
},
"default_currency": {
"description": "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).",
@@ -78523,7 +87546,7 @@
"description": "Documents that may be submitted to satisfy various informational requests.",
"properties": {
"bank_account_ownership_verification": {
- "description": "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a voided check.",
+ "description": "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.",
"properties": {
"files": {
"description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.",
@@ -78535,7 +87558,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"company_license": {
"description": "One or more documents that demonstrate proof of a company's license to operate.",
@@ -78550,7 +87576,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"company_memorandum_of_association": {
"description": "One or more documents showing the company's Memorandum of Association.",
@@ -78565,7 +87594,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"company_ministerial_decree": {
"description": "(Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.",
@@ -78580,7 +87612,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"company_registration_verification": {
"description": "One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.",
@@ -78595,7 +87630,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"company_tax_id_verification": {
"description": "One or more documents that demonstrate proof of a company's tax ID.",
@@ -78610,7 +87648,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"proof_of_registration": {
"description": "One or more documents showing the company’s proof of registration with the national business registry.",
@@ -78625,11 +87666,25 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
}
},
"title": "documents_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank_account_ownership_verification",
+ "company_address_verification",
+ "company_license",
+ "company_memorandum_of_association",
+ "company_ministerial_decree",
+ "company_registration_verification",
+ "company_tax_id_verification",
+ "company_vat_id_verification",
+ "proof_of_registration"
+ ]
},
"email": {
"description": "The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.",
@@ -78687,7 +87742,15 @@
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"address_kana": {
"description": "The Kana variation of the individual's primary address (Japan only).",
@@ -78729,7 +87792,17 @@
}
},
"title": "japan_address_kana_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"address_kanji": {
"description": "The Kanji variation of the individual's primary address (Japan only).",
@@ -78771,7 +87844,17 @@
}
},
"title": "japan_address_kanji_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"dob": {
"anyOf": [
@@ -78796,7 +87879,12 @@
"year"
],
"title": "date_of_birth_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
{
"enum": [
@@ -78942,7 +88030,15 @@
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"relationship": {
"description": "Describes the person’s relationship to the account.",
@@ -78980,7 +88076,17 @@
}
},
"title": "individual_relationship_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "controller",
+ "director",
+ "executive",
+ "officer",
+ "owner",
+ "partner",
+ "percent_ownership",
+ "title"
+ ]
},
"ssn_last_4": {
"description": "The last four digits of the individual's Social Security Number (U.S. only).",
@@ -79005,7 +88111,11 @@
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
},
"document": {
"description": "An identifying document, either a passport or local ID card.",
@@ -79022,15 +88132,50 @@
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
}
},
"title": "person_verification_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_document",
+ "document"
+ ]
}
},
"title": "individual_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "address_kana",
+ "address_kanji",
+ "birth_city",
+ "birth_country",
+ "dob",
+ "email",
+ "first_name",
+ "first_name_kana",
+ "first_name_kanji",
+ "full_name_aliases",
+ "gender",
+ "id_number",
+ "id_number_secondary",
+ "last_name",
+ "last_name_kana",
+ "last_name_kanji",
+ "maiden_name",
+ "metadata",
+ "phone",
+ "political_exposure",
+ "registered_address",
+ "relationship",
+ "ssn_last_4",
+ "verification"
+ ]
},
"metadata": {
"anyOf": [
@@ -79061,7 +88206,10 @@
}
},
"title": "risk_control_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "pause_requested"
+ ]
},
"payouts": {
"description": "Represents the risk control status of payouts. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).",
@@ -79072,11 +88220,18 @@
}
},
"title": "risk_control_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "pause_requested"
+ ]
}
},
"title": "risk_controls_hash_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "charges",
+ "payouts"
+ ]
},
"settings": {
"description": "Options for customizing how the account functions within Stripe.",
@@ -79090,7 +88245,10 @@
}
},
"title": "bacs_debit_payments_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_name"
+ ]
},
"branding": {
"description": "Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.",
@@ -79117,7 +88275,14 @@
}
},
"title": "branding_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "icon",
+ "logo",
+ "primary_color",
+ "secondary_color",
+ "show_support_phone"
+ ]
},
"capital": {
"description": "Settings specific to the account's use of the Capital product.",
@@ -79143,7 +88308,11 @@
}
},
"title": "capital_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payout_destination",
+ "payout_destination_selector"
+ ]
},
"card_issuing": {
"description": "Settings specific to the account's use of the Card Issuing product.",
@@ -79177,11 +88346,20 @@
}
},
"title": "settings_terms_of_service_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
}
},
"title": "card_issuing_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tos_acceptance",
+ "tos_acceptances"
+ ]
},
"card_payments": {
"description": "Settings specific to card charging on the account.",
@@ -79199,7 +88377,11 @@
}
},
"title": "decline_charge_on_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "avs_failure",
+ "cvc_failure"
+ ]
},
"statement_descriptor_prefix": {
"description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.",
@@ -79238,7 +88420,14 @@
}
},
"title": "card_payments_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "decline_on",
+ "onboarding_policy",
+ "statement_descriptor_prefix",
+ "statement_descriptor_prefix_kana",
+ "statement_descriptor_prefix_kanji"
+ ]
},
"invoices": {
"description": "Settings specific to the account's use of Invoices.",
@@ -79263,7 +88452,10 @@
}
},
"title": "invoices_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_account_tax_ids"
+ ]
},
"payments": {
"description": "Settings that apply across payment methods for charging on the account.",
@@ -79285,7 +88477,12 @@
}
},
"title": "payments_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "statement_descriptor",
+ "statement_descriptor_kana",
+ "statement_descriptor_kanji"
+ ]
},
"payouts": {
"description": "Settings specific to the account's payouts.",
@@ -79344,7 +88541,15 @@
}
},
"title": "transfer_schedule_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "automatic",
+ "delay_days",
+ "interval",
+ "monthly_anchor",
+ "timezone",
+ "weekly_anchor"
+ ]
},
"statement_descriptor": {
"description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.",
@@ -79353,7 +88558,12 @@
}
},
"title": "payout_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "debit_negative_balances",
+ "schedule",
+ "statement_descriptor"
+ ]
},
"tax_forms": {
"description": "Settings specific to the account's tax forms.",
@@ -79364,7 +88574,10 @@
}
},
"title": "tax_form_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "consented_to_paperless_delivery"
+ ]
},
"treasury": {
"description": "Settings specific to the account's Treasury FinancialAccounts.",
@@ -79398,15 +88611,42 @@
}
},
"title": "settings_terms_of_service_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
}
},
"title": "treasury_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tos_acceptance"
+ ]
}
},
"title": "settings_specs_update",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affirm_payments",
+ "apply_future_requirements",
+ "bacs_debit_payments",
+ "bank_bca_onboarding",
+ "branding",
+ "capital",
+ "card_issuing",
+ "card_issuing_charge_card",
+ "card_issuing_payout",
+ "card_payments",
+ "funding_credit",
+ "invoices",
+ "konbini_payments",
+ "payments",
+ "payouts",
+ "tax_forms",
+ "treasury"
+ ]
},
"tos_acceptance": {
"description": "Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.",
@@ -79432,10 +88672,25 @@
}
},
"title": "tos_acceptance_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "service_agreement",
+ "user_agent"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "business_type",
+ "capabilities",
+ "company",
+ "email",
+ "individual",
+ "metadata",
+ "tos_acceptance"
+ ]
}
}
},
@@ -79549,6 +88804,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -79693,7 +88954,10 @@
"type": "boolean"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
}
}
},
@@ -79857,6 +89121,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -79935,7 +89205,11 @@
"required": [
"external_account"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "external_account",
+ "metadata"
+ ]
}
}
},
@@ -80209,7 +89483,7 @@
"description": "Documents that may be submitted to satisfy various informational requests.",
"properties": {
"bank_account_ownership_verification": {
- "description": "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a voided check.",
+ "description": "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.",
"properties": {
"files": {
"description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.",
@@ -80221,11 +89495,17 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
}
},
"title": "external_account_documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank_account_ownership_verification"
+ ]
},
"exp_month": {
"description": "Two digit number representing the card’s expiration month.",
@@ -80268,7 +89548,11 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_for_currency",
+ "metadata"
+ ]
}
}
},
@@ -80446,7 +89730,17 @@
}
},
"title": "all_people_relationship_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "authorizer",
+ "director",
+ "executive",
+ "legal_guardian",
+ "officer",
+ "owner",
+ "partner",
+ "representative"
+ ]
},
"style": "deepObject"
},
@@ -80515,6 +89809,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -80605,7 +89905,7 @@
"additionalProperties": false,
"properties": {
"additional_tos_acceptances": {
- "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
"properties": {
"account": {
"description": "Details on the legal guardian's acceptance of the main Stripe service agreement.",
@@ -80636,11 +89936,20 @@
}
},
"title": "settings_terms_of_service_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
}
},
"title": "person_additional_tos_acceptances_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "representative"
+ ]
},
"address": {
"description": "The person's address.",
@@ -80677,7 +89986,15 @@
}
},
"title": "legal_entity_and_kyc_address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"address_kana": {
"description": "The Kana variation of the person's address (Japan only).",
@@ -80719,7 +90036,17 @@
}
},
"title": "japan_address_kana_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"address_kanji": {
"description": "The Kanji variation of the person's address (Japan only).",
@@ -80761,7 +90088,17 @@
}
},
"title": "japan_address_kanji_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"dob": {
"anyOf": [
@@ -80786,7 +90123,12 @@
"year"
],
"title": "date_of_birth_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
{
"enum": [
@@ -80823,7 +90165,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"passport": {
"description": "One or more documents showing the person's passport page with photo and personal data.",
@@ -80848,7 +90193,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"visa": {
"description": "One or more documents showing the person's visa required for living in the country where they are residing.",
@@ -80873,11 +90221,20 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
}
},
"title": "person_documents_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "DASHBOARD_proof_of_liveness",
+ "company_authorization",
+ "passport",
+ "visa"
+ ]
},
"email": {
"description": "The person's email address.",
@@ -81029,7 +90386,15 @@
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"relationship": {
"description": "The relationship that this person has with the account's legal entity.",
@@ -81075,7 +90440,20 @@
}
},
"title": "relationship_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "authorizer",
+ "controller",
+ "director",
+ "executive",
+ "legal_guardian",
+ "officer",
+ "owner",
+ "partner",
+ "percent_ownership",
+ "representative",
+ "title"
+ ]
},
"ssn_last_4": {
"description": "The last four digits of the person's Social Security number (U.S. only).",
@@ -81099,7 +90477,11 @@
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
},
"document": {
"description": "An identifying document, either a passport or local ID card.",
@@ -81116,14 +90498,34 @@
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
}
},
"title": "person_verification_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_document",
+ "document"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "dob",
+ "email",
+ "first_name",
+ "id_number",
+ "last_name",
+ "metadata",
+ "phone",
+ "relationship",
+ "ssn_last_4"
+ ]
}
}
},
@@ -81373,7 +90775,7 @@
"additionalProperties": false,
"properties": {
"additional_tos_acceptances": {
- "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
"properties": {
"account": {
"description": "Details on the legal guardian's acceptance of the main Stripe service agreement.",
@@ -81404,11 +90806,20 @@
}
},
"title": "settings_terms_of_service_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
}
},
"title": "person_additional_tos_acceptances_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "representative"
+ ]
},
"address": {
"description": "The person's address.",
@@ -81445,7 +90856,15 @@
}
},
"title": "legal_entity_and_kyc_address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"address_kana": {
"description": "The Kana variation of the person's address (Japan only).",
@@ -81487,7 +90906,17 @@
}
},
"title": "japan_address_kana_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"address_kanji": {
"description": "The Kanji variation of the person's address (Japan only).",
@@ -81529,7 +90958,17 @@
}
},
"title": "japan_address_kanji_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"dob": {
"anyOf": [
@@ -81554,7 +90993,12 @@
"year"
],
"title": "date_of_birth_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
{
"enum": [
@@ -81591,7 +91035,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"passport": {
"description": "One or more documents showing the person's passport page with photo and personal data.",
@@ -81616,7 +91063,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"visa": {
"description": "One or more documents showing the person's visa required for living in the country where they are residing.",
@@ -81641,11 +91091,20 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
}
},
"title": "person_documents_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "DASHBOARD_proof_of_liveness",
+ "company_authorization",
+ "passport",
+ "visa"
+ ]
},
"email": {
"description": "The person's email address.",
@@ -81797,7 +91256,15 @@
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"relationship": {
"description": "The relationship that this person has with the account's legal entity.",
@@ -81843,7 +91310,20 @@
}
},
"title": "relationship_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "authorizer",
+ "controller",
+ "director",
+ "executive",
+ "legal_guardian",
+ "officer",
+ "owner",
+ "partner",
+ "percent_ownership",
+ "representative",
+ "title"
+ ]
},
"ssn_last_4": {
"description": "The last four digits of the person's Social Security number (U.S. only).",
@@ -81867,7 +91347,11 @@
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
},
"document": {
"description": "An identifying document, either a passport or local ID card.",
@@ -81884,14 +91368,34 @@
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
}
},
"title": "person_verification_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_document",
+ "document"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "dob",
+ "email",
+ "first_name",
+ "id_number",
+ "last_name",
+ "metadata",
+ "phone",
+ "relationship",
+ "ssn_last_4"
+ ]
}
}
},
@@ -81966,7 +91470,10 @@
"required": [
"reason"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reason"
+ ]
}
}
},
@@ -82113,6 +91620,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -82161,7 +91674,10 @@
"required": [
"domain_name"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "domain_name"
+ ]
}
}
},
@@ -82354,7 +91870,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -82465,6 +91987,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -82628,7 +92156,10 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata"
+ ]
}
}
},
@@ -82843,6 +92374,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -82912,7 +92449,11 @@
"type": "object"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "metadata"
+ ]
}
}
},
@@ -83009,7 +92550,11 @@
"type"
],
"title": "scope_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type",
+ "user"
+ ]
},
"style": "deepObject"
},
@@ -83079,6 +92624,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -83160,7 +92711,11 @@
"type"
],
"title": "scope_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type",
+ "user"
+ ]
}
},
"required": [
@@ -83168,7 +92723,13 @@
"payload",
"scope"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_at",
+ "name",
+ "payload",
+ "scope"
+ ]
}
}
},
@@ -83252,14 +92813,22 @@
"type"
],
"title": "scope_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type",
+ "user"
+ ]
}
},
"required": [
"name",
"scope"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name",
+ "scope"
+ ]
}
}
},
@@ -83346,7 +92915,11 @@
"type"
],
"title": "scope_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type",
+ "user"
+ ]
},
"style": "deepObject"
}
@@ -83479,7 +93052,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -83633,6 +93212,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -83734,7 +93319,8 @@
"enum": [
"usage_threshold"
],
- "type": "string"
+ "type": "string",
+ "x-stripeBypassValidation": true
},
"style": "form"
},
@@ -83851,6 +93437,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -83897,7 +93489,8 @@
"enum": [
"usage_threshold"
],
- "type": "string"
+ "type": "string",
+ "x-stripeBypassValidation": true
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -83914,10 +93507,26 @@
"description": "Limit the scope to this alert only to this customer.",
"maxLength": 5000,
"type": "string"
+ },
+ "subscription": {
+ "description": "Limit the scope of this rated usage alert to this subscription.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "subscription_item": {
+ "description": "Limit the scope of this rated usage alert to this subscription item.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "alert_filter",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer",
+ "price",
+ "subscription",
+ "subscription_item"
+ ]
},
"title": {
"description": "The title of the alert.",
@@ -83950,14 +93559,25 @@
"recurrence"
],
"title": "usage_threshold_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gte",
+ "meter",
+ "recurrence"
+ ]
}
},
"required": [
"alert_type",
"title"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "alert_type",
+ "filter",
+ "title",
+ "usage_threshold_config"
+ ]
}
}
},
@@ -84374,6 +93994,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -84443,7 +94069,13 @@
"required": [
"percent_off"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "metadata",
+ "name",
+ "percent_off"
+ ]
}
}
},
@@ -84596,7 +94228,12 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "metadata",
+ "name"
+ ]
}
}
},
@@ -84656,7 +94293,10 @@
}
},
"title": "event_adjustment_cancel_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "identifier"
+ ]
},
"event_name": {
"description": "The name of the meter event. Corresponds with the `event_name` field on a meter.",
@@ -84683,7 +94323,12 @@
"event_name",
"type"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cancel",
+ "event_name",
+ "type"
+ ]
}
}
},
@@ -84768,7 +94413,13 @@
"event_name",
"payload"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "event_name",
+ "identifier",
+ "payload",
+ "timestamp"
+ ]
}
}
},
@@ -84919,6 +94570,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -84985,7 +94642,11 @@
"type"
],
"title": "customer_mapping_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "event_payload_key",
+ "type"
+ ]
},
"default_aggregation": {
"description": "The default settings to aggregate a meter's events with.",
@@ -85003,7 +94664,10 @@
"formula"
],
"title": "aggregation_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "formula"
+ ]
},
"display_name": {
"description": "The meter's name.",
@@ -85044,7 +94708,10 @@
"event_payload_key"
],
"title": "meter_value_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "event_payload_key"
+ ]
}
},
"required": [
@@ -85052,7 +94719,15 @@
"display_name",
"event_name"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer_mapping",
+ "default_aggregation",
+ "display_name",
+ "event_name",
+ "event_time_window",
+ "value_settings"
+ ]
}
}
},
@@ -85192,7 +94867,10 @@
"type": "array"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_name"
+ ]
}
}
},
@@ -85455,6 +95133,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -85669,6 +95353,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -85750,7 +95440,12 @@
}
},
"title": "business_profile_create_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "headline",
+ "privacy_policy_url",
+ "terms_of_service_url"
+ ]
},
"default_return_url": {
"anyOf": [
@@ -85814,7 +95509,11 @@
"enabled"
],
"title": "customer_update_creation_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allowed_updates",
+ "enabled"
+ ]
},
"invoice_history": {
"description": "Information about showing the billing history in the portal.",
@@ -85828,7 +95527,10 @@
"enabled"
],
"title": "invoice_list_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"payment_method_update": {
"description": "Information about updating payment methods in the portal.",
@@ -85842,7 +95544,10 @@
"enabled"
],
"title": "payment_method_update_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"subscription_cancel": {
"description": "Information about canceling subscriptions in the portal.",
@@ -85887,7 +95592,11 @@
"options"
],
"title": "subscription_cancellation_reason_creation_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "options"
+ ]
},
"enabled": {
"description": "Whether the feature is enabled.",
@@ -85915,7 +95624,14 @@
"enabled"
],
"title": "subscription_cancel_creation_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cancellation_reason",
+ "cancellation_redirect",
+ "enabled",
+ "mode",
+ "proration_behavior"
+ ]
},
"subscription_update": {
"description": "Information about updating subscriptions in the portal.",
@@ -85970,7 +95686,11 @@
"product"
],
"title": "subscription_update_product_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "prices",
+ "product"
+ ]
},
"type": "array"
},
@@ -85999,11 +95719,25 @@
"products"
],
"title": "subscription_update_creation_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_allowed_updates",
+ "enabled",
+ "products",
+ "proration_behavior",
+ "schedule_at_period_end"
+ ]
}
},
"title": "features_creation_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer_update",
+ "invoice_history",
+ "payment_method_update",
+ "subscription_cancel",
+ "subscription_update"
+ ]
},
"login_page": {
"description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).",
@@ -86017,7 +95751,10 @@
"enabled"
],
"title": "login_page_create_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -86031,7 +95768,14 @@
"business_profile",
"features"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "business_profile",
+ "default_return_url",
+ "features",
+ "login_page",
+ "metadata"
+ ]
}
}
},
@@ -86227,7 +95971,12 @@
}
},
"title": "business_profile_update_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "headline",
+ "privacy_policy_url",
+ "terms_of_service_url"
+ ]
},
"default_return_url": {
"anyOf": [
@@ -86288,7 +96037,11 @@
}
},
"title": "customer_update_updating_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allowed_updates",
+ "enabled"
+ ]
},
"invoice_history": {
"description": "Information about showing the billing history in the portal.",
@@ -86302,7 +96055,10 @@
"enabled"
],
"title": "invoice_list_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"payment_method_update": {
"description": "Information about updating payment methods in the portal.",
@@ -86316,7 +96072,10 @@
"enabled"
],
"title": "payment_method_update_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"subscription_cancel": {
"description": "Information about canceling subscriptions in the portal.",
@@ -86360,7 +96119,11 @@
"enabled"
],
"title": "subscription_cancellation_reason_updating_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "options"
+ ]
},
"enabled": {
"description": "Whether the feature is enabled.",
@@ -86385,7 +96148,14 @@
}
},
"title": "subscription_cancel_updating_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cancellation_reason",
+ "cancellation_redirect",
+ "enabled",
+ "mode",
+ "proration_behavior"
+ ]
},
"subscription_update": {
"description": "Information about updating subscriptions in the portal.",
@@ -86440,7 +96210,11 @@
"product"
],
"title": "subscription_update_product_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "prices",
+ "product"
+ ]
},
"type": "array"
},
@@ -86464,11 +96238,25 @@
}
},
"title": "subscription_update_updating_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_allowed_updates",
+ "enabled",
+ "products",
+ "proration_behavior",
+ "schedule_at_period_end"
+ ]
}
},
"title": "features_updating_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer_update",
+ "invoice_history",
+ "payment_method_update",
+ "subscription_cancel",
+ "subscription_update"
+ ]
},
"login_page": {
"description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).",
@@ -86482,7 +96270,10 @@
"enabled"
],
"title": "login_page_update_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"metadata": {
"anyOf": [
@@ -86502,7 +96293,15 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "business_profile",
+ "default_return_url",
+ "features",
+ "login_page",
+ "metadata"
+ ]
}
}
},
@@ -86586,7 +96385,10 @@
}
},
"title": "after_completion_hosted_confirmation_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom_message"
+ ]
},
"redirect": {
"description": "Configuration when `after_completion.type=redirect`.",
@@ -86600,7 +96402,10 @@
"return_url"
],
"title": "after_completion_redirect_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "return_url"
+ ]
},
"type": {
"description": "The specified behavior after the flow is completed.",
@@ -86616,7 +96421,12 @@
"type"
],
"title": "flow_data_after_completion_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "hosted_confirmation",
+ "redirect",
+ "type"
+ ]
},
"subscription_cancel": {
"description": "Configuration when `flow_data.type=subscription_cancel`.",
@@ -86637,7 +96447,10 @@
"coupon"
],
"title": "coupon_offer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": {
"description": "Type of retention strategy to use with the customer.",
@@ -86652,7 +96465,11 @@
"type"
],
"title": "retention_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon_offer",
+ "type"
+ ]
},
"subscription": {
"description": "The ID of the subscription to be canceled.",
@@ -86664,7 +96481,11 @@
"subscription"
],
"title": "flow_data_subscription_cancel_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "retention",
+ "subscription"
+ ]
},
"subscription_update": {
"description": "Configuration when `flow_data.type=subscription_update`.",
@@ -86679,7 +96500,10 @@
"subscription"
],
"title": "flow_data_subscription_update_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "subscription"
+ ]
},
"subscription_update_confirm": {
"description": "Configuration when `flow_data.type=subscription_update_confirm`.",
@@ -86700,7 +96524,11 @@
}
},
"title": "subscription_update_confirm_discount_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "promotion_code"
+ ]
},
"type": "array"
},
@@ -86727,7 +96555,13 @@
"id"
],
"title": "subscription_update_confirm_item_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "deleted",
+ "id",
+ "price",
+ "quantity"
+ ]
},
"type": "array"
},
@@ -86742,7 +96576,13 @@
"subscription"
],
"title": "flow_data_subscription_update_confirm_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discounts",
+ "items",
+ "recurring_items",
+ "subscription"
+ ]
},
"type": {
"description": "Type of flow that the customer will go through.",
@@ -86759,7 +96599,14 @@
"type"
],
"title": "flow_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "after_completion",
+ "subscription_cancel",
+ "subscription_update",
+ "subscription_update_confirm",
+ "type"
+ ]
},
"locale": {
"description": "The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.",
@@ -86826,7 +96673,15 @@
"required": [
"customer"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "configuration",
+ "customer",
+ "flow_data",
+ "locale",
+ "on_behalf_of",
+ "return_url"
+ ]
}
}
},
@@ -86900,7 +96755,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -87034,6 +96895,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -87396,6 +97263,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -87516,7 +97389,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -87658,6 +97537,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -87756,7 +97641,11 @@
"account"
],
"title": "destination_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "amount"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -87798,7 +97687,11 @@
}
},
"title": "radar_options_with_hidden_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "session",
+ "skip_rules"
+ ]
},
"receipt_email": {
"description": "The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).",
@@ -87842,7 +97735,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
@@ -87870,7 +97771,14 @@
"name"
],
"title": "optional_fields_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "carrier",
+ "name",
+ "phone",
+ "tracking_number"
+ ]
},
"source": {
"description": "A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer.",
@@ -87879,12 +97787,12 @@
"x-stripeBypassValidation": true
},
"statement_descriptor": {
- "description": "For a non-card charge, text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors). This value overrides the account's default statement descriptor. For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
+ "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
"maxLength": 22,
"type": "string"
},
@@ -87905,14 +97813,32 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "destination"
+ ]
},
"transfer_group": {
"description": "A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options).",
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "application_fee",
+ "currency",
+ "customer",
+ "description",
+ "destination",
+ "metadata",
+ "receipt_email",
+ "shipping",
+ "source",
+ "statement_descriptor",
+ "statement_descriptor_suffix"
+ ]
}
}
},
@@ -88056,6 +97982,14 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "next_page",
+ "object",
+ "total_count",
+ "url"
]
}
}
@@ -88221,7 +98155,10 @@
"user_report"
],
"title": "fraud_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "user_report"
+ ]
},
"metadata": {
"anyOf": [
@@ -88259,7 +98196,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"booking_number": {
"description": "The booking number associated with the car rental.",
@@ -88328,11 +98268,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"drivers": {
"description": "The details of the passengers in the travel reservation",
@@ -88348,7 +98297,10 @@
"name"
],
"title": "car_rental_driver",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -88405,7 +98357,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"pickup_at": {
"description": "Car pick-up time. Measured in seconds since the Unix epoch.",
@@ -88465,7 +98425,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"return_at": {
"description": "Car return time. Measured in seconds since the Unix epoch.",
@@ -88484,7 +98452,29 @@
"return_at"
],
"title": "car_rental",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "booking_number",
+ "car_class_code",
+ "car_make",
+ "car_model",
+ "company",
+ "customer_service_phone_number",
+ "days_rented",
+ "delivery",
+ "drivers",
+ "extra_charges",
+ "no_show",
+ "pickup_address",
+ "pickup_at",
+ "rate_amount",
+ "rate_interval",
+ "renter_name",
+ "return_address",
+ "return_at",
+ "tax_exempt"
+ ]
},
"event_details": {
"description": "Event details for this PaymentIntent",
@@ -88528,7 +98518,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -88543,7 +98541,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"company": {
"description": "The name of the company",
@@ -88583,11 +98584,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"ends_at": {
"description": "Event end time. Measured in seconds since the Unix epoch.",
@@ -88614,7 +98624,18 @@
"name"
],
"title": "event",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "access_controlled_venue",
+ "address",
+ "affiliate",
+ "company",
+ "delivery",
+ "ends_at",
+ "genre",
+ "name",
+ "starts_at"
+ ]
},
"flight": {
"description": "Flight reservation details for this PaymentIntent",
@@ -88632,7 +98653,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"agency_number": {
"description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.",
@@ -88677,11 +98701,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"passenger_name": {
"description": "The name of the person or entity on the reservation.",
@@ -88702,7 +98735,10 @@
"name"
],
"title": "flight_passenger",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -88759,7 +98795,17 @@
"departs_at"
],
"title": "flight_segment",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "arrival_airport",
+ "arrives_at",
+ "carrier",
+ "departs_at",
+ "departure_airport",
+ "flight_number",
+ "service_class"
+ ]
},
"type": "array"
},
@@ -88773,7 +98819,17 @@
"segments"
],
"title": "flight",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "agency_number",
+ "carrier",
+ "delivery",
+ "passenger_name",
+ "passengers",
+ "segments",
+ "ticket_number"
+ ]
},
"lodging": {
"description": "Lodging reservation details for this PaymentIntent",
@@ -88813,7 +98869,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"adults": {
"description": "The number of adults on the booking",
@@ -88832,7 +98896,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"booking_number": {
"description": "The booking number associated with the lodging reservation.",
@@ -88898,11 +98965,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -88950,7 +99026,10 @@
"name"
],
"title": "lodging_passenger",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -88981,7 +99060,30 @@
"checkout_at"
],
"title": "lodging",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "adults",
+ "affiliate",
+ "booking_number",
+ "category",
+ "checkin_at",
+ "checkout_at",
+ "customer_service_phone_number",
+ "daily_room_rate_amount",
+ "delivery",
+ "extra_charges",
+ "fire_safety_act_compliance",
+ "name",
+ "no_show",
+ "number_of_rooms",
+ "passengers",
+ "property_phone_number",
+ "room_class",
+ "room_nights",
+ "total_room_tax_amount",
+ "total_tax_amount"
+ ]
},
"subscription": {
"description": "Subscription details for this PaymentIntent",
@@ -88999,7 +99101,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"auto_renewal": {
"description": "Info whether the subscription will be auto renewed upon expiry.",
@@ -89028,7 +99133,11 @@
"interval"
],
"title": "subscription_billing_interval",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "count",
+ "interval"
+ ]
},
"ends_at": {
"description": "Subscription end time. Measured in seconds since the Unix epoch.",
@@ -89050,11 +99159,27 @@
"name"
],
"title": "subscription",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "auto_renewal",
+ "billing_interval",
+ "ends_at",
+ "name",
+ "starts_at"
+ ]
}
},
"title": "payment_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "car_rental",
+ "event_details",
+ "flight",
+ "healthcare",
+ "lodging",
+ "subscription"
+ ]
},
"receipt_email": {
"description": "This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.",
@@ -89099,7 +99224,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
@@ -89127,14 +99260,28 @@
"name"
],
"title": "optional_fields_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "carrier",
+ "name",
+ "phone",
+ "tracking_number"
+ ]
},
"transfer_group": {
"description": "A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.",
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer",
+ "description",
+ "metadata",
+ "receipt_email",
+ "shipping"
+ ]
}
}
},
@@ -89239,7 +99386,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"booking_number": {
"description": "The booking number associated with the car rental.",
@@ -89308,11 +99458,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"drivers": {
"description": "The details of the passengers in the travel reservation",
@@ -89328,7 +99487,10 @@
"name"
],
"title": "car_rental_driver",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -89385,7 +99547,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"pickup_at": {
"description": "Car pick-up time. Measured in seconds since the Unix epoch.",
@@ -89445,7 +99615,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"return_at": {
"description": "Car return time. Measured in seconds since the Unix epoch.",
@@ -89464,7 +99642,29 @@
"return_at"
],
"title": "car_rental",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "booking_number",
+ "car_class_code",
+ "car_make",
+ "car_model",
+ "company",
+ "customer_service_phone_number",
+ "days_rented",
+ "delivery",
+ "drivers",
+ "extra_charges",
+ "no_show",
+ "pickup_address",
+ "pickup_at",
+ "rate_amount",
+ "rate_interval",
+ "renter_name",
+ "return_address",
+ "return_at",
+ "tax_exempt"
+ ]
},
"event_details": {
"description": "Event details for this PaymentIntent",
@@ -89508,7 +99708,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -89523,7 +99731,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"company": {
"description": "The name of the company",
@@ -89563,11 +99774,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"ends_at": {
"description": "Event end time. Measured in seconds since the Unix epoch.",
@@ -89594,7 +99814,18 @@
"name"
],
"title": "event",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "access_controlled_venue",
+ "address",
+ "affiliate",
+ "company",
+ "delivery",
+ "ends_at",
+ "genre",
+ "name",
+ "starts_at"
+ ]
},
"flight": {
"description": "Flight reservation details for this PaymentIntent",
@@ -89612,7 +99843,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"agency_number": {
"description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.",
@@ -89657,11 +99891,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"passenger_name": {
"description": "The name of the person or entity on the reservation.",
@@ -89682,7 +99925,10 @@
"name"
],
"title": "flight_passenger",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -89739,7 +99985,17 @@
"departs_at"
],
"title": "flight_segment",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "arrival_airport",
+ "arrives_at",
+ "carrier",
+ "departs_at",
+ "departure_airport",
+ "flight_number",
+ "service_class"
+ ]
},
"type": "array"
},
@@ -89753,7 +100009,17 @@
"segments"
],
"title": "flight",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "agency_number",
+ "carrier",
+ "delivery",
+ "passenger_name",
+ "passengers",
+ "segments",
+ "ticket_number"
+ ]
},
"lodging": {
"description": "Lodging reservation details for this PaymentIntent",
@@ -89793,7 +100059,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"adults": {
"description": "The number of adults on the booking",
@@ -89812,7 +100086,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"booking_number": {
"description": "The booking number associated with the lodging reservation.",
@@ -89878,11 +100155,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -89930,7 +100216,10 @@
"name"
],
"title": "lodging_passenger",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -89961,7 +100250,30 @@
"checkout_at"
],
"title": "lodging",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "adults",
+ "affiliate",
+ "booking_number",
+ "category",
+ "checkin_at",
+ "checkout_at",
+ "customer_service_phone_number",
+ "daily_room_rate_amount",
+ "delivery",
+ "extra_charges",
+ "fire_safety_act_compliance",
+ "name",
+ "no_show",
+ "number_of_rooms",
+ "passengers",
+ "property_phone_number",
+ "room_class",
+ "room_nights",
+ "total_room_tax_amount",
+ "total_tax_amount"
+ ]
},
"subscription": {
"description": "Subscription details for this PaymentIntent",
@@ -89979,7 +100291,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"auto_renewal": {
"description": "Info whether the subscription will be auto renewed upon expiry.",
@@ -90008,7 +100323,11 @@
"interval"
],
"title": "subscription_billing_interval",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "count",
+ "interval"
+ ]
},
"ends_at": {
"description": "Subscription end time. Measured in seconds since the Unix epoch.",
@@ -90030,23 +100349,39 @@
"name"
],
"title": "subscription",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "auto_renewal",
+ "billing_interval",
+ "ends_at",
+ "name",
+ "starts_at"
+ ]
}
},
"title": "payment_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "car_rental",
+ "event_details",
+ "flight",
+ "healthcare",
+ "lodging",
+ "subscription"
+ ]
},
"receipt_email": {
"description": "The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.",
"type": "string"
},
"statement_descriptor": {
- "description": "For a non-card charge, text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors). This value overrides the account's default statement descriptor. For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
+ "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
"maxLength": 22,
"type": "string"
},
@@ -90059,14 +100394,24 @@
}
},
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount"
+ ]
},
"transfer_group": {
"description": "A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.",
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "application_fee",
+ "receipt_email",
+ "statement_descriptor",
+ "statement_descriptor_suffix"
+ ]
}
}
},
@@ -90210,6 +100555,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -90338,7 +100689,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -90375,7 +100732,10 @@
"email"
],
"title": "customer_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email"
+ ]
},
"style": "deepObject"
},
@@ -90528,6 +100888,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -90613,6 +100979,10 @@
"explode": true,
"style": "deepObject"
},
+ "permissions": {
+ "explode": true,
+ "style": "deepObject"
+ },
"phone_number_collection": {
"explode": true,
"style": "deepObject"
@@ -90664,11 +101034,18 @@
"enabled"
],
"title": "recovery_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allow_promotion_codes",
+ "enabled"
+ ]
}
},
"title": "after_expiration_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "recovery"
+ ]
},
"allow_promotion_codes": {
"description": "Enables user redeemable promotion codes.",
@@ -90701,14 +101078,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"billing_address_collection": {
"description": "Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.",
@@ -90747,7 +101132,10 @@
"position"
],
"title": "payment_method_reuse_agreement_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "position"
+ ]
},
"promotions": {
"description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.",
@@ -90767,7 +101155,12 @@
}
},
"title": "consent_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment_method_reuse_agreement",
+ "promotions",
+ "terms_of_service"
+ ]
},
"currency": {
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set.",
@@ -90805,7 +101198,11 @@
"value"
],
"title": "custom_field_option_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "label",
+ "value"
+ ]
},
"type": "array"
}
@@ -90814,7 +101211,11 @@
"options"
],
"title": "custom_field_dropdown_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_value",
+ "options"
+ ]
},
"key": {
"description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.",
@@ -90842,7 +101243,11 @@
"type"
],
"title": "custom_field_label_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom",
+ "type"
+ ]
},
"numeric": {
"description": "Configuration for `type=numeric` fields.",
@@ -90862,7 +101267,12 @@
}
},
"title": "custom_field_numeric_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_value",
+ "maximum_length",
+ "minimum_length"
+ ]
},
"optional": {
"description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.",
@@ -90886,7 +101296,12 @@
}
},
"title": "custom_field_text_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_value",
+ "maximum_length",
+ "minimum_length"
+ ]
},
"type": {
"description": "The type of the field.",
@@ -90904,7 +101319,16 @@
"type"
],
"title": "custom_field_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dropdown",
+ "key",
+ "label",
+ "numeric",
+ "optional",
+ "text",
+ "type"
+ ]
},
"type": "array"
},
@@ -90925,7 +101349,10 @@
"message"
],
"title": "custom_text_position_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "message"
+ ]
},
{
"enum": [
@@ -90950,7 +101377,10 @@
"message"
],
"title": "custom_text_position_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "message"
+ ]
},
{
"enum": [
@@ -90975,7 +101405,10 @@
"message"
],
"title": "custom_text_position_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "message"
+ ]
},
{
"enum": [
@@ -91000,7 +101433,10 @@
"message"
],
"title": "custom_text_position_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "message"
+ ]
},
{
"enum": [
@@ -91013,7 +101449,13 @@
}
},
"title": "custom_text_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "after_submit",
+ "shipping_address",
+ "submit",
+ "terms_of_service_acceptance"
+ ]
},
"customer": {
"description": "ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card\npayment method will be used to prefill the email, name, card details, and billing address\non the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)\nwill be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.\n\nIf the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.\nIf the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.\n\nIf blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow.\n\nYou can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.",
@@ -91064,7 +101506,12 @@
}
},
"title": "customer_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "name",
+ "shipping"
+ ]
},
"discounts": {
"description": "The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.",
@@ -91082,7 +101529,11 @@
}
},
"title": "discount_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "promotion_code"
+ ]
},
"type": "array"
},
@@ -91148,7 +101599,11 @@
"value"
],
"title": "custom_field_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name",
+ "value"
+ ]
},
"type": "array"
},
@@ -91191,7 +101646,11 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -91215,7 +101674,11 @@
}
},
"title": "rendering_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_tax_display",
+ "invoice_title"
+ ]
},
{
"enum": [
@@ -91228,14 +101691,27 @@
}
},
"title": "invoice_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "custom_fields",
+ "description",
+ "footer",
+ "issuer",
+ "metadata",
+ "rendering_options"
+ ]
}
},
"required": [
"enabled"
],
"title": "invoice_creation_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "invoice_data"
+ ]
},
"line_items": {
"description": "A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).\n\nFor `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.\n\nFor `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.",
@@ -91261,7 +101737,12 @@
"enabled"
],
"title": "adjustable_quantity_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "maximum",
+ "minimum"
+ ]
},
"dynamic_tax_rates": {
"description": "The [tax rates](https://stripe.com/docs/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.",
@@ -91325,7 +101806,14 @@
"name"
],
"title": "product_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "images",
+ "metadata",
+ "name",
+ "tax_code"
+ ]
},
"recurring": {
"description": "The recurring components of a price such as `interval` and `interval_count`.",
@@ -91349,7 +101837,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -91374,7 +101865,12 @@
"currency"
],
"title": "price_data_with_product_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.",
@@ -91390,7 +101886,18 @@
}
},
"title": "line_item_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "adjustable_quantity",
+ "display",
+ "dynamic_tax_rates",
+ "metadata",
+ "price",
+ "price_data",
+ "pricing_spec",
+ "quantity",
+ "tax_rates"
+ ]
},
"type": "array"
},
@@ -91543,7 +102050,15 @@
"line1"
],
"title": "address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
@@ -91571,15 +102086,22 @@
"name"
],
"title": "shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "carrier",
+ "name",
+ "phone",
+ "tracking_number"
+ ]
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
"type": "string"
},
@@ -91599,7 +102121,11 @@
"destination"
],
"title": "transfer_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "destination"
+ ]
},
"transfer_group": {
"description": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.",
@@ -91607,7 +102133,23 @@
}
},
"title": "payment_intent_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "application_fee_amount",
+ "capture_method",
+ "cross_border_classification",
+ "description",
+ "fulfillment_date",
+ "metadata",
+ "on_behalf_of",
+ "receipt_email",
+ "setup_future_usage",
+ "shipping",
+ "statement_descriptor",
+ "statement_descriptor_suffix",
+ "transfer_data",
+ "transfer_group"
+ ]
},
"payment_method_collection": {
"description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.\nThis may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).",
@@ -91636,7 +102178,10 @@
}
},
"title": "payment_method_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allow_redisplay"
+ ]
},
"payment_method_options": {
"description": "Payment-method-specific configuration.",
@@ -91704,7 +102249,14 @@
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom_mandate_url",
+ "default_for",
+ "interval_description",
+ "payment_schedule",
+ "transaction_type"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
@@ -91727,7 +102279,13 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "mandate_options",
+ "setup_future_usage",
+ "verification_method"
+ ]
},
"affirm": {
"description": "contains details about the Affirm payment method options.",
@@ -91741,7 +102299,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"afterpay_clearpay": {
"description": "contains details about the Afterpay Clearpay payment method options.",
@@ -91755,7 +102316,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"alipay": {
"description": "contains details about the Alipay payment method options.",
@@ -91769,7 +102333,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "setup_future_usage"
+ ]
},
"amazon_pay": {
"description": "contains details about the AmazonPay payment method options.",
@@ -91784,7 +102352,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"au_becs_debit": {
"description": "contains details about the AU Becs Debit payment method options.",
@@ -91798,7 +102369,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"bacs_debit": {
"description": "contains details about the Bacs Debit payment method options.",
@@ -91814,7 +102388,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage",
+ "target_date"
+ ]
},
"bancontact": {
"description": "contains details about the Bancontact payment method options.",
@@ -91828,7 +102406,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"boleto": {
"description": "contains details about the Boleto payment method options.",
@@ -91848,7 +102429,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
"card": {
"description": "contains details about the Card payment method options.",
@@ -91862,7 +102447,10 @@
}
},
"title": "installments_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"request_three_d_secure": {
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
@@ -91894,7 +102482,15 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "installments",
+ "request_three_d_secure",
+ "restrictions",
+ "setup_future_usage",
+ "statement_descriptor_suffix_kana",
+ "statement_descriptor_suffix_kanji"
+ ]
},
"cashapp": {
"description": "contains details about the Cashapp Pay payment method options.",
@@ -91910,7 +102506,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"customer_balance": {
"description": "contains details about the Customer Balance payment method options.",
@@ -91931,7 +102530,10 @@
"country"
],
"title": "eu_bank_transfer_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"requested_address_types": {
"description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.",
@@ -91967,7 +102569,13 @@
"type"
],
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "eu_bank_transfer",
+ "id_bank_transfer",
+ "requested_address_types",
+ "type"
+ ]
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
@@ -91985,7 +102593,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank_transfer",
+ "funding_type",
+ "setup_future_usage"
+ ]
},
"eps": {
"description": "contains details about the EPS payment method options.",
@@ -91999,7 +102612,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"fpx": {
"description": "contains details about the FPX payment method options.",
@@ -92013,7 +102629,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"giropay": {
"description": "contains details about the Giropay payment method options.",
@@ -92027,7 +102646,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"grabpay": {
"description": "contains details about the Grabpay payment method options.",
@@ -92041,7 +102663,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"ideal": {
"description": "contains details about the Ideal payment method options.",
@@ -92055,7 +102680,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"klarna": {
"description": "contains details about the Klarna payment method options.",
@@ -92069,7 +102697,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"konbini": {
"description": "contains details about the Konbini payment method options.",
@@ -92087,7 +102718,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
"link": {
"description": "contains details about the Link payment method options.",
@@ -92102,7 +102737,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"mobilepay": {
"description": "contains details about the Mobilepay payment method options.",
@@ -92116,7 +102754,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"multibanco": {
"description": "contains details about the Multibanco payment method options.",
@@ -92130,7 +102771,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"oxxo": {
"description": "contains details about the OXXO payment method options.",
@@ -92148,7 +102792,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
"p24": {
"description": "contains details about the P24 payment method options.",
@@ -92166,7 +102814,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage",
+ "tos_shown_and_accepted"
+ ]
},
"paynow": {
"description": "contains details about the PayNow payment method options.",
@@ -92180,7 +102832,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"paypal": {
"description": "contains details about the PayPal payment method options.",
@@ -92255,7 +102910,16 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "preferred_locale",
+ "reference",
+ "reference_id",
+ "risk_correlation_id",
+ "setup_future_usage",
+ "subsellers"
+ ]
},
"payto": {
"description": "contains details about the PayTo payment method options.",
@@ -92322,7 +102986,16 @@
}
},
"title": "setup_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "end_date",
+ "payment_schedule",
+ "payments_per_period",
+ "purpose",
+ "start_date"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
@@ -92334,7 +103007,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage"
+ ]
},
"pix": {
"description": "contains details about the Pix payment method options.",
@@ -92345,7 +103022,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_after_seconds"
+ ]
},
"revolut_pay": {
"description": "contains details about the RevolutPay payment method options.",
@@ -92360,7 +103040,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"sepa_debit": {
"description": "contains details about the Sepa Debit payment method options.",
@@ -92376,7 +103059,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage",
+ "target_date",
+ "verification_method"
+ ]
},
"sofort": {
"description": "contains details about the Sofort payment method options.",
@@ -92390,7 +103078,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"swish": {
"description": "contains details about the Swish payment method options.",
@@ -92402,7 +103093,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "authorization_method",
+ "reference"
+ ]
},
"us_bank_account": {
"description": "contains details about the Us Bank Account payment method options.",
@@ -92440,7 +103135,11 @@
}
},
"title": "linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "permissions",
+ "prefetch"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
@@ -92462,7 +103161,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "financial_connections",
+ "setup_future_usage",
+ "verification_method"
+ ]
},
"wechat_pay": {
"description": "contains details about the WeChat Pay payment method options.",
@@ -92494,11 +103198,59 @@
"client"
],
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "app_id",
+ "client",
+ "setup_future_usage"
+ ]
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "affirm",
+ "afterpay_clearpay",
+ "alipay",
+ "amazon_pay",
+ "au_becs_debit",
+ "bacs_debit",
+ "bancontact",
+ "boleto",
+ "card",
+ "cashapp",
+ "customer_balance",
+ "demo_pay",
+ "eps",
+ "fpx",
+ "giropay",
+ "grabpay",
+ "id_bank_transfer",
+ "ideal",
+ "klarna",
+ "konbini",
+ "kr_market",
+ "link",
+ "mobilepay",
+ "multibanco",
+ "ng_card",
+ "ng_market",
+ "oxxo",
+ "p24",
+ "pay_by_bank",
+ "paynow",
+ "paypal",
+ "payto",
+ "pix",
+ "revolut_pay",
+ "sepa_debit",
+ "sofort",
+ "swish",
+ "upi",
+ "us_bank_account",
+ "wechat_pay"
+ ]
},
"payment_method_types": {
"description": "A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.\n\nYou can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).\nSee [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.\n\nRead more about the supported payment methods and their requirements in our [payment\nmethod details guide](/docs/payments/checkout/payment-methods).\n\nIf multiple payment methods are passed, Checkout will dynamically reorder them to\nprioritize the most relevant payment methods based on the customer's location and\nother characteristics.",
@@ -92525,6 +103277,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -92534,6 +103287,7 @@
"payto",
"pix",
"promptpay",
+ "rechnung",
"revolut_pay",
"sepa_debit",
"sofort",
@@ -92548,6 +103302,35 @@
},
"type": "array"
},
+ "permissions": {
+ "description": "This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.\n\nFor specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.",
+ "properties": {
+ "update": {
+ "description": "Permissions for updating the Checkout Session.",
+ "properties": {
+ "shipping_details": {
+ "description": "Determines which entity is allowed to update the shipping details.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.\n\nWhen set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.",
+ "enum": [
+ "client_only",
+ "server_only"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "permissions_update_param",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "line_items",
+ "shipping_details"
+ ]
+ }
+ },
+ "title": "permissions_param",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "update"
+ ]
+ },
"phone_number_collection": {
"description": "Controls phone number collection settings for the session.\n\nWe recommend that you review your privacy policy and check with your legal contacts\nbefore using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).",
"properties": {
@@ -92560,10 +103343,13 @@
"enabled"
],
"title": "phone_number_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"redirect_on_completion": {
- "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`.",
+ "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.",
"enum": [
"always",
"if_required",
@@ -92601,7 +103387,12 @@
}
},
"title": "saved_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allow_redisplay_filters",
+ "payment_method_remove",
+ "payment_method_save"
+ ]
},
"setup_intent_data": {
"description": "A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.",
@@ -92624,7 +103415,12 @@
}
},
"title": "setup_intent_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "metadata",
+ "on_behalf_of"
+ ]
},
"shipping_address_collection": {
"description": "When set, provides configuration for Checkout to collect a shipping address from a customer.",
@@ -92880,7 +103676,10 @@
"allowed_countries"
],
"title": "shipping_address_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allowed_countries"
+ ]
},
"shipping_options": {
"description": "The shipping rate options to apply to this Session. Up to a maximum of 5.",
@@ -92921,7 +103720,11 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit",
+ "value"
+ ]
},
"minimum": {
"description": "The lower bound of the estimated range. If empty, represents no lower bound.",
@@ -92947,11 +103750,19 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit",
+ "value"
+ ]
}
},
"title": "delivery_estimate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "maximum",
+ "minimum"
+ ]
},
"display_name": {
"description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.",
@@ -92990,7 +103801,11 @@
"amount"
],
"title": "currency_option",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "tax_behavior"
+ ]
},
"description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
"type": "object"
@@ -93001,7 +103816,12 @@
"currency"
],
"title": "fixed_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "currency_options"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -93035,11 +103855,21 @@
"display_name"
],
"title": "method_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_name",
+ "fixed_amount",
+ "metadata",
+ "type"
+ ]
}
},
"title": "shipping_option_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "shipping_rate",
+ "shipping_rate_data"
+ ]
},
"type": "array"
},
@@ -93101,11 +103931,18 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"title": "invoice_settings_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "issuer"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -93142,7 +103979,11 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_percent",
+ "destination"
+ ]
},
"trial_end": {
"description": "Unix timestamp representing the end of the trial period the customer\nwill get before being charged for the first time. Has to be at least\n48 hours in the future.",
@@ -93173,18 +104014,38 @@
"missing_payment_method"
],
"title": "end_behavior",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "missing_payment_method"
+ ]
}
},
"required": [
"end_behavior"
],
"title": "trial_settings_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
"title": "subscription_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "application_fee_percent",
+ "billing_cycle_anchor",
+ "default_tax_rates",
+ "description",
+ "invoice_settings",
+ "metadata",
+ "on_behalf_of",
+ "proration_behavior",
+ "tax_filing_currency",
+ "transfer_data",
+ "trial_end",
+ "trial_period_days"
+ ]
},
"success_url": {
"description": "The URL to which Stripe should send customers when payment or setup\nis complete.\nThis parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use\ninformation from the successful Checkout Session on your page, read the\nguide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).",
@@ -93203,7 +104064,11 @@
"enabled"
],
"title": "tax_id_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "required"
+ ]
},
"ui_mode": {
"description": "The UI mode of the Session. Defaults to `hosted`.",
@@ -93215,7 +104080,17 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "client_reference_id",
+ "customer",
+ "customer_email",
+ "line_items",
+ "metadata",
+ "mode",
+ "return_url",
+ "success_url"
+ ]
}
}
},
@@ -93331,6 +104206,10 @@
"content": {
"application/x-www-form-urlencoded": {
"encoding": {
+ "collected_information": {
+ "explode": true,
+ "style": "deepObject"
+ },
"expand": {
"explode": true,
"style": "deepObject"
@@ -93338,11 +104217,95 @@
"metadata": {
"explode": true,
"style": "deepObject"
+ },
+ "shipping_options": {
+ "explode": true,
+ "style": "deepObject"
}
},
"schema": {
"additionalProperties": false,
"properties": {
+ "collected_information": {
+ "description": "Information about the customer collected within the Checkout Session.",
+ "properties": {
+ "shipping_details": {
+ "description": "The shipping details to apply to this Session.",
+ "properties": {
+ "address": {
+ "description": "The address of the customer",
+ "properties": {
+ "city": {
+ "description": "City, district, suburb, town, or village.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "country": {
+ "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "line1": {
+ "description": "Address line 1 (e.g., street, PO Box, or company name).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "line2": {
+ "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "postal_code": {
+ "description": "ZIP or postal code.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "state": {
+ "description": "State, county, province, or region.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "country",
+ "line1"
+ ],
+ "title": "address",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
+ },
+ "name": {
+ "description": "The name of customer",
+ "maxLength": 255,
+ "type": "string"
+ }
+ },
+ "required": [
+ "address",
+ "name"
+ ],
+ "title": "shipping_details_params",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "name"
+ ]
+ }
+ },
+ "title": "collected_information_params",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_details",
+ "shipping_details"
+ ]
+ },
"expand": {
"description": "Specifies which fields in the response should be expanded.",
"items": {
@@ -93367,9 +104330,214 @@
}
],
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
+ },
+ "shipping_options": {
+ "anyOf": [
+ {
+ "items": {
+ "properties": {
+ "shipping_rate": {
+ "description": "The ID of the Shipping Rate to use for this shipping option.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "shipping_rate_data": {
+ "description": "Parameters to be passed to Shipping Rate creation for this shipping option.",
+ "properties": {
+ "delivery_estimate": {
+ "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.",
+ "properties": {
+ "maximum": {
+ "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.",
+ "properties": {
+ "unit": {
+ "description": "A unit of time.",
+ "enum": [
+ "business_day",
+ "day",
+ "hour",
+ "month",
+ "week"
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "Must be greater than 0.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "unit",
+ "value"
+ ],
+ "title": "delivery_estimate_bound",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit",
+ "value"
+ ]
+ },
+ "minimum": {
+ "description": "The lower bound of the estimated range. If empty, represents no lower bound.",
+ "properties": {
+ "unit": {
+ "description": "A unit of time.",
+ "enum": [
+ "business_day",
+ "day",
+ "hour",
+ "month",
+ "week"
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "Must be greater than 0.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "unit",
+ "value"
+ ],
+ "title": "delivery_estimate_bound",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit",
+ "value"
+ ]
+ }
+ },
+ "title": "delivery_estimate",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "maximum",
+ "minimum"
+ ]
+ },
+ "display_name": {
+ "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.",
+ "maxLength": 100,
+ "type": "string"
+ },
+ "fixed_amount": {
+ "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.",
+ "properties": {
+ "amount": {
+ "description": "A non-negative integer in cents representing how much to charge.",
+ "type": "integer"
+ },
+ "currency": {
+ "description": "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).",
+ "type": "string"
+ },
+ "currency_options": {
+ "additionalProperties": {
+ "properties": {
+ "amount": {
+ "description": "A non-negative integer in cents representing how much to charge.",
+ "type": "integer"
+ },
+ "tax_behavior": {
+ "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
+ "enum": [
+ "exclusive",
+ "inclusive",
+ "unspecified"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "amount"
+ ],
+ "title": "currency_option",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "tax_behavior"
+ ]
+ },
+ "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
+ "type": "object"
+ }
+ },
+ "required": [
+ "amount",
+ "currency"
+ ],
+ "title": "fixed_amount",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "currency_options"
+ ]
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
+ "type": "object"
+ },
+ "tax_behavior": {
+ "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
+ "enum": [
+ "exclusive",
+ "inclusive",
+ "unspecified"
+ ],
+ "type": "string"
+ },
+ "tax_code": {
+ "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of calculation to use on the shipping rate.",
+ "enum": [
+ "fixed_amount"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "display_name"
+ ],
+ "title": "method_params",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_name",
+ "fixed_amount",
+ "metadata",
+ "type"
+ ]
+ }
+ },
+ "title": "shipping_option_params",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "shipping_rate",
+ "shipping_rate_data"
+ ]
+ },
+ "type": "array"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The shipping rate options to apply to this Session. Up to a maximum of 5."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata"
+ ]
}
}
},
@@ -93583,6 +104751,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -93709,6 +104883,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -93767,7 +104947,10 @@
"public_name"
],
"title": "beneficiary_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "public_name"
+ ]
},
"currency": {
"description": "Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used.",
@@ -93803,7 +104986,15 @@
"required": [
"product"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "beneficiary",
+ "currency",
+ "metadata",
+ "metric_tons",
+ "product"
+ ]
}
}
},
@@ -93961,7 +105152,10 @@
"public_name"
],
"title": "beneficiary_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "public_name"
+ ]
},
{
"enum": [
@@ -93988,7 +105182,11 @@
"type": "object"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "beneficiary",
+ "metadata"
+ ]
}
}
},
@@ -94193,6 +105391,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -94387,6 +105591,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -94649,6 +105859,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -94769,7 +105985,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -94880,6 +106102,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -94942,7 +106170,11 @@
}
},
"title": "applies_to_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "product_classes",
+ "products"
+ ]
},
"currency": {
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).",
@@ -94960,7 +106192,10 @@
"amount_off"
],
"title": "currency_option",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_off"
+ ]
},
"description": "Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
"type": "object"
@@ -95028,7 +106263,16 @@
"type": "integer"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_off",
+ "currency",
+ "duration",
+ "duration_in_months",
+ "metadata",
+ "name",
+ "percent_off"
+ ]
}
}
},
@@ -95223,7 +106467,10 @@
"amount_off"
],
"title": "currency_option",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_off"
+ ]
},
"description": "Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
"type": "object"
@@ -95259,7 +106506,11 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata",
+ "name"
+ ]
}
}
},
@@ -95322,7 +106573,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -95454,6 +106711,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -95584,7 +106847,12 @@
"taxable_amount"
],
"title": "tax_amount_with_tax_rate_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "tax_rate",
+ "taxable_amount"
+ ]
},
"type": "array"
},
@@ -95637,7 +106905,18 @@
"type"
],
"title": "credit_note_line_item_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "description",
+ "invoice_line_item",
+ "quantity",
+ "tax_amounts",
+ "tax_rates",
+ "type",
+ "unit_amount",
+ "unit_amount_decimal"
+ ]
},
"type": "array"
},
@@ -95689,7 +106968,15 @@
}
},
"title": "credit_note_refund_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_applied",
+ "amount_refunded",
+ "invoice_payment",
+ "metadata",
+ "refund"
+ ]
},
"type": "array"
},
@@ -95703,13 +106990,23 @@
}
},
"title": "credit_note_shipping_cost",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "shipping_rate"
+ ]
}
},
"required": [
"invoice"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "invoice",
+ "lines",
+ "memo",
+ "metadata",
+ "reason"
+ ]
}
}
},
@@ -95867,7 +107164,12 @@
"taxable_amount"
],
"title": "tax_amount_with_tax_rate_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "tax_rate",
+ "taxable_amount"
+ ]
},
"type": "array"
},
@@ -95920,7 +107222,18 @@
"type"
],
"title": "credit_note_line_item_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "description",
+ "invoice_line_item",
+ "quantity",
+ "tax_amounts",
+ "tax_rates",
+ "type",
+ "unit_amount",
+ "unit_amount_decimal"
+ ]
},
"type": "array"
},
@@ -96016,7 +107329,15 @@
}
},
"title": "credit_note_refund_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_applied",
+ "amount_refunded",
+ "invoice_payment",
+ "metadata",
+ "refund"
+ ]
},
"type": "array"
},
@@ -96037,7 +107358,10 @@
}
},
"title": "credit_note_shipping_cost",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "shipping_rate"
+ ]
},
"style": "deepObject"
}
@@ -96228,7 +107552,12 @@
"taxable_amount"
],
"title": "tax_amount_with_tax_rate_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "tax_rate",
+ "taxable_amount"
+ ]
},
"type": "array"
},
@@ -96281,7 +107610,18 @@
"type"
],
"title": "credit_note_line_item_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "description",
+ "invoice_line_item",
+ "quantity",
+ "tax_amounts",
+ "tax_rates",
+ "type",
+ "unit_amount",
+ "unit_amount_decimal"
+ ]
},
"type": "array"
},
@@ -96377,7 +107717,15 @@
}
},
"title": "credit_note_refund_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_applied",
+ "amount_refunded",
+ "invoice_payment",
+ "metadata",
+ "refund"
+ ]
},
"type": "array"
},
@@ -96398,7 +107746,10 @@
}
},
"title": "credit_note_shipping_cost",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "shipping_rate"
+ ]
},
"style": "deepObject"
},
@@ -96468,6 +107819,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -96604,6 +107961,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -96742,7 +108105,11 @@
"type": "object"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "memo",
+ "metadata"
+ ]
}
}
},
@@ -96874,7 +108241,10 @@
"enabled"
],
"title": "buy_button_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"payment_element": {
"description": "Configuration for the Payment Element.",
@@ -96939,14 +108309,28 @@
}
},
"title": "features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment_method_allow_redisplay_filters",
+ "payment_method_redisplay",
+ "payment_method_redisplay_limit",
+ "payment_method_remove",
+ "payment_method_save",
+ "payment_method_save_usage",
+ "payment_method_set_as_default",
+ "payment_method_update"
+ ]
}
},
"required": [
"enabled"
],
"title": "payment_element_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "features"
+ ]
},
"pricing_table": {
"description": "Configuration for the pricing table.",
@@ -96960,11 +108344,22 @@
"enabled"
],
"title": "pricing_table_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
}
},
"title": "components",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "buy_button",
+ "customer_sheet",
+ "mobile_payment_element",
+ "payment_element",
+ "payment_sheet",
+ "pricing_table"
+ ]
},
"customer": {
"description": "The ID of an existing customer for which to create the Customer Session.",
@@ -96984,7 +108379,11 @@
"components",
"customer"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "components",
+ "customer"
+ ]
}
}
},
@@ -97047,7 +108446,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -97180,6 +108585,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -97281,7 +108692,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
{
"enum": [
@@ -97313,11 +108732,17 @@
}
},
"title": "balance_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reconciliation_mode"
+ ]
}
},
"title": "cash_balance_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "settings"
+ ]
},
"coupon": {
"maxLength": 5000,
@@ -97370,7 +108795,11 @@
"value"
],
"title": "custom_field_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name",
+ "value"
+ ]
},
"type": "array"
},
@@ -97408,7 +108837,12 @@
}
},
"title": "customer_rendering_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_tax_display",
+ "invoice_title",
+ "template"
+ ]
},
{
"enum": [
@@ -97421,7 +108855,18 @@
}
},
"title": "customer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_to_forgive",
+ "amount_to_forgive_currency",
+ "custom_fields",
+ "days_until_due",
+ "default_payment_method",
+ "footer",
+ "rendering_options",
+ "send_hosted_payment_email",
+ "supported_payment_methods"
+ ]
},
"metadata": {
"anyOf": [
@@ -97510,7 +108955,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"name": {
"description": "Customer name.",
@@ -97528,7 +108981,12 @@
"name"
],
"title": "customer_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "name",
+ "phone"
+ ]
},
{
"enum": [
@@ -97571,7 +109029,11 @@
}
},
"title": "tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ip_address",
+ "validate_location"
+ ]
},
"tax_exempt": {
"description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.",
@@ -97588,7 +109050,7 @@
"items": {
"properties": {
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -97622,6 +109084,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -97678,7 +109141,11 @@
"value"
],
"title": "data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type",
+ "value"
+ ]
},
"type": "array"
},
@@ -97691,7 +109158,17 @@
"type": "boolean"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "description",
+ "email",
+ "metadata",
+ "name",
+ "payment_method",
+ "phone",
+ "shipping"
+ ]
}
}
},
@@ -97835,6 +109312,14 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "next_page",
+ "object",
+ "total_count",
+ "url"
]
}
}
@@ -98070,7 +109555,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
{
"enum": [
@@ -98102,11 +109595,17 @@
}
},
"title": "balance_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reconciliation_mode"
+ ]
}
},
"title": "cash_balance_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "settings"
+ ]
},
"coupon": {
"maxLength": 5000,
@@ -98164,7 +109663,11 @@
"value"
],
"title": "custom_field_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name",
+ "value"
+ ]
},
"type": "array"
},
@@ -98202,7 +109705,12 @@
}
},
"title": "customer_rendering_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_tax_display",
+ "invoice_title",
+ "template"
+ ]
},
{
"enum": [
@@ -98215,7 +109723,18 @@
}
},
"title": "customer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_to_forgive",
+ "amount_to_forgive_currency",
+ "custom_fields",
+ "days_until_due",
+ "default_payment_method",
+ "footer",
+ "rendering_options",
+ "send_hosted_payment_email",
+ "supported_payment_methods"
+ ]
},
"metadata": {
"anyOf": [
@@ -98300,7 +109819,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"name": {
"description": "Customer name.",
@@ -98318,7 +109845,12 @@
"name"
],
"title": "customer_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "name",
+ "phone"
+ ]
},
{
"enum": [
@@ -98361,7 +109893,11 @@
}
},
"title": "tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ip_address",
+ "validate_location"
+ ]
},
"tax_exempt": {
"description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.",
@@ -98377,7 +109913,16 @@
"type": "boolean"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "description",
+ "email",
+ "metadata",
+ "name",
+ "phone",
+ "shipping"
+ ]
}
}
},
@@ -98524,6 +110069,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -98616,7 +110167,13 @@
"amount",
"currency"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "metadata"
+ ]
}
}
},
@@ -98794,7 +110351,11 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "metadata"
+ ]
}
}
},
@@ -98944,10 +110505,16 @@
}
},
"title": "balance_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reconciliation_mode"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "settings"
+ ]
}
}
},
@@ -99094,6 +110661,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -99291,7 +110864,10 @@
"country"
],
"title": "eu_bank_account_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"requested_address_types": {
"description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.",
@@ -99324,7 +110900,12 @@
"type"
],
"title": "bank_transfer_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "eu_bank_transfer",
+ "requested_address_types",
+ "type"
+ ]
},
"currency": {
"description": "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).",
@@ -99351,7 +110932,12 @@
"currency",
"funding_type"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank_transfer",
+ "currency",
+ "funding_type"
+ ]
}
}
},
@@ -99484,6 +111070,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -99562,6 +111149,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -99785,6 +111378,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -99862,7 +111461,11 @@
"required": [
"source"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata",
+ "source"
+ ]
}
}
},
@@ -100216,7 +111819,15 @@
}
},
"title": "source_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"email": {
"description": "Owner's email address.",
@@ -100234,10 +111845,31 @@
}
},
"title": "owner",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_name",
+ "account_holder_type",
+ "address_city",
+ "address_country",
+ "address_line1",
+ "address_line2",
+ "address_state",
+ "address_zip",
+ "exp_month",
+ "exp_year",
+ "metadata",
+ "name",
+ "owner"
+ ]
}
}
},
@@ -100335,7 +111967,10 @@
"type": "array"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amounts"
+ ]
}
}
},
@@ -100482,6 +112117,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -100536,7 +112177,7 @@
"type": "array"
},
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -100570,6 +112211,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -100625,7 +112267,11 @@
"type",
"value"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type",
+ "value"
+ ]
}
}
},
@@ -100836,7 +112482,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -100958,6 +112610,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -101346,11 +113004,29 @@
}
},
"title": "shipping_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
}
},
"title": "visa_compelling_evidence3_disputed_transaction",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer_account_id",
+ "customer_device_fingerprint",
+ "customer_device_id",
+ "customer_email_address",
+ "customer_purchase_ip",
+ "merchandise_or_services",
+ "product_description",
+ "shipping_address"
+ ]
},
"prior_undisputed_transactions": {
"description": "List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission.",
@@ -101546,24 +113222,50 @@
}
},
"title": "shipping_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
}
},
"required": [
"charge"
],
"title": "visa_compelling_evidence3_prior_undisputed_transaction",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "charge",
+ "customer_account_id",
+ "customer_device_fingerprint",
+ "customer_device_id",
+ "customer_email_address",
+ "customer_purchase_ip",
+ "product_description",
+ "shipping_address"
+ ]
},
"type": "array"
}
},
"title": "visa_compelling_evidence3",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "disputed_transaction",
+ "prior_undisputed_transactions"
+ ]
}
},
"title": "enhanced_evidence",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "visa_compelling_evidence_3",
+ "visa_compliance"
+ ]
},
{
"enum": [
@@ -101641,7 +113343,45 @@
}
},
"title": "dispute_evidence_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "access_activity_log",
+ "billing_address",
+ "booking",
+ "cancellation_policy",
+ "cancellation_policy_disclosure",
+ "cancellation_rebuttal",
+ "credit_voucher",
+ "customer_communication",
+ "customer_email_address",
+ "customer_name",
+ "customer_purchase_ip",
+ "customer_signature",
+ "duplicate_charge_documentation",
+ "duplicate_charge_explanation",
+ "duplicate_charge_id",
+ "enhanced_evidence",
+ "event_details",
+ "government_order",
+ "narrative",
+ "prior_undisputed_payments",
+ "product_description",
+ "product_service_ad",
+ "receipt",
+ "refund_policy",
+ "refund_policy_disclosure",
+ "refund_refusal_explanation",
+ "service_date",
+ "service_documentation",
+ "shipping_address",
+ "shipping_carrier",
+ "shipping_date",
+ "shipping_documentation",
+ "shipping_tracking_number",
+ "terms_disclosure",
+ "uncategorized_file",
+ "uncategorized_text"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -101673,7 +113413,12 @@
"type": "boolean"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "evidence",
+ "metadata",
+ "submit"
+ ]
}
}
},
@@ -101887,6 +113632,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -102103,6 +113854,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -102170,7 +113927,12 @@
"lookup_key",
"name"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "lookup_key",
+ "metadata",
+ "name"
+ ]
}
}
},
@@ -102334,7 +114096,11 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata",
+ "name"
+ ]
}
}
},
@@ -102409,7 +114175,13 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer",
+ "issuing_card",
+ "nonce",
+ "verification_session"
+ ]
}
}
},
@@ -102539,7 +114311,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -102686,6 +114464,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -102880,6 +114664,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -103000,7 +114790,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -103131,6 +114927,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -103182,7 +114984,7 @@
"type": "integer"
},
"file": {
- "description": "The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.",
+ "description": "The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.",
"maxLength": 5000,
"type": "string"
},
@@ -103207,7 +115009,12 @@
"required": [
"file"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_at",
+ "file",
+ "metadata"
+ ]
}
}
},
@@ -103385,7 +115192,11 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_at",
+ "metadata"
+ ]
}
}
},
@@ -103448,7 +115259,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -103510,6 +115327,7 @@
"finance_report_run",
"identity_document",
"identity_document_downloadable",
+ "issuing_regulatory_reporting",
"pci_document",
"selfie",
"sigma_scheduled_query",
@@ -103588,6 +115406,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -103642,7 +115466,7 @@
"description": "Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.",
"properties": {
"create": {
- "description": "Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.",
+ "description": "Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `issuing_regulatory_reporting`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.",
"type": "boolean"
},
"expires_at": {
@@ -103672,7 +115496,12 @@
"create"
],
"title": "file_link_creation_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "create",
+ "expires_at",
+ "metadata"
+ ]
},
"purpose": {
"description": "The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.",
@@ -103684,6 +115513,7 @@
"customer_signature",
"dispute_evidence",
"identity_document",
+ "issuing_regulatory_reporting",
"pci_document",
"tax_document_user_upload",
"terminal_reader_splashscreen"
@@ -103696,7 +115526,11 @@
"file",
"purpose"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "file",
+ "purpose"
+ ]
}
}
},
@@ -103824,7 +115658,11 @@
}
},
"title": "accountholder_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "customer"
+ ]
},
"style": "deepObject"
},
@@ -103942,6 +115780,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -104213,6 +116057,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -104360,6 +116210,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -104436,7 +116292,10 @@
"required": [
"features"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "features"
+ ]
}
}
},
@@ -104522,7 +116381,10 @@
"required": [
"features"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "features"
+ ]
}
}
},
@@ -104608,7 +116470,10 @@
"required": [
"features"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "features"
+ ]
}
}
},
@@ -104746,6 +116611,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -104899,7 +116770,12 @@
"type"
],
"title": "accountholder_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "customer",
+ "type"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -104941,7 +116817,12 @@
}
},
"title": "filters_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_subcategories",
+ "countries",
+ "institution"
+ ]
},
"limits": {
"description": "Settings for configuring Session-specific limits.",
@@ -104955,7 +116836,10 @@
"accounts"
],
"title": "limits_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "accounts"
+ ]
},
"manual_entry": {
"description": "Settings for configuring manual entry of account details for this Session.",
@@ -104970,7 +116854,10 @@
}
},
"title": "manual_entry_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode"
+ ]
},
"permissions": {
"description": "List of data features that you would like to request access to.\n\nPossible values are `balances`, `transactions`, `ownership`, and `payment_method`.",
@@ -105010,7 +116897,16 @@
"account_holder",
"permissions"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder",
+ "filters",
+ "limits",
+ "manual_entry",
+ "permissions",
+ "prefetch",
+ "return_url"
+ ]
}
}
},
@@ -105199,7 +117095,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -105226,7 +117128,10 @@
"after"
],
"title": "transaction_refresh_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "after"
+ ]
},
"style": "deepObject"
}
@@ -105286,6 +117191,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -105404,7 +117315,13 @@
}
},
"title": "created_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
"style": "deepObject"
},
@@ -105509,6 +117426,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -105604,13 +117527,21 @@
"value"
],
"title": "header_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name",
+ "value"
+ ]
},
"type": "array"
}
},
"title": "request_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "body",
+ "headers"
+ ]
},
"url": {
"description": "The destination URL for the forwarded request. Must be supported by the config.",
@@ -105623,7 +117554,13 @@
"replacements",
"url"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment_method",
+ "replacements",
+ "request",
+ "url"
+ ]
}
}
},
@@ -105828,6 +117765,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -105889,7 +117832,10 @@
"payment_intent"
],
"title": "payment_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment_intent"
+ ]
},
"type": {
"description": "The type of event that created this object.",
@@ -105904,7 +117850,11 @@
"type"
],
"title": "created_by_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment",
+ "type"
+ ]
},
"currency": {
"description": "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).",
@@ -105933,7 +117883,14 @@
"required": [
"currency"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "created_by",
+ "currency",
+ "initial_amount",
+ "metadata"
+ ]
}
}
},
@@ -106001,7 +117958,11 @@
"required": [
"code"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "code",
+ "giftcard_pin"
+ ]
}
}
},
@@ -106159,7 +118120,11 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "metadata"
+ ]
}
}
},
@@ -106318,6 +118283,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -106383,7 +118354,10 @@
"payment_intent"
],
"title": "payment_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment_intent"
+ ]
},
"type": {
"description": "The type of event that created this object.",
@@ -106398,7 +118372,11 @@
"type"
],
"title": "created_by_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment",
+ "type"
+ ]
},
"currency": {
"description": "The currency of the transaction. This must match the currency of the gift card.",
@@ -106440,7 +118418,17 @@
"currency",
"gift_card"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "confirm",
+ "created_by",
+ "currency",
+ "description",
+ "gift_card",
+ "metadata",
+ "transfer_group"
+ ]
}
}
},
@@ -106599,7 +118587,11 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "metadata"
+ ]
}
}
},
@@ -106807,7 +118799,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -106944,6 +118942,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -107075,7 +119079,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -107212,6 +119222,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -107310,7 +119326,13 @@
}
},
"title": "document_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allowed_types",
+ "require_id_number",
+ "require_live_capture",
+ "require_matching_selfie"
+ ]
},
{
"enum": [
@@ -107323,7 +119345,16 @@
}
},
"title": "session_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "document",
+ "duplicate",
+ "email",
+ "matching",
+ "phone",
+ "phone_otp",
+ "phone_records"
+ ]
},
"provided_details": {
"description": "Details provided about the user being verified. These details may be shown to the user.",
@@ -107338,7 +119369,14 @@
}
},
"title": "provided_details_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "dob",
+ "email",
+ "name",
+ "phone"
+ ]
},
"related_customer": {
"description": "Token referencing a Customer resource.",
@@ -107364,7 +119402,17 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "client_reference_id",
+ "metadata",
+ "options",
+ "provided_details",
+ "related_customer",
+ "return_url",
+ "type",
+ "verification_flow"
+ ]
}
}
},
@@ -107548,7 +119596,13 @@
}
},
"title": "document_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allowed_types",
+ "require_id_number",
+ "require_live_capture",
+ "require_matching_selfie"
+ ]
},
{
"enum": [
@@ -107561,7 +119615,16 @@
}
},
"title": "session_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "document",
+ "duplicate",
+ "email",
+ "matching",
+ "phone",
+ "phone_otp",
+ "phone_records"
+ ]
},
"provided_details": {
"description": "Details provided about the user being verified. These details may be shown to the user.",
@@ -107576,7 +119639,14 @@
}
},
"title": "provided_details_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "dob",
+ "email",
+ "name",
+ "phone"
+ ]
},
"type": {
"description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.",
@@ -107588,7 +119658,13 @@
"x-stripeBypassValidation": true
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata",
+ "options",
+ "provided_details",
+ "type"
+ ]
}
}
},
@@ -107785,7 +119861,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -107928,6 +120010,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -108052,7 +120140,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -108072,7 +120164,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -108081,7 +120178,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -108151,7 +120251,11 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end",
+ "start"
+ ]
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
@@ -108194,7 +120298,12 @@
"product"
],
"title": "one_time_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Non-negative integer. The quantity of units for the invoice item.",
@@ -108249,7 +120358,16 @@
"required": [
"customer"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "customer",
+ "description",
+ "metadata",
+ "period",
+ "price"
+ ]
}
}
},
@@ -108506,7 +120624,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -108526,7 +120648,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -108535,7 +120662,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -108610,7 +120740,11 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end",
+ "start"
+ ]
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
@@ -108653,7 +120787,12 @@
"product"
],
"title": "one_time_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Non-negative integer. The quantity of units for the invoice item.",
@@ -108710,7 +120849,14 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "description",
+ "metadata",
+ "period",
+ "price"
+ ]
}
}
},
@@ -108787,7 +120933,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -108834,7 +120986,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -108974,6 +121132,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -109114,7 +121278,13 @@
"description"
],
"title": "payment_plan_amount_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "days_until_due",
+ "description",
+ "due_date"
+ ]
},
"type": "array"
},
@@ -109162,14 +121332,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"collection_method": {
"description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`.",
@@ -109204,7 +121382,11 @@
"value"
],
"title": "custom_field_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name",
+ "value"
+ ]
},
"type": "array"
},
@@ -109298,7 +121480,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -109318,7 +121504,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -109327,7 +121518,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -109385,7 +121579,11 @@
"invoice"
],
"title": "from_invoice",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "action",
+ "invoice"
+ ]
},
"issuer": {
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
@@ -109407,7 +121605,11 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
},
"metadata": {
"anyOf": [
@@ -109473,7 +121675,10 @@
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "transaction_type"
+ ]
},
"verification_method": {
"description": "Verification method for the intent",
@@ -109487,7 +121692,11 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -109514,7 +121723,10 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred_language"
+ ]
},
{
"enum": [
@@ -109564,7 +121776,12 @@
"type"
],
"title": "installment_plan",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "count",
+ "interval",
+ "type"
+ ]
},
{
"enum": [
@@ -109577,7 +121794,11 @@
}
},
"title": "installments_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "plan"
+ ]
},
"request_three_d_secure": {
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
@@ -109590,7 +121811,11 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "installments",
+ "request_three_d_secure"
+ ]
},
{
"enum": [
@@ -109621,7 +121846,10 @@
"country"
],
"title": "eu_bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"type": {
"description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
@@ -109629,7 +121857,12 @@
}
},
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "eu_bank_transfer",
+ "id_bank_transfer",
+ "type"
+ ]
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
@@ -109637,7 +121870,11 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank_transfer",
+ "funding_type"
+ ]
},
{
"enum": [
@@ -109669,7 +121906,10 @@
{
"properties": {},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "verification_method"
+ ]
},
{
"enum": [
@@ -109708,7 +121948,11 @@
}
},
"title": "invoice_linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_subcategories",
+ "institution"
+ ]
},
"permissions": {
"description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.",
@@ -109740,7 +121984,12 @@
}
},
"title": "invoice_linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "filters",
+ "permissions",
+ "prefetch"
+ ]
},
"verification_method": {
"description": "Verification method for the intent",
@@ -109754,7 +122003,11 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "financial_connections",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -109767,7 +122020,17 @@
}
},
"title": "payment_method_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "bancontact",
+ "card",
+ "customer_balance",
+ "id_bank_transfer",
+ "konbini",
+ "sepa_debit",
+ "us_bank_account"
+ ]
},
"payment_method_types": {
"anyOf": [
@@ -109821,7 +122084,12 @@
}
},
"title": "payment_settings",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_mandate",
+ "payment_method_options",
+ "payment_method_types"
+ ]
},
"pending_invoice_items_behavior": {
"description": "How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.",
@@ -109858,11 +122126,23 @@
}
},
"title": "rendering_pdf_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "page_size"
+ ]
}
},
"title": "rendering_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_tax_display",
+ "custom_text",
+ "invoice_title",
+ "pdf",
+ "summary_items_data",
+ "template",
+ "template_version"
+ ]
},
"shipping_cost": {
"description": "Settings for the cost of shipping for this invoice.",
@@ -109902,7 +122182,11 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit",
+ "value"
+ ]
},
"minimum": {
"description": "The lower bound of the estimated range. If empty, represents no lower bound.",
@@ -109928,11 +122212,19 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit",
+ "value"
+ ]
}
},
"title": "delivery_estimate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "maximum",
+ "minimum"
+ ]
},
"display_name": {
"description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.",
@@ -109971,7 +122263,11 @@
"amount"
],
"title": "currency_option",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "tax_behavior"
+ ]
},
"description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
"type": "object"
@@ -109982,7 +122278,12 @@
"currency"
],
"title": "fixed_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "currency_options"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -110016,11 +122317,21 @@
"display_name"
],
"title": "method_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_name",
+ "fixed_amount",
+ "metadata",
+ "type"
+ ]
}
},
"title": "shipping_cost",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "shipping_rate",
+ "shipping_rate_data"
+ ]
},
"shipping_details": {
"description": "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.",
@@ -110060,7 +122371,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"name": {
"description": "Recipient name.",
@@ -110088,7 +122407,12 @@
"name"
],
"title": "recipient_shipping_with_optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "name",
+ "phone"
+ ]
},
"statement_descriptor": {
"description": "Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.",
@@ -110116,10 +122440,22 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "destination"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "auto_advance",
+ "collection_method",
+ "customer",
+ "description",
+ "metadata",
+ "subscription"
+ ]
}
}
},
@@ -110224,14 +122560,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"coupon": {
"description": "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.",
@@ -110286,7 +122630,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
{
"enum": [
@@ -110336,7 +122688,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"name": {
"description": "Customer name.",
@@ -110354,7 +122714,12 @@
"name"
],
"title": "customer_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "name",
+ "phone"
+ ]
},
{
"enum": [
@@ -110384,7 +122749,10 @@
}
},
"title": "tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ip_address"
+ ]
},
"tax_exempt": {
"description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.",
@@ -110401,7 +122769,7 @@
"items": {
"properties": {
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -110435,6 +122803,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -110491,13 +122860,24 @@
"value"
],
"title": "data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type",
+ "value"
+ ]
},
"type": "array"
}
},
"title": "customer_details_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "shipping",
+ "tax",
+ "tax_exempt",
+ "tax_ids"
+ ]
},
"discounts": {
"anyOf": [
@@ -110540,7 +122920,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -110560,7 +122944,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -110569,7 +122958,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -110591,7 +122983,7 @@
"type": "array"
},
"invoice_items": {
- "description": "List of invoice items to add or update in the upcoming invoice preview.",
+ "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).",
"items": {
"properties": {
"amount": {
@@ -110652,7 +123044,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -110672,7 +123068,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -110681,7 +123082,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -110735,7 +123139,11 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end",
+ "start"
+ ]
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
@@ -110778,7 +123186,12 @@
"product"
],
"title": "one_time_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Non-negative integer. The quantity of units for the invoice item.",
@@ -110836,7 +123249,24 @@
}
},
"title": "invoice_item_preview_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "discountable",
+ "discounts",
+ "invoiceitem",
+ "metadata",
+ "period",
+ "price",
+ "quantity",
+ "tax_behavior",
+ "tax_code",
+ "tax_rates",
+ "unit_amount",
+ "unit_amount_decimal"
+ ]
},
"type": "array"
},
@@ -110860,7 +123290,11 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
},
"on_behalf_of": {
"anyOf": [
@@ -110912,7 +123346,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount"
+ ]
},
"duration": {
"description": "Time span for the amendment starting from the `amendment_start`.",
@@ -110937,7 +123374,11 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.",
@@ -110962,7 +123403,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount_end",
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"amendment_start": {
"description": "Details to identify the earliest timestamp where the proposed change should take effect.",
@@ -110979,7 +123426,10 @@
"index"
],
"title": "amendment_end_index_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "index"
+ ]
},
"discount_end": {
"description": "Use the `end` time of a given discount.",
@@ -110994,7 +123444,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to start.",
@@ -111020,7 +123473,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendment_end",
+ "discount_end",
+ "timestamp",
+ "type"
+ ]
},
"billing_cycle_anchor": {
"description": "For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.",
@@ -111062,7 +123521,10 @@
"type"
],
"title": "amendment_discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"index": {
"description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.",
@@ -111075,7 +123537,14 @@
}
},
"title": "add_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "discount_end",
+ "index",
+ "promotion_code"
+ ]
},
"remove": {
"description": "Details of the discount to remove.",
@@ -111097,7 +123566,12 @@
}
},
"title": "remove_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "promotion_code"
+ ]
},
"set": {
"description": "Details of the discount to replace the existing discounts with.",
@@ -111119,7 +123593,12 @@
}
},
"title": "set_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "promotion_code"
+ ]
},
"type": {
"description": "Determines the type of discount action.",
@@ -111135,7 +123614,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add",
+ "remove",
+ "set",
+ "type"
+ ]
},
"type": "array"
},
@@ -111186,7 +123671,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -111206,7 +123695,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -111215,7 +123709,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -111267,14 +123764,26 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"required": [
"price"
],
"title": "add_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discounts",
+ "metadata",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"remove": {
"description": "Details of the subscription item to remove.",
@@ -111289,7 +123798,10 @@
"price"
],
"title": "remove_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "price"
+ ]
},
"set": {
"description": "Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.",
@@ -111334,7 +123846,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -111354,7 +123870,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -111363,7 +123884,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -111415,14 +123939,26 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"required": [
"price"
],
"title": "set_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discounts",
+ "metadata",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"type": {
"description": "Determines the type of item action.",
@@ -111438,7 +123974,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add",
+ "remove",
+ "set",
+ "type"
+ ]
},
"type": "array"
},
@@ -111492,7 +124034,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add",
+ "remove",
+ "set",
+ "type"
+ ]
},
"type": "array"
},
@@ -111525,7 +124073,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "behavior"
+ ]
},
"type": {
"description": "Determines the type of the pause_collection amendment.",
@@ -111540,7 +124091,11 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "set",
+ "type"
+ ]
},
"set_schedule_end": {
"description": "Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.",
@@ -111566,18 +124121,36 @@
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "prorate_up_front"
+ ]
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
"required": [
"amendment_start"
],
"title": "amendment_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendment_end",
+ "amendment_start",
+ "billing_cycle_anchor",
+ "discount_actions",
+ "item_actions",
+ "metadata_actions",
+ "proration_behavior",
+ "set_pause_collection",
+ "set_schedule_end",
+ "trial_settings"
+ ]
},
"type": "array"
},
@@ -111645,7 +124218,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -111665,7 +124242,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -111674,7 +124256,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -111705,7 +124290,7 @@
"type": "string"
},
"unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
+ "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.",
"type": "integer"
},
"unit_amount_decimal": {
@@ -111719,7 +124304,12 @@
"product"
],
"title": "one_time_price_data_with_negative_amounts",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for this item. Defaults to 1.",
@@ -111746,6 +124336,10 @@
},
"title": "add_invoice_item_entry",
"type": "object",
+ "x-stripeMostCommon": [
+ "price",
+ "quantity"
+ ],
"x-stripeParam": {
"class_name": "AddInvoiceItem"
}
@@ -111783,14 +124377,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"billing_cycle_anchor": {
"description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).",
@@ -111814,7 +124416,11 @@
}
},
"title": "billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_gte",
+ "reset_billing_cycle_anchor"
+ ]
},
{
"enum": [
@@ -111921,7 +124527,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -111941,7 +124551,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -111950,7 +124565,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -112024,11 +124642,25 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"title": "invoice_settings",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "custom_fields",
+ "days_until_due",
+ "description",
+ "footer",
+ "issuer",
+ "send_hosted_payment_email",
+ "supported_payment_methods"
+ ]
},
"items": {
"description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.",
@@ -112047,7 +124679,10 @@
"usage_gte"
],
"title": "item_billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "usage_gte"
+ ]
},
{
"enum": [
@@ -112099,7 +124734,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -112119,7 +124758,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -112128,7 +124772,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -112192,7 +124839,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -112219,7 +124869,13 @@
"recurring"
],
"title": "recurring_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "recurring",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.",
@@ -112267,11 +124923,25 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"title": "configuration_item_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_thresholds",
+ "discounts",
+ "metadata",
+ "plan",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"type": "array"
},
@@ -112307,7 +124977,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "behavior"
+ ]
},
"proration_behavior": {
"description": "Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.",
@@ -112350,7 +125023,11 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_percent",
+ "destination"
+ ]
},
"trial": {
"description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.",
@@ -112396,18 +125073,53 @@
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "prorate_up_front"
+ ]
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
"required": [
"items"
],
"title": "phase_configuration_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add_invoice_items",
+ "application_fee_percent",
+ "automatic_tax",
+ "billing_cycle_anchor",
+ "billing_thresholds",
+ "collection_method",
+ "coupon",
+ "currency",
+ "default_payment_method",
+ "default_tax_rates",
+ "description",
+ "discounts",
+ "end_date",
+ "invoice_settings",
+ "items",
+ "iterations",
+ "metadata",
+ "on_behalf_of",
+ "pause_collection",
+ "proration_behavior",
+ "start_date",
+ "tax_filing_currency",
+ "transfer_data",
+ "trial",
+ "trial_continuation",
+ "trial_end",
+ "trial_settings"
+ ]
},
"type": "array"
},
@@ -112431,7 +125143,10 @@
"index"
],
"title": "amendment_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "index"
+ ]
},
"duration": {
"description": "Time span for prebilling, starting from `bill_from`.",
@@ -112456,7 +125171,11 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "End the prebilled period at a precise integer timestamp, starting from the Unix epoch.",
@@ -112478,7 +125197,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendment_end",
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"iterations": {
"description": "This is used to determine the number of billing cycles to prebill.",
@@ -112486,7 +125211,11 @@
}
},
"title": "prebilling_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bill_until",
+ "iterations"
+ ]
},
"type": "array"
},
@@ -112510,7 +125239,15 @@
}
},
"title": "schedule_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendments",
+ "billing_behavior",
+ "end_behavior",
+ "phases",
+ "prebilling",
+ "proration_behavior"
+ ]
},
"subscription": {
"description": "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.",
@@ -112595,7 +125332,10 @@
"usage_gte"
],
"title": "item_billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "usage_gte"
+ ]
},
{
"enum": [
@@ -112655,7 +125395,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -112675,7 +125419,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -112684,7 +125433,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -112763,7 +125515,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -112790,7 +125545,13 @@
"recurring"
],
"title": "recurring_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "recurring",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for this item.",
@@ -112816,7 +125577,19 @@
}
},
"title": "subscription_item_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_thresholds",
+ "clear_usage",
+ "deleted",
+ "discounts",
+ "id",
+ "metadata",
+ "plan",
+ "price",
+ "quantity",
+ "tax_rates"
+ ]
},
"type": "array"
},
@@ -112832,7 +125605,10 @@
"iterations"
],
"title": "prebilling_preview_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iterations"
+ ]
},
"proration_behavior": {
"description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.",
@@ -112879,10 +125655,28 @@
}
},
"title": "subscription_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_cycle_anchor",
+ "cancel_at",
+ "cancel_at_period_end",
+ "cancel_now",
+ "default_tax_rates",
+ "items",
+ "prebilling",
+ "proration_behavior",
+ "proration_date",
+ "resume_at",
+ "start_date",
+ "trial_end"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer",
+ "subscription"
+ ]
}
}
},
@@ -113026,6 +125820,14 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "next_page",
+ "object",
+ "total_count",
+ "url"
]
}
}
@@ -113082,14 +125884,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"style": "deepObject"
},
@@ -113169,7 +125979,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
{
"enum": [
@@ -113219,7 +126037,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"name": {
"description": "Customer name.",
@@ -113237,7 +126063,12 @@
"name"
],
"title": "customer_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "name",
+ "phone"
+ ]
},
{
"enum": [
@@ -113267,7 +126098,10 @@
}
},
"title": "tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ip_address"
+ ]
},
"tax_exempt": {
"description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.",
@@ -113284,7 +126118,7 @@
"items": {
"properties": {
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -113318,6 +126152,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -113374,13 +126209,24 @@
"value"
],
"title": "data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type",
+ "value"
+ ]
},
"type": "array"
}
},
"title": "customer_details_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "shipping",
+ "tax",
+ "tax_exempt",
+ "tax_ids"
+ ]
},
"style": "deepObject"
},
@@ -113431,7 +126277,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -113451,7 +126301,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -113460,7 +126315,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -113490,7 +126348,7 @@
"style": "deepObject"
},
{
- "description": "List of invoice items to add or update in the upcoming invoice preview.",
+ "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).",
"explode": true,
"in": "query",
"name": "invoice_items",
@@ -113556,7 +126414,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -113576,7 +126438,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -113585,7 +126452,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -113639,7 +126509,11 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end",
+ "start"
+ ]
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
@@ -113682,7 +126556,12 @@
"product"
],
"title": "one_time_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Non-negative integer. The quantity of units for the invoice item.",
@@ -113740,7 +126619,24 @@
}
},
"title": "invoice_item_preview_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "discountable",
+ "discounts",
+ "invoiceitem",
+ "metadata",
+ "period",
+ "price",
+ "quantity",
+ "tax_behavior",
+ "tax_code",
+ "tax_rates",
+ "unit_amount",
+ "unit_amount_decimal"
+ ]
},
"type": "array"
},
@@ -113771,7 +126667,11 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
},
"style": "deepObject"
},
@@ -113849,7 +126749,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount"
+ ]
},
"duration": {
"description": "Time span for the amendment starting from the `amendment_start`.",
@@ -113874,7 +126777,11 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.",
@@ -113899,7 +126806,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount_end",
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"amendment_start": {
"description": "Details to identify the earliest timestamp where the proposed change should take effect.",
@@ -113916,7 +126829,10 @@
"index"
],
"title": "amendment_end_index_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "index"
+ ]
},
"discount_end": {
"description": "Use the `end` time of a given discount.",
@@ -113931,7 +126847,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to start.",
@@ -113957,7 +126876,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendment_end",
+ "discount_end",
+ "timestamp",
+ "type"
+ ]
},
"billing_cycle_anchor": {
"description": "For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.",
@@ -113999,7 +126924,10 @@
"type"
],
"title": "amendment_discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"index": {
"description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.",
@@ -114012,7 +126940,14 @@
}
},
"title": "add_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "discount_end",
+ "index",
+ "promotion_code"
+ ]
},
"remove": {
"description": "Details of the discount to remove.",
@@ -114034,7 +126969,12 @@
}
},
"title": "remove_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "promotion_code"
+ ]
},
"set": {
"description": "Details of the discount to replace the existing discounts with.",
@@ -114056,7 +126996,12 @@
}
},
"title": "set_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "promotion_code"
+ ]
},
"type": {
"description": "Determines the type of discount action.",
@@ -114072,7 +127017,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add",
+ "remove",
+ "set",
+ "type"
+ ]
},
"type": "array"
},
@@ -114123,7 +127074,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -114143,7 +127098,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -114152,7 +127112,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -114204,14 +127167,26 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"required": [
"price"
],
"title": "add_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discounts",
+ "metadata",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"remove": {
"description": "Details of the subscription item to remove.",
@@ -114226,7 +127201,10 @@
"price"
],
"title": "remove_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "price"
+ ]
},
"set": {
"description": "Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.",
@@ -114271,7 +127249,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -114291,7 +127273,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -114300,7 +127287,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -114352,14 +127342,26 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"required": [
"price"
],
"title": "set_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discounts",
+ "metadata",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"type": {
"description": "Determines the type of item action.",
@@ -114375,7 +127377,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add",
+ "remove",
+ "set",
+ "type"
+ ]
},
"type": "array"
},
@@ -114429,7 +127437,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add",
+ "remove",
+ "set",
+ "type"
+ ]
},
"type": "array"
},
@@ -114462,7 +127476,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "behavior"
+ ]
},
"type": {
"description": "Determines the type of the pause_collection amendment.",
@@ -114477,7 +127494,11 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "set",
+ "type"
+ ]
},
"set_schedule_end": {
"description": "Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.",
@@ -114503,18 +127524,36 @@
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "prorate_up_front"
+ ]
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
"required": [
"amendment_start"
],
"title": "amendment_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendment_end",
+ "amendment_start",
+ "billing_cycle_anchor",
+ "discount_actions",
+ "item_actions",
+ "metadata_actions",
+ "proration_behavior",
+ "set_pause_collection",
+ "set_schedule_end",
+ "trial_settings"
+ ]
},
"type": "array"
},
@@ -114582,7 +127621,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -114602,7 +127645,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -114611,7 +127659,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -114642,7 +127693,7 @@
"type": "string"
},
"unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
+ "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.",
"type": "integer"
},
"unit_amount_decimal": {
@@ -114656,7 +127707,12 @@
"product"
],
"title": "one_time_price_data_with_negative_amounts",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for this item. Defaults to 1.",
@@ -114683,6 +127739,10 @@
},
"title": "add_invoice_item_entry",
"type": "object",
+ "x-stripeMostCommon": [
+ "price",
+ "quantity"
+ ],
"x-stripeParam": {
"class_name": "AddInvoiceItem"
}
@@ -114720,14 +127780,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"billing_cycle_anchor": {
"description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).",
@@ -114751,7 +127819,11 @@
}
},
"title": "billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_gte",
+ "reset_billing_cycle_anchor"
+ ]
},
{
"enum": [
@@ -114858,7 +127930,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -114878,7 +127954,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -114887,7 +127968,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -114961,11 +128045,25 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"title": "invoice_settings",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "custom_fields",
+ "days_until_due",
+ "description",
+ "footer",
+ "issuer",
+ "send_hosted_payment_email",
+ "supported_payment_methods"
+ ]
},
"items": {
"description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.",
@@ -114984,7 +128082,10 @@
"usage_gte"
],
"title": "item_billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "usage_gte"
+ ]
},
{
"enum": [
@@ -115036,7 +128137,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -115056,7 +128161,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -115065,7 +128175,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -115129,7 +128242,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -115156,7 +128272,13 @@
"recurring"
],
"title": "recurring_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "recurring",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.",
@@ -115204,11 +128326,25 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"title": "configuration_item_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_thresholds",
+ "discounts",
+ "metadata",
+ "plan",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"type": "array"
},
@@ -115244,7 +128380,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "behavior"
+ ]
},
"proration_behavior": {
"description": "Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.",
@@ -115287,7 +128426,11 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_percent",
+ "destination"
+ ]
},
"trial": {
"description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.",
@@ -115333,18 +128476,53 @@
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "prorate_up_front"
+ ]
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
"required": [
"items"
],
"title": "phase_configuration_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add_invoice_items",
+ "application_fee_percent",
+ "automatic_tax",
+ "billing_cycle_anchor",
+ "billing_thresholds",
+ "collection_method",
+ "coupon",
+ "currency",
+ "default_payment_method",
+ "default_tax_rates",
+ "description",
+ "discounts",
+ "end_date",
+ "invoice_settings",
+ "items",
+ "iterations",
+ "metadata",
+ "on_behalf_of",
+ "pause_collection",
+ "proration_behavior",
+ "start_date",
+ "tax_filing_currency",
+ "transfer_data",
+ "trial",
+ "trial_continuation",
+ "trial_end",
+ "trial_settings"
+ ]
},
"type": "array"
},
@@ -115368,7 +128546,10 @@
"index"
],
"title": "amendment_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "index"
+ ]
},
"duration": {
"description": "Time span for prebilling, starting from `bill_from`.",
@@ -115393,7 +128574,11 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "End the prebilled period at a precise integer timestamp, starting from the Unix epoch.",
@@ -115415,7 +128600,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendment_end",
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"iterations": {
"description": "This is used to determine the number of billing cycles to prebill.",
@@ -115423,7 +128614,11 @@
}
},
"title": "prebilling_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bill_until",
+ "iterations"
+ ]
},
"type": "array"
},
@@ -115447,7 +128642,15 @@
}
},
"title": "schedule_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendments",
+ "billing_behavior",
+ "end_behavior",
+ "phases",
+ "prebilling",
+ "proration_behavior"
+ ]
},
"style": "deepObject"
},
@@ -115636,7 +128839,10 @@
"usage_gte"
],
"title": "item_billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "usage_gte"
+ ]
},
{
"enum": [
@@ -115696,7 +128902,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -115716,7 +128926,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -115725,7 +128940,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -115804,7 +129022,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -115831,7 +129052,13 @@
"recurring"
],
"title": "recurring_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "recurring",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for this item.",
@@ -115857,7 +129084,19 @@
}
},
"title": "subscription_item_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_thresholds",
+ "clear_usage",
+ "deleted",
+ "discounts",
+ "id",
+ "metadata",
+ "plan",
+ "price",
+ "quantity",
+ "tax_rates"
+ ]
},
"type": "array"
},
@@ -115873,7 +129112,10 @@
"iterations"
],
"title": "prebilling_preview_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iterations"
+ ]
},
"proration_behavior": {
"description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.",
@@ -115920,7 +129162,21 @@
}
},
"title": "subscription_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_cycle_anchor",
+ "cancel_at",
+ "cancel_at_period_end",
+ "cancel_now",
+ "default_tax_rates",
+ "items",
+ "prebilling",
+ "proration_behavior",
+ "proration_date",
+ "resume_at",
+ "start_date",
+ "trial_end"
+ ]
},
"style": "deepObject"
},
@@ -115946,7 +129202,10 @@
"usage_gte"
],
"title": "item_billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "usage_gte"
+ ]
},
{
"enum": [
@@ -116006,7 +129265,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -116026,7 +129289,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -116035,7 +129303,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -116114,7 +129385,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -116141,7 +129415,13 @@
"recurring"
],
"title": "recurring_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "recurring",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for this item.",
@@ -116167,7 +129447,19 @@
}
},
"title": "subscription_item_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_thresholds",
+ "clear_usage",
+ "deleted",
+ "discounts",
+ "id",
+ "metadata",
+ "plan",
+ "price",
+ "quantity",
+ "tax_rates"
+ ]
},
"type": "array"
},
@@ -116190,7 +129482,10 @@
"iterations"
],
"title": "prebilling_preview_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iterations"
+ ]
},
"style": "deepObject"
},
@@ -116353,14 +129648,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"style": "deepObject"
},
@@ -116440,7 +129743,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
{
"enum": [
@@ -116490,7 +129801,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"name": {
"description": "Customer name.",
@@ -116508,7 +129827,12 @@
"name"
],
"title": "customer_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "name",
+ "phone"
+ ]
},
{
"enum": [
@@ -116538,7 +129862,10 @@
}
},
"title": "tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ip_address"
+ ]
},
"tax_exempt": {
"description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.",
@@ -116555,7 +129882,7 @@
"items": {
"properties": {
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -116589,6 +129916,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -116645,13 +129973,24 @@
"value"
],
"title": "data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type",
+ "value"
+ ]
},
"type": "array"
}
},
"title": "customer_details_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "shipping",
+ "tax",
+ "tax_exempt",
+ "tax_ids"
+ ]
},
"style": "deepObject"
},
@@ -116702,7 +130041,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -116722,7 +130065,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -116731,7 +130079,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -116772,7 +130123,7 @@
"style": "deepObject"
},
{
- "description": "List of invoice items to add or update in the upcoming invoice preview.",
+ "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).",
"explode": true,
"in": "query",
"name": "invoice_items",
@@ -116838,7 +130189,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -116858,7 +130213,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -116867,7 +130227,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -116921,7 +130284,11 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end",
+ "start"
+ ]
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
@@ -116964,7 +130331,12 @@
"product"
],
"title": "one_time_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Non-negative integer. The quantity of units for the invoice item.",
@@ -117022,7 +130394,24 @@
}
},
"title": "invoice_item_preview_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "discountable",
+ "discounts",
+ "invoiceitem",
+ "metadata",
+ "period",
+ "price",
+ "quantity",
+ "tax_behavior",
+ "tax_code",
+ "tax_rates",
+ "unit_amount",
+ "unit_amount_decimal"
+ ]
},
"type": "array"
},
@@ -117053,7 +130442,11 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
},
"style": "deepObject"
},
@@ -117141,7 +130534,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount"
+ ]
},
"duration": {
"description": "Time span for the amendment starting from the `amendment_start`.",
@@ -117166,7 +130562,11 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.",
@@ -117191,7 +130591,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount_end",
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"amendment_start": {
"description": "Details to identify the earliest timestamp where the proposed change should take effect.",
@@ -117208,7 +130614,10 @@
"index"
],
"title": "amendment_end_index_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "index"
+ ]
},
"discount_end": {
"description": "Use the `end` time of a given discount.",
@@ -117223,7 +130632,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to start.",
@@ -117249,7 +130661,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendment_end",
+ "discount_end",
+ "timestamp",
+ "type"
+ ]
},
"billing_cycle_anchor": {
"description": "For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.",
@@ -117291,7 +130709,10 @@
"type"
],
"title": "amendment_discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"index": {
"description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.",
@@ -117304,7 +130725,14 @@
}
},
"title": "add_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "discount_end",
+ "index",
+ "promotion_code"
+ ]
},
"remove": {
"description": "Details of the discount to remove.",
@@ -117326,7 +130754,12 @@
}
},
"title": "remove_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "promotion_code"
+ ]
},
"set": {
"description": "Details of the discount to replace the existing discounts with.",
@@ -117348,7 +130781,12 @@
}
},
"title": "set_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "promotion_code"
+ ]
},
"type": {
"description": "Determines the type of discount action.",
@@ -117364,7 +130802,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add",
+ "remove",
+ "set",
+ "type"
+ ]
},
"type": "array"
},
@@ -117415,7 +130859,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -117435,7 +130883,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -117444,7 +130897,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -117496,14 +130952,26 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"required": [
"price"
],
"title": "add_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discounts",
+ "metadata",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"remove": {
"description": "Details of the subscription item to remove.",
@@ -117518,7 +130986,10 @@
"price"
],
"title": "remove_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "price"
+ ]
},
"set": {
"description": "Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.",
@@ -117563,7 +131034,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -117583,7 +131058,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -117592,7 +131072,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -117644,14 +131127,26 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"required": [
"price"
],
"title": "set_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discounts",
+ "metadata",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"type": {
"description": "Determines the type of item action.",
@@ -117667,7 +131162,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add",
+ "remove",
+ "set",
+ "type"
+ ]
},
"type": "array"
},
@@ -117721,7 +131222,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add",
+ "remove",
+ "set",
+ "type"
+ ]
},
"type": "array"
},
@@ -117754,7 +131261,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "behavior"
+ ]
},
"type": {
"description": "Determines the type of the pause_collection amendment.",
@@ -117769,7 +131279,11 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "set",
+ "type"
+ ]
},
"set_schedule_end": {
"description": "Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.",
@@ -117795,18 +131309,36 @@
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "prorate_up_front"
+ ]
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
"required": [
"amendment_start"
],
"title": "amendment_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendment_end",
+ "amendment_start",
+ "billing_cycle_anchor",
+ "discount_actions",
+ "item_actions",
+ "metadata_actions",
+ "proration_behavior",
+ "set_pause_collection",
+ "set_schedule_end",
+ "trial_settings"
+ ]
},
"type": "array"
},
@@ -117874,7 +131406,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -117894,7 +131430,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -117903,7 +131444,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -117934,7 +131478,7 @@
"type": "string"
},
"unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
+ "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.",
"type": "integer"
},
"unit_amount_decimal": {
@@ -117948,7 +131492,12 @@
"product"
],
"title": "one_time_price_data_with_negative_amounts",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for this item. Defaults to 1.",
@@ -117975,6 +131524,10 @@
},
"title": "add_invoice_item_entry",
"type": "object",
+ "x-stripeMostCommon": [
+ "price",
+ "quantity"
+ ],
"x-stripeParam": {
"class_name": "AddInvoiceItem"
}
@@ -118012,14 +131565,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"billing_cycle_anchor": {
"description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).",
@@ -118043,7 +131604,11 @@
}
},
"title": "billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_gte",
+ "reset_billing_cycle_anchor"
+ ]
},
{
"enum": [
@@ -118150,7 +131715,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -118170,7 +131739,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -118179,7 +131753,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -118253,11 +131830,25 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"title": "invoice_settings",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "custom_fields",
+ "days_until_due",
+ "description",
+ "footer",
+ "issuer",
+ "send_hosted_payment_email",
+ "supported_payment_methods"
+ ]
},
"items": {
"description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.",
@@ -118276,7 +131867,10 @@
"usage_gte"
],
"title": "item_billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "usage_gte"
+ ]
},
{
"enum": [
@@ -118328,7 +131922,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -118348,7 +131946,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -118357,7 +131960,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -118421,7 +132027,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -118448,7 +132057,13 @@
"recurring"
],
"title": "recurring_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "recurring",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.",
@@ -118496,11 +132111,25 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"title": "configuration_item_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_thresholds",
+ "discounts",
+ "metadata",
+ "plan",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"type": "array"
},
@@ -118536,7 +132165,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "behavior"
+ ]
},
"proration_behavior": {
"description": "Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.",
@@ -118579,7 +132211,11 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_percent",
+ "destination"
+ ]
},
"trial": {
"description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.",
@@ -118625,18 +132261,53 @@
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "prorate_up_front"
+ ]
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
"required": [
"items"
],
"title": "phase_configuration_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add_invoice_items",
+ "application_fee_percent",
+ "automatic_tax",
+ "billing_cycle_anchor",
+ "billing_thresholds",
+ "collection_method",
+ "coupon",
+ "currency",
+ "default_payment_method",
+ "default_tax_rates",
+ "description",
+ "discounts",
+ "end_date",
+ "invoice_settings",
+ "items",
+ "iterations",
+ "metadata",
+ "on_behalf_of",
+ "pause_collection",
+ "proration_behavior",
+ "start_date",
+ "tax_filing_currency",
+ "transfer_data",
+ "trial",
+ "trial_continuation",
+ "trial_end",
+ "trial_settings"
+ ]
},
"type": "array"
},
@@ -118660,7 +132331,10 @@
"index"
],
"title": "amendment_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "index"
+ ]
},
"duration": {
"description": "Time span for prebilling, starting from `bill_from`.",
@@ -118685,7 +132359,11 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "End the prebilled period at a precise integer timestamp, starting from the Unix epoch.",
@@ -118707,7 +132385,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendment_end",
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"iterations": {
"description": "This is used to determine the number of billing cycles to prebill.",
@@ -118715,7 +132399,11 @@
}
},
"title": "prebilling_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bill_until",
+ "iterations"
+ ]
},
"type": "array"
},
@@ -118739,7 +132427,15 @@
}
},
"title": "schedule_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendments",
+ "billing_behavior",
+ "end_behavior",
+ "phases",
+ "prebilling",
+ "proration_behavior"
+ ]
},
"style": "deepObject"
},
@@ -118939,7 +132635,10 @@
"usage_gte"
],
"title": "item_billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "usage_gte"
+ ]
},
{
"enum": [
@@ -118999,7 +132698,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -119019,7 +132722,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -119028,7 +132736,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -119107,7 +132818,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -119134,7 +132848,13 @@
"recurring"
],
"title": "recurring_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "recurring",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for this item.",
@@ -119160,7 +132880,19 @@
}
},
"title": "subscription_item_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_thresholds",
+ "clear_usage",
+ "deleted",
+ "discounts",
+ "id",
+ "metadata",
+ "plan",
+ "price",
+ "quantity",
+ "tax_rates"
+ ]
},
"type": "array"
},
@@ -119176,7 +132908,10 @@
"iterations"
],
"title": "prebilling_preview_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iterations"
+ ]
},
"proration_behavior": {
"description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.",
@@ -119223,7 +132958,21 @@
}
},
"title": "subscription_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_cycle_anchor",
+ "cancel_at",
+ "cancel_at_period_end",
+ "cancel_now",
+ "default_tax_rates",
+ "items",
+ "prebilling",
+ "proration_behavior",
+ "proration_date",
+ "resume_at",
+ "start_date",
+ "trial_end"
+ ]
},
"style": "deepObject"
},
@@ -119249,7 +132998,10 @@
"usage_gte"
],
"title": "item_billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "usage_gte"
+ ]
},
{
"enum": [
@@ -119309,7 +133061,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -119329,7 +133085,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -119338,7 +133099,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -119417,7 +133181,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -119444,7 +133211,13 @@
"recurring"
],
"title": "recurring_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "recurring",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for this item.",
@@ -119470,7 +133243,19 @@
}
},
"title": "subscription_item_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_thresholds",
+ "clear_usage",
+ "deleted",
+ "discounts",
+ "id",
+ "metadata",
+ "plan",
+ "price",
+ "quantity",
+ "tax_rates"
+ ]
},
"type": "array"
},
@@ -119493,7 +133278,10 @@
"iterations"
],
"title": "prebilling_preview_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iterations"
+ ]
},
"style": "deepObject"
},
@@ -119636,6 +133424,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -119919,7 +133713,13 @@
"description"
],
"title": "payment_plan_amount_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "days_until_due",
+ "description",
+ "due_date"
+ ]
},
"type": "array"
},
@@ -119967,14 +133767,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"collection_method": {
"description": "Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.",
@@ -120005,7 +133813,11 @@
"value"
],
"title": "custom_field_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name",
+ "value"
+ ]
},
"type": "array"
},
@@ -120124,7 +133936,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -120144,7 +133960,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -120153,7 +133974,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -120219,7 +134043,11 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
},
"metadata": {
"anyOf": [
@@ -120305,7 +134133,10 @@
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "transaction_type"
+ ]
},
"verification_method": {
"description": "Verification method for the intent",
@@ -120319,7 +134150,11 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -120346,7 +134181,10 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred_language"
+ ]
},
{
"enum": [
@@ -120396,7 +134234,12 @@
"type"
],
"title": "installment_plan",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "count",
+ "interval",
+ "type"
+ ]
},
{
"enum": [
@@ -120409,7 +134252,11 @@
}
},
"title": "installments_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "plan"
+ ]
},
"request_three_d_secure": {
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
@@ -120422,7 +134269,11 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "installments",
+ "request_three_d_secure"
+ ]
},
{
"enum": [
@@ -120453,7 +134304,10 @@
"country"
],
"title": "eu_bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"type": {
"description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
@@ -120461,7 +134315,12 @@
}
},
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "eu_bank_transfer",
+ "id_bank_transfer",
+ "type"
+ ]
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
@@ -120469,7 +134328,11 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank_transfer",
+ "funding_type"
+ ]
},
{
"enum": [
@@ -120501,7 +134364,10 @@
{
"properties": {},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "verification_method"
+ ]
},
{
"enum": [
@@ -120540,7 +134406,11 @@
}
},
"title": "invoice_linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_subcategories",
+ "institution"
+ ]
},
"permissions": {
"description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.",
@@ -120572,7 +134442,12 @@
}
},
"title": "invoice_linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "filters",
+ "permissions",
+ "prefetch"
+ ]
},
"verification_method": {
"description": "Verification method for the intent",
@@ -120586,7 +134461,11 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "financial_connections",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -120599,7 +134478,17 @@
}
},
"title": "payment_method_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "bancontact",
+ "card",
+ "customer_balance",
+ "id_bank_transfer",
+ "konbini",
+ "sepa_debit",
+ "us_bank_account"
+ ]
},
"payment_method_types": {
"anyOf": [
@@ -120653,7 +134542,12 @@
}
},
"title": "payment_settings",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_mandate",
+ "payment_method_options",
+ "payment_method_types"
+ ]
},
"rendering": {
"description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.",
@@ -120681,11 +134575,23 @@
}
},
"title": "rendering_pdf_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "page_size"
+ ]
}
},
"title": "rendering_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_tax_display",
+ "custom_text",
+ "invoice_title",
+ "pdf",
+ "summary_items_data",
+ "template",
+ "template_version"
+ ]
},
"shipping_cost": {
"anyOf": [
@@ -120726,7 +134632,11 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit",
+ "value"
+ ]
},
"minimum": {
"description": "The lower bound of the estimated range. If empty, represents no lower bound.",
@@ -120752,11 +134662,19 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit",
+ "value"
+ ]
}
},
"title": "delivery_estimate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "maximum",
+ "minimum"
+ ]
},
"display_name": {
"description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.",
@@ -120795,7 +134713,11 @@
"amount"
],
"title": "currency_option",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "tax_behavior"
+ ]
},
"description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
"type": "object"
@@ -120806,7 +134728,12 @@
"currency"
],
"title": "fixed_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "currency_options"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -120840,11 +134767,21 @@
"display_name"
],
"title": "method_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_name",
+ "fixed_amount",
+ "metadata",
+ "type"
+ ]
}
},
"title": "shipping_cost",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "shipping_rate",
+ "shipping_rate_data"
+ ]
},
{
"enum": [
@@ -120894,7 +134831,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"name": {
"description": "Recipient name.",
@@ -120922,7 +134867,12 @@
"name"
],
"title": "recipient_shipping_with_optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "name",
+ "phone"
+ ]
},
{
"enum": [
@@ -120955,7 +134905,11 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "destination"
+ ]
},
{
"enum": [
@@ -120967,7 +134921,13 @@
"description": "If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "auto_advance",
+ "collection_method",
+ "description",
+ "metadata"
+ ]
}
}
},
@@ -121116,7 +135076,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -121136,7 +135100,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -121145,7 +135114,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -121217,7 +135189,11 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end",
+ "start"
+ ]
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
@@ -121273,7 +135249,14 @@
"name"
],
"title": "product_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "images",
+ "metadata",
+ "name",
+ "tax_code"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -121298,7 +135281,12 @@
"currency"
],
"title": "one_time_price_data_with_product_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Non-negative integer. The quantity of units for the line item.",
@@ -121375,7 +135363,17 @@
"percentage"
],
"title": "tax_rate_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country",
+ "description",
+ "display_name",
+ "inclusive",
+ "jurisdiction",
+ "percentage",
+ "state",
+ "tax_type"
+ ]
},
"taxable_amount": {
"description": "The amount on which tax is calculated, in cents (or local equivalent).",
@@ -121388,7 +135386,12 @@
"taxable_amount"
],
"title": "tax_amount_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "tax_rate_data",
+ "taxable_amount"
+ ]
},
"type": "array"
},
@@ -121421,7 +135424,16 @@
}
},
"title": "lines_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "description",
+ "invoice_item",
+ "metadata",
+ "period",
+ "price",
+ "quantity"
+ ]
},
"type": "array"
}
@@ -121429,7 +135441,11 @@
"required": [
"lines"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "invoice_metadata",
+ "lines"
+ ]
}
}
},
@@ -121553,7 +135569,13 @@
"money_movement_type"
],
"title": "out_of_band_payment",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "money_movement_type",
+ "payment_reference"
+ ]
},
"payment_intent": {
"description": "The ID of the PaymentIntent to attach to the invoice.",
@@ -121561,7 +135583,12 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_requested",
+ "out_of_band_payment",
+ "payment_intent"
+ ]
}
}
},
@@ -121640,7 +135667,11 @@
"required": [
"payment_intent"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_requested",
+ "payment_intent"
+ ]
}
}
},
@@ -121711,7 +135742,10 @@
"type": "array"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "auto_advance"
+ ]
}
}
},
@@ -121858,6 +135892,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -121999,7 +136039,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -122019,7 +136063,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -122028,7 +136077,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -122103,7 +136155,11 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end",
+ "start"
+ ]
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
@@ -122159,7 +136215,14 @@
"name"
],
"title": "product_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "images",
+ "metadata",
+ "name",
+ "tax_code"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -122184,7 +136247,12 @@
"currency"
],
"title": "one_time_price_data_with_product_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Non-negative integer. The quantity of units for the line item.",
@@ -122261,7 +136329,17 @@
"percentage"
],
"title": "tax_rate_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country",
+ "description",
+ "display_name",
+ "inclusive",
+ "jurisdiction",
+ "percentage",
+ "state",
+ "tax_type"
+ ]
},
"taxable_amount": {
"description": "The amount on which tax is calculated, in cents (or local equivalent).",
@@ -122274,7 +136352,12 @@
"taxable_amount"
],
"title": "tax_amount_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "tax_rate_data",
+ "taxable_amount"
+ ]
},
"type": "array"
},
@@ -122306,7 +136389,15 @@
"description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "description",
+ "metadata",
+ "period",
+ "price",
+ "quantity"
+ ]
}
}
},
@@ -122628,6 +136719,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -122809,7 +136906,11 @@
"id"
],
"title": "lines_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "behavior",
+ "id"
+ ]
},
"type": "array"
}
@@ -122817,7 +136918,11 @@
"required": [
"lines"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "invoice_metadata",
+ "lines"
+ ]
}
}
},
@@ -123033,7 +137138,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -123053,7 +137162,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -123062,7 +137176,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -123134,7 +137251,11 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end",
+ "start"
+ ]
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
@@ -123190,7 +137311,14 @@
"name"
],
"title": "product_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "images",
+ "metadata",
+ "name",
+ "tax_code"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -123215,7 +137343,12 @@
"currency"
],
"title": "one_time_price_data_with_product_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Non-negative integer. The quantity of units for the line item.",
@@ -123292,7 +137425,17 @@
"percentage"
],
"title": "tax_rate_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country",
+ "description",
+ "display_name",
+ "inclusive",
+ "jurisdiction",
+ "percentage",
+ "state",
+ "tax_type"
+ ]
},
"taxable_amount": {
"description": "The amount on which tax is calculated, in cents (or local equivalent).",
@@ -123305,7 +137448,12 @@
"taxable_amount"
],
"title": "tax_amount_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "tax_rate_data",
+ "taxable_amount"
+ ]
},
"type": "array"
},
@@ -123341,7 +137489,16 @@
"id"
],
"title": "lines_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "description",
+ "id",
+ "metadata",
+ "period",
+ "price",
+ "quantity"
+ ]
},
"type": "array"
}
@@ -123349,7 +137506,11 @@
"required": [
"lines"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "invoice_metadata",
+ "lines"
+ ]
}
}
},
@@ -123501,7 +137662,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -123627,6 +137794,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -123770,7 +137943,10 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata"
+ ]
}
}
},
@@ -123863,7 +138039,11 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "metadata"
+ ]
}
}
},
@@ -123952,7 +138132,10 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata"
+ ]
}
}
},
@@ -124015,7 +138198,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -124176,6 +138365,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -124277,14 +138472,25 @@
"postal_code"
],
"title": "required_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
}
},
"required": [
"address"
],
"title": "billing_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address"
+ ]
},
"company": {
"description": "Additional information about a `company` cardholder.",
@@ -124296,7 +138502,10 @@
}
},
"title": "company_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"email": {
"description": "The cardholder's email address.",
@@ -124345,11 +138554,19 @@
}
},
"title": "terms_acceptance_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
}
},
"title": "card_issuing_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "user_terms_acceptance"
+ ]
},
"dob": {
"description": "The date of birth of this cardholder. Cardholders must be older than 13 years old.",
@@ -124373,7 +138590,12 @@
"year"
],
"title": "date_of_birth_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
"first_name": {
"description": "The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.",
@@ -124401,15 +138623,30 @@
}
},
"title": "person_verification_document_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
}
},
"title": "person_verification_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "document"
+ ]
}
},
"title": "individual_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "card_issuing",
+ "dob",
+ "first_name",
+ "last_name",
+ "user_terms_acceptance",
+ "verification"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -125400,7 +139637,12 @@
"interval"
],
"title": "spending_limits_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "categories",
+ "interval"
+ ]
},
"type": "array"
},
@@ -125410,7 +139652,17 @@
}
},
"title": "authorization_controls_param_v2",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allowed_categories",
+ "allowed_merchant_countries",
+ "allowed_merchant_network_ids",
+ "blocked_categories",
+ "blocked_merchant_countries",
+ "blocked_merchant_network_ids",
+ "spending_limits",
+ "spending_limits_currency"
+ ]
},
"status": {
"description": "Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`.",
@@ -125434,7 +139686,14 @@
"billing",
"name"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing",
+ "email",
+ "metadata",
+ "name",
+ "phone_number"
+ ]
}
}
},
@@ -125626,14 +139885,25 @@
"postal_code"
],
"title": "required_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
}
},
"required": [
"address"
],
"title": "billing_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address"
+ ]
},
"company": {
"description": "Additional information about a `company` cardholder.",
@@ -125645,7 +139915,10 @@
}
},
"title": "company_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"email": {
"description": "The cardholder's email address.",
@@ -125694,11 +139967,19 @@
}
},
"title": "terms_acceptance_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
}
},
"title": "card_issuing_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "user_terms_acceptance"
+ ]
},
"dob": {
"description": "The date of birth of this cardholder. Cardholders must be older than 13 years old.",
@@ -125722,7 +140003,12 @@
"year"
],
"title": "date_of_birth_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
"first_name": {
"description": "The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.",
@@ -125750,15 +140036,30 @@
}
},
"title": "person_verification_document_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
}
},
"title": "person_verification_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "document"
+ ]
}
},
"title": "individual_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "card_issuing",
+ "dob",
+ "first_name",
+ "last_name",
+ "user_terms_acceptance",
+ "verification"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -126745,7 +141046,12 @@
"interval"
],
"title": "spending_limits_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "categories",
+ "interval"
+ ]
},
"type": "array"
},
@@ -126755,7 +141061,17 @@
}
},
"title": "authorization_controls_param_v2",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allowed_categories",
+ "allowed_merchant_countries",
+ "allowed_merchant_network_ids",
+ "blocked_categories",
+ "blocked_merchant_countries",
+ "blocked_merchant_network_ids",
+ "spending_limits",
+ "spending_limits_currency"
+ ]
},
"status": {
"description": "Specifies whether to permit authorizations on this cardholder's cards.",
@@ -126766,7 +141082,13 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing",
+ "email",
+ "metadata",
+ "phone_number"
+ ]
}
}
},
@@ -126840,7 +141162,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -127022,6 +141350,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -127117,7 +141451,10 @@
}
},
"title": "encrypted_pin_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "encrypted_number"
+ ]
},
"replacement_for": {
"description": "The card this is meant to be a replacement for (if any).",
@@ -127194,7 +141531,15 @@
"postal_code"
],
"title": "required_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"address_validation": {
"description": "Address validation settings.",
@@ -127213,7 +141558,10 @@
"mode"
],
"title": "address_validation_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode"
+ ]
},
"customs": {
"description": "Customs information for the shipment.",
@@ -127225,7 +141573,10 @@
}
},
"title": "customs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "eori_number"
+ ]
},
"name": {
"description": "The name printed on the shipping label when shipping the card.",
@@ -127264,7 +141615,18 @@
"name"
],
"title": "shipping_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "address_validation",
+ "customs",
+ "name",
+ "phone_number",
+ "require_signature",
+ "service",
+ "speed",
+ "type"
+ ]
},
"spending_controls": {
"description": "Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.",
@@ -128226,13 +142588,30 @@
"interval"
],
"title": "spending_limits_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "categories",
+ "interval"
+ ]
},
"type": "array"
}
},
"title": "authorization_controls_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allowed_categories",
+ "allowed_merchant_countries",
+ "allowed_merchant_currencies",
+ "allowed_merchant_network_ids",
+ "blocked_categories",
+ "blocked_merchant_countries",
+ "blocked_merchant_currencies",
+ "blocked_merchant_network_ids",
+ "max_approvals",
+ "spending_limits"
+ ]
},
"status": {
"description": "Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.",
@@ -128255,7 +142634,14 @@
"currency",
"type"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cardholder",
+ "currency",
+ "metadata",
+ "status",
+ "type"
+ ]
}
}
},
@@ -128443,7 +142829,10 @@
}
},
"title": "encrypted_pin_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "encrypted_number"
+ ]
},
"shipping": {
"description": "Updated shipping information for the card.",
@@ -128489,7 +142878,15 @@
"postal_code"
],
"title": "required_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"address_validation": {
"description": "Address validation settings.",
@@ -128508,7 +142905,10 @@
"mode"
],
"title": "address_validation_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode"
+ ]
},
"customs": {
"description": "Customs information for the shipment.",
@@ -128520,7 +142920,10 @@
}
},
"title": "customs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "eori_number"
+ ]
},
"name": {
"description": "The name printed on the shipping label when shipping the card.",
@@ -128559,7 +142962,18 @@
"name"
],
"title": "shipping_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "address_validation",
+ "customs",
+ "name",
+ "phone_number",
+ "require_signature",
+ "service",
+ "speed",
+ "type"
+ ]
},
"spending_controls": {
"description": "Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.",
@@ -129521,13 +143935,30 @@
"interval"
],
"title": "spending_limits_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "categories",
+ "interval"
+ ]
},
"type": "array"
}
},
"title": "authorization_controls_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allowed_categories",
+ "allowed_merchant_countries",
+ "allowed_merchant_currencies",
+ "allowed_merchant_network_ids",
+ "blocked_categories",
+ "blocked_merchant_countries",
+ "blocked_merchant_currencies",
+ "blocked_merchant_network_ids",
+ "max_approvals",
+ "spending_limits"
+ ]
},
"status": {
"description": "Dictates whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`.",
@@ -129540,7 +143971,12 @@
"x-stripeBypassValidation": true
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cancellation_reason",
+ "metadata",
+ "status"
+ ]
}
}
},
@@ -129677,6 +144113,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -129756,7 +144198,11 @@
"submitted_at"
],
"title": "application_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "purpose",
+ "submitted_at"
+ ]
},
"credit_user": {
"description": "Information about the company or person applying or holding the account.",
@@ -129776,7 +144222,11 @@
"name"
],
"title": "credit_user_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -129798,7 +144248,12 @@
"application",
"credit_user"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "application",
+ "credit_user",
+ "metadata"
+ ]
}
}
},
@@ -129878,7 +144333,11 @@
"name"
],
"title": "credit_user_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name"
+ ]
},
"decided_at": {
"description": "Date when a decision was made.",
@@ -129904,7 +144363,11 @@
"amount"
],
"title": "credit_limit_approved_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency"
+ ]
},
"credit_limit_decreased": {
"description": "Details about the credit limit decreased.",
@@ -130008,7 +144471,13 @@
"reasons"
],
"title": "credit_limit_decreased_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "reason_other_explanation",
+ "reasons"
+ ]
},
"credit_line_closed": {
"description": "Details about the credit line closed.",
@@ -130103,7 +144572,11 @@
"reasons"
],
"title": "credit_line_closed_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reason_other_explanation",
+ "reasons"
+ ]
},
"type": {
"description": "Outcome of the decision.",
@@ -130120,7 +144593,13 @@
"type"
],
"title": "proactive_decision_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "credit_limit_approved",
+ "credit_limit_decreased",
+ "credit_line_closed",
+ "type"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -130137,6 +144616,11 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
"type": "object"
},
+ "regulatory_reporting_file": {
+ "description": "File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).",
+ "maxLength": 5000,
+ "type": "string"
+ },
"underwriting_exception": {
"description": "If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.",
"properties": {
@@ -130164,7 +144648,11 @@
"original_decision_type"
],
"title": "underwriting_exception_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "explanation",
+ "original_decision_type"
+ ]
}
},
"required": [
@@ -130172,7 +144660,13 @@
"decided_at",
"decision"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "credit_user",
+ "decided_at",
+ "decision",
+ "metadata"
+ ]
}
}
},
@@ -130350,7 +144844,11 @@
"submitted_at"
],
"title": "application_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "purpose",
+ "submitted_at"
+ ]
},
"credit_user": {
"description": "Information about the company or person applying or holding the account.",
@@ -130370,7 +144868,11 @@
"name"
],
"title": "credit_user_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name"
+ ]
},
"decided_at": {
"description": "Date when a decision was made.",
@@ -130465,7 +144967,11 @@
"reasons"
],
"title": "application_rejected_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reason_other_explanation",
+ "reasons"
+ ]
},
"credit_limit_approved": {
"description": "Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)",
@@ -130483,7 +144989,11 @@
"amount"
],
"title": "credit_limit_approved_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency"
+ ]
},
"credit_limit_decreased": {
"description": "Details about the credit limit decreased.",
@@ -130587,7 +145097,13 @@
"reasons"
],
"title": "credit_limit_decreased_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "reason_other_explanation",
+ "reasons"
+ ]
},
"credit_line_closed": {
"description": "Details about the credit line closed.",
@@ -130682,7 +145198,11 @@
"reasons"
],
"title": "credit_line_closed_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reason_other_explanation",
+ "reasons"
+ ]
},
"type": {
"description": "Outcome of the decision.",
@@ -130702,7 +145222,14 @@
"type"
],
"title": "correct_decision_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "application_rejected",
+ "credit_limit_approved",
+ "credit_limit_decreased",
+ "credit_line_closed",
+ "type"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -130719,6 +145246,11 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
"type": "object"
},
+ "regulatory_reporting_file": {
+ "description": "File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions). Optional if previously provided and no changes are needed.",
+ "maxLength": 5000,
+ "type": "string"
+ },
"underwriting_exception": {
"description": "If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.",
"properties": {
@@ -130746,10 +145278,21 @@
"original_decision_type"
],
"title": "underwriting_exception_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "explanation",
+ "original_decision_type"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "application",
+ "credit_user",
+ "decided_at",
+ "decision",
+ "metadata"
+ ]
}
}
},
@@ -130912,7 +145455,11 @@
"reasons"
],
"title": "application_rejected_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reason_other_explanation",
+ "reasons"
+ ]
},
"credit_limit_approved": {
"description": "Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)",
@@ -130930,7 +145477,11 @@
"amount"
],
"title": "credit_limit_approved_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency"
+ ]
},
"type": {
"description": "Outcome of the decision.",
@@ -130947,7 +145498,12 @@
"type"
],
"title": "application_decision_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "application_rejected",
+ "credit_limit_approved",
+ "type"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -130964,6 +145520,11 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
"type": "object"
},
+ "regulatory_reporting_file": {
+ "description": "File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).",
+ "maxLength": 5000,
+ "type": "string"
+ },
"underwriting_exception": {
"description": "If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.",
"properties": {
@@ -130991,14 +145552,23 @@
"original_decision_type"
],
"title": "underwriting_exception_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "explanation",
+ "original_decision_type"
+ ]
}
},
"required": [
"decided_at",
"decision"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "decided_at",
+ "decision",
+ "metadata"
+ ]
}
}
},
@@ -131061,7 +145631,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -131200,6 +145776,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -131394,7 +145976,19 @@
}
},
"title": "canceled",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "canceled_at",
+ "cancellation_policy_provided",
+ "cancellation_reason",
+ "expected_at",
+ "explanation",
+ "product_description",
+ "product_type",
+ "return_status",
+ "returned_at"
+ ]
},
{
"enum": [
@@ -131487,7 +146081,15 @@
}
},
"title": "duplicate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "card_statement",
+ "cash_receipt",
+ "check_image",
+ "explanation",
+ "original_transaction"
+ ]
},
{
"enum": [
@@ -131533,7 +146135,11 @@
}
},
"title": "fraudulent",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "explanation"
+ ]
},
{
"enum": [
@@ -131633,7 +146239,15 @@
}
},
"title": "merchandise_not_as_described",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "explanation",
+ "received_at",
+ "return_description",
+ "return_status",
+ "returned_at"
+ ]
},
{
"enum": [
@@ -131679,7 +146293,11 @@
}
},
"title": "no_valid_authorization",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "explanation"
+ ]
},
{
"enum": [
@@ -131764,7 +146382,14 @@
}
},
"title": "not_received",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "expected_at",
+ "explanation",
+ "product_description",
+ "product_type"
+ ]
},
{
"enum": [
@@ -131834,7 +146459,13 @@
}
},
"title": "other",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "explanation",
+ "product_description",
+ "product_type"
+ ]
},
{
"enum": [
@@ -131940,7 +146571,14 @@
}
},
"title": "service_not_as_described",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "canceled_at",
+ "cancellation_reason",
+ "explanation",
+ "received_at"
+ ]
},
{
"enum": [
@@ -131953,7 +146591,18 @@
}
},
"title": "evidence_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "canceled",
+ "duplicate",
+ "fraudulent",
+ "merchandise_not_as_described",
+ "no_valid_authorization",
+ "not_received",
+ "other",
+ "reason",
+ "service_not_as_described"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -131988,10 +146637,18 @@
"received_debit"
],
"title": "treasury_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "received_debit"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "evidence",
+ "metadata",
+ "transaction"
+ ]
}
}
},
@@ -132272,7 +146929,19 @@
}
},
"title": "canceled",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "canceled_at",
+ "cancellation_policy_provided",
+ "cancellation_reason",
+ "expected_at",
+ "explanation",
+ "product_description",
+ "product_type",
+ "return_status",
+ "returned_at"
+ ]
},
{
"enum": [
@@ -132365,7 +147034,15 @@
}
},
"title": "duplicate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "card_statement",
+ "cash_receipt",
+ "check_image",
+ "explanation",
+ "original_transaction"
+ ]
},
{
"enum": [
@@ -132411,7 +147088,11 @@
}
},
"title": "fraudulent",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "explanation"
+ ]
},
{
"enum": [
@@ -132511,7 +147192,15 @@
}
},
"title": "merchandise_not_as_described",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "explanation",
+ "received_at",
+ "return_description",
+ "return_status",
+ "returned_at"
+ ]
},
{
"enum": [
@@ -132557,7 +147246,11 @@
}
},
"title": "no_valid_authorization",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "explanation"
+ ]
},
{
"enum": [
@@ -132642,7 +147335,14 @@
}
},
"title": "not_received",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "expected_at",
+ "explanation",
+ "product_description",
+ "product_type"
+ ]
},
{
"enum": [
@@ -132712,7 +147412,13 @@
}
},
"title": "other",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "explanation",
+ "product_description",
+ "product_type"
+ ]
},
{
"enum": [
@@ -132818,7 +147524,14 @@
}
},
"title": "service_not_as_described",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_documentation",
+ "canceled_at",
+ "cancellation_reason",
+ "explanation",
+ "received_at"
+ ]
},
{
"enum": [
@@ -132831,7 +147544,18 @@
}
},
"title": "evidence_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "canceled",
+ "duplicate",
+ "fraudulent",
+ "merchandise_not_as_described",
+ "no_valid_authorization",
+ "not_received",
+ "other",
+ "reason",
+ "service_not_as_described"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -132859,7 +147583,11 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "evidence",
+ "metadata"
+ ]
}
}
},
@@ -132947,7 +147675,10 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata"
+ ]
}
}
},
@@ -133051,7 +147782,11 @@
}
},
"title": "preferences_list_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "is_default",
+ "is_platform_default"
+ ]
},
"style": "deepObject"
},
@@ -133137,6 +147872,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -133251,7 +147992,13 @@
}
},
"title": "carrier_text_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "footer_body",
+ "footer_title",
+ "header_body",
+ "header_title"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -133295,7 +148042,10 @@
"is_default"
],
"title": "preferences_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "is_default"
+ ]
},
"transfer_lookup_key": {
"description": "If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.",
@@ -133305,7 +148055,17 @@
"required": [
"physical_bundle"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "card_logo",
+ "carrier_text",
+ "lookup_key",
+ "metadata",
+ "name",
+ "physical_bundle",
+ "preferences",
+ "transfer_lookup_key"
+ ]
}
}
},
@@ -133533,7 +148293,13 @@
}
},
"title": "carrier_text_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "footer_body",
+ "footer_title",
+ "header_body",
+ "header_title"
+ ]
},
{
"enum": [
@@ -133606,14 +148372,27 @@
"is_default"
],
"title": "preferences_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "is_default"
+ ]
},
"transfer_lookup_key": {
"description": "If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.",
"type": "boolean"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "card_logo",
+ "carrier_text",
+ "lookup_key",
+ "metadata",
+ "name",
+ "physical_bundle",
+ "preferences",
+ "transfer_lookup_key"
+ ]
}
}
},
@@ -133779,6 +148558,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -133910,7 +148695,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -134036,6 +148827,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -134170,7 +148967,10 @@
"required": [
"status"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "status"
+ ]
}
}
},
@@ -134255,7 +149055,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -134380,6 +149186,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -134523,7 +149335,10 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata"
+ ]
}
}
},
@@ -134736,6 +149551,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -134821,7 +149642,10 @@
"enabled"
],
"title": "automatic_tax",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"billing_details": {
"anyOf": [
@@ -134862,7 +149686,15 @@
}
},
"title": "validated_optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"email": {
"description": "The billing email provided by the customer.",
@@ -134880,7 +149712,13 @@
}
},
"title": "billing_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
+ ]
},
{
"enum": [
@@ -134913,7 +149751,11 @@
"type"
],
"title": "credits_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gift_card",
+ "type"
+ ]
},
"type": "array"
},
@@ -134962,7 +149804,11 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "coupon_data"
+ ]
},
"type": "array"
},
@@ -135013,7 +149859,11 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "coupon_data"
+ ]
},
"type": "array"
},
@@ -135063,7 +149913,12 @@
}
},
"title": "price_data_with_optional_product",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"product": {
"description": "The ID of a [Product](https://stripe.com/docs/api/products) to add to the Order.\n\nThe product must have a `default_price` specified. Otherwise, specify the price by passing the `price` or `price_data` parameter.",
@@ -135160,7 +150015,13 @@
"width"
],
"title": "package_dimensions_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "height",
+ "length",
+ "weight",
+ "width"
+ ]
},
{
"enum": [
@@ -135210,7 +150071,14 @@
"name"
],
"title": "product_upsert_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "id",
+ "metadata",
+ "name",
+ "sku",
+ "tax_code"
+ ]
},
"quantity": {
"description": "The quantity of the line item.",
@@ -135236,7 +150104,11 @@
}
},
"title": "create_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "product",
+ "quantity"
+ ]
},
"type": "array"
},
@@ -135304,7 +150176,13 @@
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom_mandate_url",
+ "interval_description",
+ "payment_schedule",
+ "transaction_type"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -135328,7 +150206,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage",
+ "verification_method"
+ ]
},
"afterpay_clearpay": {
"description": "If paying by `afterpay_clearpay`, this sub-hash contains details about the AfterpayClearpay payment method options to pass to the order's PaymentIntent.",
@@ -135356,7 +150239,12 @@
}
},
"title": "afterpay_clearpay_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "reference",
+ "setup_future_usage"
+ ]
},
"alipay": {
"description": "If paying by `alipay`, this sub-hash contains details about the Alipay payment method options to pass to the order's PaymentIntent.",
@@ -135372,7 +150260,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"bancontact": {
"description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the order's PaymentIntent.",
@@ -135398,7 +150289,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred_language",
+ "setup_future_usage"
+ ]
},
"card": {
"description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the order's PaymentIntent.",
@@ -135423,7 +150318,11 @@
}
},
"title": "card_payment_method_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "setup_future_usage"
+ ]
},
"customer_balance": {
"description": "If paying by `customer_balance`, this sub-hash contains details about the Customer Balance payment method options to pass to the order's PaymentIntent.",
@@ -135444,7 +150343,10 @@
"country"
],
"title": "eu_bank_transfer_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"requested_address_types": {
"description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.",
@@ -135480,7 +150382,14 @@
"type"
],
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "eu_bank_transfer",
+ "id_bank_account",
+ "id_bank_transfer",
+ "requested_address_types",
+ "type"
+ ]
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
@@ -135498,7 +150407,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank_transfer",
+ "funding_type",
+ "setup_future_usage"
+ ]
},
"ideal": {
"description": "If paying by `ideal`, this sub-hash contains details about the iDEAL payment method options to pass to the order's PaymentIntent.",
@@ -135514,7 +150428,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
"klarna": {
"description": "If paying by `klarna`, this sub-hash contains details about the Klarna payment method options to pass to the order's PaymentIntent.",
@@ -135590,7 +150507,15 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "line_items",
+ "payment_details",
+ "payment_method_category",
+ "preferred_locale",
+ "setup_future_usage"
+ ]
},
"link": {
"description": "If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent.",
@@ -135619,7 +150544,13 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "persistent_token",
+ "request_multicapture",
+ "setup_future_usage"
+ ]
},
"oxxo": {
"description": "If paying by `oxxo`, this sub-hash contains details about the OXXO payment method options to pass to the order's PaymentIntent.",
@@ -135637,7 +150568,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
"p24": {
"description": "If paying by `p24`, this sub-hash contains details about the P24 payment method options to pass to the order's PaymentIntent.",
@@ -135655,7 +150590,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "installments",
+ "setup_future_usage",
+ "tos_shown_and_accepted"
+ ]
},
"paypal": {
"description": "If paying by `paypal`, this sub-hash contains details about the PayPal payment method options to pass to the order's PaymentIntent.",
@@ -135730,7 +150670,18 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allow_delayed_notification",
+ "capture_method",
+ "line_items",
+ "preferred_locale",
+ "reference",
+ "reference_id",
+ "risk_correlation_id",
+ "setup_future_usage",
+ "subsellers"
+ ]
},
"sepa_debit": {
"description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Debit payment method options to pass to the order's PaymentIntent.",
@@ -135739,7 +150690,11 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reference",
+ "reference_prefix"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -135753,7 +150708,13 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage",
+ "target_date",
+ "verification_method"
+ ]
},
"sofort": {
"description": "If paying by `sofort`, this sub-hash contains details about the Sofort payment method options to pass to the order's PaymentIntent.",
@@ -135783,7 +150744,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred_language",
+ "setup_future_usage"
+ ]
},
"wechat_pay": {
"description": "If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the order's PaymentIntent.",
@@ -135815,11 +150780,33 @@
"client"
],
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "app_id",
+ "client",
+ "setup_future_usage"
+ ]
}
},
"title": "create_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "afterpay_clearpay",
+ "alipay",
+ "bancontact",
+ "card",
+ "customer_balance",
+ "ideal",
+ "klarna",
+ "link",
+ "oxxo",
+ "p24",
+ "paypal",
+ "sepa_debit",
+ "sofort",
+ "wechat_pay"
+ ]
},
"payment_method_types": {
"description": "The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
@@ -135881,18 +150868,37 @@
"destination"
],
"title": "transfer_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_percent",
+ "destination"
+ ]
}
},
"title": "create_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "application_fee_amount",
+ "payment_method_options",
+ "payment_method_types",
+ "return_url",
+ "skip_payment_intent_creation",
+ "statement_descriptor",
+ "statement_descriptor_suffix",
+ "transfer_data",
+ "transfer_group"
+ ]
}
},
"required": [
"settings"
],
"title": "create_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "settings"
+ ]
},
"shipping_cost": {
"anyOf": [
@@ -135933,7 +150939,11 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit",
+ "value"
+ ]
},
"minimum": {
"description": "The lower bound of the estimated range. If empty, represents no lower bound.",
@@ -135959,11 +150969,19 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit",
+ "value"
+ ]
}
},
"title": "delivery_estimate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "maximum",
+ "minimum"
+ ]
},
"display_name": {
"description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.",
@@ -136002,7 +151020,11 @@
"amount"
],
"title": "currency_option",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "tax_behavior"
+ ]
},
"description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
"type": "object"
@@ -136013,7 +151035,12 @@
"currency"
],
"title": "fixed_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "currency_options"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -136047,11 +151074,21 @@
"display_name"
],
"title": "method_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_name",
+ "fixed_amount",
+ "metadata",
+ "type"
+ ]
}
},
"title": "shipping_cost",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "shipping_rate",
+ "shipping_rate_data"
+ ]
},
{
"enum": [
@@ -136101,7 +151138,15 @@
}
},
"title": "validated_optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"name": {
"description": "The name of the recipient of the order.",
@@ -136129,7 +151174,12 @@
"name"
],
"title": "shipping_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "name",
+ "phone"
+ ]
},
{
"enum": [
@@ -136158,7 +151208,7 @@
"items": {
"properties": {
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -136192,6 +151242,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -136248,20 +151299,36 @@
"value"
],
"title": "data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type",
+ "value"
+ ]
},
"type": "array"
}
},
"title": "tax_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_exempt",
+ "tax_ids"
+ ]
}
},
"required": [
"currency",
"line_items"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "customer",
+ "description",
+ "line_items",
+ "metadata",
+ "payment"
+ ]
}
}
},
@@ -136441,7 +151508,10 @@
"enabled"
],
"title": "automatic_tax",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"billing_details": {
"anyOf": [
@@ -136482,7 +151552,15 @@
}
},
"title": "validated_optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"email": {
"description": "The billing email provided by the customer.",
@@ -136500,7 +151578,13 @@
}
},
"title": "billing_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
+ ]
},
{
"enum": [
@@ -136533,7 +151617,11 @@
"type"
],
"title": "credits_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gift_card",
+ "type"
+ ]
},
"type": "array"
},
@@ -136592,7 +151680,11 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "coupon_data"
+ ]
},
"type": "array"
},
@@ -136643,7 +151735,11 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "coupon_data"
+ ]
},
"type": "array"
},
@@ -136698,7 +151794,12 @@
}
},
"title": "price_data_with_optional_product",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"product": {
"description": "The ID of a [Product](https://stripe.com/docs/api/products) to add to the Order.\n\nThe product must have a `default_price` specified. Otherwise, specify the price by passing the `price` or `price_data` parameter.",
@@ -136795,7 +151896,13 @@
"width"
],
"title": "package_dimensions_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "height",
+ "length",
+ "weight",
+ "width"
+ ]
},
{
"enum": [
@@ -136845,7 +151952,14 @@
"name"
],
"title": "product_upsert_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "id",
+ "metadata",
+ "name",
+ "sku",
+ "tax_code"
+ ]
},
"quantity": {
"description": "The quantity of the line item.",
@@ -136871,7 +151985,12 @@
}
},
"title": "update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "id",
+ "product",
+ "quantity"
+ ]
},
"type": "array"
},
@@ -136960,7 +152079,13 @@
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom_mandate_url",
+ "interval_description",
+ "payment_schedule",
+ "transaction_type"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -136984,7 +152109,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -137022,7 +152152,12 @@
}
},
"title": "afterpay_clearpay_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "reference",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -137048,7 +152183,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -137084,7 +152222,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred_language",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -137119,7 +152261,11 @@
}
},
"title": "card_payment_method_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -137150,7 +152296,10 @@
"country"
],
"title": "eu_bank_transfer_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"requested_address_types": {
"description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.",
@@ -137186,7 +152335,14 @@
"type"
],
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "eu_bank_transfer",
+ "id_bank_account",
+ "id_bank_transfer",
+ "requested_address_types",
+ "type"
+ ]
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
@@ -137204,7 +152360,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank_transfer",
+ "funding_type",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -137230,7 +152391,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -137316,7 +152480,15 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "line_items",
+ "payment_details",
+ "payment_method_category",
+ "preferred_locale",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -137355,7 +152527,13 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "persistent_token",
+ "request_multicapture",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -137383,7 +152561,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -137411,7 +152593,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "installments",
+ "setup_future_usage",
+ "tos_shown_and_accepted"
+ ]
},
{
"enum": [
@@ -137496,7 +152683,18 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allow_delayed_notification",
+ "capture_method",
+ "line_items",
+ "preferred_locale",
+ "reference",
+ "reference_id",
+ "risk_correlation_id",
+ "setup_future_usage",
+ "subsellers"
+ ]
},
{
"enum": [
@@ -137515,7 +152713,11 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reference",
+ "reference_prefix"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -137529,7 +152731,13 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage",
+ "target_date",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -137569,7 +152777,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred_language",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -137611,7 +152823,12 @@
"client"
],
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "app_id",
+ "client",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -137624,7 +152841,24 @@
}
},
"title": "update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "afterpay_clearpay",
+ "alipay",
+ "bancontact",
+ "card",
+ "customer_balance",
+ "ideal",
+ "klarna",
+ "link",
+ "oxxo",
+ "p24",
+ "paypal",
+ "sepa_debit",
+ "sofort",
+ "wechat_pay"
+ ]
},
"payment_method_types": {
"description": "The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
@@ -137697,7 +152931,12 @@
"destination"
],
"title": "transfer_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_percent",
+ "destination"
+ ]
},
{
"enum": [
@@ -137710,14 +152949,28 @@
}
},
"title": "update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "application_fee_amount",
+ "payment_method_options",
+ "payment_method_types",
+ "return_url",
+ "skip_payment_intent_creation",
+ "statement_descriptor",
+ "statement_descriptor_suffix",
+ "transfer_data",
+ "transfer_group"
+ ]
}
},
"required": [
"settings"
],
"title": "update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "settings"
+ ]
},
"shipping_cost": {
"anyOf": [
@@ -137758,7 +153011,11 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit",
+ "value"
+ ]
},
"minimum": {
"description": "The lower bound of the estimated range. If empty, represents no lower bound.",
@@ -137784,11 +153041,19 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit",
+ "value"
+ ]
}
},
"title": "delivery_estimate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "maximum",
+ "minimum"
+ ]
},
"display_name": {
"description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.",
@@ -137827,7 +153092,11 @@
"amount"
],
"title": "currency_option",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "tax_behavior"
+ ]
},
"description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
"type": "object"
@@ -137838,7 +153107,12 @@
"currency"
],
"title": "fixed_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "currency_options"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -137872,11 +153146,21 @@
"display_name"
],
"title": "method_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_name",
+ "fixed_amount",
+ "metadata",
+ "type"
+ ]
}
},
"title": "shipping_cost",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "shipping_rate",
+ "shipping_rate_data"
+ ]
},
{
"enum": [
@@ -137926,7 +153210,15 @@
}
},
"title": "validated_optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"name": {
"description": "The name of the recipient of the order.",
@@ -137954,7 +153246,12 @@
"name"
],
"title": "shipping_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "name",
+ "phone"
+ ]
},
{
"enum": [
@@ -137983,7 +153280,7 @@
"items": {
"properties": {
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -138017,6 +153314,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -138073,16 +153371,32 @@
"value"
],
"title": "data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type",
+ "value"
+ ]
},
"type": "array"
}
},
"title": "tax_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_exempt",
+ "tax_ids"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "customer",
+ "description",
+ "line_items",
+ "metadata",
+ "payment"
+ ]
}
}
},
@@ -138296,6 +153610,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -138426,7 +153746,10 @@
"required": [
"expected_total"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expected_total"
+ ]
}
}
},
@@ -138489,7 +153812,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -138611,6 +153940,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -138729,15 +154064,24 @@
"calculation"
],
"title": "async_workflows_inputs_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "calculation"
+ ]
}
},
"title": "async_workflows_inputs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax"
+ ]
}
},
"title": "async_workflows_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "inputs"
+ ]
},
"automatic_payment_methods": {
"description": "When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.",
@@ -138759,7 +154103,11 @@
"enabled"
],
"title": "automatic_payment_methods_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allow_redirects",
+ "enabled"
+ ]
},
"capture_method": {
"description": "Controls when the funds will be captured from the customer's account.",
@@ -138792,7 +154140,7 @@
"type": "string"
},
"customer": {
- "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
+ "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
"maxLength": 5000,
"type": "string"
},
@@ -138854,7 +154202,11 @@
"user_agent"
],
"title": "online_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ip_address",
+ "user_agent"
+ ]
},
"type": {
"description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.",
@@ -138870,14 +154222,23 @@
"type"
],
"title": "customer_acceptance_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "accepted_at",
+ "offline",
+ "online",
+ "type"
+ ]
}
},
"required": [
"customer_acceptance"
],
"title": "secret_key_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer_acceptance"
+ ]
},
{
"enum": [
@@ -138934,7 +154295,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"booking_number": {
"description": "The booking number associated with the car rental.",
@@ -139003,11 +154367,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"drivers": {
"description": "The details of the passengers in the travel reservation",
@@ -139023,7 +154396,10 @@
"name"
],
"title": "car_rental_driver",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -139080,7 +154456,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"pickup_at": {
"description": "Car pick-up time. Measured in seconds since the Unix epoch.",
@@ -139140,7 +154524,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"return_at": {
"description": "Car return time. Measured in seconds since the Unix epoch.",
@@ -139159,7 +154551,29 @@
"return_at"
],
"title": "car_rental",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "booking_number",
+ "car_class_code",
+ "car_make",
+ "car_model",
+ "company",
+ "customer_service_phone_number",
+ "days_rented",
+ "delivery",
+ "drivers",
+ "extra_charges",
+ "no_show",
+ "pickup_address",
+ "pickup_at",
+ "rate_amount",
+ "rate_interval",
+ "renter_name",
+ "return_address",
+ "return_at",
+ "tax_exempt"
+ ]
},
"event_details": {
"description": "Event details for this PaymentIntent",
@@ -139203,7 +154617,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -139218,7 +154640,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"company": {
"description": "The name of the company",
@@ -139258,11 +154683,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"ends_at": {
"description": "Event end time. Measured in seconds since the Unix epoch.",
@@ -139289,7 +154723,18 @@
"name"
],
"title": "event",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "access_controlled_venue",
+ "address",
+ "affiliate",
+ "company",
+ "delivery",
+ "ends_at",
+ "genre",
+ "name",
+ "starts_at"
+ ]
},
"flight": {
"description": "Flight reservation details for this PaymentIntent",
@@ -139307,7 +154752,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"agency_number": {
"description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.",
@@ -139352,11 +154800,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"passenger_name": {
"description": "The name of the person or entity on the reservation.",
@@ -139377,7 +154834,10 @@
"name"
],
"title": "flight_passenger",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -139434,7 +154894,17 @@
"departs_at"
],
"title": "flight_segment",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "arrival_airport",
+ "arrives_at",
+ "carrier",
+ "departs_at",
+ "departure_airport",
+ "flight_number",
+ "service_class"
+ ]
},
"type": "array"
},
@@ -139448,7 +154918,17 @@
"segments"
],
"title": "flight",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "agency_number",
+ "carrier",
+ "delivery",
+ "passenger_name",
+ "passengers",
+ "segments",
+ "ticket_number"
+ ]
},
"lodging": {
"description": "Lodging reservation details for this PaymentIntent",
@@ -139488,7 +154968,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"adults": {
"description": "The number of adults on the booking",
@@ -139507,7 +154995,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"booking_number": {
"description": "The booking number associated with the lodging reservation.",
@@ -139573,11 +155064,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -139625,7 +155125,10 @@
"name"
],
"title": "lodging_passenger",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -139656,7 +155159,30 @@
"checkout_at"
],
"title": "lodging",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "adults",
+ "affiliate",
+ "booking_number",
+ "category",
+ "checkin_at",
+ "checkout_at",
+ "customer_service_phone_number",
+ "daily_room_rate_amount",
+ "delivery",
+ "extra_charges",
+ "fire_safety_act_compliance",
+ "name",
+ "no_show",
+ "number_of_rooms",
+ "passengers",
+ "property_phone_number",
+ "room_class",
+ "room_nights",
+ "total_room_tax_amount",
+ "total_tax_amount"
+ ]
},
"subscription": {
"description": "Subscription details for this PaymentIntent",
@@ -139674,7 +155200,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"auto_renewal": {
"description": "Info whether the subscription will be auto renewed upon expiry.",
@@ -139703,7 +155232,11 @@
"interval"
],
"title": "subscription_billing_interval",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "count",
+ "interval"
+ ]
},
"ends_at": {
"description": "Subscription end time. Measured in seconds since the Unix epoch.",
@@ -139725,11 +155258,27 @@
"name"
],
"title": "subscription",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "auto_renewal",
+ "billing_interval",
+ "ends_at",
+ "name",
+ "starts_at"
+ ]
}
},
"title": "payment_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "car_rental",
+ "event_details",
+ "flight",
+ "healthcare",
+ "lodging",
+ "subscription"
+ ]
},
"payment_method": {
"description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent.\n\nIf you don't provide the `payment_method` parameter or the `source` parameter with `confirm=true`, `source` automatically populates with `customer.default_source` to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward.",
@@ -139769,7 +155318,12 @@
"transit_number"
],
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "institution_number",
+ "transit_number"
+ ]
},
"affirm": {
"description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.",
@@ -139823,7 +155377,11 @@
"bsb_number"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number"
+ ]
},
"bacs_debit": {
"description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.",
@@ -139840,7 +155398,11 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "sort_code"
+ ]
},
"bancontact": {
"description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.",
@@ -139887,7 +155449,15 @@
}
},
"title": "billing_details_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
{
"enum": [
@@ -139944,7 +155514,13 @@
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
+ ]
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -139965,7 +155541,10 @@
"tax_id"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"cashapp": {
"description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.",
@@ -140019,7 +155598,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"fpx": {
"description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.",
@@ -140068,7 +155650,11 @@
"bank"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "bank"
+ ]
},
"giropay": {
"description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.",
@@ -140110,13 +155696,22 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"interac_present": {
"description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "device_identifier",
+ "device_type",
+ "emv",
+ "location"
+ ]
},
"klarna": {
"description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.",
@@ -140143,11 +155738,19 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"konbini": {
"description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.",
@@ -140161,6 +155764,12 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"metadata": {
"additionalProperties": {
"type": "string"
@@ -140224,7 +155833,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"paynow": {
"description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.",
@@ -140258,13 +155870,21 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number",
+ "pay_id"
+ ]
},
"pix": {
"description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"promptpay": {
"description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.",
@@ -140282,7 +155902,11 @@
}
},
"title": "radar_options_with_hidden_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "session",
+ "skip_rules"
+ ]
},
"rechnung": {
"description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.",
@@ -140309,14 +155933,22 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"required": [
"dob"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"revolut_pay": {
"description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
@@ -140337,7 +155969,10 @@
"iban"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iban"
+ ]
},
"sofort": {
"description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.",
@@ -140359,7 +155994,10 @@
"country"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"swish": {
"description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.",
@@ -140396,6 +156034,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -140454,7 +156093,14 @@
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "account_number",
+ "account_type",
+ "financial_connections_account",
+ "routing_number"
+ ]
},
"wechat_pay": {
"description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.",
@@ -140473,7 +156119,12 @@
"type"
],
"title": "payment_method_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_details",
+ "metadata",
+ "type"
+ ]
},
"payment_method_options": {
"description": "Payment method-specific configuration for this PaymentIntent.",
@@ -140523,7 +156174,13 @@
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom_mandate_url",
+ "interval_description",
+ "payment_schedule",
+ "transaction_type"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -140547,7 +156204,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -140584,7 +156246,13 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "preferred_locale",
+ "purchase_details",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -140622,7 +156290,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "reference",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -140648,7 +156321,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -140682,7 +156358,13 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "charge_metadata",
+ "charge_permission_id",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -140709,7 +156391,10 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -140728,7 +156413,10 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reference_prefix"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -140742,7 +156430,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage",
+ "target_date"
+ ]
},
{
"enum": [
@@ -140778,7 +156471,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred_language",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -140809,7 +156506,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "code",
+ "mandate_options",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -140840,7 +156542,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -140903,7 +156609,12 @@
"type"
],
"title": "installment_plan",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "count",
+ "interval",
+ "type"
+ ]
},
{
"enum": [
@@ -140916,7 +156627,11 @@
}
},
"title": "installments_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "plan"
+ ]
},
"mandate_options": {
"description": "Configuration options for setting up an eMandate for cards issued in India.",
@@ -140987,7 +156702,18 @@
"start_date"
],
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "description",
+ "end_date",
+ "interval",
+ "interval_count",
+ "reference",
+ "start_date",
+ "supported_types"
+ ]
},
"moto": {
"description": "When specified, this parameter indicates that a transaction will be marked\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.",
@@ -141146,7 +156872,15 @@
}
},
"title": "statement_details_address_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"phone": {
"description": "Phone number (e.g., a toll-free number that customers can call)",
@@ -141155,7 +156889,11 @@
}
},
"title": "statement_details_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "phone"
+ ]
},
{
"enum": [
@@ -141239,11 +156977,19 @@
"cb_avalgo"
],
"title": "cartes_bancaires_network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cb_avalgo",
+ "cb_exemption",
+ "cb_score"
+ ]
}
},
"title": "network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cartes_bancaires"
+ ]
},
"requestor_challenge_indicator": {
"description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
@@ -141272,11 +157018,56 @@
"version"
],
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ares_trans_status",
+ "cryptogram",
+ "electronic_commerce_indicator",
+ "exemption_indicator",
+ "network_options",
+ "requestor_challenge_indicator",
+ "transaction_id",
+ "version"
+ ]
}
},
"title": "payment_intent_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allow_partial_amount",
+ "buy_now_pay_later_options",
+ "capture_method",
+ "cvc_token",
+ "installments",
+ "mandate_options",
+ "mcc",
+ "mit_exemption",
+ "moto",
+ "network",
+ "network_options",
+ "network_token",
+ "off_session_usage",
+ "recipient_details",
+ "request_decremental_authorization",
+ "request_extended_authorization",
+ "request_flexible_extended_authorization",
+ "request_incremental_authorization",
+ "request_incremental_authorization_support",
+ "request_multicapture",
+ "request_overcapture",
+ "request_partial_authorization",
+ "request_three_d_secure",
+ "require_cvc_recollection",
+ "sender_details",
+ "setup_future_usage",
+ "statement_descriptor_suffix_kana",
+ "statement_descriptor_suffix_kanji",
+ "statement_details",
+ "stored_credential_transaction_type",
+ "stored_credential_usage",
+ "three_d_secure",
+ "transaction_purpose"
+ ]
},
{
"enum": [
@@ -141312,11 +157103,24 @@
}
},
"title": "routing_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested_priority"
+ ]
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "buy_now_pay_later_options",
+ "capture_method",
+ "request_extended_authorization",
+ "request_flexible_extended_authorization",
+ "request_incremental_authorization",
+ "request_incremental_authorization_support",
+ "request_partial_authorization",
+ "routing"
+ ]
},
{
"enum": [
@@ -141351,7 +157155,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "restricted_transaction_categories",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -141382,7 +157191,10 @@
"country"
],
"title": "eu_bank_transfer_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"requested_address_types": {
"description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.",
@@ -141418,7 +157230,14 @@
"type"
],
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "eu_bank_transfer",
+ "id_bank_account",
+ "id_bank_transfer",
+ "requested_address_types",
+ "type"
+ ]
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
@@ -141436,7 +157255,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank_transfer",
+ "funding_type",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -141460,7 +157284,10 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -141484,7 +157311,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -141508,7 +157338,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -141532,7 +157365,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -141558,7 +157394,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -141660,7 +157499,15 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "line_items",
+ "payment_details",
+ "payment_method_category",
+ "preferred_locale",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -141743,7 +157590,16 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "confirmation_number",
+ "expires_after_days",
+ "expires_at",
+ "fee_amount",
+ "product_description",
+ "setup_future_usage",
+ "tax_amount"
+ ]
},
{
"enum": [
@@ -141782,7 +157638,13 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "persistent_token",
+ "request_multicapture",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -141793,6 +157655,33 @@
],
"description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options."
},
+ "mb_way": {
+ "anyOf": [
+ {
+ "properties": {
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
+ "enum": [
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "payment_method_options_param",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options."
+ },
"mobilepay": {
"anyOf": [
{
@@ -141814,7 +157703,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "reference",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -141838,7 +157732,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -141866,7 +157763,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -141894,7 +157795,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "installments",
+ "setup_future_usage",
+ "tos_shown_and_accepted"
+ ]
},
{
"enum": [
@@ -141918,7 +157824,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -142003,7 +157912,18 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allow_delayed_notification",
+ "capture_method",
+ "line_items",
+ "preferred_locale",
+ "reference",
+ "reference_id",
+ "risk_correlation_id",
+ "setup_future_usage",
+ "subsellers"
+ ]
},
{
"enum": [
@@ -142075,7 +157995,15 @@
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "end_date",
+ "payment_schedule",
+ "payments_per_period",
+ "purpose"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -142088,7 +158016,11 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -142121,7 +158053,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_after_seconds",
+ "expires_at",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -142145,7 +158082,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -142195,7 +158135,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -142214,7 +158158,11 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reference",
+ "reference_prefix"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -142228,7 +158176,13 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage",
+ "target_date",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -142268,7 +158222,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred_language",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -142307,7 +158265,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "authorization_method",
+ "reference",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -142331,7 +158294,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -142371,7 +158337,11 @@
}
},
"title": "linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_subcategories",
+ "institution"
+ ]
},
"manual_entry": {
"description": "Customize manual entry behavior",
@@ -142389,7 +158359,10 @@
"mode"
],
"title": "linked_account_options_manual_entry_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode"
+ ]
},
"permissions": {
"description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.",
@@ -142426,7 +158399,14 @@
}
},
"title": "linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "filters",
+ "manual_entry",
+ "permissions",
+ "prefetch",
+ "return_url"
+ ]
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -142442,7 +158422,10 @@
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "collection_method"
+ ]
},
"networks": {
"description": "Additional fields for network related functions",
@@ -142460,7 +158443,10 @@
}
},
"title": "networks_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"preferred_settlement_speed": {
"description": "Preferred transaction settlement speed",
@@ -142493,7 +158479,15 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "financial_connections",
+ "mandate_options",
+ "networks",
+ "preferred_settlement_speed",
+ "setup_future_usage",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -142535,7 +158529,12 @@
"client"
],
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "app_id",
+ "client",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -142559,7 +158558,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -142572,7 +158574,71 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "affirm",
+ "afterpay_clearpay",
+ "alipay",
+ "alma",
+ "amazon_pay",
+ "au_becs_debit",
+ "bacs_debit",
+ "bancontact",
+ "blik",
+ "boleto",
+ "boleto_pilot",
+ "card",
+ "card_present",
+ "cashapp",
+ "customer_balance",
+ "demo_pay",
+ "dummy_auth_push",
+ "dummy_passthrough_card",
+ "eps",
+ "fpx",
+ "giropay",
+ "gopay",
+ "grabpay",
+ "id_bank_transfer",
+ "ideal",
+ "interac_present",
+ "kakao_pay",
+ "klarna",
+ "knet",
+ "konbini",
+ "kr_card",
+ "kr_market",
+ "link",
+ "mb_way",
+ "mobilepay",
+ "multibanco",
+ "naver_pay",
+ "ng_card",
+ "ng_market",
+ "oxxo",
+ "p24",
+ "pay_by_bank",
+ "payco",
+ "paynow",
+ "paypal",
+ "payto",
+ "pix",
+ "promptpay",
+ "qris",
+ "rechnung",
+ "revolut_pay",
+ "samsung_pay",
+ "sepa_debit",
+ "sofort",
+ "swish",
+ "twint",
+ "upi",
+ "us_bank_account",
+ "vipps",
+ "wechat_pay",
+ "zip"
+ ]
},
"payment_method_types": {
"description": "The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, it defaults to [\"card\"]. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
@@ -142592,7 +158658,11 @@
}
},
"title": "radar_options_with_hidden_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "session",
+ "skip_rules"
+ ]
},
"receipt_email": {
"description": "Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails).",
@@ -142656,7 +158726,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
@@ -142684,15 +158762,22 @@
"name"
],
"title": "optional_fields_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "carrier",
+ "name",
+ "phone",
+ "tracking_number"
+ ]
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
"type": "string"
},
@@ -142712,7 +158797,11 @@
"destination"
],
"title": "transfer_data_creation_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "destination"
+ ]
},
"transfer_group": {
"description": "A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).",
@@ -142727,7 +158816,23 @@
"amount",
"currency"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "automatic_payment_methods",
+ "confirm",
+ "currency",
+ "customer",
+ "description",
+ "metadata",
+ "off_session",
+ "payment_method",
+ "receipt_email",
+ "setup_future_usage",
+ "shipping",
+ "statement_descriptor",
+ "statement_descriptor_suffix"
+ ]
}
}
},
@@ -142871,6 +158976,14 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "next_page",
+ "object",
+ "total_count",
+ "url"
]
}
}
@@ -143086,15 +159199,24 @@
"calculation"
],
"title": "async_workflows_inputs_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "calculation"
+ ]
}
},
"title": "async_workflows_inputs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax"
+ ]
}
},
"title": "async_workflows_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "inputs"
+ ]
},
"capture_method": {
"description": "Controls when the funds will be captured from the customer's account.",
@@ -143110,7 +159232,7 @@
"type": "string"
},
"customer": {
- "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
+ "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
"maxLength": 5000,
"type": "string"
},
@@ -143147,7 +159269,11 @@
}
},
"title": "online_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ip_address",
+ "user_agent"
+ ]
},
"type": {
"description": "The type of customer acceptance information included with the Mandate.",
@@ -143163,7 +159289,11 @@
"type"
],
"title": "customer_acceptance_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "online",
+ "type"
+ ]
}
},
"required": [
@@ -143171,6 +159301,9 @@
],
"title": "client_key_param",
"type": "object",
+ "x-stripeMostCommon": [
+ "customer_acceptance"
+ ],
"x-stripeParam": {
"class_name": "MandateDataPublishableKey"
}
@@ -143212,7 +159345,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"booking_number": {
"description": "The booking number associated with the car rental.",
@@ -143281,11 +159417,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"drivers": {
"description": "The details of the passengers in the travel reservation",
@@ -143301,7 +159446,10 @@
"name"
],
"title": "car_rental_driver",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -143358,7 +159506,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"pickup_at": {
"description": "Car pick-up time. Measured in seconds since the Unix epoch.",
@@ -143418,7 +159574,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"return_at": {
"description": "Car return time. Measured in seconds since the Unix epoch.",
@@ -143437,7 +159601,29 @@
"return_at"
],
"title": "car_rental",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "booking_number",
+ "car_class_code",
+ "car_make",
+ "car_model",
+ "company",
+ "customer_service_phone_number",
+ "days_rented",
+ "delivery",
+ "drivers",
+ "extra_charges",
+ "no_show",
+ "pickup_address",
+ "pickup_at",
+ "rate_amount",
+ "rate_interval",
+ "renter_name",
+ "return_address",
+ "return_at",
+ "tax_exempt"
+ ]
},
"event_details": {
"description": "Event details for this PaymentIntent",
@@ -143481,7 +159667,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -143496,7 +159690,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"company": {
"description": "The name of the company",
@@ -143536,11 +159733,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"ends_at": {
"description": "Event end time. Measured in seconds since the Unix epoch.",
@@ -143567,7 +159773,18 @@
"name"
],
"title": "event",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "access_controlled_venue",
+ "address",
+ "affiliate",
+ "company",
+ "delivery",
+ "ends_at",
+ "genre",
+ "name",
+ "starts_at"
+ ]
},
"flight": {
"description": "Flight reservation details for this PaymentIntent",
@@ -143585,7 +159802,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"agency_number": {
"description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.",
@@ -143630,11 +159850,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"passenger_name": {
"description": "The name of the person or entity on the reservation.",
@@ -143655,7 +159884,10 @@
"name"
],
"title": "flight_passenger",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -143712,7 +159944,17 @@
"departs_at"
],
"title": "flight_segment",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "arrival_airport",
+ "arrives_at",
+ "carrier",
+ "departs_at",
+ "departure_airport",
+ "flight_number",
+ "service_class"
+ ]
},
"type": "array"
},
@@ -143726,7 +159968,17 @@
"segments"
],
"title": "flight",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "agency_number",
+ "carrier",
+ "delivery",
+ "passenger_name",
+ "passengers",
+ "segments",
+ "ticket_number"
+ ]
},
"lodging": {
"description": "Lodging reservation details for this PaymentIntent",
@@ -143766,7 +160018,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"adults": {
"description": "The number of adults on the booking",
@@ -143785,7 +160045,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"booking_number": {
"description": "The booking number associated with the lodging reservation.",
@@ -143851,11 +160114,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -143903,7 +160175,10 @@
"name"
],
"title": "lodging_passenger",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -143934,7 +160209,30 @@
"checkout_at"
],
"title": "lodging",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "adults",
+ "affiliate",
+ "booking_number",
+ "category",
+ "checkin_at",
+ "checkout_at",
+ "customer_service_phone_number",
+ "daily_room_rate_amount",
+ "delivery",
+ "extra_charges",
+ "fire_safety_act_compliance",
+ "name",
+ "no_show",
+ "number_of_rooms",
+ "passengers",
+ "property_phone_number",
+ "room_class",
+ "room_nights",
+ "total_room_tax_amount",
+ "total_tax_amount"
+ ]
},
"subscription": {
"description": "Subscription details for this PaymentIntent",
@@ -143952,7 +160250,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"auto_renewal": {
"description": "Info whether the subscription will be auto renewed upon expiry.",
@@ -143981,7 +160282,11 @@
"interval"
],
"title": "subscription_billing_interval",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "count",
+ "interval"
+ ]
},
"ends_at": {
"description": "Subscription end time. Measured in seconds since the Unix epoch.",
@@ -144003,11 +160308,27 @@
"name"
],
"title": "subscription",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "auto_renewal",
+ "billing_interval",
+ "ends_at",
+ "name",
+ "starts_at"
+ ]
}
},
"title": "payment_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "car_rental",
+ "event_details",
+ "flight",
+ "healthcare",
+ "lodging",
+ "subscription"
+ ]
},
{
"enum": [
@@ -144055,7 +160376,12 @@
"transit_number"
],
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "institution_number",
+ "transit_number"
+ ]
},
"affirm": {
"description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.",
@@ -144109,7 +160435,11 @@
"bsb_number"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number"
+ ]
},
"bacs_debit": {
"description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.",
@@ -144126,7 +160456,11 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "sort_code"
+ ]
},
"bancontact": {
"description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.",
@@ -144173,7 +160507,15 @@
}
},
"title": "billing_details_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
{
"enum": [
@@ -144230,7 +160572,13 @@
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
+ ]
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -144251,7 +160599,10 @@
"tax_id"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"cashapp": {
"description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.",
@@ -144305,7 +160656,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"fpx": {
"description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.",
@@ -144354,7 +160708,11 @@
"bank"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "bank"
+ ]
},
"giropay": {
"description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.",
@@ -144396,13 +160754,22 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"interac_present": {
"description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "device_identifier",
+ "device_type",
+ "emv",
+ "location"
+ ]
},
"klarna": {
"description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.",
@@ -144429,11 +160796,19 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"konbini": {
"description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.",
@@ -144447,6 +160822,12 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"metadata": {
"additionalProperties": {
"type": "string"
@@ -144510,7 +160891,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"paynow": {
"description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.",
@@ -144544,13 +160928,21 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number",
+ "pay_id"
+ ]
},
"pix": {
"description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"promptpay": {
"description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.",
@@ -144568,7 +160960,11 @@
}
},
"title": "radar_options_with_hidden_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "session",
+ "skip_rules"
+ ]
},
"rechnung": {
"description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.",
@@ -144595,14 +160991,22 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"required": [
"dob"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"revolut_pay": {
"description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
@@ -144623,7 +161027,10 @@
"iban"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iban"
+ ]
},
"sofort": {
"description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.",
@@ -144645,7 +161052,10 @@
"country"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"swish": {
"description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.",
@@ -144682,6 +161092,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -144740,7 +161151,14 @@
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "account_number",
+ "account_type",
+ "financial_connections_account",
+ "routing_number"
+ ]
},
"wechat_pay": {
"description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.",
@@ -144759,7 +161177,12 @@
"type"
],
"title": "payment_method_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_details",
+ "metadata",
+ "type"
+ ]
},
"payment_method_options": {
"description": "Payment-method-specific configuration for this PaymentIntent.",
@@ -144809,7 +161232,13 @@
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom_mandate_url",
+ "interval_description",
+ "payment_schedule",
+ "transaction_type"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -144833,7 +161262,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -144870,7 +161304,13 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "preferred_locale",
+ "purchase_details",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -144908,7 +161348,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "reference",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -144934,7 +161379,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -144968,7 +161416,13 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "charge_metadata",
+ "charge_permission_id",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -144995,7 +161449,10 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -145014,7 +161471,10 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reference_prefix"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -145028,7 +161488,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage",
+ "target_date"
+ ]
},
{
"enum": [
@@ -145064,7 +161529,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred_language",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -145095,7 +161564,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "code",
+ "mandate_options",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -145126,7 +161600,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -145189,7 +161667,12 @@
"type"
],
"title": "installment_plan",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "count",
+ "interval",
+ "type"
+ ]
},
{
"enum": [
@@ -145202,7 +161685,11 @@
}
},
"title": "installments_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "plan"
+ ]
},
"mandate_options": {
"description": "Configuration options for setting up an eMandate for cards issued in India.",
@@ -145273,7 +161760,18 @@
"start_date"
],
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "description",
+ "end_date",
+ "interval",
+ "interval_count",
+ "reference",
+ "start_date",
+ "supported_types"
+ ]
},
"moto": {
"description": "When specified, this parameter indicates that a transaction will be marked\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.",
@@ -145432,7 +161930,15 @@
}
},
"title": "statement_details_address_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"phone": {
"description": "Phone number (e.g., a toll-free number that customers can call)",
@@ -145441,7 +161947,11 @@
}
},
"title": "statement_details_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "phone"
+ ]
},
{
"enum": [
@@ -145525,11 +162035,19 @@
"cb_avalgo"
],
"title": "cartes_bancaires_network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cb_avalgo",
+ "cb_exemption",
+ "cb_score"
+ ]
}
},
"title": "network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cartes_bancaires"
+ ]
},
"requestor_challenge_indicator": {
"description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
@@ -145558,11 +162076,56 @@
"version"
],
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ares_trans_status",
+ "cryptogram",
+ "electronic_commerce_indicator",
+ "exemption_indicator",
+ "network_options",
+ "requestor_challenge_indicator",
+ "transaction_id",
+ "version"
+ ]
}
},
"title": "payment_intent_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allow_partial_amount",
+ "buy_now_pay_later_options",
+ "capture_method",
+ "cvc_token",
+ "installments",
+ "mandate_options",
+ "mcc",
+ "mit_exemption",
+ "moto",
+ "network",
+ "network_options",
+ "network_token",
+ "off_session_usage",
+ "recipient_details",
+ "request_decremental_authorization",
+ "request_extended_authorization",
+ "request_flexible_extended_authorization",
+ "request_incremental_authorization",
+ "request_incremental_authorization_support",
+ "request_multicapture",
+ "request_overcapture",
+ "request_partial_authorization",
+ "request_three_d_secure",
+ "require_cvc_recollection",
+ "sender_details",
+ "setup_future_usage",
+ "statement_descriptor_suffix_kana",
+ "statement_descriptor_suffix_kanji",
+ "statement_details",
+ "stored_credential_transaction_type",
+ "stored_credential_usage",
+ "three_d_secure",
+ "transaction_purpose"
+ ]
},
{
"enum": [
@@ -145598,11 +162161,24 @@
}
},
"title": "routing_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested_priority"
+ ]
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "buy_now_pay_later_options",
+ "capture_method",
+ "request_extended_authorization",
+ "request_flexible_extended_authorization",
+ "request_incremental_authorization",
+ "request_incremental_authorization_support",
+ "request_partial_authorization",
+ "routing"
+ ]
},
{
"enum": [
@@ -145637,7 +162213,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "restricted_transaction_categories",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -145668,7 +162249,10 @@
"country"
],
"title": "eu_bank_transfer_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"requested_address_types": {
"description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.",
@@ -145704,7 +162288,14 @@
"type"
],
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "eu_bank_transfer",
+ "id_bank_account",
+ "id_bank_transfer",
+ "requested_address_types",
+ "type"
+ ]
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
@@ -145722,7 +162313,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank_transfer",
+ "funding_type",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -145746,7 +162342,10 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -145770,7 +162369,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -145794,7 +162396,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -145818,7 +162423,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -145844,7 +162452,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -145946,7 +162557,15 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "line_items",
+ "payment_details",
+ "payment_method_category",
+ "preferred_locale",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -146029,7 +162648,16 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "confirmation_number",
+ "expires_after_days",
+ "expires_at",
+ "fee_amount",
+ "product_description",
+ "setup_future_usage",
+ "tax_amount"
+ ]
},
{
"enum": [
@@ -146068,7 +162696,13 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "persistent_token",
+ "request_multicapture",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -146079,6 +162713,33 @@
],
"description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options."
},
+ "mb_way": {
+ "anyOf": [
+ {
+ "properties": {
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
+ "enum": [
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "payment_method_options_param",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options."
+ },
"mobilepay": {
"anyOf": [
{
@@ -146100,7 +162761,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "reference",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -146124,7 +162790,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -146152,7 +162821,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -146180,7 +162853,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "installments",
+ "setup_future_usage",
+ "tos_shown_and_accepted"
+ ]
},
{
"enum": [
@@ -146204,7 +162882,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -146289,7 +162970,18 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allow_delayed_notification",
+ "capture_method",
+ "line_items",
+ "preferred_locale",
+ "reference",
+ "reference_id",
+ "risk_correlation_id",
+ "setup_future_usage",
+ "subsellers"
+ ]
},
{
"enum": [
@@ -146361,7 +163053,15 @@
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "end_date",
+ "payment_schedule",
+ "payments_per_period",
+ "purpose"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -146374,7 +163074,11 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -146407,7 +163111,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_after_seconds",
+ "expires_at",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -146431,7 +163140,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -146481,7 +163193,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -146500,7 +163216,11 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reference",
+ "reference_prefix"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -146514,7 +163234,13 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage",
+ "target_date",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -146554,7 +163280,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred_language",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -146593,7 +163323,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "authorization_method",
+ "reference",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -146617,7 +163352,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -146657,7 +163395,11 @@
}
},
"title": "linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_subcategories",
+ "institution"
+ ]
},
"manual_entry": {
"description": "Customize manual entry behavior",
@@ -146675,7 +163417,10 @@
"mode"
],
"title": "linked_account_options_manual_entry_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode"
+ ]
},
"permissions": {
"description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.",
@@ -146712,7 +163457,14 @@
}
},
"title": "linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "filters",
+ "manual_entry",
+ "permissions",
+ "prefetch",
+ "return_url"
+ ]
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -146728,7 +163480,10 @@
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "collection_method"
+ ]
},
"networks": {
"description": "Additional fields for network related functions",
@@ -146746,7 +163501,10 @@
}
},
"title": "networks_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"preferred_settlement_speed": {
"description": "Preferred transaction settlement speed",
@@ -146779,7 +163537,15 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "financial_connections",
+ "mandate_options",
+ "networks",
+ "preferred_settlement_speed",
+ "setup_future_usage",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -146821,7 +163587,12 @@
"client"
],
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "app_id",
+ "client",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -146845,7 +163616,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -146858,7 +163632,71 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "affirm",
+ "afterpay_clearpay",
+ "alipay",
+ "alma",
+ "amazon_pay",
+ "au_becs_debit",
+ "bacs_debit",
+ "bancontact",
+ "blik",
+ "boleto",
+ "boleto_pilot",
+ "card",
+ "card_present",
+ "cashapp",
+ "customer_balance",
+ "demo_pay",
+ "dummy_auth_push",
+ "dummy_passthrough_card",
+ "eps",
+ "fpx",
+ "giropay",
+ "gopay",
+ "grabpay",
+ "id_bank_transfer",
+ "ideal",
+ "interac_present",
+ "kakao_pay",
+ "klarna",
+ "knet",
+ "konbini",
+ "kr_card",
+ "kr_market",
+ "link",
+ "mb_way",
+ "mobilepay",
+ "multibanco",
+ "naver_pay",
+ "ng_card",
+ "ng_market",
+ "oxxo",
+ "p24",
+ "pay_by_bank",
+ "payco",
+ "paynow",
+ "paypal",
+ "payto",
+ "pix",
+ "promptpay",
+ "qris",
+ "rechnung",
+ "revolut_pay",
+ "samsung_pay",
+ "sepa_debit",
+ "sofort",
+ "swish",
+ "twint",
+ "upi",
+ "us_bank_account",
+ "vipps",
+ "wechat_pay",
+ "zip"
+ ]
},
"payment_method_types": {
"description": "The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
@@ -146930,7 +163768,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
@@ -146958,7 +163804,14 @@
"name"
],
"title": "optional_fields_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "carrier",
+ "name",
+ "phone",
+ "tracking_number"
+ ]
},
{
"enum": [
@@ -146970,12 +163823,12 @@
"description": "Shipping information for this PaymentIntent."
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
"type": "string"
},
@@ -146988,14 +163841,31 @@
}
},
"title": "transfer_data_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount"
+ ]
},
"transfer_group": {
"description": "A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "customer",
+ "description",
+ "mandate_data",
+ "metadata",
+ "payment_method",
+ "receipt_email",
+ "setup_future_usage",
+ "shipping",
+ "statement_descriptor",
+ "statement_descriptor_suffix"
+ ]
}
}
},
@@ -147070,7 +163940,11 @@
"type": "array"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency"
+ ]
}
}
},
@@ -147149,7 +164023,10 @@
"type": "array"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cancellation_reason"
+ ]
}
}
},
@@ -147260,15 +164137,24 @@
"calculation"
],
"title": "async_workflows_inputs_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "calculation"
+ ]
}
},
"title": "async_workflows_inputs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax"
+ ]
}
},
"title": "async_workflows_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "inputs"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -147319,7 +164205,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"booking_number": {
"description": "The booking number associated with the car rental.",
@@ -147388,11 +164277,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"drivers": {
"description": "The details of the passengers in the travel reservation",
@@ -147408,7 +164306,10 @@
"name"
],
"title": "car_rental_driver",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -147465,7 +164366,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"pickup_at": {
"description": "Car pick-up time. Measured in seconds since the Unix epoch.",
@@ -147525,7 +164434,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"return_at": {
"description": "Car return time. Measured in seconds since the Unix epoch.",
@@ -147544,7 +164461,29 @@
"return_at"
],
"title": "car_rental",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "booking_number",
+ "car_class_code",
+ "car_make",
+ "car_model",
+ "company",
+ "customer_service_phone_number",
+ "days_rented",
+ "delivery",
+ "drivers",
+ "extra_charges",
+ "no_show",
+ "pickup_address",
+ "pickup_at",
+ "rate_amount",
+ "rate_interval",
+ "renter_name",
+ "return_address",
+ "return_at",
+ "tax_exempt"
+ ]
},
"event_details": {
"description": "Event details for this PaymentIntent",
@@ -147588,7 +164527,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -147603,7 +164550,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"company": {
"description": "The name of the company",
@@ -147643,11 +164593,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"ends_at": {
"description": "Event end time. Measured in seconds since the Unix epoch.",
@@ -147674,7 +164633,18 @@
"name"
],
"title": "event",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "access_controlled_venue",
+ "address",
+ "affiliate",
+ "company",
+ "delivery",
+ "ends_at",
+ "genre",
+ "name",
+ "starts_at"
+ ]
},
"flight": {
"description": "Flight reservation details for this PaymentIntent",
@@ -147692,7 +164662,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"agency_number": {
"description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.",
@@ -147737,11 +164710,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"passenger_name": {
"description": "The name of the person or entity on the reservation.",
@@ -147762,7 +164744,10 @@
"name"
],
"title": "flight_passenger",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -147819,7 +164804,17 @@
"departs_at"
],
"title": "flight_segment",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "arrival_airport",
+ "arrives_at",
+ "carrier",
+ "departs_at",
+ "departure_airport",
+ "flight_number",
+ "service_class"
+ ]
},
"type": "array"
},
@@ -147833,7 +164828,17 @@
"segments"
],
"title": "flight",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "agency_number",
+ "carrier",
+ "delivery",
+ "passenger_name",
+ "passengers",
+ "segments",
+ "ticket_number"
+ ]
},
"lodging": {
"description": "Lodging reservation details for this PaymentIntent",
@@ -147873,7 +164878,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"adults": {
"description": "The number of adults on the booking",
@@ -147892,7 +164905,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"booking_number": {
"description": "The booking number associated with the lodging reservation.",
@@ -147958,11 +164974,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -148010,7 +165035,10 @@
"name"
],
"title": "lodging_passenger",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -148041,7 +165069,30 @@
"checkout_at"
],
"title": "lodging",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "adults",
+ "affiliate",
+ "booking_number",
+ "category",
+ "checkin_at",
+ "checkout_at",
+ "customer_service_phone_number",
+ "daily_room_rate_amount",
+ "delivery",
+ "extra_charges",
+ "fire_safety_act_compliance",
+ "name",
+ "no_show",
+ "number_of_rooms",
+ "passengers",
+ "property_phone_number",
+ "room_class",
+ "room_nights",
+ "total_room_tax_amount",
+ "total_tax_amount"
+ ]
},
"subscription": {
"description": "Subscription details for this PaymentIntent",
@@ -148059,7 +165110,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"auto_renewal": {
"description": "Info whether the subscription will be auto renewed upon expiry.",
@@ -148088,7 +165142,11 @@
"interval"
],
"title": "subscription_billing_interval",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "count",
+ "interval"
+ ]
},
"ends_at": {
"description": "Subscription end time. Measured in seconds since the Unix epoch.",
@@ -148110,11 +165168,27 @@
"name"
],
"title": "subscription",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "auto_renewal",
+ "billing_interval",
+ "ends_at",
+ "name",
+ "starts_at"
+ ]
}
},
"title": "payment_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "car_rental",
+ "event_details",
+ "flight",
+ "healthcare",
+ "lodging",
+ "subscription"
+ ]
},
{
"enum": [
@@ -148126,12 +165200,12 @@
"description": "Provides industry-specific information about the charge."
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
"type": "string"
},
@@ -148144,10 +165218,17 @@
}
},
"title": "transfer_data_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_to_capture",
+ "metadata"
+ ]
}
}
},
@@ -148179,7 +165260,7 @@
},
"/v1/payment_intents/{intent}/confirm": {
"post": {
- "description": "Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\nIf the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent transitions to the requires_payment_method status or the\ncanceled status if the confirmation limit is reached. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).\nIf the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.\nIf the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.\nIf any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt.
",
+ "description": "Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\nIf the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent transitions to the requires_payment_method status or the\ncanceled status if the confirmation limit is reached. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).\nIf the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.\nIf the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.\nIf any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt.\nThere is a variable upper limit on how many times a PaymentIntent can be confirmed.\nAfter this limit is reached, any further calls to this endpoint will\ntransition the PaymentIntent to the canceled state.
",
"operationId": "PostPaymentIntentsIntentConfirm",
"parameters": [
{
@@ -148292,15 +165373,24 @@
"calculation"
],
"title": "async_workflows_inputs_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "calculation"
+ ]
}
},
"title": "async_workflows_inputs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax"
+ ]
}
},
"title": "async_workflows_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "inputs"
+ ]
},
"capture_method": {
"description": "Controls when the funds will be captured from the customer's account.",
@@ -148369,7 +165459,11 @@
"user_agent"
],
"title": "online_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ip_address",
+ "user_agent"
+ ]
},
"type": {
"description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.",
@@ -148385,14 +165479,23 @@
"type"
],
"title": "customer_acceptance_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "accepted_at",
+ "offline",
+ "online",
+ "type"
+ ]
}
},
"required": [
"customer_acceptance"
],
"title": "secret_key_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer_acceptance"
+ ]
},
{
"enum": [
@@ -148420,7 +165523,11 @@
}
},
"title": "online_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ip_address",
+ "user_agent"
+ ]
},
"type": {
"description": "The type of customer acceptance information included with the Mandate.",
@@ -148436,7 +165543,11 @@
"type"
],
"title": "customer_acceptance_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "online",
+ "type"
+ ]
}
},
"required": [
@@ -148444,6 +165555,9 @@
],
"title": "client_key_param",
"type": "object",
+ "x-stripeMostCommon": [
+ "customer_acceptance"
+ ],
"x-stripeParam": {
"class_name": "MandateDataPublishableKey"
}
@@ -148486,7 +165600,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"booking_number": {
"description": "The booking number associated with the car rental.",
@@ -148555,11 +165672,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"drivers": {
"description": "The details of the passengers in the travel reservation",
@@ -148575,7 +165701,10 @@
"name"
],
"title": "car_rental_driver",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -148632,7 +165761,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"pickup_at": {
"description": "Car pick-up time. Measured in seconds since the Unix epoch.",
@@ -148692,7 +165829,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"return_at": {
"description": "Car return time. Measured in seconds since the Unix epoch.",
@@ -148711,7 +165856,29 @@
"return_at"
],
"title": "car_rental",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "booking_number",
+ "car_class_code",
+ "car_make",
+ "car_model",
+ "company",
+ "customer_service_phone_number",
+ "days_rented",
+ "delivery",
+ "drivers",
+ "extra_charges",
+ "no_show",
+ "pickup_address",
+ "pickup_at",
+ "rate_amount",
+ "rate_interval",
+ "renter_name",
+ "return_address",
+ "return_at",
+ "tax_exempt"
+ ]
},
"event_details": {
"description": "Event details for this PaymentIntent",
@@ -148755,7 +165922,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -148770,7 +165945,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"company": {
"description": "The name of the company",
@@ -148810,11 +165988,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"ends_at": {
"description": "Event end time. Measured in seconds since the Unix epoch.",
@@ -148841,7 +166028,18 @@
"name"
],
"title": "event",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "access_controlled_venue",
+ "address",
+ "affiliate",
+ "company",
+ "delivery",
+ "ends_at",
+ "genre",
+ "name",
+ "starts_at"
+ ]
},
"flight": {
"description": "Flight reservation details for this PaymentIntent",
@@ -148859,7 +166057,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"agency_number": {
"description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.",
@@ -148904,11 +166105,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"passenger_name": {
"description": "The name of the person or entity on the reservation.",
@@ -148929,7 +166139,10 @@
"name"
],
"title": "flight_passenger",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -148986,7 +166199,17 @@
"departs_at"
],
"title": "flight_segment",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "arrival_airport",
+ "arrives_at",
+ "carrier",
+ "departs_at",
+ "departure_airport",
+ "flight_number",
+ "service_class"
+ ]
},
"type": "array"
},
@@ -149000,7 +166223,17 @@
"segments"
],
"title": "flight",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "agency_number",
+ "carrier",
+ "delivery",
+ "passenger_name",
+ "passengers",
+ "segments",
+ "ticket_number"
+ ]
},
"lodging": {
"description": "Lodging reservation details for this PaymentIntent",
@@ -149040,7 +166273,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"adults": {
"description": "The number of adults on the booking",
@@ -149059,7 +166300,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"booking_number": {
"description": "The booking number associated with the lodging reservation.",
@@ -149125,11 +166369,20 @@
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "email",
+ "name",
+ "phone"
+ ]
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode",
+ "recipient"
+ ]
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -149177,7 +166430,10 @@
"name"
],
"title": "lodging_passenger",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -149208,7 +166464,30 @@
"checkout_at"
],
"title": "lodging",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "adults",
+ "affiliate",
+ "booking_number",
+ "category",
+ "checkin_at",
+ "checkout_at",
+ "customer_service_phone_number",
+ "daily_room_rate_amount",
+ "delivery",
+ "extra_charges",
+ "fire_safety_act_compliance",
+ "name",
+ "no_show",
+ "number_of_rooms",
+ "passengers",
+ "property_phone_number",
+ "room_class",
+ "room_nights",
+ "total_room_tax_amount",
+ "total_tax_amount"
+ ]
},
"subscription": {
"description": "Subscription details for this PaymentIntent",
@@ -149226,7 +166505,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"auto_renewal": {
"description": "Info whether the subscription will be auto renewed upon expiry.",
@@ -149255,7 +166537,11 @@
"interval"
],
"title": "subscription_billing_interval",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "count",
+ "interval"
+ ]
},
"ends_at": {
"description": "Subscription end time. Measured in seconds since the Unix epoch.",
@@ -149277,11 +166563,27 @@
"name"
],
"title": "subscription",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "affiliate",
+ "auto_renewal",
+ "billing_interval",
+ "ends_at",
+ "name",
+ "starts_at"
+ ]
}
},
"title": "payment_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "car_rental",
+ "event_details",
+ "flight",
+ "healthcare",
+ "lodging",
+ "subscription"
+ ]
},
{
"enum": [
@@ -149325,7 +166627,12 @@
"transit_number"
],
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "institution_number",
+ "transit_number"
+ ]
},
"affirm": {
"description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.",
@@ -149379,7 +166686,11 @@
"bsb_number"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number"
+ ]
},
"bacs_debit": {
"description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.",
@@ -149396,7 +166707,11 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "sort_code"
+ ]
},
"bancontact": {
"description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.",
@@ -149443,7 +166758,15 @@
}
},
"title": "billing_details_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
{
"enum": [
@@ -149500,7 +166823,13 @@
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
+ ]
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -149521,7 +166850,10 @@
"tax_id"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"cashapp": {
"description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.",
@@ -149575,7 +166907,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"fpx": {
"description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.",
@@ -149624,7 +166959,11 @@
"bank"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "bank"
+ ]
},
"giropay": {
"description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.",
@@ -149666,13 +167005,22 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"interac_present": {
"description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "device_identifier",
+ "device_type",
+ "emv",
+ "location"
+ ]
},
"klarna": {
"description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.",
@@ -149699,11 +167047,19 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"konbini": {
"description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.",
@@ -149717,6 +167073,12 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"metadata": {
"additionalProperties": {
"type": "string"
@@ -149780,7 +167142,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"paynow": {
"description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.",
@@ -149814,13 +167179,21 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number",
+ "pay_id"
+ ]
},
"pix": {
"description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"promptpay": {
"description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.",
@@ -149838,7 +167211,11 @@
}
},
"title": "radar_options_with_hidden_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "session",
+ "skip_rules"
+ ]
},
"rechnung": {
"description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.",
@@ -149865,14 +167242,22 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"required": [
"dob"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"revolut_pay": {
"description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
@@ -149893,7 +167278,10 @@
"iban"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iban"
+ ]
},
"sofort": {
"description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.",
@@ -149915,7 +167303,10 @@
"country"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"swish": {
"description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.",
@@ -149952,6 +167343,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -150010,7 +167402,14 @@
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "account_number",
+ "account_type",
+ "financial_connections_account",
+ "routing_number"
+ ]
},
"wechat_pay": {
"description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.",
@@ -150029,7 +167428,12 @@
"type"
],
"title": "payment_method_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_details",
+ "metadata",
+ "type"
+ ]
},
"payment_method_options": {
"description": "Payment method-specific configuration for this PaymentIntent.",
@@ -150079,7 +167483,13 @@
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom_mandate_url",
+ "interval_description",
+ "payment_schedule",
+ "transaction_type"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -150103,7 +167513,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -150140,7 +167555,13 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "preferred_locale",
+ "purchase_details",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -150178,7 +167599,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "reference",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -150204,7 +167630,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -150238,7 +167667,13 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "charge_metadata",
+ "charge_permission_id",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -150265,7 +167700,10 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -150284,7 +167722,10 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reference_prefix"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -150298,7 +167739,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage",
+ "target_date"
+ ]
},
{
"enum": [
@@ -150334,7 +167780,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred_language",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -150365,7 +167815,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "code",
+ "mandate_options",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -150396,7 +167851,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -150459,7 +167918,12 @@
"type"
],
"title": "installment_plan",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "count",
+ "interval",
+ "type"
+ ]
},
{
"enum": [
@@ -150472,7 +167936,11 @@
}
},
"title": "installments_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "plan"
+ ]
},
"mandate_options": {
"description": "Configuration options for setting up an eMandate for cards issued in India.",
@@ -150543,7 +168011,18 @@
"start_date"
],
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "description",
+ "end_date",
+ "interval",
+ "interval_count",
+ "reference",
+ "start_date",
+ "supported_types"
+ ]
},
"moto": {
"description": "When specified, this parameter indicates that a transaction will be marked\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.",
@@ -150702,7 +168181,15 @@
}
},
"title": "statement_details_address_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"phone": {
"description": "Phone number (e.g., a toll-free number that customers can call)",
@@ -150711,7 +168198,11 @@
}
},
"title": "statement_details_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "phone"
+ ]
},
{
"enum": [
@@ -150795,11 +168286,19 @@
"cb_avalgo"
],
"title": "cartes_bancaires_network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cb_avalgo",
+ "cb_exemption",
+ "cb_score"
+ ]
}
},
"title": "network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cartes_bancaires"
+ ]
},
"requestor_challenge_indicator": {
"description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
@@ -150828,11 +168327,56 @@
"version"
],
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ares_trans_status",
+ "cryptogram",
+ "electronic_commerce_indicator",
+ "exemption_indicator",
+ "network_options",
+ "requestor_challenge_indicator",
+ "transaction_id",
+ "version"
+ ]
}
},
"title": "payment_intent_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allow_partial_amount",
+ "buy_now_pay_later_options",
+ "capture_method",
+ "cvc_token",
+ "installments",
+ "mandate_options",
+ "mcc",
+ "mit_exemption",
+ "moto",
+ "network",
+ "network_options",
+ "network_token",
+ "off_session_usage",
+ "recipient_details",
+ "request_decremental_authorization",
+ "request_extended_authorization",
+ "request_flexible_extended_authorization",
+ "request_incremental_authorization",
+ "request_incremental_authorization_support",
+ "request_multicapture",
+ "request_overcapture",
+ "request_partial_authorization",
+ "request_three_d_secure",
+ "require_cvc_recollection",
+ "sender_details",
+ "setup_future_usage",
+ "statement_descriptor_suffix_kana",
+ "statement_descriptor_suffix_kanji",
+ "statement_details",
+ "stored_credential_transaction_type",
+ "stored_credential_usage",
+ "three_d_secure",
+ "transaction_purpose"
+ ]
},
{
"enum": [
@@ -150868,11 +168412,24 @@
}
},
"title": "routing_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested_priority"
+ ]
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "buy_now_pay_later_options",
+ "capture_method",
+ "request_extended_authorization",
+ "request_flexible_extended_authorization",
+ "request_incremental_authorization",
+ "request_incremental_authorization_support",
+ "request_partial_authorization",
+ "routing"
+ ]
},
{
"enum": [
@@ -150907,7 +168464,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "restricted_transaction_categories",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -150938,7 +168500,10 @@
"country"
],
"title": "eu_bank_transfer_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"requested_address_types": {
"description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.",
@@ -150974,7 +168539,14 @@
"type"
],
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "eu_bank_transfer",
+ "id_bank_account",
+ "id_bank_transfer",
+ "requested_address_types",
+ "type"
+ ]
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
@@ -150992,7 +168564,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank_transfer",
+ "funding_type",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151016,7 +168593,10 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151040,7 +168620,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151064,7 +168647,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151088,7 +168674,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151114,7 +168703,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151216,7 +168808,15 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "line_items",
+ "payment_details",
+ "payment_method_category",
+ "preferred_locale",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151299,7 +168899,16 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "confirmation_number",
+ "expires_after_days",
+ "expires_at",
+ "fee_amount",
+ "product_description",
+ "setup_future_usage",
+ "tax_amount"
+ ]
},
{
"enum": [
@@ -151338,7 +168947,13 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "persistent_token",
+ "request_multicapture",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151349,6 +168964,33 @@
],
"description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options."
},
+ "mb_way": {
+ "anyOf": [
+ {
+ "properties": {
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
+ "enum": [
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "payment_method_options_param",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options."
+ },
"mobilepay": {
"anyOf": [
{
@@ -151370,7 +169012,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "reference",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151394,7 +169041,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151422,7 +169072,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_after_days",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151450,7 +169104,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "installments",
+ "setup_future_usage",
+ "tos_shown_and_accepted"
+ ]
},
{
"enum": [
@@ -151474,7 +169133,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151559,7 +169221,18 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allow_delayed_notification",
+ "capture_method",
+ "line_items",
+ "preferred_locale",
+ "reference",
+ "reference_id",
+ "risk_correlation_id",
+ "setup_future_usage",
+ "subsellers"
+ ]
},
{
"enum": [
@@ -151631,7 +169304,15 @@
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "end_date",
+ "payment_schedule",
+ "payments_per_period",
+ "purpose"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -151644,7 +169325,11 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151677,7 +169362,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "expires_after_seconds",
+ "expires_at",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151701,7 +169391,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151751,7 +169444,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151770,7 +169467,11 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reference",
+ "reference_prefix"
+ ]
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -151784,7 +169485,13 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "setup_future_usage",
+ "target_date",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -151824,7 +169531,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred_language",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151863,7 +169574,12 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "authorization_method",
+ "reference",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151887,7 +169603,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -151927,7 +169646,11 @@
}
},
"title": "linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_subcategories",
+ "institution"
+ ]
},
"manual_entry": {
"description": "Customize manual entry behavior",
@@ -151945,7 +169668,10 @@
"mode"
],
"title": "linked_account_options_manual_entry_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode"
+ ]
},
"permissions": {
"description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.",
@@ -151982,7 +169708,14 @@
}
},
"title": "linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "filters",
+ "manual_entry",
+ "permissions",
+ "prefetch",
+ "return_url"
+ ]
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -151998,7 +169731,10 @@
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "collection_method"
+ ]
},
"networks": {
"description": "Additional fields for network related functions",
@@ -152016,7 +169752,10 @@
}
},
"title": "networks_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"preferred_settlement_speed": {
"description": "Preferred transaction settlement speed",
@@ -152049,7 +169788,15 @@
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "financial_connections",
+ "mandate_options",
+ "networks",
+ "preferred_settlement_speed",
+ "setup_future_usage",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -152091,7 +169838,12 @@
"client"
],
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "app_id",
+ "client",
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -152115,7 +169867,10 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "setup_future_usage"
+ ]
},
{
"enum": [
@@ -152128,7 +169883,71 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "affirm",
+ "afterpay_clearpay",
+ "alipay",
+ "alma",
+ "amazon_pay",
+ "au_becs_debit",
+ "bacs_debit",
+ "bancontact",
+ "blik",
+ "boleto",
+ "boleto_pilot",
+ "card",
+ "card_present",
+ "cashapp",
+ "customer_balance",
+ "demo_pay",
+ "dummy_auth_push",
+ "dummy_passthrough_card",
+ "eps",
+ "fpx",
+ "giropay",
+ "gopay",
+ "grabpay",
+ "id_bank_transfer",
+ "ideal",
+ "interac_present",
+ "kakao_pay",
+ "klarna",
+ "knet",
+ "konbini",
+ "kr_card",
+ "kr_market",
+ "link",
+ "mb_way",
+ "mobilepay",
+ "multibanco",
+ "naver_pay",
+ "ng_card",
+ "ng_market",
+ "oxxo",
+ "p24",
+ "pay_by_bank",
+ "payco",
+ "paynow",
+ "paypal",
+ "payto",
+ "pix",
+ "promptpay",
+ "qris",
+ "rechnung",
+ "revolut_pay",
+ "samsung_pay",
+ "sepa_debit",
+ "sofort",
+ "swish",
+ "twint",
+ "upi",
+ "us_bank_account",
+ "vipps",
+ "wechat_pay",
+ "zip"
+ ]
},
"payment_method_types": {
"description": "The list of payment method types (for example, a card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
@@ -152148,7 +169967,11 @@
}
},
"title": "radar_options_with_hidden_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "session",
+ "skip_rules"
+ ]
},
"receipt_email": {
"anyOf": [
@@ -152216,7 +170039,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
@@ -152244,7 +170075,14 @@
"name"
],
"title": "optional_fields_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "carrier",
+ "name",
+ "phone",
+ "tracking_number"
+ ]
},
{
"enum": [
@@ -152260,7 +170098,13 @@
"type": "boolean"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment_method",
+ "receipt_email",
+ "setup_future_usage",
+ "shipping"
+ ]
}
}
},
@@ -152367,15 +170211,24 @@
"calculation"
],
"title": "async_workflows_inputs_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "calculation"
+ ]
}
},
"title": "async_workflows_inputs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax"
+ ]
}
},
"title": "async_workflows_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "inputs"
+ ]
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
@@ -152406,13 +170259,21 @@
}
},
"title": "transfer_data_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount"
+ ]
}
},
"required": [
"amount"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "description",
+ "metadata"
+ ]
}
}
},
@@ -152519,15 +170380,24 @@
"calculation"
],
"title": "async_workflows_inputs_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "calculation"
+ ]
}
},
"title": "async_workflows_inputs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax"
+ ]
}
},
"title": "async_workflows_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "inputs"
+ ]
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
@@ -152550,7 +170420,7 @@
"type": "object"
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).",
"maxLength": 22,
"type": "string"
},
@@ -152563,13 +170433,22 @@
}
},
"title": "transfer_data_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount"
+ ]
}
},
"required": [
"amount"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "description",
+ "metadata",
+ "statement_descriptor"
+ ]
}
}
},
@@ -152652,7 +170531,11 @@
"type": "array"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amounts",
+ "descriptor_code"
+ ]
}
}
},
@@ -152799,6 +170682,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -152913,7 +170802,10 @@
}
},
"title": "after_completion_confirmation_page_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom_message"
+ ]
},
"redirect": {
"description": "Configuration when `type=redirect`.",
@@ -152928,7 +170820,10 @@
"url"
],
"title": "after_completion_redirect_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "url"
+ ]
},
"type": {
"description": "The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.",
@@ -152943,7 +170838,12 @@
"type"
],
"title": "after_completion_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "hosted_confirmation",
+ "redirect",
+ "type"
+ ]
},
"allow_promotion_codes": {
"description": "Enables user redeemable promotion codes.",
@@ -152984,14 +170884,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"billing_address_collection": {
"description": "Configuration for collecting the customer's billing address. Defaults to `auto`.",
@@ -153020,7 +170928,10 @@
"position"
],
"title": "payment_method_reuse_agreement_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "position"
+ ]
},
"promotions": {
"description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.",
@@ -153040,7 +170951,12 @@
}
},
"title": "consent_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment_method_reuse_agreement",
+ "promotions",
+ "terms_of_service"
+ ]
},
"currency": {
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price.",
@@ -153073,7 +170989,11 @@
"value"
],
"title": "custom_field_option_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "label",
+ "value"
+ ]
},
"type": "array"
}
@@ -153082,7 +171002,11 @@
"options"
],
"title": "custom_field_dropdown_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_value",
+ "options"
+ ]
},
"key": {
"description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.",
@@ -153110,7 +171034,11 @@
"type"
],
"title": "custom_field_label_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom",
+ "type"
+ ]
},
"numeric": {
"description": "Configuration for `type=numeric` fields.",
@@ -153125,7 +171053,12 @@
}
},
"title": "custom_field_numeric_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_value",
+ "maximum_length",
+ "minimum_length"
+ ]
},
"optional": {
"description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.",
@@ -153144,7 +171077,12 @@
}
},
"title": "custom_field_text_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_value",
+ "maximum_length",
+ "minimum_length"
+ ]
},
"type": {
"description": "The type of the field.",
@@ -153162,7 +171100,16 @@
"type"
],
"title": "custom_field_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dropdown",
+ "key",
+ "label",
+ "numeric",
+ "optional",
+ "text",
+ "type"
+ ]
},
"type": "array"
},
@@ -153183,7 +171130,10 @@
"message"
],
"title": "custom_text_position_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "message"
+ ]
},
{
"enum": [
@@ -153208,7 +171158,10 @@
"message"
],
"title": "custom_text_position_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "message"
+ ]
},
{
"enum": [
@@ -153233,7 +171186,10 @@
"message"
],
"title": "custom_text_position_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "message"
+ ]
},
{
"enum": [
@@ -153258,7 +171214,10 @@
"message"
],
"title": "custom_text_position_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "message"
+ ]
},
{
"enum": [
@@ -153271,7 +171230,13 @@
}
},
"title": "custom_text_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "after_submit",
+ "shipping_address",
+ "submit",
+ "terms_of_service_acceptance"
+ ]
},
"customer_creation": {
"description": "Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).",
@@ -153343,7 +171308,11 @@
"value"
],
"title": "custom_field_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name",
+ "value"
+ ]
},
"type": "array"
},
@@ -153386,7 +171355,11 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
},
"metadata": {
"anyOf": [
@@ -153420,7 +171393,11 @@
}
},
"title": "rendering_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_tax_display",
+ "invoice_title"
+ ]
},
{
"enum": [
@@ -153433,14 +171410,27 @@
}
},
"title": "invoice_settings_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "custom_fields",
+ "description",
+ "footer",
+ "issuer",
+ "metadata",
+ "rendering_options"
+ ]
}
},
"required": [
"enabled"
],
"title": "invoice_creation_create_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "invoice_data"
+ ]
},
"line_items": {
"description": "The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.",
@@ -153466,7 +171456,12 @@
"enabled"
],
"title": "adjustable_quantity_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "maximum",
+ "minimum"
+ ]
},
"price": {
"description": "The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.",
@@ -153483,7 +171478,12 @@
"quantity"
],
"title": "line_items_create_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "adjustable_quantity",
+ "price",
+ "quantity"
+ ]
},
"type": "array"
},
@@ -153531,12 +171531,12 @@
"type": "string"
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
"type": "string"
},
@@ -153547,7 +171547,16 @@
}
},
"title": "payment_intent_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_method",
+ "description",
+ "metadata",
+ "setup_future_usage",
+ "statement_descriptor",
+ "statement_descriptor_suffix",
+ "transfer_group"
+ ]
},
"payment_method_collection": {
"description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).",
@@ -153579,6 +171588,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -153613,7 +171623,10 @@
"enabled"
],
"title": "phone_number_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"restrictions": {
"description": "Settings that restrict the usage of a payment link.",
@@ -153630,14 +171643,20 @@
"limit"
],
"title": "completed_sessions_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "limit"
+ ]
}
},
"required": [
"completed_sessions"
],
"title": "restrictions_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "completed_sessions"
+ ]
},
"shipping_address_collection": {
"description": "Configuration for collecting the customer's shipping address.",
@@ -153893,7 +171912,10 @@
"allowed_countries"
],
"title": "shipping_address_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allowed_countries"
+ ]
},
"shipping_options": {
"description": "The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.",
@@ -153906,7 +171928,10 @@
}
},
"title": "shipping_option_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "shipping_rate"
+ ]
},
"type": "array"
},
@@ -153951,11 +171976,18 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"title": "subscription_data_invoice_settings_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "issuer"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -153988,18 +172020,31 @@
"missing_payment_method"
],
"title": "end_behavior",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "missing_payment_method"
+ ]
}
},
"required": [
"end_behavior"
],
"title": "trial_settings_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
"title": "subscription_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "invoice_settings",
+ "metadata",
+ "trial_period_days",
+ "trial_settings"
+ ]
},
"tax_id_collection": {
"description": "Controls tax ID collection during checkout.",
@@ -154013,7 +172058,11 @@
"enabled"
],
"title": "tax_id_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "required"
+ ]
},
"transfer_data": {
"description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.",
@@ -154031,13 +172080,21 @@
"destination"
],
"title": "transfer_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "destination"
+ ]
}
},
"required": [
"line_items"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "line_items",
+ "metadata"
+ ]
}
}
},
@@ -154234,7 +172291,10 @@
}
},
"title": "after_completion_confirmation_page_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom_message"
+ ]
},
"redirect": {
"description": "Configuration when `type=redirect`.",
@@ -154249,7 +172309,10 @@
"url"
],
"title": "after_completion_redirect_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "url"
+ ]
},
"type": {
"description": "The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.",
@@ -154264,7 +172327,12 @@
"type"
],
"title": "after_completion_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "hosted_confirmation",
+ "redirect",
+ "type"
+ ]
},
"allow_promotion_codes": {
"description": "Enables user redeemable promotion codes.",
@@ -154297,14 +172365,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"billing_address_collection": {
"description": "Configuration for collecting the customer's billing address. Defaults to `auto`.",
@@ -154342,7 +172418,11 @@
"value"
],
"title": "custom_field_option_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "label",
+ "value"
+ ]
},
"type": "array"
}
@@ -154351,7 +172431,11 @@
"options"
],
"title": "custom_field_dropdown_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_value",
+ "options"
+ ]
},
"key": {
"description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.",
@@ -154379,7 +172463,11 @@
"type"
],
"title": "custom_field_label_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom",
+ "type"
+ ]
},
"numeric": {
"description": "Configuration for `type=numeric` fields.",
@@ -154394,7 +172482,12 @@
}
},
"title": "custom_field_numeric_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_value",
+ "maximum_length",
+ "minimum_length"
+ ]
},
"optional": {
"description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.",
@@ -154413,7 +172506,12 @@
}
},
"title": "custom_field_text_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_value",
+ "maximum_length",
+ "minimum_length"
+ ]
},
"type": {
"description": "The type of the field.",
@@ -154431,7 +172529,16 @@
"type"
],
"title": "custom_field_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dropdown",
+ "key",
+ "label",
+ "numeric",
+ "optional",
+ "text",
+ "type"
+ ]
},
"type": "array"
},
@@ -154461,7 +172568,10 @@
"message"
],
"title": "custom_text_position_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "message"
+ ]
},
{
"enum": [
@@ -154486,7 +172596,10 @@
"message"
],
"title": "custom_text_position_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "message"
+ ]
},
{
"enum": [
@@ -154511,7 +172624,10 @@
"message"
],
"title": "custom_text_position_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "message"
+ ]
},
{
"enum": [
@@ -154536,7 +172652,10 @@
"message"
],
"title": "custom_text_position_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "message"
+ ]
},
{
"enum": [
@@ -154549,7 +172668,13 @@
}
},
"title": "custom_text_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "after_submit",
+ "shipping_address",
+ "submit",
+ "terms_of_service_acceptance"
+ ]
},
"customer_creation": {
"description": "Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).",
@@ -154631,7 +172756,11 @@
"value"
],
"title": "custom_field_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name",
+ "value"
+ ]
},
"type": "array"
},
@@ -154674,7 +172803,11 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
},
"metadata": {
"anyOf": [
@@ -154708,7 +172841,11 @@
}
},
"title": "rendering_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_tax_display",
+ "invoice_title"
+ ]
},
{
"enum": [
@@ -154721,14 +172858,27 @@
}
},
"title": "invoice_settings_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "custom_fields",
+ "description",
+ "footer",
+ "issuer",
+ "metadata",
+ "rendering_options"
+ ]
}
},
"required": [
"enabled"
],
"title": "invoice_creation_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "invoice_data"
+ ]
},
"line_items": {
"description": "The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.",
@@ -154754,7 +172904,12 @@
"enabled"
],
"title": "adjustable_quantity_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "maximum",
+ "minimum"
+ ]
},
"id": {
"description": "The ID of an existing line item on the payment link.",
@@ -154770,7 +172925,13 @@
"id"
],
"title": "line_items_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "adjustable_quantity",
+ "id",
+ "price",
+ "quantity"
+ ]
},
"type": "array"
},
@@ -154829,7 +172990,7 @@
"type": "string"
}
],
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead."
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead."
},
"statement_descriptor_suffix": {
"anyOf": [
@@ -154844,7 +173005,7 @@
"type": "string"
}
],
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement."
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement."
},
"transfer_group": {
"anyOf": [
@@ -154863,7 +173024,15 @@
}
},
"title": "payment_intent_data_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "metadata",
+ "setup_future_usage",
+ "statement_descriptor",
+ "statement_descriptor_suffix",
+ "transfer_group"
+ ]
},
"payment_method_collection": {
"description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).",
@@ -154896,6 +173065,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -154943,14 +173113,20 @@
"limit"
],
"title": "completed_sessions_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "limit"
+ ]
}
},
"required": [
"completed_sessions"
],
"title": "restrictions_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "completed_sessions"
+ ]
},
{
"enum": [
@@ -155216,7 +173392,10 @@
"allowed_countries"
],
"title": "shipping_address_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allowed_countries"
+ ]
},
{
"enum": [
@@ -155253,11 +173432,18 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"title": "subscription_data_invoice_settings_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "issuer"
+ ]
},
"metadata": {
"anyOf": [
@@ -155297,14 +173483,20 @@
"missing_payment_method"
],
"title": "end_behavior",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "missing_payment_method"
+ ]
}
},
"required": [
"end_behavior"
],
"title": "trial_settings_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
},
{
"enum": [
@@ -155317,7 +173509,13 @@
}
},
"title": "subscription_data_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "invoice_settings",
+ "metadata",
+ "trial_period_days",
+ "trial_settings"
+ ]
},
"tax_id_collection": {
"description": "Controls tax ID collection during checkout.",
@@ -155331,10 +173529,19 @@
"enabled"
],
"title": "tax_id_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "required"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "line_items",
+ "metadata"
+ ]
}
}
},
@@ -155481,6 +173688,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -155629,6 +173842,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -155847,11 +174066,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"affirm": {
"description": "[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.",
@@ -155870,11 +174095,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"afterpay_clearpay": {
"description": "Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.",
@@ -155893,11 +174124,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"alipay": {
"description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.",
@@ -155916,11 +174153,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"amazon_pay": {
"description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.",
@@ -155939,11 +174182,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"apple_pay": {
"description": "Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.",
@@ -155962,11 +174211,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"apple_pay_later": {
"description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.",
@@ -155985,11 +174240,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"au_becs_debit": {
"description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.",
@@ -156008,11 +174269,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"bacs_debit": {
"description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.",
@@ -156031,11 +174298,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"bancontact": {
"description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.",
@@ -156054,11 +174327,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"blik": {
"description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.",
@@ -156077,11 +174356,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"boleto": {
"description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.",
@@ -156100,11 +174385,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"card": {
"description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.",
@@ -156123,11 +174414,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"cartes_bancaires": {
"description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.",
@@ -156146,11 +174443,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"cashapp": {
"description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.",
@@ -156169,11 +174472,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"customer_balance": {
"description": "Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.",
@@ -156192,11 +174501,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"eps": {
"description": "EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.",
@@ -156215,11 +174530,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -156246,11 +174567,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"giropay": {
"description": "giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.",
@@ -156269,11 +174596,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"google_pay": {
"description": "Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.",
@@ -156292,11 +174625,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"grabpay": {
"description": "GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.",
@@ -156315,11 +174654,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"ideal": {
"description": "iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.",
@@ -156338,11 +174683,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"jcb": {
"description": "JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.",
@@ -156361,11 +174712,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"klarna": {
"description": "Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.",
@@ -156384,11 +174741,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"konbini": {
"description": "Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.",
@@ -156407,11 +174770,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"link": {
"description": "[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.",
@@ -156430,11 +174799,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"mobilepay": {
"description": "MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.",
@@ -156453,11 +174828,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"multibanco": {
"description": "Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.",
@@ -156476,11 +174857,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"name": {
"description": "Configuration name.",
@@ -156504,11 +174891,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"p24": {
"description": "Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.",
@@ -156527,11 +174920,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"parent": {
"description": "Configuration's parent configuration. Specify to create a child configuration.",
@@ -156555,11 +174954,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"paypal": {
"description": "PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.",
@@ -156578,11 +174983,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"payto": {
"description": "PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details.",
@@ -156601,11 +175012,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"promptpay": {
"description": "PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.",
@@ -156624,11 +175041,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"revolut_pay": {
"description": "Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.",
@@ -156647,11 +175070,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"sepa_debit": {
"description": "The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.",
@@ -156670,11 +175099,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"sofort": {
"description": "Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.",
@@ -156693,11 +175128,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"swish": {
"description": "Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.",
@@ -156716,11 +175157,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"twint": {
"description": "Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.",
@@ -156739,11 +175186,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"us_bank_account": {
"description": "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details.",
@@ -156762,11 +175215,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"wechat_pay": {
"description": "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.",
@@ -156785,11 +175244,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"zip": {
"description": "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.",
@@ -156808,14 +175273,24 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name",
+ "parent"
+ ]
}
}
},
@@ -157124,11 +175599,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"active": {
"description": "Whether the configuration can be used for new payments.",
@@ -157151,11 +175632,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"afterpay_clearpay": {
"description": "Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.",
@@ -157174,11 +175661,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"alipay": {
"description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.",
@@ -157197,11 +175690,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"amazon_pay": {
"description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.",
@@ -157220,11 +175719,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"apple_pay": {
"description": "Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.",
@@ -157243,11 +175748,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"apple_pay_later": {
"description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.",
@@ -157266,11 +175777,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"au_becs_debit": {
"description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.",
@@ -157289,11 +175806,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"bacs_debit": {
"description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.",
@@ -157312,11 +175835,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"bancontact": {
"description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.",
@@ -157335,11 +175864,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"blik": {
"description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.",
@@ -157358,11 +175893,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"boleto": {
"description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.",
@@ -157381,11 +175922,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"card": {
"description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.",
@@ -157404,11 +175951,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"cartes_bancaires": {
"description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.",
@@ -157427,11 +175980,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"cashapp": {
"description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.",
@@ -157450,11 +176009,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"customer_balance": {
"description": "Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.",
@@ -157473,11 +176038,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"eps": {
"description": "EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.",
@@ -157496,11 +176067,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -157527,11 +176104,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"giropay": {
"description": "giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.",
@@ -157550,11 +176133,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"google_pay": {
"description": "Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.",
@@ -157573,11 +176162,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"grabpay": {
"description": "GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.",
@@ -157596,11 +176191,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"ideal": {
"description": "iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.",
@@ -157619,11 +176220,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"jcb": {
"description": "JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.",
@@ -157642,11 +176249,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"klarna": {
"description": "Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.",
@@ -157665,11 +176278,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"konbini": {
"description": "Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.",
@@ -157688,11 +176307,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"link": {
"description": "[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.",
@@ -157711,11 +176336,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"mobilepay": {
"description": "MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.",
@@ -157734,11 +176365,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"multibanco": {
"description": "Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.",
@@ -157757,11 +176394,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"name": {
"description": "Configuration name.",
@@ -157785,11 +176428,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"p24": {
"description": "Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.",
@@ -157808,11 +176457,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"paynow": {
"description": "PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.",
@@ -157831,11 +176486,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"paypal": {
"description": "PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.",
@@ -157854,11 +176515,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"payto": {
"description": "PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details.",
@@ -157877,11 +176544,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"promptpay": {
"description": "PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.",
@@ -157900,11 +176573,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"revolut_pay": {
"description": "Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.",
@@ -157923,11 +176602,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"sepa_debit": {
"description": "The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.",
@@ -157946,11 +176631,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"sofort": {
"description": "Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.",
@@ -157969,11 +176660,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"swish": {
"description": "Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.",
@@ -157992,11 +176689,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"twint": {
"description": "Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.",
@@ -158015,11 +176718,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"us_bank_account": {
"description": "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details.",
@@ -158038,11 +176747,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"wechat_pay": {
"description": "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.",
@@ -158061,11 +176776,17 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
},
"zip": {
"description": "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.",
@@ -158084,14 +176805,24 @@
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preference"
+ ]
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_preference"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "name"
+ ]
}
}
},
@@ -158249,6 +176980,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -158303,7 +177040,11 @@
"required": [
"domain_name"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "domain_name",
+ "enabled"
+ ]
}
}
},
@@ -158440,7 +177181,10 @@
"type": "array"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
}
}
},
@@ -158626,6 +177370,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -158705,6 +177450,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -158826,6 +177577,10 @@
"explode": true,
"style": "deepObject"
},
+ "mb_way": {
+ "explode": true,
+ "style": "deepObject"
+ },
"metadata": {
"explode": true,
"style": "deepObject"
@@ -158935,7 +177690,12 @@
"transit_number"
],
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "institution_number",
+ "transit_number"
+ ]
},
"affirm": {
"description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.",
@@ -158989,7 +177749,11 @@
"bsb_number"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number"
+ ]
},
"bacs_debit": {
"description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.",
@@ -159006,7 +177770,11 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "sort_code"
+ ]
},
"bancontact": {
"description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.",
@@ -159053,7 +177821,15 @@
}
},
"title": "billing_details_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
{
"enum": [
@@ -159110,7 +177886,13 @@
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
+ ]
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -159131,7 +177913,10 @@
"tax_id"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"card": {
"anyOf": [
@@ -159164,7 +177949,10 @@
}
},
"title": "networks_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred"
+ ]
},
"number": {
"description": "The card number, as a string without any separators.",
@@ -159179,6 +177967,14 @@
],
"title": "card_details_params",
"type": "object",
+ "x-stripeMostCommon": [
+ "cvc",
+ "exp_month",
+ "exp_year",
+ "funding_options",
+ "networks",
+ "number"
+ ],
"x-stripeParam": {
"class_name": "CardDetails"
}
@@ -159196,6 +177992,9 @@
],
"title": "token_params",
"type": "object",
+ "x-stripeMostCommon": [
+ "token"
+ ],
"x-stripeParam": {
"class_name": "Token"
}
@@ -159261,7 +178060,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -159318,7 +178120,11 @@
"bank"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "bank"
+ ]
},
"giropay": {
"description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.",
@@ -159360,13 +178166,22 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"interac_present": {
"description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "device_identifier",
+ "device_type",
+ "emv",
+ "location"
+ ]
},
"klarna": {
"description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.",
@@ -159393,11 +178208,19 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"konbini": {
"description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.",
@@ -159411,6 +178234,12 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"metadata": {
"additionalProperties": {
"type": "string"
@@ -159474,7 +178303,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"payment_method": {
"description": "The PaymentMethod to share.",
@@ -159513,13 +178345,21 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number",
+ "pay_id"
+ ]
},
"pix": {
"description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"promptpay": {
"description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.",
@@ -159537,7 +178377,11 @@
}
},
"title": "radar_options_with_hidden_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "session",
+ "skip_rules"
+ ]
},
"rechnung": {
"description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.",
@@ -159564,14 +178408,22 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"required": [
"dob"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"revolut_pay": {
"description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
@@ -159592,7 +178444,10 @@
"iban"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iban"
+ ]
},
"sofort": {
"description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.",
@@ -159614,7 +178469,10 @@
"country"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"swish": {
"description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.",
@@ -159652,6 +178510,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -159710,7 +178569,14 @@
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "account_number",
+ "account_type",
+ "financial_connections_account",
+ "routing_number"
+ ]
},
"wechat_pay": {
"description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.",
@@ -159725,7 +178591,14 @@
"type": "object"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_details",
+ "customer",
+ "metadata",
+ "payment_method",
+ "type"
+ ]
}
}
},
@@ -159865,10 +178738,6 @@
"explode": true,
"style": "deepObject"
},
- "rechnung": {
- "explode": true,
- "style": "deepObject"
- },
"us_bank_account": {
"explode": true,
"style": "deepObject"
@@ -159925,7 +178794,15 @@
}
},
"title": "billing_details_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
{
"enum": [
@@ -159982,7 +178859,13 @@
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
+ ]
},
"card": {
"description": "If this is a `card` PaymentMethod, this hash contains the user's card details.",
@@ -160010,11 +178893,19 @@
}
},
"title": "networks_update_api_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred"
+ ]
}
},
"title": "update_api_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "exp_month",
+ "exp_year",
+ "networks"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -160067,41 +178958,12 @@
}
},
"title": "param",
- "type": "object"
- },
- "rechnung": {
- "description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.",
- "properties": {
- "dob": {
- "description": "Customer's date of birth",
- "properties": {
- "day": {
- "description": "The day of birth, between 1 and 31.",
- "type": "integer"
- },
- "month": {
- "description": "The month of birth, between 1 and 12.",
- "type": "integer"
- },
- "year": {
- "description": "The four-digit year of birth.",
- "type": "integer"
- }
- },
- "required": [
- "day",
- "month",
- "year"
- ],
- "title": "date_of_birth",
- "type": "object"
- }
- },
- "required": [
- "dob"
- ],
- "title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number",
+ "pay_id"
+ ]
},
"us_bank_account": {
"description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.",
@@ -160124,10 +178986,18 @@
}
},
"title": "update_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "account_type"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_details",
+ "metadata"
+ ]
}
}
},
@@ -160202,7 +179072,10 @@
"required": [
"customer"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer"
+ ]
}
}
},
@@ -160332,7 +179205,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -160369,7 +179248,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -160501,6 +179386,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -160602,7 +179493,14 @@
"amount",
"currency"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "metadata",
+ "statement_descriptor"
+ ]
}
}
},
@@ -160756,7 +179654,10 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata"
+ ]
}
}
},
@@ -160901,7 +179802,10 @@
"type": "object"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata"
+ ]
}
}
},
@@ -160974,7 +179878,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -161097,6 +180007,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -161282,7 +180198,17 @@
"name"
],
"title": "inline_product_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "id",
+ "images",
+ "metadata",
+ "name",
+ "statement_descriptor",
+ "tax_code",
+ "unit_label"
+ ]
},
{
"description": "The ID of the product whose pricing the created plan will represent.",
@@ -161333,7 +180259,14 @@
"up_to"
],
"title": "tier",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "flat_amount",
+ "flat_amount_decimal",
+ "unit_amount",
+ "unit_amount_decimal",
+ "up_to"
+ ]
},
"type": "array"
},
@@ -161366,7 +180299,11 @@
"round"
],
"title": "transform_usage_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "divide_by",
+ "round"
+ ]
},
"trial_period_days": {
"description": "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).",
@@ -161385,7 +180322,16 @@
"currency",
"interval"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "amount",
+ "currency",
+ "interval",
+ "metadata",
+ "nickname",
+ "product"
+ ]
}
}
},
@@ -161608,7 +180554,12 @@
"type": "integer"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "metadata",
+ "nickname"
+ ]
}
}
},
@@ -161681,7 +180632,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -161795,7 +180752,12 @@
}
},
"title": "all_prices_recurring_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "meter",
+ "usage_type"
+ ]
},
"style": "deepObject"
},
@@ -161880,6 +180842,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -161984,7 +180952,11 @@
"enabled"
],
"title": "custom_unit_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "preset"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -162037,7 +181009,14 @@
"up_to"
],
"title": "tier",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "flat_amount",
+ "flat_amount_decimal",
+ "unit_amount",
+ "unit_amount_decimal",
+ "up_to"
+ ]
},
"type": "array"
},
@@ -162052,7 +181031,10 @@
}
},
"title": "currency_option",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit_amount"
+ ]
},
"description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
"type": "object"
@@ -162081,7 +181063,11 @@
"enabled"
],
"title": "custom_unit_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "preset"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -162158,7 +181144,17 @@
"name"
],
"title": "inline_product_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "id",
+ "images",
+ "metadata",
+ "name",
+ "statement_descriptor",
+ "tax_code",
+ "unit_label"
+ ]
},
"recurring": {
"description": "The recurring components of a price such as `interval` and `usage_type`.",
@@ -162209,7 +181205,14 @@
"interval"
],
"title": "recurring",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "aggregate_usage",
+ "interval",
+ "meter",
+ "trial_period_days",
+ "usage_type"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -162262,7 +181265,14 @@
"up_to"
],
"title": "tier",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "flat_amount",
+ "flat_amount_decimal",
+ "unit_amount",
+ "unit_amount_decimal",
+ "up_to"
+ ]
},
"type": "array"
},
@@ -162299,7 +181309,11 @@
"round"
],
"title": "transform_usage_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "divide_by",
+ "round"
+ ]
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`.",
@@ -162314,7 +181328,16 @@
"required": [
"currency"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "currency",
+ "metadata",
+ "nickname",
+ "product",
+ "recurring",
+ "unit_amount"
+ ]
}
}
},
@@ -162458,6 +181481,14 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "next_page",
+ "object",
+ "total_count",
+ "url"
]
}
}
@@ -162616,7 +181647,11 @@
"enabled"
],
"title": "custom_unit_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "preset"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -162669,7 +181704,14 @@
"up_to"
],
"title": "tier",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "flat_amount",
+ "flat_amount_decimal",
+ "unit_amount",
+ "unit_amount_decimal",
+ "up_to"
+ ]
},
"type": "array"
},
@@ -162684,7 +181726,10 @@
}
},
"title": "currency_option",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit_amount"
+ ]
},
"type": "object"
},
@@ -162754,7 +181799,12 @@
"price"
],
"title": "migrate_to_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "behavior",
+ "effective_after",
+ "price"
+ ]
},
{
"enum": [
@@ -162784,7 +181834,12 @@
"type": "boolean"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "metadata",
+ "nickname"
+ ]
}
}
},
@@ -162857,7 +181912,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -163019,6 +182080,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -163114,7 +182181,11 @@
"enabled"
],
"title": "custom_unit_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "preset"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -163167,7 +182238,14 @@
"up_to"
],
"title": "tier",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "flat_amount",
+ "flat_amount_decimal",
+ "unit_amount",
+ "unit_amount_decimal",
+ "up_to"
+ ]
},
"type": "array"
},
@@ -163182,7 +182260,10 @@
}
},
"title": "currency_option",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit_amount"
+ ]
},
"description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
"type": "object"
@@ -163209,7 +182290,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -163234,7 +182318,13 @@
"currency"
],
"title": "price_data_without_product",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "currency_options",
+ "recurring",
+ "unit_amount"
+ ]
},
"description": {
"description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.",
@@ -163275,7 +182365,10 @@
"name"
],
"title": "features",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -163318,7 +182411,13 @@
"width"
],
"title": "package_dimensions_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "height",
+ "length",
+ "weight",
+ "width"
+ ]
},
"provisioning": {
"description": "Provisioning configuration for this product.",
@@ -163340,7 +182439,11 @@
"currency"
],
"title": "fixed_amount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency"
+ ]
},
"type": {
"description": "The specific type of gift_card provisioning, only `fixed_amount` currently supported.",
@@ -163354,7 +182457,11 @@
"type"
],
"title": "gift_card_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amount",
+ "type"
+ ]
},
"type": {
"description": "The type of provisioning, only `gift_card` currently supported.",
@@ -163368,7 +182475,11 @@
"type"
],
"title": "provisioning_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gift_card",
+ "type"
+ ]
},
"shippable": {
"description": "Whether this product is shipped (i.e., physical goods).",
@@ -163405,7 +182516,14 @@
"required": [
"name"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "description",
+ "id",
+ "metadata",
+ "name"
+ ]
}
}
},
@@ -163549,6 +182667,14 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "next_page",
+ "object",
+ "total_count",
+ "url"
]
}
}
@@ -163809,7 +182935,10 @@
"name"
],
"title": "features",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "name"
+ ]
},
"type": "array"
},
@@ -163872,7 +183001,13 @@
"width"
],
"title": "package_dimensions_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "height",
+ "length",
+ "weight",
+ "width"
+ ]
},
{
"enum": [
@@ -163936,7 +183071,14 @@
"description": "A URL of a publicly-accessible webpage for this product."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "default_price",
+ "description",
+ "metadata",
+ "name"
+ ]
}
}
},
@@ -164082,6 +183224,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -164144,7 +183292,10 @@
"required": [
"entitlement_feature"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "entitlement_feature"
+ ]
}
}
},
@@ -164380,7 +183531,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -164502,6 +183659,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -164598,7 +183761,10 @@
}
},
"title": "currency_option",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "minimum_amount"
+ ]
},
"description": "Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
"type": "object"
@@ -164617,13 +183783,24 @@
}
},
"title": "restrictions_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency_options",
+ "first_time_transaction",
+ "minimum_amount",
+ "minimum_amount_currency"
+ ]
}
},
"required": [
"coupon"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "code",
+ "coupon",
+ "metadata"
+ ]
}
}
},
@@ -164796,17 +183973,26 @@
}
},
"title": "currency_option",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "minimum_amount"
+ ]
},
"description": "Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
"type": "object"
}
},
"title": "restrictions_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency_options"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata"
+ ]
}
}
},
@@ -164952,6 +184138,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -165156,6 +184348,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -165333,6 +184531,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -165418,10 +184622,6 @@
"explode": true,
"style": "deepObject"
},
- "phases": {
- "explode": true,
- "style": "deepObject"
- },
"subscription_data": {
"explode": true,
"style": "deepObject"
@@ -165497,14 +184697,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"collection_method": {
"description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.",
@@ -165593,7 +184801,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -165613,7 +184825,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -165622,7 +184839,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -165633,7 +184853,7 @@
"type": "string"
}
],
- "description": "The discounts applied to the quote. You can only set up to one discount."
+ "description": "The discounts applied to the quote."
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -165680,7 +184900,11 @@
"quote"
],
"title": "from_quote_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "is_revision",
+ "quote"
+ ]
},
"header": {
"anyOf": [
@@ -165724,11 +184948,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"title": "quote_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom_fields",
+ "days_until_due",
+ "description",
+ "footer",
+ "issuer"
+ ]
},
"line_items": {
"description": "A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.",
@@ -165775,7 +185010,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -165795,7 +185034,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -165804,7 +185048,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -165856,7 +185103,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -165882,7 +185132,12 @@
"product"
],
"title": "price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "The quantity of the line item.",
@@ -165908,7 +185163,11 @@
}
},
"title": "line_item_create_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "price",
+ "quantity"
+ ]
},
"type": "array"
},
@@ -165948,7 +185207,10 @@
"type"
],
"title": "line_discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"index": {
"description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.",
@@ -165961,7 +185223,14 @@
}
},
"title": "add_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "discount_end",
+ "index",
+ "promotion_code"
+ ]
},
"add_item": {
"description": "Details for the `add_item` type.",
@@ -166006,7 +185275,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -166026,7 +185299,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -166035,7 +185313,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -166087,14 +185368,26 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"required": [
"price"
],
"title": "add_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discounts",
+ "metadata",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"add_metadata": {
"additionalProperties": {
@@ -166123,7 +185416,12 @@
}
},
"title": "remove_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "promotion_code"
+ ]
},
"remove_item": {
"description": "Details for the `remove_item` type.",
@@ -166138,7 +185436,10 @@
"price"
],
"title": "remove_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "price"
+ ]
},
"remove_metadata": {
"description": "Details for the `remove_metadata` type: specify an array of metadata keys.",
@@ -166169,7 +185470,12 @@
}
},
"title": "set_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "promotion_code"
+ ]
},
"type": "array"
},
@@ -166217,7 +185523,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -166237,7 +185547,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -166246,7 +185561,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -166298,14 +185616,26 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"required": [
"price"
],
"title": "set_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discounts",
+ "metadata",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"type": "array"
},
@@ -166348,7 +185678,19 @@
"type"
],
"title": "action_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add_discount",
+ "add_item",
+ "add_metadata",
+ "remove_discount",
+ "remove_item",
+ "remove_metadata",
+ "set_discounts",
+ "set_items",
+ "set_metadata",
+ "type"
+ ]
},
"type": "array"
},
@@ -166378,7 +185720,12 @@
"type"
],
"title": "applies_to_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "new_reference",
+ "subscription_schedule",
+ "type"
+ ]
},
"billing_cycle_anchor": {
"description": "For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.",
@@ -166411,7 +185758,12 @@
"cancel_at"
],
"title": "cancel_subscription_schedule_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cancel_at",
+ "invoice_now",
+ "prorate"
+ ]
},
"ends_at": {
"description": "Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.",
@@ -166429,7 +185781,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount"
+ ]
},
"duration": {
"description": "Time span for the quote line starting from the `starts_at` date.",
@@ -166454,7 +185809,11 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp.",
@@ -166479,7 +185838,13 @@
"type"
],
"title": "ends_at_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount_end",
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"proration_behavior": {
"description": "Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.",
@@ -166510,7 +185875,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "behavior"
+ ]
},
"type": {
"description": "Determines the type of the pause_collection amendment.",
@@ -166525,7 +185893,11 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "set",
+ "type"
+ ]
},
"set_schedule_end": {
"description": "Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.",
@@ -166551,7 +185923,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount"
+ ]
},
"line_ends_at": {
"description": "The timestamp the given line ends at.",
@@ -166562,7 +185937,10 @@
}
},
"title": "line_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "index"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp.",
@@ -166587,7 +185965,13 @@
"type"
],
"title": "starts_at_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount_end",
+ "line_ends_at",
+ "timestamp",
+ "type"
+ ]
},
"trial_settings": {
"description": "Settings related to subscription trials.",
@@ -166605,15 +185989,33 @@
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "prorate_up_front"
+ ]
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
"title": "quote_line_create_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "actions",
+ "applies_to",
+ "billing_cycle_anchor",
+ "cancel_subscription_schedule",
+ "ends_at",
+ "proration_behavior",
+ "set_pause_collection",
+ "set_schedule_end",
+ "starts_at",
+ "trial_settings"
+ ]
},
"type": "array"
},
@@ -166638,362 +186040,6 @@
],
"description": "The account on behalf of which to charge."
},
- "phases": {
- "description": "List representing phases of the Quote. Each phase can be customized to have different durations, prices, and coupons.",
- "items": {
- "properties": {
- "billing_cycle_anchor": {
- "description": "When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.",
- "enum": [
- "reset"
- ],
- "type": "string"
- },
- "collection_method": {
- "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.",
- "enum": [
- "charge_automatically",
- "send_invoice"
- ],
- "type": "string"
- },
- "default_tax_rates": {
- "anyOf": [
- {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase."
- },
- "discounts": {
- "anyOf": [
- {
- "items": {
- "properties": {
- "coupon": {
- "description": "ID of the coupon to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount": {
- "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount_end": {
- "description": "Details to determine how long the discount should be applied for.",
- "properties": {
- "duration": {
- "description": "Time span for the redeemed discount.",
- "properties": {
- "interval": {
- "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.",
- "enum": [
- "day",
- "month",
- "week",
- "year"
- ],
- "type": "string"
- },
- "interval_count": {
- "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.",
- "type": "integer"
- }
- },
- "required": [
- "interval",
- "interval_count"
- ],
- "title": "discount_end_duration_specs",
- "type": "object"
- },
- "timestamp": {
- "description": "A precise Unix timestamp for the discount to end. Must be in the future.",
- "format": "unix-time",
- "type": "integer"
- },
- "type": {
- "description": "The type of calculation made to determine when the discount ends.",
- "enum": [
- "duration",
- "timestamp"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "title": "discount_end",
- "type": "object"
- },
- "promotion_code": {
- "description": "ID of the promotion code to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "discounts_data_param",
- "type": "object"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts."
- },
- "end_date": {
- "description": "The date at which this phase of the quote ends. If set, `iterations` must not be set.",
- "format": "unix-time",
- "type": "integer"
- },
- "invoice_settings": {
- "description": "All invoices will be billed using the specified settings.",
- "properties": {
- "days_until_due": {
- "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.",
- "type": "integer"
- }
- },
- "title": "phase_invoice_settings_params",
- "type": "object"
- },
- "iterations": {
- "description": "Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.",
- "type": "integer"
- },
- "line_items": {
- "description": "A list of line items the customer is being quoted for within this phase. Each line item includes information about the product, the quantity, and the resulting cost.",
- "items": {
- "properties": {
- "discounts": {
- "anyOf": [
- {
- "items": {
- "properties": {
- "coupon": {
- "description": "ID of the coupon to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount": {
- "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount_end": {
- "description": "Details to determine how long the discount should be applied for.",
- "properties": {
- "duration": {
- "description": "Time span for the redeemed discount.",
- "properties": {
- "interval": {
- "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.",
- "enum": [
- "day",
- "month",
- "week",
- "year"
- ],
- "type": "string"
- },
- "interval_count": {
- "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.",
- "type": "integer"
- }
- },
- "required": [
- "interval",
- "interval_count"
- ],
- "title": "discount_end_duration_specs",
- "type": "object"
- },
- "timestamp": {
- "description": "A precise Unix timestamp for the discount to end. Must be in the future.",
- "format": "unix-time",
- "type": "integer"
- },
- "type": {
- "description": "The type of calculation made to determine when the discount ends.",
- "enum": [
- "duration",
- "timestamp"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "title": "discount_end",
- "type": "object"
- },
- "promotion_code": {
- "description": "ID of the promotion code to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "discounts_data_param",
- "type": "object"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "The discounts applied to this line item."
- },
- "price": {
- "description": "The ID of the price object. One of `price` or `price_data` is required.",
- "maxLength": 5000,
- "type": "string"
- },
- "price_data": {
- "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
- "properties": {
- "currency": {
- "description": "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).",
- "type": "string"
- },
- "product": {
- "description": "The ID of the product that this price will belong to.",
- "maxLength": 5000,
- "type": "string"
- },
- "recurring": {
- "description": "The recurring components of a price such as `interval` and `interval_count`.",
- "properties": {
- "interval": {
- "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.",
- "enum": [
- "day",
- "month",
- "week",
- "year"
- ],
- "type": "string"
- },
- "interval_count": {
- "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).",
- "type": "integer"
- }
- },
- "required": [
- "interval"
- ],
- "title": "recurring_adhoc",
- "type": "object"
- },
- "tax_behavior": {
- "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
- "enum": [
- "exclusive",
- "inclusive",
- "unspecified"
- ],
- "type": "string"
- },
- "unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
- },
- "unit_amount_decimal": {
- "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.",
- "format": "decimal",
- "type": "string"
- }
- },
- "required": [
- "currency",
- "product"
- ],
- "title": "price_data",
- "type": "object"
- },
- "quantity": {
- "description": "The quantity of the line item.",
- "type": "integer"
- },
- "tax_rates": {
- "anyOf": [
- {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item."
- }
- },
- "title": "line_item_create_params",
- "type": "object"
- },
- "type": "array"
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on the subscription schedule's phases when the quote is accepted.",
- "type": "object"
- },
- "proration_behavior": {
- "description": "If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.",
- "enum": [
- "always_invoice",
- "create_prorations",
- "none"
- ],
- "type": "string"
- },
- "trial": {
- "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.",
- "type": "boolean"
- },
- "trial_end": {
- "description": "Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`.",
- "format": "unix-time",
- "type": "integer"
- }
- },
- "required": [
- "line_items"
- ],
- "title": "quote_phase_params",
- "type": "object"
- },
- "type": "array"
- },
"subscription_data": {
"description": "When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.",
"properties": {
@@ -167017,7 +186063,11 @@
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "id",
+ "index"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp.",
@@ -167040,7 +186090,12 @@
"type"
],
"title": "bill_from_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "line_starts_at",
+ "timestamp",
+ "type"
+ ]
},
"bill_until": {
"description": "The end of the period to bill until when the Quote is accepted.",
@@ -167068,7 +186123,11 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"line_ends_at": {
"description": "Details of a Quote line item from which to bill until.",
@@ -167084,7 +186143,11 @@
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "id",
+ "index"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp.",
@@ -167107,11 +186170,21 @@
"type"
],
"title": "bill_until_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "line_ends_at",
+ "timestamp",
+ "type"
+ ]
}
},
"title": "bill_on_acceptance_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bill_from",
+ "bill_until"
+ ]
},
"billing_behavior": {
"description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.",
@@ -167164,11 +186237,6 @@
],
"type": "string"
},
- "from_schedule": {
- "description": "The id of a subscription schedule the quote will update. The quote will inherit the state of the subscription schedule, such as `phases`. Cannot be combined with other parameters.",
- "maxLength": 5000,
- "type": "string"
- },
"from_subscription": {
"description": "The id of a subscription that the quote will update. By default, the quote will contain the state of the subscription (such as line items, collection method and billing thresholds) unless overridden.",
"maxLength": 5000,
@@ -167194,7 +186262,10 @@
"iterations"
],
"title": "prebilling_preview_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iterations"
+ ]
},
{
"enum": [
@@ -167230,7 +186301,20 @@
}
},
"title": "subscription_data_create_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bill_on_acceptance",
+ "billing_behavior",
+ "billing_cycle_anchor",
+ "description",
+ "effective_date",
+ "end_behavior",
+ "from_subscription",
+ "metadata",
+ "prebilling",
+ "proration_behavior",
+ "trial_period_days"
+ ]
},
"subscription_data_overrides": {
"description": "List representing overrides for `subscription_data` configurations for specific subscription schedules.",
@@ -167262,7 +186346,12 @@
"type"
],
"title": "applies_to_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "new_reference",
+ "subscription_schedule",
+ "type"
+ ]
},
"bill_on_acceptance": {
"description": "Describes the period to bill for upon accepting the quote.",
@@ -167284,7 +186373,11 @@
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "id",
+ "index"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp.",
@@ -167307,7 +186400,12 @@
"type"
],
"title": "bill_from_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "line_starts_at",
+ "timestamp",
+ "type"
+ ]
},
"bill_until": {
"description": "The end of the period to bill until when the Quote is accepted.",
@@ -167335,7 +186433,11 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"line_ends_at": {
"description": "Details of a Quote line item from which to bill until.",
@@ -167351,7 +186453,11 @@
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "id",
+ "index"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp.",
@@ -167374,11 +186480,21 @@
"type"
],
"title": "bill_until_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "line_ends_at",
+ "timestamp",
+ "type"
+ ]
}
},
"title": "bill_on_acceptance_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bill_from",
+ "bill_until"
+ ]
},
"billing_behavior": {
"description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.",
@@ -167420,7 +186536,16 @@
"applies_to"
],
"title": "create_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "applies_to",
+ "bill_on_acceptance",
+ "billing_behavior",
+ "customer",
+ "description",
+ "end_behavior",
+ "proration_behavior"
+ ]
},
"type": "array"
},
@@ -167450,7 +186575,12 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_percent",
+ "destination"
+ ]
},
{
"enum": [
@@ -167462,7 +186592,11 @@
"description": "The data with which to automatically create a Transfer for each of the invoices."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "line_items",
+ "metadata"
+ ]
}
}
},
@@ -167634,10 +186768,6 @@
"explode": true,
"style": "deepObject"
},
- "phases": {
- "explode": true,
- "style": "deepObject"
- },
"subscription_data": {
"explode": true,
"style": "deepObject"
@@ -167713,14 +186843,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"collection_method": {
"description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.",
@@ -167809,7 +186947,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -167829,7 +186971,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -167838,7 +186985,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -167849,7 +186999,7 @@
"type": "string"
}
],
- "description": "The discounts applied to the quote. You can only set up to one discount."
+ "description": "The discounts applied to the quote."
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -167921,11 +187071,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"title": "quote_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom_fields",
+ "days_until_due",
+ "description",
+ "footer",
+ "issuer"
+ ]
},
"line_items": {
"description": "A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.",
@@ -167972,7 +187133,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -167992,7 +187157,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -168001,7 +187171,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -168058,7 +187231,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -168084,7 +187260,12 @@
"product"
],
"title": "price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "The quantity of the line item.",
@@ -168110,7 +187291,12 @@
}
},
"title": "line_item_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "id",
+ "price",
+ "quantity"
+ ]
},
"type": "array"
},
@@ -168150,7 +187336,10 @@
"type"
],
"title": "line_discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"index": {
"description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.",
@@ -168163,7 +187352,14 @@
}
},
"title": "add_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "discount_end",
+ "index",
+ "promotion_code"
+ ]
},
"add_item": {
"description": "Details for the `add_item` type.",
@@ -168208,7 +187404,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -168228,7 +187428,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -168237,7 +187442,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -168289,14 +187497,26 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"required": [
"price"
],
"title": "add_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discounts",
+ "metadata",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"add_metadata": {
"additionalProperties": {
@@ -168325,7 +187545,12 @@
}
},
"title": "remove_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "promotion_code"
+ ]
},
"remove_item": {
"description": "Details for the `remove_item` type.",
@@ -168340,7 +187565,10 @@
"price"
],
"title": "remove_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "price"
+ ]
},
"remove_metadata": {
"description": "Details for the `remove_metadata` type: specify an array of metadata keys.",
@@ -168371,7 +187599,12 @@
}
},
"title": "set_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "promotion_code"
+ ]
},
"type": "array"
},
@@ -168419,7 +187652,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -168439,7 +187676,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -168448,7 +187690,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -168500,14 +187745,26 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"required": [
"price"
],
"title": "set_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discounts",
+ "metadata",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"type": "array"
},
@@ -168550,7 +187807,19 @@
"type"
],
"title": "action_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add_discount",
+ "add_item",
+ "add_metadata",
+ "remove_discount",
+ "remove_item",
+ "remove_metadata",
+ "set_discounts",
+ "set_items",
+ "set_metadata",
+ "type"
+ ]
},
"type": "array"
},
@@ -168580,7 +187849,12 @@
"type"
],
"title": "applies_to_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "new_reference",
+ "subscription_schedule",
+ "type"
+ ]
},
"billing_cycle_anchor": {
"description": "For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.",
@@ -168613,7 +187887,12 @@
"cancel_at"
],
"title": "cancel_subscription_schedule_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cancel_at",
+ "invoice_now",
+ "prorate"
+ ]
},
"ends_at": {
"description": "Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.",
@@ -168631,7 +187910,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount"
+ ]
},
"duration": {
"description": "Time span for the quote line starting from the `starts_at` date.",
@@ -168656,7 +187938,11 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp.",
@@ -168681,7 +187967,13 @@
"type"
],
"title": "ends_at_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount_end",
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"id": {
"description": "The ID of an existing line on the quote.",
@@ -168717,7 +188009,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "behavior"
+ ]
},
"type": {
"description": "Determines the type of the pause_collection amendment.",
@@ -168732,7 +188027,11 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "set",
+ "type"
+ ]
},
"set_schedule_end": {
"description": "Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.",
@@ -168758,7 +188057,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount"
+ ]
},
"line_ends_at": {
"description": "The timestamp the given line ends at.",
@@ -168774,7 +188076,11 @@
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "id",
+ "index"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp.",
@@ -168799,7 +188105,13 @@
"type"
],
"title": "starts_at_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount_end",
+ "line_ends_at",
+ "timestamp",
+ "type"
+ ]
},
"trial_settings": {
"description": "Settings related to subscription trials.",
@@ -168817,15 +188129,34 @@
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "prorate_up_front"
+ ]
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
"title": "quote_line_update_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "actions",
+ "applies_to",
+ "billing_cycle_anchor",
+ "cancel_subscription_schedule",
+ "ends_at",
+ "id",
+ "proration_behavior",
+ "set_pause_collection",
+ "set_schedule_end",
+ "starts_at",
+ "trial_settings"
+ ]
},
"type": "array"
},
@@ -168850,362 +188181,6 @@
],
"description": "The account on behalf of which to charge."
},
- "phases": {
- "description": "List representing phases of the Quote. Each phase can be customized to have different durations, prices, and coupons.",
- "items": {
- "properties": {
- "billing_cycle_anchor": {
- "description": "When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.",
- "enum": [
- "reset"
- ],
- "type": "string"
- },
- "collection_method": {
- "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.",
- "enum": [
- "charge_automatically",
- "send_invoice"
- ],
- "type": "string"
- },
- "default_tax_rates": {
- "anyOf": [
- {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase."
- },
- "discounts": {
- "anyOf": [
- {
- "items": {
- "properties": {
- "coupon": {
- "description": "ID of the coupon to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount": {
- "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount_end": {
- "description": "Details to determine how long the discount should be applied for.",
- "properties": {
- "duration": {
- "description": "Time span for the redeemed discount.",
- "properties": {
- "interval": {
- "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.",
- "enum": [
- "day",
- "month",
- "week",
- "year"
- ],
- "type": "string"
- },
- "interval_count": {
- "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.",
- "type": "integer"
- }
- },
- "required": [
- "interval",
- "interval_count"
- ],
- "title": "discount_end_duration_specs",
- "type": "object"
- },
- "timestamp": {
- "description": "A precise Unix timestamp for the discount to end. Must be in the future.",
- "format": "unix-time",
- "type": "integer"
- },
- "type": {
- "description": "The type of calculation made to determine when the discount ends.",
- "enum": [
- "duration",
- "timestamp"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "title": "discount_end",
- "type": "object"
- },
- "promotion_code": {
- "description": "ID of the promotion code to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "discounts_data_param",
- "type": "object"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts."
- },
- "end_date": {
- "description": "The date at which this phase of the quote ends. If set, `iterations` must not be set.",
- "format": "unix-time",
- "type": "integer"
- },
- "invoice_settings": {
- "description": "All invoices will be billed using the specified settings.",
- "properties": {
- "days_until_due": {
- "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.",
- "type": "integer"
- }
- },
- "title": "phase_invoice_settings_params",
- "type": "object"
- },
- "iterations": {
- "description": "Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.",
- "type": "integer"
- },
- "line_items": {
- "description": "A list of line items the customer is being quoted for within this phase. Each line item includes information about the product, the quantity, and the resulting cost.",
- "items": {
- "properties": {
- "discounts": {
- "anyOf": [
- {
- "items": {
- "properties": {
- "coupon": {
- "description": "ID of the coupon to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount": {
- "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount_end": {
- "description": "Details to determine how long the discount should be applied for.",
- "properties": {
- "duration": {
- "description": "Time span for the redeemed discount.",
- "properties": {
- "interval": {
- "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.",
- "enum": [
- "day",
- "month",
- "week",
- "year"
- ],
- "type": "string"
- },
- "interval_count": {
- "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.",
- "type": "integer"
- }
- },
- "required": [
- "interval",
- "interval_count"
- ],
- "title": "discount_end_duration_specs",
- "type": "object"
- },
- "timestamp": {
- "description": "A precise Unix timestamp for the discount to end. Must be in the future.",
- "format": "unix-time",
- "type": "integer"
- },
- "type": {
- "description": "The type of calculation made to determine when the discount ends.",
- "enum": [
- "duration",
- "timestamp"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "title": "discount_end",
- "type": "object"
- },
- "promotion_code": {
- "description": "ID of the promotion code to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "discounts_data_param",
- "type": "object"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "The discounts applied to this line item."
- },
- "price": {
- "description": "The ID of the price object. One of `price` or `price_data` is required.",
- "maxLength": 5000,
- "type": "string"
- },
- "price_data": {
- "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
- "properties": {
- "currency": {
- "description": "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).",
- "type": "string"
- },
- "product": {
- "description": "The ID of the product that this price will belong to.",
- "maxLength": 5000,
- "type": "string"
- },
- "recurring": {
- "description": "The recurring components of a price such as `interval` and `interval_count`.",
- "properties": {
- "interval": {
- "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.",
- "enum": [
- "day",
- "month",
- "week",
- "year"
- ],
- "type": "string"
- },
- "interval_count": {
- "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).",
- "type": "integer"
- }
- },
- "required": [
- "interval"
- ],
- "title": "recurring_adhoc",
- "type": "object"
- },
- "tax_behavior": {
- "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
- "enum": [
- "exclusive",
- "inclusive",
- "unspecified"
- ],
- "type": "string"
- },
- "unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
- },
- "unit_amount_decimal": {
- "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.",
- "format": "decimal",
- "type": "string"
- }
- },
- "required": [
- "currency",
- "product"
- ],
- "title": "price_data",
- "type": "object"
- },
- "quantity": {
- "description": "The quantity of the line item.",
- "type": "integer"
- },
- "tax_rates": {
- "anyOf": [
- {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item."
- }
- },
- "title": "line_item_create_params",
- "type": "object"
- },
- "type": "array"
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on the subscription schedule's phases when the quote is accepted. After a quote has been finalized, this field can be updated by specifying an identical set of quote phases to what was on the quote originally, excluding changes in metadata and phases that are now in the past.",
- "type": "object"
- },
- "proration_behavior": {
- "description": "If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.",
- "enum": [
- "always_invoice",
- "create_prorations",
- "none"
- ],
- "type": "string"
- },
- "trial": {
- "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.",
- "type": "boolean"
- },
- "trial_end": {
- "description": "Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`.",
- "format": "unix-time",
- "type": "integer"
- }
- },
- "required": [
- "line_items"
- ],
- "title": "quote_phase_params",
- "type": "object"
- },
- "type": "array"
- },
"subscription_data": {
"description": "When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.",
"properties": {
@@ -169230,7 +188205,11 @@
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "id",
+ "index"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp.",
@@ -169253,7 +188232,12 @@
"type"
],
"title": "bill_from_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "line_starts_at",
+ "timestamp",
+ "type"
+ ]
},
"bill_until": {
"description": "The end of the period to bill until when the Quote is accepted.",
@@ -169281,7 +188265,11 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"line_ends_at": {
"description": "Details of a Quote line item from which to bill until.",
@@ -169297,7 +188285,11 @@
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "id",
+ "index"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp.",
@@ -169320,11 +188312,21 @@
"type"
],
"title": "bill_until_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "line_ends_at",
+ "timestamp",
+ "type"
+ ]
}
},
"title": "bill_on_acceptance_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bill_from",
+ "bill_until"
+ ]
},
{
"enum": [
@@ -169416,7 +188418,10 @@
"iterations"
],
"title": "prebilling_preview_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iterations"
+ ]
},
{
"enum": [
@@ -169452,7 +188457,19 @@
}
},
"title": "subscription_data_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bill_on_acceptance",
+ "billing_behavior",
+ "billing_cycle_anchor",
+ "description",
+ "effective_date",
+ "end_behavior",
+ "metadata",
+ "prebilling",
+ "proration_behavior",
+ "trial_period_days"
+ ]
},
"subscription_data_overrides": {
"anyOf": [
@@ -169485,7 +188502,12 @@
"type"
],
"title": "applies_to_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "new_reference",
+ "subscription_schedule",
+ "type"
+ ]
},
"bill_on_acceptance": {
"anyOf": [
@@ -169508,7 +188530,11 @@
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "id",
+ "index"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp.",
@@ -169531,7 +188557,12 @@
"type"
],
"title": "bill_from_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "line_starts_at",
+ "timestamp",
+ "type"
+ ]
},
"bill_until": {
"description": "The end of the period to bill until when the Quote is accepted.",
@@ -169559,7 +188590,11 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"line_ends_at": {
"description": "Details of a Quote line item from which to bill until.",
@@ -169575,7 +188610,11 @@
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "id",
+ "index"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp.",
@@ -169598,11 +188637,21 @@
"type"
],
"title": "bill_until_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "line_ends_at",
+ "timestamp",
+ "type"
+ ]
}
},
"title": "bill_on_acceptance_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bill_from",
+ "bill_until"
+ ]
},
{
"enum": [
@@ -169663,7 +188712,16 @@
"applies_to"
],
"title": "update_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "applies_to",
+ "bill_on_acceptance",
+ "billing_behavior",
+ "customer",
+ "description",
+ "end_behavior",
+ "proration_behavior"
+ ]
},
"type": "array"
},
@@ -169697,7 +188755,12 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_percent",
+ "destination"
+ ]
},
{
"enum": [
@@ -169709,7 +188772,11 @@
"description": "The data with which to automatically create a Transfer for each of the invoices."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "line_items",
+ "metadata"
+ ]
}
}
},
@@ -169990,6 +189057,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -170194,144 +189267,156 @@
"object",
"url"
],
- "title": "QuotesResourceListLineItems",
+ "title": "QuotesResourceListLineItems",
+ "type": "object",
+ "x-expandableFields": [
+ "data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ]
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/quotes/{quote}/lines": {
+ "get": {
+ "description": "Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
",
+ "operationId": "GetQuotesQuoteLines",
+ "parameters": [
+ {
+ "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
+ "in": "query",
+ "name": "ending_before",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ },
+ {
+ "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
+ "in": "query",
+ "name": "limit",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ },
+ "style": "form"
+ },
+ {
+ "in": "path",
+ "name": "quote",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ },
+ {
+ "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
+ "in": "query",
+ "name": "starting_after",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {},
+ "schema": {
+ "additionalProperties": false,
+ "properties": {},
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "description": "",
+ "properties": {
+ "data": {
+ "description": "Details about each object.",
+ "items": {
+ "$ref": "#/components/schemas/quote_line"
+ },
+ "type": "array"
+ },
+ "has_more": {
+ "description": "True if this list has another page of items after this one that can be fetched.",
+ "type": "boolean"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
+ "enum": [
+ "list"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL where this list can be accessed.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ],
+ "title": "QuotesResourceListLines",
"type": "object",
"x-expandableFields": [
"data"
- ]
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/quotes/{quote}/lines": {
- "get": {
- "description": "Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
",
- "operationId": "GetQuotesQuoteLines",
- "parameters": [
- {
- "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
- "in": "query",
- "name": "ending_before",
- "required": false,
- "schema": {
- "type": "string"
- },
- "style": "form"
- },
- {
- "description": "Specifies which fields in the response should be expanded.",
- "explode": true,
- "in": "query",
- "name": "expand",
- "required": false,
- "schema": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "style": "deepObject"
- },
- {
- "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
- "in": "query",
- "name": "limit",
- "required": false,
- "schema": {
- "type": "integer"
- },
- "style": "form"
- },
- {
- "in": "path",
- "name": "quote",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- },
- {
- "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
- "in": "query",
- "name": "starting_after",
- "required": false,
- "schema": {
- "type": "string"
- },
- "style": "form"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {},
- "schema": {
- "additionalProperties": false,
- "properties": {},
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "description": "",
- "properties": {
- "data": {
- "description": "Details about each object.",
- "items": {
- "$ref": "#/components/schemas/quote_line"
- },
- "type": "array"
- },
- "has_more": {
- "description": "True if this list has another page of items after this one that can be fetched.",
- "type": "boolean"
- },
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
- "enum": [
- "list"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL where this list can be accessed.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "required": [
+ ],
+ "x-stripeMostCommon": [
"data",
"has_more",
"object",
"url"
- ],
- "title": "QuotesResourceListLines",
- "type": "object",
- "x-expandableFields": [
- "data"
]
}
}
@@ -170460,7 +189545,10 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reason"
+ ]
}
}
},
@@ -170492,7 +189580,7 @@
},
"/v1/quotes/{quote}/pdf": {
"get": {
- "description": "Download the PDF for a finalized quote. Explanation for special handling can be found here
",
+ "description": "Download the PDF for a finalized quote. Explanation for special handling can be found here
",
"operationId": "GetQuotesQuotePdf",
"parameters": [
{
@@ -170681,6 +189769,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -170823,146 +189917,158 @@
"object",
"url"
],
- "title": "QuotesResourcePreviewInvoiceLineItemsList",
+ "title": "QuotesResourcePreviewInvoiceLineItemsList",
+ "type": "object",
+ "x-expandableFields": [
+ "data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ]
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/quotes/{quote}/preview_subscription_schedules": {
+ "get": {
+ "description": "Preview the schedules that would be generated by accepting the quote
",
+ "operationId": "GetQuotesQuotePreviewSubscriptionSchedules",
+ "parameters": [
+ {
+ "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
+ "in": "query",
+ "name": "ending_before",
+ "required": false,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ },
+ {
+ "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
+ "in": "query",
+ "name": "limit",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ },
+ "style": "form"
+ },
+ {
+ "in": "path",
+ "name": "quote",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ },
+ {
+ "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
+ "in": "query",
+ "name": "starting_after",
+ "required": false,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {},
+ "schema": {
+ "additionalProperties": false,
+ "properties": {},
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "description": "",
+ "properties": {
+ "data": {
+ "description": "Details about each object.",
+ "items": {
+ "$ref": "#/components/schemas/quote_preview_subscription_schedule"
+ },
+ "type": "array"
+ },
+ "has_more": {
+ "description": "True if this list has another page of items after this one that can be fetched.",
+ "type": "boolean"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
+ "enum": [
+ "list"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL where this list can be accessed.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ],
+ "title": "QuotesResourcePreviewsSchedulesScheduleList",
"type": "object",
"x-expandableFields": [
"data"
- ]
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/quotes/{quote}/preview_subscription_schedules": {
- "get": {
- "description": "Preview the schedules that would be generated by accepting the quote
",
- "operationId": "GetQuotesQuotePreviewSubscriptionSchedules",
- "parameters": [
- {
- "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
- "in": "query",
- "name": "ending_before",
- "required": false,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- },
- {
- "description": "Specifies which fields in the response should be expanded.",
- "explode": true,
- "in": "query",
- "name": "expand",
- "required": false,
- "schema": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "style": "deepObject"
- },
- {
- "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
- "in": "query",
- "name": "limit",
- "required": false,
- "schema": {
- "type": "integer"
- },
- "style": "form"
- },
- {
- "in": "path",
- "name": "quote",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- },
- {
- "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
- "in": "query",
- "name": "starting_after",
- "required": false,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {},
- "schema": {
- "additionalProperties": false,
- "properties": {},
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "description": "",
- "properties": {
- "data": {
- "description": "Details about each object.",
- "items": {
- "$ref": "#/components/schemas/quote_preview_subscription_schedule"
- },
- "type": "array"
- },
- "has_more": {
- "description": "True if this list has another page of items after this one that can be fetched.",
- "type": "boolean"
- },
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
- "enum": [
- "list"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL where this list can be accessed.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "required": [
+ ],
+ "x-stripeMostCommon": [
"data",
"has_more",
"object",
"url"
- ],
- "title": "QuotesResourcePreviewsSchedulesScheduleList",
- "type": "object",
- "x-expandableFields": [
- "data"
]
}
}
@@ -171092,7 +190198,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -171214,6 +190326,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -171334,7 +190452,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -171467,6 +190591,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -171523,7 +190653,11 @@
"value",
"value_list"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "value",
+ "value_list"
+ ]
}
}
},
@@ -171727,7 +190861,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -171838,6 +190978,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -171922,7 +191068,13 @@
"alias",
"name"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "alias",
+ "item_type",
+ "metadata",
+ "name"
+ ]
}
}
},
@@ -172127,7 +191279,12 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "alias",
+ "metadata",
+ "name"
+ ]
}
}
},
@@ -172200,7 +191357,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -172320,6 +191483,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -172434,7 +191603,18 @@
"type": "boolean"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "charge",
+ "currency",
+ "customer",
+ "instructions_email",
+ "metadata",
+ "origin",
+ "payment_intent",
+ "reason"
+ ]
}
}
},
@@ -172586,7 +191766,10 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata"
+ ]
}
}
},
@@ -172715,7 +191898,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -172826,6 +192015,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -173556,7 +192751,160 @@
}
},
"title": "run_parameter_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "age_bucket",
+ "all",
+ "amount",
+ "amount_filter",
+ "apple_subscriber",
+ "application_id",
+ "authentication_outcome_detailed",
+ "billing_analytics_metric",
+ "calculation_type",
+ "capability_type",
+ "card_bin",
+ "card_brand",
+ "card_brands",
+ "card_country",
+ "card_fingerprint",
+ "card_funding",
+ "card_number",
+ "card_type",
+ "card_types",
+ "cau_correction_factor",
+ "charge",
+ "chart_detail_page_id",
+ "cof",
+ "columns",
+ "compare_to_end",
+ "compare_to_start",
+ "connect_charge_type",
+ "connected_account",
+ "contract",
+ "conversion_currency",
+ "countries",
+ "country",
+ "currency",
+ "cursor",
+ "customer",
+ "customers",
+ "dataset_id",
+ "date_format",
+ "days_to_use",
+ "decimal_separator",
+ "digital_wallet",
+ "direction",
+ "download",
+ "entity_type",
+ "exchange_rate",
+ "exchange_rates",
+ "experiment_id",
+ "fee_category",
+ "filter_column",
+ "filter_columns",
+ "filter_currency",
+ "filter_value",
+ "filter_values",
+ "filters",
+ "first_day_of_week_offset",
+ "gateway_conversation_avs_outcome",
+ "gateway_conversation_cvc_outcome",
+ "google_order",
+ "group_by",
+ "group_by_key",
+ "group_id",
+ "group_type",
+ "grouped_column",
+ "grouped_columns",
+ "grouped_metadata_column",
+ "include_blocked_payments",
+ "include_connect_charges",
+ "interval_end",
+ "interval_start",
+ "invoice",
+ "invoice_line_item",
+ "ip_address",
+ "ip_country",
+ "is_eu_vat_moss",
+ "is_latam",
+ "is_link_in_pmm_supported",
+ "is_top_fraudy_attributes",
+ "is_unbilled",
+ "jurisdiction_key",
+ "limit",
+ "list_item",
+ "list_items",
+ "livemode",
+ "match_mode",
+ "match_status",
+ "max_churn",
+ "meter_id",
+ "min_trim_size",
+ "nci_filter_for",
+ "nci_mcc",
+ "numeric_filters",
+ "offset",
+ "payment_link_id",
+ "payment_method_type",
+ "payment_method_types",
+ "payment_methods",
+ "payout",
+ "payout_date_end",
+ "payout_date_start",
+ "payout_status",
+ "payout_type",
+ "platform",
+ "platform_id",
+ "product",
+ "product_feature_description",
+ "radar_bad_outcome_configuration",
+ "radar_fraud_outcomes",
+ "radar_good_outcomes",
+ "rate",
+ "recognition_end",
+ "recognition_start",
+ "recon_party_name",
+ "recon_space",
+ "recon_space_type",
+ "reconciliation_status",
+ "reference_id",
+ "reporting_category",
+ "reporting_string_filters",
+ "retries_correction_factor",
+ "rev_rec_month_summary_line_item",
+ "risk_score",
+ "rule_action",
+ "rule_attribute",
+ "rule_attribute_case_insensitive",
+ "rule_attribute_name_value",
+ "rule_id",
+ "rule_predicate_sql",
+ "secondary_cursor",
+ "seconds_since_card_first_seen",
+ "segment_id",
+ "sort_order",
+ "sorted_column",
+ "states",
+ "string_filters",
+ "tax_form_id",
+ "tax_type",
+ "taxable",
+ "timezone",
+ "total_charges_per_card_number_daily",
+ "total_fraud_volume",
+ "total_legitimate_volume",
+ "tracking_load_type",
+ "transaction_age_max",
+ "transaction_age_min",
+ "transaction_initiators",
+ "transaction_type",
+ "unit",
+ "ur",
+ "use_dispute_creation_date",
+ "used_network_tokens",
+ "view_type"
+ ]
},
"report_type": {
"description": "The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `\"balance.summary.1\"`.",
@@ -173566,7 +192914,11 @@
"required": [
"report_type"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "parameters",
+ "report_type"
+ ]
}
}
},
@@ -173738,6 +193090,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -173857,7 +193215,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -173967,6 +193331,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -174154,7 +193524,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -174276,6 +193652,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -174338,7 +193720,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -174471,6 +193859,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -174560,7 +193954,11 @@
"enabled"
],
"title": "automatic_payment_methods_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allow_redirects",
+ "enabled"
+ ]
},
"confirm": {
"description": "Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary.",
@@ -174636,7 +194034,11 @@
"user_agent"
],
"title": "online_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ip_address",
+ "user_agent"
+ ]
},
"type": {
"description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.",
@@ -174652,14 +194054,23 @@
"type"
],
"title": "customer_acceptance_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "accepted_at",
+ "offline",
+ "online",
+ "type"
+ ]
}
},
"required": [
"customer_acceptance"
],
"title": "secret_key_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer_acceptance"
+ ]
},
{
"enum": [
@@ -174719,7 +194130,12 @@
"transit_number"
],
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "institution_number",
+ "transit_number"
+ ]
},
"affirm": {
"description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.",
@@ -174773,7 +194189,11 @@
"bsb_number"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number"
+ ]
},
"bacs_debit": {
"description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.",
@@ -174790,7 +194210,11 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "sort_code"
+ ]
},
"bancontact": {
"description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.",
@@ -174837,7 +194261,15 @@
}
},
"title": "billing_details_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
{
"enum": [
@@ -174894,7 +194326,13 @@
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
+ ]
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -174915,7 +194353,10 @@
"tax_id"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"cashapp": {
"description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.",
@@ -174969,7 +194410,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"fpx": {
"description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.",
@@ -175018,7 +194462,11 @@
"bank"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "bank"
+ ]
},
"giropay": {
"description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.",
@@ -175060,13 +194508,22 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"interac_present": {
"description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "device_identifier",
+ "device_type",
+ "emv",
+ "location"
+ ]
},
"klarna": {
"description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.",
@@ -175093,11 +194550,19 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"konbini": {
"description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.",
@@ -175111,6 +194576,12 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"metadata": {
"additionalProperties": {
"type": "string"
@@ -175174,7 +194645,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"paynow": {
"description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.",
@@ -175208,13 +194682,21 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number",
+ "pay_id"
+ ]
},
"pix": {
"description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"promptpay": {
"description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.",
@@ -175232,7 +194714,11 @@
}
},
"title": "radar_options_with_hidden_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "session",
+ "skip_rules"
+ ]
},
"rechnung": {
"description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.",
@@ -175259,14 +194745,22 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"required": [
"dob"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"revolut_pay": {
"description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
@@ -175287,7 +194781,10 @@
"iban"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iban"
+ ]
},
"sofort": {
"description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.",
@@ -175309,7 +194806,10 @@
"country"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"swish": {
"description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.",
@@ -175346,6 +194846,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -175404,7 +194905,14 @@
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "account_number",
+ "account_type",
+ "financial_connections_account",
+ "routing_number"
+ ]
},
"wechat_pay": {
"description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.",
@@ -175423,7 +194931,12 @@
"type"
],
"title": "payment_method_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_details",
+ "metadata",
+ "type"
+ ]
},
"payment_method_options": {
"description": "Payment method-specific configuration for this SetupIntent.",
@@ -175491,7 +195004,14 @@
}
},
"title": "setup_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom_mandate_url",
+ "default_for",
+ "interval_description",
+ "payment_schedule",
+ "transaction_type"
+ ]
},
"verification_method": {
"description": "Bank account verification method.",
@@ -175505,13 +195025,21 @@
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "mandate_options",
+ "verification_method"
+ ]
},
"amazon_pay": {
"description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.",
"properties": {},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "charge_permission_id"
+ ]
},
"bacs_debit": {
"description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.",
@@ -175520,11 +195048,17 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reference_prefix"
+ ]
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options"
+ ]
},
"card": {
"description": "Configuration for any card setup attempted on this SetupIntent.",
@@ -175603,7 +195137,19 @@
"start_date"
],
"title": "setup_intent_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "currency",
+ "description",
+ "end_date",
+ "interval",
+ "interval_count",
+ "reference",
+ "start_date",
+ "supported_types"
+ ]
},
"moto": {
"description": "When specified, this parameter signals that a card has been collected\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.",
@@ -175704,11 +195250,19 @@
"cb_avalgo"
],
"title": "cartes_bancaires_network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cb_avalgo",
+ "cb_exemption",
+ "cb_score"
+ ]
}
},
"title": "network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cartes_bancaires"
+ ]
},
"requestor_challenge_indicator": {
"description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
@@ -175732,11 +195286,32 @@
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ares_trans_status",
+ "cryptogram",
+ "electronic_commerce_indicator",
+ "exemption_preferred",
+ "gateway",
+ "network_options",
+ "requestor_challenge_indicator",
+ "transaction_id",
+ "version"
+ ]
}
},
"title": "setup_intent_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "moto",
+ "network",
+ "network_token",
+ "request_name_verification",
+ "request_three_d_secure",
+ "three_d_secure",
+ "verify_card_account"
+ ]
},
"card_present": {
"description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.",
@@ -175754,7 +195329,10 @@
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "persistent_token"
+ ]
},
"paypal": {
"description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.",
@@ -175777,7 +195355,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_agreement_id",
+ "currency",
+ "subsellers"
+ ]
},
"payto": {
"description": "If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.",
@@ -175844,11 +195427,23 @@
}
},
"title": "setup_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "end_date",
+ "payment_schedule",
+ "payments_per_period",
+ "purpose",
+ "start_date"
+ ]
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options"
+ ]
},
"sepa_debit": {
"description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.",
@@ -175857,11 +195452,19 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reference",
+ "reference_prefix"
+ ]
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "verification_method"
+ ]
},
"us_bank_account": {
"description": "If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.",
@@ -175891,7 +195494,11 @@
}
},
"title": "linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_subcategories",
+ "institution"
+ ]
},
"manual_entry": {
"description": "Customize manual entry behavior",
@@ -175909,7 +195516,10 @@
"mode"
],
"title": "linked_account_options_manual_entry_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode"
+ ]
},
"permissions": {
"description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.",
@@ -175946,7 +195556,14 @@
}
},
"title": "linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "filters",
+ "manual_entry",
+ "permissions",
+ "prefetch",
+ "return_url"
+ ]
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -175962,7 +195579,10 @@
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "collection_method"
+ ]
},
"networks": {
"description": "Additional fields for network related functions",
@@ -175980,7 +195600,10 @@
}
},
"title": "networks_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"verification_method": {
"description": "Bank account verification method.",
@@ -175994,11 +195617,35 @@
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "financial_connections",
+ "mandate_options",
+ "networks",
+ "verification_method"
+ ]
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "alipay",
+ "amazon_pay",
+ "bacs_debit",
+ "blik",
+ "card",
+ "card_present",
+ "demo_pay",
+ "dummy_auth_push",
+ "klarna",
+ "link",
+ "paypal",
+ "payto",
+ "sepa_debit",
+ "upi",
+ "us_bank_account"
+ ]
},
"payment_method_types": {
"description": "The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, it defaults to [\"card\"].",
@@ -176029,7 +195676,11 @@
"currency"
],
"title": "setup_intent_single_use_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency"
+ ]
},
"usage": {
"description": "Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`.",
@@ -176044,7 +195695,16 @@
"type": "boolean"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "automatic_payment_methods",
+ "confirm",
+ "customer",
+ "description",
+ "metadata",
+ "payment_method",
+ "usage"
+ ]
}
}
},
@@ -176287,7 +195947,12 @@
"transit_number"
],
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "institution_number",
+ "transit_number"
+ ]
},
"affirm": {
"description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.",
@@ -176341,7 +196006,11 @@
"bsb_number"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number"
+ ]
},
"bacs_debit": {
"description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.",
@@ -176358,7 +196027,11 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "sort_code"
+ ]
},
"bancontact": {
"description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.",
@@ -176405,7 +196078,15 @@
}
},
"title": "billing_details_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
{
"enum": [
@@ -176462,7 +196143,13 @@
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
+ ]
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -176483,7 +196170,10 @@
"tax_id"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"cashapp": {
"description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.",
@@ -176537,7 +196227,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"fpx": {
"description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.",
@@ -176586,7 +196279,11 @@
"bank"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "bank"
+ ]
},
"giropay": {
"description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.",
@@ -176628,13 +196325,22 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"interac_present": {
"description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "device_identifier",
+ "device_type",
+ "emv",
+ "location"
+ ]
},
"klarna": {
"description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.",
@@ -176661,11 +196367,19 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"konbini": {
"description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.",
@@ -176679,6 +196393,12 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"metadata": {
"additionalProperties": {
"type": "string"
@@ -176742,7 +196462,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"paynow": {
"description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.",
@@ -176776,13 +196499,21 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number",
+ "pay_id"
+ ]
},
"pix": {
"description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"promptpay": {
"description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.",
@@ -176800,7 +196531,11 @@
}
},
"title": "radar_options_with_hidden_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "session",
+ "skip_rules"
+ ]
},
"rechnung": {
"description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.",
@@ -176827,14 +196562,22 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"required": [
"dob"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"revolut_pay": {
"description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
@@ -176855,7 +196598,10 @@
"iban"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iban"
+ ]
},
"sofort": {
"description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.",
@@ -176877,7 +196623,10 @@
"country"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"swish": {
"description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.",
@@ -176914,6 +196663,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -176972,7 +196722,14 @@
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "account_number",
+ "account_type",
+ "financial_connections_account",
+ "routing_number"
+ ]
},
"wechat_pay": {
"description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.",
@@ -176991,7 +196748,12 @@
"type"
],
"title": "payment_method_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_details",
+ "metadata",
+ "type"
+ ]
},
"payment_method_options": {
"description": "Payment method-specific configuration for this SetupIntent.",
@@ -177059,7 +196821,14 @@
}
},
"title": "setup_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom_mandate_url",
+ "default_for",
+ "interval_description",
+ "payment_schedule",
+ "transaction_type"
+ ]
},
"verification_method": {
"description": "Bank account verification method.",
@@ -177073,13 +196842,21 @@
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "mandate_options",
+ "verification_method"
+ ]
},
"amazon_pay": {
"description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.",
"properties": {},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "charge_permission_id"
+ ]
},
"bacs_debit": {
"description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.",
@@ -177088,11 +196865,17 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reference_prefix"
+ ]
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options"
+ ]
},
"card": {
"description": "Configuration for any card setup attempted on this SetupIntent.",
@@ -177171,7 +196954,19 @@
"start_date"
],
"title": "setup_intent_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "currency",
+ "description",
+ "end_date",
+ "interval",
+ "interval_count",
+ "reference",
+ "start_date",
+ "supported_types"
+ ]
},
"moto": {
"description": "When specified, this parameter signals that a card has been collected\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.",
@@ -177272,11 +197067,19 @@
"cb_avalgo"
],
"title": "cartes_bancaires_network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cb_avalgo",
+ "cb_exemption",
+ "cb_score"
+ ]
}
},
"title": "network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cartes_bancaires"
+ ]
},
"requestor_challenge_indicator": {
"description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
@@ -177300,11 +197103,32 @@
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ares_trans_status",
+ "cryptogram",
+ "electronic_commerce_indicator",
+ "exemption_preferred",
+ "gateway",
+ "network_options",
+ "requestor_challenge_indicator",
+ "transaction_id",
+ "version"
+ ]
}
},
"title": "setup_intent_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "moto",
+ "network",
+ "network_token",
+ "request_name_verification",
+ "request_three_d_secure",
+ "three_d_secure",
+ "verify_card_account"
+ ]
},
"card_present": {
"description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.",
@@ -177322,7 +197146,10 @@
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "persistent_token"
+ ]
},
"paypal": {
"description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.",
@@ -177345,7 +197172,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_agreement_id",
+ "currency",
+ "subsellers"
+ ]
},
"payto": {
"description": "If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.",
@@ -177412,11 +197244,23 @@
}
},
"title": "setup_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "end_date",
+ "payment_schedule",
+ "payments_per_period",
+ "purpose",
+ "start_date"
+ ]
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options"
+ ]
},
"sepa_debit": {
"description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.",
@@ -177425,11 +197269,19 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reference",
+ "reference_prefix"
+ ]
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "verification_method"
+ ]
},
"us_bank_account": {
"description": "If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.",
@@ -177459,7 +197311,11 @@
}
},
"title": "linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_subcategories",
+ "institution"
+ ]
},
"manual_entry": {
"description": "Customize manual entry behavior",
@@ -177477,7 +197333,10 @@
"mode"
],
"title": "linked_account_options_manual_entry_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode"
+ ]
},
"permissions": {
"description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.",
@@ -177514,7 +197373,14 @@
}
},
"title": "linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "filters",
+ "manual_entry",
+ "permissions",
+ "prefetch",
+ "return_url"
+ ]
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -177530,7 +197396,10 @@
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "collection_method"
+ ]
},
"networks": {
"description": "Additional fields for network related functions",
@@ -177548,7 +197417,10 @@
}
},
"title": "networks_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"verification_method": {
"description": "Bank account verification method.",
@@ -177562,11 +197434,35 @@
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "financial_connections",
+ "mandate_options",
+ "networks",
+ "verification_method"
+ ]
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "alipay",
+ "amazon_pay",
+ "bacs_debit",
+ "blik",
+ "card",
+ "card_present",
+ "demo_pay",
+ "dummy_auth_push",
+ "klarna",
+ "link",
+ "paypal",
+ "payto",
+ "sepa_debit",
+ "upi",
+ "us_bank_account"
+ ]
},
"payment_method_types": {
"description": "The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this array, it defaults to [\"card\"].",
@@ -177577,7 +197473,13 @@
"type": "array"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer",
+ "description",
+ "metadata",
+ "payment_method"
+ ]
}
}
},
@@ -177654,7 +197556,10 @@
"type": "array"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cancellation_reason"
+ ]
}
}
},
@@ -177773,7 +197678,11 @@
"user_agent"
],
"title": "online_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ip_address",
+ "user_agent"
+ ]
},
"type": {
"description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.",
@@ -177789,14 +197698,23 @@
"type"
],
"title": "customer_acceptance_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "accepted_at",
+ "offline",
+ "online",
+ "type"
+ ]
}
},
"required": [
"customer_acceptance"
],
"title": "secret_key_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer_acceptance"
+ ]
},
{
"enum": [
@@ -177824,7 +197742,11 @@
}
},
"title": "online_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ip_address",
+ "user_agent"
+ ]
},
"type": {
"description": "The type of customer acceptance information included with the Mandate.",
@@ -177840,7 +197762,11 @@
"type"
],
"title": "customer_acceptance_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "online",
+ "type"
+ ]
}
},
"required": [
@@ -177848,6 +197774,9 @@
],
"title": "client_key_param",
"type": "object",
+ "x-stripeMostCommon": [
+ "customer_acceptance"
+ ],
"x-stripeParam": {
"class_name": "MandateDataPublishableKey"
}
@@ -177887,7 +197816,12 @@
"transit_number"
],
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "institution_number",
+ "transit_number"
+ ]
},
"affirm": {
"description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.",
@@ -177941,7 +197875,11 @@
"bsb_number"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number"
+ ]
},
"bacs_debit": {
"description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.",
@@ -177958,7 +197896,11 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "sort_code"
+ ]
},
"bancontact": {
"description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.",
@@ -178005,7 +197947,15 @@
}
},
"title": "billing_details_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
{
"enum": [
@@ -178062,7 +198012,13 @@
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
+ ]
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -178083,7 +198039,10 @@
"tax_id"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"cashapp": {
"description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.",
@@ -178137,7 +198096,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"fpx": {
"description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.",
@@ -178186,7 +198148,11 @@
"bank"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "bank"
+ ]
},
"giropay": {
"description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.",
@@ -178228,13 +198194,22 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"interac_present": {
"description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "device_identifier",
+ "device_type",
+ "emv",
+ "location"
+ ]
},
"klarna": {
"description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.",
@@ -178261,11 +198236,19 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"konbini": {
"description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.",
@@ -178279,6 +198262,12 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"metadata": {
"additionalProperties": {
"type": "string"
@@ -178342,7 +198331,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"paynow": {
"description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.",
@@ -178376,13 +198368,21 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number",
+ "pay_id"
+ ]
},
"pix": {
"description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"promptpay": {
"description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.",
@@ -178400,7 +198400,11 @@
}
},
"title": "radar_options_with_hidden_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "session",
+ "skip_rules"
+ ]
},
"rechnung": {
"description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.",
@@ -178427,14 +198431,22 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"required": [
"dob"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"revolut_pay": {
"description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
@@ -178455,7 +198467,10 @@
"iban"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iban"
+ ]
},
"sofort": {
"description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.",
@@ -178477,7 +198492,10 @@
"country"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"swish": {
"description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.",
@@ -178514,6 +198532,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -178572,7 +198591,14 @@
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "account_number",
+ "account_type",
+ "financial_connections_account",
+ "routing_number"
+ ]
},
"wechat_pay": {
"description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.",
@@ -178591,7 +198617,12 @@
"type"
],
"title": "payment_method_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_details",
+ "metadata",
+ "type"
+ ]
},
"payment_method_options": {
"description": "Payment method-specific configuration for this SetupIntent.",
@@ -178659,7 +198690,14 @@
}
},
"title": "setup_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom_mandate_url",
+ "default_for",
+ "interval_description",
+ "payment_schedule",
+ "transaction_type"
+ ]
},
"verification_method": {
"description": "Bank account verification method.",
@@ -178673,13 +198711,21 @@
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "mandate_options",
+ "verification_method"
+ ]
},
"amazon_pay": {
"description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.",
"properties": {},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "charge_permission_id"
+ ]
},
"bacs_debit": {
"description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.",
@@ -178688,11 +198734,17 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reference_prefix"
+ ]
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options"
+ ]
},
"card": {
"description": "Configuration for any card setup attempted on this SetupIntent.",
@@ -178771,7 +198823,19 @@
"start_date"
],
"title": "setup_intent_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "currency",
+ "description",
+ "end_date",
+ "interval",
+ "interval_count",
+ "reference",
+ "start_date",
+ "supported_types"
+ ]
},
"moto": {
"description": "When specified, this parameter signals that a card has been collected\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.",
@@ -178872,11 +198936,19 @@
"cb_avalgo"
],
"title": "cartes_bancaires_network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cb_avalgo",
+ "cb_exemption",
+ "cb_score"
+ ]
}
},
"title": "network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cartes_bancaires"
+ ]
},
"requestor_challenge_indicator": {
"description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
@@ -178900,11 +198972,32 @@
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ares_trans_status",
+ "cryptogram",
+ "electronic_commerce_indicator",
+ "exemption_preferred",
+ "gateway",
+ "network_options",
+ "requestor_challenge_indicator",
+ "transaction_id",
+ "version"
+ ]
}
},
"title": "setup_intent_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "moto",
+ "network",
+ "network_token",
+ "request_name_verification",
+ "request_three_d_secure",
+ "three_d_secure",
+ "verify_card_account"
+ ]
},
"card_present": {
"description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.",
@@ -178922,7 +199015,10 @@
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "persistent_token"
+ ]
},
"paypal": {
"description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.",
@@ -178945,7 +199041,12 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_agreement_id",
+ "currency",
+ "subsellers"
+ ]
},
"payto": {
"description": "If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.",
@@ -179012,11 +199113,23 @@
}
},
"title": "setup_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "end_date",
+ "payment_schedule",
+ "payments_per_period",
+ "purpose",
+ "start_date"
+ ]
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options"
+ ]
},
"sepa_debit": {
"description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.",
@@ -179025,11 +199138,19 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reference",
+ "reference_prefix"
+ ]
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "verification_method"
+ ]
},
"us_bank_account": {
"description": "If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.",
@@ -179059,7 +199180,11 @@
}
},
"title": "linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_subcategories",
+ "institution"
+ ]
},
"manual_entry": {
"description": "Customize manual entry behavior",
@@ -179077,7 +199202,10 @@
"mode"
],
"title": "linked_account_options_manual_entry_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mode"
+ ]
},
"permissions": {
"description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.",
@@ -179114,7 +199242,14 @@
}
},
"title": "linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "filters",
+ "manual_entry",
+ "permissions",
+ "prefetch",
+ "return_url"
+ ]
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -179130,7 +199265,10 @@
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "collection_method"
+ ]
},
"networks": {
"description": "Additional fields for network related functions",
@@ -179148,7 +199286,10 @@
}
},
"title": "networks_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"verification_method": {
"description": "Bank account verification method.",
@@ -179162,11 +199303,35 @@
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "financial_connections",
+ "mandate_options",
+ "networks",
+ "verification_method"
+ ]
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "alipay",
+ "amazon_pay",
+ "bacs_debit",
+ "blik",
+ "card",
+ "card_present",
+ "demo_pay",
+ "dummy_auth_push",
+ "klarna",
+ "link",
+ "paypal",
+ "payto",
+ "sepa_debit",
+ "upi",
+ "us_bank_account"
+ ]
},
"return_url": {
"description": "The URL to redirect your customer back to after they authenticate on the payment method's app or site.\nIf you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.\nThis parameter is only used for cards and other redirect-based payment methods.",
@@ -179177,7 +199342,10 @@
"type": "boolean"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment_method"
+ ]
}
}
},
@@ -179260,7 +199428,11 @@
"type": "array"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amounts",
+ "descriptor_code"
+ ]
}
}
},
@@ -179333,7 +199505,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -179454,6 +199632,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -179526,7 +199710,11 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit",
+ "value"
+ ]
},
"minimum": {
"description": "The lower bound of the estimated range. If empty, represents no lower bound.",
@@ -179552,11 +199740,19 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "unit",
+ "value"
+ ]
}
},
"title": "delivery_estimate",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "maximum",
+ "minimum"
+ ]
},
"display_name": {
"description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.",
@@ -179603,7 +199799,11 @@
"amount"
],
"title": "currency_option",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "tax_behavior"
+ ]
},
"description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
"type": "object"
@@ -179614,7 +199814,12 @@
"currency"
],
"title": "fixed_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "currency_options"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -179647,7 +199852,13 @@
"required": [
"display_name"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_name",
+ "fixed_amount",
+ "metadata",
+ "type"
+ ]
}
}
},
@@ -179812,14 +200023,21 @@
}
},
"title": "currency_option_update",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "tax_behavior"
+ ]
},
"description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
"type": "object"
}
},
"title": "fixed_amount_update",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency_options"
+ ]
},
"metadata": {
"anyOf": [
@@ -179848,7 +200066,12 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "fixed_amount",
+ "metadata"
+ ]
}
}
},
@@ -179985,6 +200208,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -180171,7 +200400,10 @@
"contact_email"
],
"title": "mandate_offline_acceptance_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "contact_email"
+ ]
},
"online": {
"description": "The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`",
@@ -180192,7 +200424,12 @@
}
},
"title": "mandate_online_acceptance_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
},
"status": {
"description": "The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).",
@@ -180224,7 +200461,16 @@
"status"
],
"title": "mandate_acceptance_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "offline",
+ "online",
+ "status",
+ "type",
+ "user_agent"
+ ]
},
"amount": {
"anyOf": [
@@ -180268,7 +200514,14 @@
}
},
"title": "mandate_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acceptance",
+ "amount",
+ "currency",
+ "interval",
+ "notification_method"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -180319,7 +200572,15 @@
}
},
"title": "source_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"email": {
"description": "Owner's email address.",
@@ -180337,7 +200598,13 @@
}
},
"title": "owner",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
+ ]
},
"receiver": {
"description": "Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`).",
@@ -180354,7 +200621,10 @@
}
},
"title": "receiver_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "refund_attributes_method"
+ ]
},
"redirect": {
"description": "Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`).",
@@ -180368,7 +200638,10 @@
"return_url"
],
"title": "redirect_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "return_url"
+ ]
},
"source_order": {
"description": "Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.",
@@ -180408,7 +200681,15 @@
}
},
"title": "order_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "parent",
+ "quantity",
+ "type"
+ ]
},
"type": "array"
},
@@ -180453,7 +200734,15 @@
"line1"
],
"title": "address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
@@ -180480,11 +200769,22 @@
"address"
],
"title": "order_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "carrier",
+ "name",
+ "phone",
+ "tracking_number"
+ ]
}
},
"title": "shallow_order_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "items",
+ "shipping"
+ ]
},
"statement_descriptor": {
"description": "An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all.",
@@ -180510,7 +200810,18 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "customer",
+ "metadata",
+ "original_source",
+ "owner",
+ "redirect",
+ "statement_descriptor",
+ "type"
+ ]
}
}
},
@@ -180700,7 +201011,10 @@
"contact_email"
],
"title": "mandate_offline_acceptance_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "contact_email"
+ ]
},
"online": {
"description": "The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`",
@@ -180721,7 +201035,12 @@
}
},
"title": "mandate_online_acceptance_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
},
"status": {
"description": "The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).",
@@ -180753,7 +201072,16 @@
"status"
],
"title": "mandate_acceptance_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "offline",
+ "online",
+ "status",
+ "type",
+ "user_agent"
+ ]
},
"amount": {
"anyOf": [
@@ -180797,7 +201125,14 @@
}
},
"title": "mandate_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acceptance",
+ "amount",
+ "currency",
+ "interval",
+ "notification_method"
+ ]
},
"metadata": {
"anyOf": [
@@ -180854,7 +201189,15 @@
}
},
"title": "source_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"email": {
"description": "Owner's email address.",
@@ -180872,7 +201215,13 @@
}
},
"title": "owner",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
+ ]
},
"source_order": {
"description": "Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.",
@@ -180912,7 +201261,15 @@
}
},
"title": "order_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "parent",
+ "quantity",
+ "type"
+ ]
},
"type": "array"
},
@@ -180957,7 +201314,15 @@
"line1"
],
"title": "address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
@@ -180984,14 +201349,30 @@
"address"
],
"title": "order_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "carrier",
+ "name",
+ "phone",
+ "tracking_number"
+ ]
}
},
"title": "order_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "items",
+ "shipping"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "metadata",
+ "owner"
+ ]
}
}
},
@@ -181137,6 +201518,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -181208,7 +201595,10 @@
"required": [
"values"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "values"
+ ]
}
}
},
@@ -181354,6 +201744,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -181424,7 +201820,10 @@
"usage_gte"
],
"title": "item_billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "usage_gte"
+ ]
},
{
"enum": [
@@ -181476,7 +201875,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -181496,7 +201899,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -181505,7 +201913,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -181587,7 +201998,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -181614,7 +202028,13 @@
"recurring"
],
"title": "recurring_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "recurring",
+ "unit_amount"
+ ]
},
"proration_behavior": {
"description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.",
@@ -181681,13 +202101,25 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"required": [
"subscription"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata",
+ "payment_behavior",
+ "price",
+ "proration_behavior",
+ "quantity",
+ "subscription"
+ ]
}
}
},
@@ -181759,7 +202191,10 @@
"type": "integer"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "proration_behavior"
+ ]
}
}
},
@@ -181914,7 +202349,10 @@
"usage_gte"
],
"title": "item_billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "usage_gte"
+ ]
},
{
"enum": [
@@ -181966,7 +202404,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -181986,7 +202428,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -181995,7 +202442,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -182091,7 +202541,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -182118,7 +202571,13 @@
"recurring"
],
"title": "recurring_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "recurring",
+ "unit_amount"
+ ]
},
"proration_behavior": {
"description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.",
@@ -182157,7 +202616,14 @@
"description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata",
+ "payment_behavior",
+ "price",
+ "proration_behavior",
+ "quantity"
+ ]
}
}
},
@@ -182302,6 +202768,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -182392,7 +202864,12 @@
"required": [
"quantity"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "action",
+ "quantity",
+ "timestamp"
+ ]
}
}
},
@@ -182455,7 +202932,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -182492,7 +202975,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -182529,7 +203018,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -182613,7 +203108,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -182698,6 +203199,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -182798,14 +203305,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"billing_cycle_anchor": {
"description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).",
@@ -182829,7 +203344,11 @@
}
},
"title": "billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_gte",
+ "reset_billing_cycle_anchor"
+ ]
},
{
"enum": [
@@ -182913,11 +203432,26 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"title": "subscription_schedule_default_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "custom_fields",
+ "days_until_due",
+ "description",
+ "footer",
+ "issuer",
+ "rendering",
+ "send_hosted_payment_email",
+ "supported_payment_methods"
+ ]
},
"on_behalf_of": {
"anyOf": [
@@ -182950,7 +203484,11 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_percent",
+ "destination"
+ ]
},
{
"enum": [
@@ -182963,7 +203501,19 @@
}
},
"title": "default_settings_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "application_fee_percent",
+ "automatic_tax",
+ "billing_cycle_anchor",
+ "billing_thresholds",
+ "collection_method",
+ "default_payment_method",
+ "description",
+ "invoice_settings",
+ "on_behalf_of",
+ "transfer_data"
+ ]
},
"end_behavior": {
"description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.",
@@ -183053,7 +203603,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -183073,7 +203627,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -183082,7 +203641,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -183113,7 +203675,7 @@
"type": "string"
},
"unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
+ "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.",
"type": "integer"
},
"unit_amount_decimal": {
@@ -183127,7 +203689,12 @@
"product"
],
"title": "one_time_price_data_with_negative_amounts",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for this item. Defaults to 1.",
@@ -183154,6 +203721,10 @@
},
"title": "add_invoice_item_entry",
"type": "object",
+ "x-stripeMostCommon": [
+ "price",
+ "quantity"
+ ],
"x-stripeParam": {
"class_name": "AddInvoiceItem"
}
@@ -183191,14 +203762,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"billing_cycle_anchor": {
"description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).",
@@ -183222,7 +203801,11 @@
}
},
"title": "billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_gte",
+ "reset_billing_cycle_anchor"
+ ]
},
{
"enum": [
@@ -183329,7 +203912,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -183349,7 +203936,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -183358,7 +203950,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -183421,11 +204016,25 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"title": "invoice_settings",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "custom_fields",
+ "days_until_due",
+ "description",
+ "footer",
+ "issuer",
+ "send_hosted_payment_email",
+ "supported_payment_methods"
+ ]
},
"items": {
"description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.",
@@ -183444,7 +204053,10 @@
"usage_gte"
],
"title": "item_billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "usage_gte"
+ ]
},
{
"enum": [
@@ -183496,7 +204108,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -183516,7 +204132,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -183525,7 +204146,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -183589,7 +204213,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -183616,7 +204243,13 @@
"recurring"
],
"title": "recurring_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "recurring",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.",
@@ -183664,11 +204297,25 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"title": "configuration_item_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_thresholds",
+ "discounts",
+ "metadata",
+ "plan",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"type": "array"
},
@@ -183704,7 +204351,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "behavior"
+ ]
},
"proration_behavior": {
"description": "Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.",
@@ -183731,7 +204381,11 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_percent",
+ "destination"
+ ]
},
"trial": {
"description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.",
@@ -183766,18 +204420,53 @@
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "prorate_up_front"
+ ]
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
"required": [
"items"
],
"title": "phase_configuration_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add_invoice_items",
+ "application_fee_percent",
+ "automatic_tax",
+ "billing_cycle_anchor",
+ "billing_thresholds",
+ "cancel_at_period_end",
+ "collection_method",
+ "coupon",
+ "currency",
+ "default_payment_method",
+ "default_tax_rates",
+ "description",
+ "discounts",
+ "end_date",
+ "invoice_settings",
+ "items",
+ "iterations",
+ "metadata",
+ "on_behalf_of",
+ "pause_collection",
+ "proration_behavior",
+ "tax_filing_currency",
+ "transfer_data",
+ "trial",
+ "trial_continuation",
+ "trial_end",
+ "trial_settings"
+ ]
},
"type": "array"
},
@@ -183801,7 +204490,11 @@
"iterations"
],
"title": "prebilling_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iterations",
+ "update_behavior"
+ ]
},
"start_date": {
"anyOf": [
@@ -183820,7 +204513,13 @@
"description": "When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer",
+ "metadata",
+ "phases",
+ "start_date"
+ ]
}
}
},
@@ -184002,14 +204701,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"billing_cycle_anchor": {
"description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).",
@@ -184033,7 +204740,11 @@
}
},
"title": "billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_gte",
+ "reset_billing_cycle_anchor"
+ ]
},
{
"enum": [
@@ -184117,11 +204828,26 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"title": "subscription_schedule_default_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "custom_fields",
+ "days_until_due",
+ "description",
+ "footer",
+ "issuer",
+ "rendering",
+ "send_hosted_payment_email",
+ "supported_payment_methods"
+ ]
},
"on_behalf_of": {
"anyOf": [
@@ -184154,7 +204880,11 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_percent",
+ "destination"
+ ]
},
{
"enum": [
@@ -184167,7 +204897,19 @@
}
},
"title": "default_settings_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "application_fee_percent",
+ "automatic_tax",
+ "billing_cycle_anchor",
+ "billing_thresholds",
+ "collection_method",
+ "default_payment_method",
+ "description",
+ "invoice_settings",
+ "on_behalf_of",
+ "transfer_data"
+ ]
},
"end_behavior": {
"description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.",
@@ -184252,7 +204994,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -184272,7 +205018,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -184281,7 +205032,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -184312,7 +205066,7 @@
"type": "string"
},
"unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
+ "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.",
"type": "integer"
},
"unit_amount_decimal": {
@@ -184326,7 +205080,12 @@
"product"
],
"title": "one_time_price_data_with_negative_amounts",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for this item. Defaults to 1.",
@@ -184353,6 +205112,10 @@
},
"title": "add_invoice_item_entry",
"type": "object",
+ "x-stripeMostCommon": [
+ "price",
+ "quantity"
+ ],
"x-stripeParam": {
"class_name": "AddInvoiceItem"
}
@@ -184390,14 +205153,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"billing_cycle_anchor": {
"description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).",
@@ -184421,7 +205192,11 @@
}
},
"title": "billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_gte",
+ "reset_billing_cycle_anchor"
+ ]
},
{
"enum": [
@@ -184528,7 +205303,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -184548,7 +205327,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -184557,7 +205341,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -184631,11 +205418,25 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"title": "invoice_settings",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "custom_fields",
+ "days_until_due",
+ "description",
+ "footer",
+ "issuer",
+ "send_hosted_payment_email",
+ "supported_payment_methods"
+ ]
},
"items": {
"description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.",
@@ -184654,7 +205455,10 @@
"usage_gte"
],
"title": "item_billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "usage_gte"
+ ]
},
{
"enum": [
@@ -184706,7 +205510,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -184726,7 +205534,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -184735,7 +205548,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -184799,7 +205615,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -184826,7 +205645,13 @@
"recurring"
],
"title": "recurring_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "recurring",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.",
@@ -184874,11 +205699,25 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"title": "configuration_item_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_thresholds",
+ "discounts",
+ "metadata",
+ "plan",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"type": "array"
},
@@ -184914,7 +205753,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "behavior"
+ ]
},
"proration_behavior": {
"description": "Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.",
@@ -184957,7 +205799,11 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_percent",
+ "destination"
+ ]
},
"trial": {
"description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.",
@@ -185003,18 +205849,53 @@
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "prorate_up_front"
+ ]
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
"required": [
"items"
],
"title": "phase_configuration_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add_invoice_items",
+ "application_fee_percent",
+ "automatic_tax",
+ "billing_cycle_anchor",
+ "billing_thresholds",
+ "collection_method",
+ "coupon",
+ "currency",
+ "default_payment_method",
+ "default_tax_rates",
+ "description",
+ "discounts",
+ "end_date",
+ "invoice_settings",
+ "items",
+ "iterations",
+ "metadata",
+ "on_behalf_of",
+ "pause_collection",
+ "proration_behavior",
+ "start_date",
+ "tax_filing_currency",
+ "transfer_data",
+ "trial",
+ "trial_continuation",
+ "trial_end",
+ "trial_settings"
+ ]
},
"type": "array"
},
@@ -185038,7 +205919,11 @@
"iterations"
],
"title": "prebilling_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iterations",
+ "update_behavior"
+ ]
},
"proration_behavior": {
"description": "If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.",
@@ -185050,7 +205935,12 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata",
+ "phases",
+ "proration_behavior"
+ ]
}
}
},
@@ -185140,7 +206030,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount"
+ ]
},
"duration": {
"description": "Time span for the amendment starting from the `amendment_start`.",
@@ -185165,7 +206058,11 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.",
@@ -185190,7 +206087,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount_end",
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"amendment_start": {
"description": "Details to identify the earliest timestamp where the proposed change should take effect.",
@@ -185207,7 +206110,10 @@
"index"
],
"title": "amendment_end_index_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "index"
+ ]
},
"discount_end": {
"description": "Use the `end` time of a given discount.",
@@ -185222,7 +206128,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discount"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to start.",
@@ -185248,7 +206157,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendment_end",
+ "discount_end",
+ "timestamp",
+ "type"
+ ]
},
"billing_cycle_anchor": {
"description": "For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.",
@@ -185290,7 +206205,10 @@
"type"
],
"title": "amendment_discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"index": {
"description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.",
@@ -185303,7 +206221,14 @@
}
},
"title": "add_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "discount_end",
+ "index",
+ "promotion_code"
+ ]
},
"remove": {
"description": "Details of the discount to remove.",
@@ -185325,7 +206250,12 @@
}
},
"title": "remove_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "promotion_code"
+ ]
},
"set": {
"description": "Details of the discount to replace the existing discounts with.",
@@ -185347,7 +206277,12 @@
}
},
"title": "set_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon",
+ "discount",
+ "promotion_code"
+ ]
},
"type": {
"description": "Determines the type of discount action.",
@@ -185363,7 +206298,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add",
+ "remove",
+ "set",
+ "type"
+ ]
},
"type": "array"
},
@@ -185414,155 +206355,186 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
- },
- "timestamp": {
- "description": "A precise Unix timestamp for the discount to end. Must be in the future.",
- "format": "unix-time",
- "type": "integer"
- },
- "type": {
- "description": "The type of calculation made to determine when the discount ends.",
- "enum": [
- "duration",
- "timestamp"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "title": "discount_end",
- "type": "object"
- },
- "promotion_code": {
- "description": "ID of the promotion code to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "discounts_data_param",
- "type": "object"
- },
- "type": "array"
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
- "type": "object"
- },
- "price": {
- "description": "The ID of the price object.",
- "maxLength": 5000,
- "type": "string"
- },
- "quantity": {
- "description": "Quantity for this item.",
- "type": "integer"
- },
- "tax_rates": {
- "description": "The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "trial": {
- "description": "Options that configure the trial on the subscription item.",
- "properties": {
- "converts_to": {
- "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "type": {
- "description": "Determines the type of trial for this item.",
- "enum": [
- "free",
- "paid"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "title": "trial_specs",
- "type": "object"
- }
- },
- "required": [
- "price"
- ],
- "title": "add_item_specs",
- "type": "object"
- },
- "remove": {
- "description": "Details of the subscription item to remove.",
- "properties": {
- "price": {
- "description": "ID of a price to remove.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "required": [
- "price"
- ],
- "title": "remove_item_specs",
- "type": "object"
- },
- "set": {
- "description": "Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.",
- "properties": {
- "discounts": {
- "description": "If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.",
- "items": {
- "properties": {
- "coupon": {
- "description": "ID of the coupon to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount": {
- "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount_end": {
- "description": "Details to determine how long the discount should be applied for.",
- "properties": {
- "duration": {
- "description": "Time span for the redeemed discount.",
- "properties": {
- "interval": {
- "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.",
- "enum": [
- "day",
- "month",
- "week",
- "year"
- ],
- "type": "string"
- },
- "interval_count": {
- "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.",
- "type": "integer"
- }
- },
- "required": [
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
+ },
+ "timestamp": {
+ "description": "A precise Unix timestamp for the discount to end. Must be in the future.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "type": {
+ "description": "The type of calculation made to determine when the discount ends.",
+ "enum": [
+ "duration",
+ "timestamp"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "discount_end",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
+ },
+ "promotion_code": {
+ "description": "ID of the promotion code to create a new discount for.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "discounts_data_param",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
+ },
+ "type": "array"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
+ "type": "object"
+ },
+ "price": {
+ "description": "The ID of the price object.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Quantity for this item.",
+ "type": "integer"
+ },
+ "tax_rates": {
+ "description": "The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "trial": {
+ "description": "Options that configure the trial on the subscription item.",
+ "properties": {
+ "converts_to": {
+ "description": "List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": {
+ "description": "Determines the type of trial for this item.",
+ "enum": [
+ "free",
+ "paid"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "trial_specs",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
+ }
+ },
+ "required": [
+ "price"
+ ],
+ "title": "add_item_specs",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discounts",
+ "metadata",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
+ },
+ "remove": {
+ "description": "Details of the subscription item to remove.",
+ "properties": {
+ "price": {
+ "description": "ID of a price to remove.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "price"
+ ],
+ "title": "remove_item_specs",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "price"
+ ]
+ },
+ "set": {
+ "description": "Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.",
+ "properties": {
+ "discounts": {
+ "description": "If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.",
+ "items": {
+ "properties": {
+ "coupon": {
+ "description": "ID of the coupon to create a new discount for.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "discount": {
+ "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "discount_end": {
+ "description": "Details to determine how long the discount should be applied for.",
+ "properties": {
+ "duration": {
+ "description": "Time span for the redeemed discount.",
+ "properties": {
+ "interval": {
+ "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.",
+ "enum": [
+ "day",
+ "month",
+ "week",
+ "year"
+ ],
+ "type": "string"
+ },
+ "interval_count": {
+ "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "interval",
+ "interval_count"
+ ],
+ "title": "discount_end_duration_specs",
+ "type": "object",
+ "x-stripeMostCommon": [
"interval",
"interval_count"
- ],
- "title": "discount_end_duration_specs",
- "type": "object"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -185582,7 +206554,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -185591,7 +206568,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -185643,14 +206623,26 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"required": [
"price"
],
"title": "set_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "discounts",
+ "metadata",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"type": {
"description": "Determines the type of item action.",
@@ -185666,7 +206658,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add",
+ "remove",
+ "set",
+ "type"
+ ]
},
"type": "array"
},
@@ -185720,7 +206718,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "add",
+ "remove",
+ "set",
+ "type"
+ ]
},
"type": "array"
},
@@ -185753,7 +206757,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "behavior"
+ ]
},
"type": {
"description": "Determines the type of the pause_collection amendment.",
@@ -185768,7 +206775,11 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "set",
+ "type"
+ ]
},
"set_schedule_end": {
"description": "Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.",
@@ -185794,18 +206805,36 @@
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "prorate_up_front"
+ ]
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
"required": [
"amendment_start"
],
"title": "amendment_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendment_end",
+ "amendment_start",
+ "billing_cycle_anchor",
+ "discount_actions",
+ "item_actions",
+ "metadata_actions",
+ "proration_behavior",
+ "set_pause_collection",
+ "set_schedule_end",
+ "trial_settings"
+ ]
},
"type": "array"
},
@@ -185837,7 +206866,10 @@
"index"
],
"title": "amendment_start_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "index"
+ ]
},
"timestamp": {
"description": "Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.",
@@ -185858,7 +206890,12 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendment_start",
+ "timestamp",
+ "type"
+ ]
},
"bill_until": {
"description": "The end of the prebilled time period.",
@@ -185875,7 +206912,10 @@
"index"
],
"title": "amendment_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "index"
+ ]
},
"duration": {
"description": "Time span for prebilling, starting from `bill_from`.",
@@ -185900,7 +206940,11 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "End the prebilled period at a precise integer timestamp, starting from the Unix epoch.",
@@ -185922,7 +206966,13 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendment_end",
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"invoice_at": {
"description": "When the prebilling invoice should be created. The default value is `now`.",
@@ -185941,7 +206991,13 @@
}
},
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bill_from",
+ "bill_until",
+ "invoice_at",
+ "update_behavior"
+ ]
},
"type": "array"
},
@@ -185976,10 +207032,18 @@
}
},
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amendments",
+ "proration_behavior",
+ "schedule_settings"
+ ]
}
}
},
@@ -186054,7 +207118,10 @@
"type": "boolean"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "invoice_now"
+ ]
}
}
},
@@ -186177,7 +207244,10 @@
"enabled"
],
"title": "automatic_tax_filter_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
"style": "deepObject"
},
@@ -186223,7 +207293,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -186233,6 +207309,7 @@
"style": "deepObject"
},
{
+ "description": "Only return subscriptions whose current_period_end falls within the given date interval.",
"explode": true,
"in": "query",
"name": "current_period_end",
@@ -186259,7 +207336,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -186269,6 +207352,7 @@
"style": "deepObject"
},
{
+ "description": "Only return subscriptions whose current_period_start falls within the given date interval.",
"explode": true,
"in": "query",
"name": "current_period_start",
@@ -186295,7 +207379,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -186472,6 +207562,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -186617,7 +207713,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -186637,7 +207737,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -186646,7 +207751,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -186677,7 +207785,7 @@
"type": "string"
},
"unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
+ "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.",
"type": "integer"
},
"unit_amount_decimal": {
@@ -186691,7 +207799,12 @@
"product"
],
"title": "one_time_price_data_with_negative_amounts",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for this item. Defaults to 1.",
@@ -186718,6 +207831,10 @@
},
"title": "add_invoice_item_entry",
"type": "object",
+ "x-stripeMostCommon": [
+ "price",
+ "quantity"
+ ],
"x-stripeParam": {
"class_name": "AddInvoiceItem"
}
@@ -186765,14 +207882,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"backdate_start_date": {
"description": "For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.",
@@ -186813,7 +207938,14 @@
"day_of_month"
],
"title": "billing_cycle_anchor_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day_of_month",
+ "hour",
+ "minute",
+ "month",
+ "second"
+ ]
},
"billing_thresholds": {
"anyOf": [
@@ -186829,7 +207961,11 @@
}
},
"title": "billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_gte",
+ "reset_billing_cycle_anchor"
+ ]
},
{
"enum": [
@@ -186949,7 +208085,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -186969,7 +208109,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -186978,7 +208123,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -187040,11 +208188,25 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"title": "invoice_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "custom_fields",
+ "description",
+ "footer",
+ "issuer",
+ "rendering",
+ "send_hosted_payment_email",
+ "supported_payment_methods"
+ ]
},
"items": {
"description": "A list of up to 20 subscription items, each with an attached price.",
@@ -187063,7 +208225,10 @@
"usage_gte"
],
"title": "item_billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "usage_gte"
+ ]
},
{
"enum": [
@@ -187115,7 +208280,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -187135,7 +208304,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -187144,7 +208318,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -187208,7 +208385,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -187235,7 +208415,13 @@
"recurring"
],
"title": "recurring_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "recurring",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for this item.",
@@ -187283,11 +208469,25 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "converts_to",
+ "type"
+ ]
}
},
"title": "subscription_item_create_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_thresholds",
+ "discounts",
+ "metadata",
+ "plan",
+ "price",
+ "quantity",
+ "tax_rates",
+ "trial"
+ ]
},
"type": "array"
},
@@ -187359,7 +208559,10 @@
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "transaction_type"
+ ]
},
"verification_method": {
"description": "Verification method for the intent",
@@ -187373,7 +208576,11 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -187400,7 +208607,10 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred_language"
+ ]
},
{
"enum": [
@@ -187437,7 +208647,12 @@
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "description"
+ ]
},
"network": {
"description": "Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.",
@@ -187470,7 +208685,13 @@
}
},
"title": "subscription_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "mit_exemption",
+ "network",
+ "request_three_d_secure"
+ ]
},
{
"enum": [
@@ -187501,7 +208722,10 @@
"country"
],
"title": "eu_bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"type": {
"description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
@@ -187509,7 +208733,12 @@
}
},
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "eu_bank_transfer",
+ "id_bank_transfer",
+ "type"
+ ]
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
@@ -187517,7 +208746,11 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank_transfer",
+ "funding_type"
+ ]
},
{
"enum": [
@@ -187549,7 +208782,10 @@
{
"properties": {},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "verification_method"
+ ]
},
{
"enum": [
@@ -187588,7 +208824,11 @@
}
},
"title": "invoice_linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_subcategories",
+ "institution"
+ ]
},
"permissions": {
"description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.",
@@ -187620,7 +208860,12 @@
}
},
"title": "invoice_linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "filters",
+ "permissions",
+ "prefetch"
+ ]
},
"verification_method": {
"description": "Verification method for the intent",
@@ -187634,7 +208879,11 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "financial_connections",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -187647,7 +208896,17 @@
}
},
"title": "payment_method_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "bancontact",
+ "card",
+ "customer_balance",
+ "id_bank_transfer",
+ "konbini",
+ "sepa_debit",
+ "us_bank_account"
+ ]
},
"payment_method_types": {
"anyOf": [
@@ -187709,7 +208968,12 @@
}
},
"title": "payment_settings",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment_method_options",
+ "payment_method_types",
+ "save_default_payment_method"
+ ]
},
"pending_invoice_item_interval": {
"anyOf": [
@@ -187734,7 +208998,11 @@
"interval"
],
"title": "pending_invoice_item_interval_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
{
"enum": [
@@ -187765,7 +209033,11 @@
"iterations"
],
"title": "prebilling_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iterations",
+ "update_behavior"
+ ]
},
"promotion_code": {
"description": "The 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.",
@@ -187797,7 +209069,11 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_percent",
+ "destination"
+ ]
},
"trial_end": {
"anyOf": [
@@ -187843,20 +209119,36 @@
"missing_payment_method"
],
"title": "end_behavior",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "missing_payment_method"
+ ]
}
},
"required": [
"end_behavior"
],
"title": "trial_settings_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
"required": [
"customer"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cancel_at_period_end",
+ "currency",
+ "customer",
+ "default_payment_method",
+ "description",
+ "items",
+ "metadata",
+ "payment_behavior"
+ ]
}
}
},
@@ -188000,6 +209292,14 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "next_page",
+ "object",
+ "total_count",
+ "url"
]
}
}
@@ -188086,7 +209386,12 @@
}
},
"title": "cancellation_details_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "comment",
+ "feedback",
+ "feedback_option"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -188355,7 +209660,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -188375,7 +209684,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -188384,7 +209698,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -188415,7 +209732,7 @@
"type": "string"
},
"unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
+ "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.",
"type": "integer"
},
"unit_amount_decimal": {
@@ -188429,7 +209746,12 @@
"product"
],
"title": "one_time_price_data_with_negative_amounts",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for this item. Defaults to 1.",
@@ -188456,6 +209778,10 @@
},
"title": "add_invoice_item_entry",
"type": "object",
+ "x-stripeMostCommon": [
+ "price",
+ "quantity"
+ ],
"x-stripeParam": {
"class_name": "AddInvoiceItem"
}
@@ -188503,14 +209829,22 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled",
+ "liability"
+ ]
},
"billing_cycle_anchor": {
"description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).",
@@ -188536,7 +209870,11 @@
}
},
"title": "billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_gte",
+ "reset_billing_cycle_anchor"
+ ]
},
{
"enum": [
@@ -188601,7 +209939,12 @@
}
},
"title": "cancellation_details_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "comment",
+ "feedback",
+ "feedback_option"
+ ]
},
"collection_method": {
"description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.",
@@ -188714,7 +210057,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -188734,7 +210081,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -188743,7 +210095,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -188805,11 +210160,25 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
}
},
"title": "invoice_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_tax_ids",
+ "custom_fields",
+ "description",
+ "footer",
+ "issuer",
+ "rendering",
+ "send_hosted_payment_email",
+ "supported_payment_methods"
+ ]
},
"items": {
"description": "A list of up to 20 subscription items, each with an attached price.",
@@ -188828,7 +210197,10 @@
"usage_gte"
],
"title": "item_billing_thresholds_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "usage_gte"
+ ]
},
{
"enum": [
@@ -188888,7 +210260,11 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
@@ -188908,7 +210284,12 @@
"type"
],
"title": "discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "duration",
+ "timestamp",
+ "type"
+ ]
},
"promotion_code": {
"description": "ID of the promotion code to create a new discount for.",
@@ -188917,7 +210298,10 @@
}
},
"title": "discounts_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "coupon"
+ ]
},
"type": "array"
},
@@ -188996,7 +210380,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval"
+ ]
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -189023,7 +210410,13 @@
"recurring"
],
"title": "recurring_price_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "product",
+ "recurring",
+ "unit_amount"
+ ]
},
"quantity": {
"description": "Quantity for this item.",
@@ -189049,7 +210442,19 @@
}
},
"title": "subscription_item_update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_thresholds",
+ "clear_usage",
+ "deleted",
+ "discounts",
+ "id",
+ "metadata",
+ "plan",
+ "price",
+ "quantity",
+ "tax_rates"
+ ]
},
"type": "array"
},
@@ -189111,7 +210516,11 @@
"behavior"
],
"title": "pause_collection_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "behavior",
+ "resumes_at"
+ ]
},
{
"enum": [
@@ -189155,7 +210564,10 @@
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "transaction_type"
+ ]
},
"verification_method": {
"description": "Verification method for the intent",
@@ -189169,7 +210581,11 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -189196,7 +210612,10 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred_language"
+ ]
},
{
"enum": [
@@ -189233,7 +210652,12 @@
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_type",
+ "description"
+ ]
},
"network": {
"description": "Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.",
@@ -189266,7 +210690,13 @@
}
},
"title": "subscription_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "mandate_options",
+ "mit_exemption",
+ "network",
+ "request_three_d_secure"
+ ]
},
{
"enum": [
@@ -189297,7 +210727,10 @@
"country"
],
"title": "eu_bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"type": {
"description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
@@ -189305,7 +210738,12 @@
}
},
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "eu_bank_transfer",
+ "id_bank_transfer",
+ "type"
+ ]
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
@@ -189313,7 +210751,11 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank_transfer",
+ "funding_type"
+ ]
},
{
"enum": [
@@ -189345,7 +210787,10 @@
{
"properties": {},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "verification_method"
+ ]
},
{
"enum": [
@@ -189384,7 +210829,11 @@
}
},
"title": "invoice_linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_subcategories",
+ "institution"
+ ]
},
"permissions": {
"description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.",
@@ -189416,7 +210865,12 @@
}
},
"title": "invoice_linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "filters",
+ "permissions",
+ "prefetch"
+ ]
},
"verification_method": {
"description": "Verification method for the intent",
@@ -189430,7 +210884,11 @@
}
},
"title": "invoice_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "financial_connections",
+ "verification_method"
+ ]
},
{
"enum": [
@@ -189443,7 +210901,17 @@
}
},
"title": "payment_method_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acss_debit",
+ "bancontact",
+ "card",
+ "customer_balance",
+ "id_bank_transfer",
+ "konbini",
+ "sepa_debit",
+ "us_bank_account"
+ ]
},
"payment_method_types": {
"anyOf": [
@@ -189505,7 +210973,12 @@
}
},
"title": "payment_settings",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment_method_options",
+ "payment_method_types",
+ "save_default_payment_method"
+ ]
},
"pending_invoice_item_interval": {
"anyOf": [
@@ -189530,7 +211003,11 @@
"interval"
],
"title": "pending_invoice_item_interval_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "interval",
+ "interval_count"
+ ]
},
{
"enum": [
@@ -189561,7 +211038,11 @@
"iterations"
],
"title": "prebilling_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iterations",
+ "update_behavior"
+ ]
},
"promotion_code": {
"description": "The 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.",
@@ -189599,7 +211080,11 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_percent",
+ "destination"
+ ]
},
{
"enum": [
@@ -189650,17 +211135,32 @@
"missing_payment_method"
],
"title": "end_behavior",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "missing_payment_method"
+ ]
}
},
"required": [
"end_behavior"
],
"title": "trial_settings_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "end_behavior"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cancel_at_period_end",
+ "default_payment_method",
+ "description",
+ "items",
+ "metadata",
+ "payment_behavior",
+ "proration_behavior"
+ ]
}
}
},
@@ -189803,7 +211303,11 @@
"type": "integer"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_cycle_anchor",
+ "proration_behavior"
+ ]
}
}
},
@@ -190034,7 +211538,15 @@
"country"
],
"title": "postal_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"address_source": {
"description": "The type of customer address provided.",
@@ -190053,7 +211565,7 @@
"items": {
"properties": {
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -190087,6 +211599,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -190143,7 +211656,11 @@
"value"
],
"title": "data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type",
+ "value"
+ ]
},
"type": "array"
},
@@ -190158,7 +211675,14 @@
}
},
"title": "customer_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "address_source",
+ "ip_address",
+ "tax_ids",
+ "taxability_override"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -190207,7 +211731,15 @@
"amount"
],
"title": "calculation_line_item",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "product",
+ "quantity",
+ "reference",
+ "tax_behavior",
+ "tax_code"
+ ]
},
"type": "array"
},
@@ -190302,14 +211834,25 @@
"country"
],
"title": "merchant_postal_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
}
},
"required": [
"address"
],
"title": "ship_from_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address"
+ ]
},
"shipping_cost": {
"description": "Shipping cost details to be used for the calculation.",
@@ -190332,12 +211875,18 @@
"type": "string"
},
"tax_code": {
- "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) used to calculate tax on shipping. If not provided, the default shipping tax code from your [Tax Settings](/settings/tax) is used.",
+ "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) used to calculate tax on shipping. If not provided, the default shipping tax code from your [Tax Settings](https://dashboard.stripe.com/settings/tax) is used.",
"type": "string"
}
},
"title": "shipping_cost",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "shipping_rate",
+ "tax_behavior",
+ "tax_code"
+ ]
},
"tax_date": {
"description": "Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future.",
@@ -190348,7 +211897,13 @@
"currency",
"line_items"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "customer_details",
+ "line_items",
+ "shipping_cost"
+ ]
}
}
},
@@ -190564,6 +212119,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -190646,7 +212207,11 @@
}
},
"title": "payee_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "type"
+ ]
},
"style": "deepObject"
},
@@ -190731,6 +212296,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -191015,6 +212586,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -191095,7 +212672,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"at": {
"description": "Options for the registration in AT.",
@@ -191116,7 +212696,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191133,7 +212716,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"au": {
"description": "Options for the registration in AU.",
@@ -191150,7 +212737,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"be": {
"description": "Options for the registration in BE.",
@@ -191171,7 +212761,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191188,7 +212781,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"bg": {
"description": "Options for the registration in BG.",
@@ -191209,7 +212806,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191226,7 +212826,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"bh": {
"description": "Options for the registration in BH.",
@@ -191243,7 +212847,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"ca": {
"description": "Options for the registration in CA.",
@@ -191261,7 +212868,10 @@
"province"
],
"title": "province_standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "province"
+ ]
},
"type": {
"description": "Type of registration to be created in Canada.",
@@ -191277,7 +212887,11 @@
"type"
],
"title": "canada",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "province_standard",
+ "type"
+ ]
},
"ch": {
"description": "Options for the registration in CH.",
@@ -191294,7 +212908,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"cl": {
"description": "Options for the registration in CL.",
@@ -191311,7 +212928,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"co": {
"description": "Options for the registration in CO.",
@@ -191328,7 +212948,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"cy": {
"description": "Options for the registration in CY.",
@@ -191349,7 +212972,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191366,7 +212992,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"cz": {
"description": "Options for the registration in CZ.",
@@ -191387,7 +213017,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191404,7 +213037,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"de": {
"description": "Options for the registration in DE.",
@@ -191425,7 +213062,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191442,7 +213082,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"dk": {
"description": "Options for the registration in DK.",
@@ -191463,7 +213107,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191480,7 +213127,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"ee": {
"description": "Options for the registration in EE.",
@@ -191501,7 +213152,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191518,7 +213172,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"eg": {
"description": "Options for the registration in EG.",
@@ -191535,7 +213193,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"es": {
"description": "Options for the registration in ES.",
@@ -191556,7 +213217,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191573,7 +213237,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"fi": {
"description": "Options for the registration in FI.",
@@ -191594,7 +213262,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191611,7 +213282,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"fr": {
"description": "Options for the registration in FR.",
@@ -191632,7 +213307,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191649,7 +213327,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"gb": {
"description": "Options for the registration in GB.",
@@ -191666,7 +213348,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"ge": {
"description": "Options for the registration in GE.",
@@ -191683,7 +213368,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"gr": {
"description": "Options for the registration in GR.",
@@ -191704,7 +213392,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191721,7 +213412,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"hr": {
"description": "Options for the registration in HR.",
@@ -191742,7 +213437,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191759,7 +213457,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"hu": {
"description": "Options for the registration in HU.",
@@ -191780,7 +213482,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191797,7 +213502,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"id": {
"description": "Options for the registration in ID.",
@@ -191814,7 +213523,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"ie": {
"description": "Options for the registration in IE.",
@@ -191835,7 +213547,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191852,7 +213567,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"is": {
"description": "Options for the registration in IS.",
@@ -191869,7 +213588,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"it": {
"description": "Options for the registration in IT.",
@@ -191890,7 +213612,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191907,7 +213632,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"jp": {
"description": "Options for the registration in JP.",
@@ -191924,7 +213653,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"ke": {
"description": "Options for the registration in KE.",
@@ -191941,7 +213673,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"kr": {
"description": "Options for the registration in KR.",
@@ -191958,7 +213693,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"kz": {
"description": "Options for the registration in KZ.",
@@ -191975,7 +213713,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"lt": {
"description": "Options for the registration in LT.",
@@ -191996,7 +213737,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192013,7 +213757,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"lu": {
"description": "Options for the registration in LU.",
@@ -192034,7 +213782,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192051,7 +213802,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"lv": {
"description": "Options for the registration in LV.",
@@ -192072,7 +213827,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192089,7 +213847,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"mt": {
"description": "Options for the registration in MT.",
@@ -192110,7 +213872,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192127,7 +213892,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"mx": {
"description": "Options for the registration in MX.",
@@ -192144,7 +213913,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"my": {
"description": "Options for the registration in MY.",
@@ -192161,7 +213933,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"ng": {
"description": "Options for the registration in NG.",
@@ -192178,7 +213953,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"nl": {
"description": "Options for the registration in NL.",
@@ -192199,7 +213977,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192216,7 +213997,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"no": {
"description": "Options for the registration in NO.",
@@ -192233,7 +214018,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"nz": {
"description": "Options for the registration in NZ.",
@@ -192250,7 +214038,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"om": {
"description": "Options for the registration in OM.",
@@ -192267,7 +214058,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"pl": {
"description": "Options for the registration in PL.",
@@ -192288,7 +214082,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192305,7 +214102,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"pt": {
"description": "Options for the registration in PT.",
@@ -192326,7 +214127,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192343,7 +214147,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"ro": {
"description": "Options for the registration in RO.",
@@ -192364,7 +214172,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192381,7 +214192,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"sa": {
"description": "Options for the registration in SA.",
@@ -192398,7 +214213,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"se": {
"description": "Options for the registration in SE.",
@@ -192419,7 +214237,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192436,7 +214257,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"sg": {
"description": "Options for the registration in SG.",
@@ -192453,7 +214278,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"si": {
"description": "Options for the registration in SI.",
@@ -192474,7 +214302,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192491,7 +214322,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"sk": {
"description": "Options for the registration in SK.",
@@ -192512,7 +214347,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "place_of_supply_scheme"
+ ]
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192529,7 +214367,11 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "standard",
+ "type"
+ ]
},
"th": {
"description": "Options for the registration in TH.",
@@ -192546,7 +214388,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"tr": {
"description": "Options for the registration in TR.",
@@ -192563,7 +214408,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"us": {
"description": "Options for the registration in US.",
@@ -192581,7 +214429,10 @@
"jurisdiction"
],
"title": "local_amusement_tax",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "jurisdiction"
+ ]
},
"local_lease_tax": {
"description": "Options for the local lease tax registration.",
@@ -192596,7 +214447,10 @@
"jurisdiction"
],
"title": "local_lease_tax",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "jurisdiction"
+ ]
},
"state": {
"description": "Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).",
@@ -192620,7 +214474,14 @@
"type"
],
"title": "united_states",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "local_amusement_tax",
+ "local_lease_tax",
+ "state",
+ "state_sales_tax",
+ "type"
+ ]
},
"vn": {
"description": "Options for the registration in VN.",
@@ -192637,7 +214498,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
},
"za": {
"description": "Options for the registration in ZA.",
@@ -192654,11 +214518,75 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type"
+ ]
}
},
"title": "country_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ae",
+ "at",
+ "au",
+ "be",
+ "bg",
+ "bh",
+ "ca",
+ "ch",
+ "cl",
+ "co",
+ "cy",
+ "cz",
+ "de",
+ "dk",
+ "ee",
+ "eg",
+ "es",
+ "fi",
+ "fr",
+ "gb",
+ "ge",
+ "gr",
+ "hr",
+ "hu",
+ "id",
+ "ie",
+ "in",
+ "is",
+ "it",
+ "jp",
+ "ke",
+ "kr",
+ "kz",
+ "lt",
+ "lu",
+ "lv",
+ "mt",
+ "mx",
+ "my",
+ "ng",
+ "nl",
+ "no",
+ "nz",
+ "om",
+ "pl",
+ "pt",
+ "ro",
+ "sa",
+ "se",
+ "sg",
+ "si",
+ "sk",
+ "th",
+ "tr",
+ "tw",
+ "ua",
+ "us",
+ "vn",
+ "za"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -192679,7 +214607,13 @@
"country",
"country_options"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active_from",
+ "country",
+ "country_options",
+ "expires_at"
+ ]
}
}
},
@@ -192858,7 +214792,11 @@
"description": "If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active_from",
+ "expires_at"
+ ]
}
}
},
@@ -192986,7 +214924,11 @@
}
},
"title": "defaults_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_behavior",
+ "tax_code"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -193034,17 +214976,32 @@
}
},
"title": "validated_country_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
}
},
"required": [
"address"
],
"title": "head_office_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "defaults",
+ "head_office"
+ ]
}
}
},
@@ -193129,7 +215086,12 @@
"calculation",
"reference"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "calculation",
+ "metadata",
+ "reference"
+ ]
}
}
},
@@ -193240,7 +215202,15 @@
"reference"
],
"title": "transaction_line_item_reversal",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_tax",
+ "metadata",
+ "original_line_item",
+ "quantity",
+ "reference"
+ ]
},
"type": "array"
},
@@ -193286,7 +215256,11 @@
"amount_tax"
],
"title": "transaction_shipping_cost_reversal",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "amount_tax"
+ ]
}
},
"required": [
@@ -193294,7 +215268,15 @@
"original_transaction",
"reference"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "flat_amount",
+ "line_items",
+ "metadata",
+ "mode",
+ "original_transaction",
+ "reference"
+ ]
}
}
},
@@ -193510,6 +215492,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -193629,240 +215617,257 @@
"object",
"url"
],
- "title": "TaxProductResourceTaxCodeList",
+ "title": "TaxProductResourceTaxCodeList",
+ "type": "object",
+ "x-expandableFields": [
+ "data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ]
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/tax_codes/{id}": {
+ "get": {
+ "description": "Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
",
+ "operationId": "GetTaxCodesId",
+ "parameters": [
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ },
+ {
+ "in": "path",
+ "name": "id",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {},
+ "schema": {
+ "additionalProperties": false,
+ "properties": {},
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/tax_code"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/tax_ids": {
+ "get": {
+ "description": "Returns a list of tax IDs.
",
+ "operationId": "GetTaxIds",
+ "parameters": [
+ {
+ "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
+ "in": "query",
+ "name": "ending_before",
+ "required": false,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ },
+ {
+ "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
+ "in": "query",
+ "name": "limit",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ },
+ "style": "form"
+ },
+ {
+ "description": "The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.",
+ "explode": true,
+ "in": "query",
+ "name": "owner",
+ "required": false,
+ "schema": {
+ "properties": {
+ "account": {
+ "description": "Account the tax ID belongs to. Required when `type=account`",
+ "type": "string"
+ },
+ "customer": {
+ "description": "Customer the tax ID belongs to. Required when `type=customer`",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of owner referenced.",
+ "enum": [
+ "account",
+ "application",
+ "customer",
+ "self"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "owner_params",
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "customer",
+ "type"
+ ]
+ },
+ "style": "deepObject"
+ },
+ {
+ "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
+ "in": "query",
+ "name": "starting_after",
+ "required": false,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {},
+ "schema": {
+ "additionalProperties": false,
+ "properties": {},
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "description": "",
+ "properties": {
+ "data": {
+ "description": "Details about each object.",
+ "items": {
+ "$ref": "#/components/schemas/tax_id"
+ },
+ "type": "array"
+ },
+ "has_more": {
+ "description": "True if this list has another page of items after this one that can be fetched.",
+ "type": "boolean"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
+ "enum": [
+ "list"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL where this list can be accessed.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ],
+ "title": "TaxIDsList",
"type": "object",
"x-expandableFields": [
"data"
- ]
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/tax_codes/{id}": {
- "get": {
- "description": "Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
",
- "operationId": "GetTaxCodesId",
- "parameters": [
- {
- "description": "Specifies which fields in the response should be expanded.",
- "explode": true,
- "in": "query",
- "name": "expand",
- "required": false,
- "schema": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "style": "deepObject"
- },
- {
- "in": "path",
- "name": "id",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {},
- "schema": {
- "additionalProperties": false,
- "properties": {},
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/tax_code"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/tax_ids": {
- "get": {
- "description": "Returns a list of tax IDs.
",
- "operationId": "GetTaxIds",
- "parameters": [
- {
- "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
- "in": "query",
- "name": "ending_before",
- "required": false,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- },
- {
- "description": "Specifies which fields in the response should be expanded.",
- "explode": true,
- "in": "query",
- "name": "expand",
- "required": false,
- "schema": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "style": "deepObject"
- },
- {
- "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
- "in": "query",
- "name": "limit",
- "required": false,
- "schema": {
- "type": "integer"
- },
- "style": "form"
- },
- {
- "description": "The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.",
- "explode": true,
- "in": "query",
- "name": "owner",
- "required": false,
- "schema": {
- "properties": {
- "account": {
- "description": "Account the tax ID belongs to. Required when `type=account`",
- "type": "string"
- },
- "customer": {
- "description": "Customer the tax ID belongs to. Required when `type=customer`",
- "maxLength": 5000,
- "type": "string"
- },
- "type": {
- "description": "Type of owner referenced.",
- "enum": [
- "account",
- "application",
- "customer",
- "self"
],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "title": "owner_params",
- "type": "object"
- },
- "style": "deepObject"
- },
- {
- "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
- "in": "query",
- "name": "starting_after",
- "required": false,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {},
- "schema": {
- "additionalProperties": false,
- "properties": {},
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "description": "",
- "properties": {
- "data": {
- "description": "Details about each object.",
- "items": {
- "$ref": "#/components/schemas/tax_id"
- },
- "type": "array"
- },
- "has_more": {
- "description": "True if this list has another page of items after this one that can be fetched.",
- "type": "boolean"
- },
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
- "enum": [
- "list"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL where this list can be accessed.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "required": [
+ "x-stripeMostCommon": [
"data",
"has_more",
"object",
"url"
- ],
- "title": "TaxIDsList",
- "type": "object",
- "x-expandableFields": [
- "data"
]
}
}
@@ -193935,10 +215940,15 @@
"type"
],
"title": "owner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "customer",
+ "type"
+ ]
},
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -193972,6 +215982,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -194027,7 +216038,11 @@
"type",
"value"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type",
+ "value"
+ ]
}
}
},
@@ -194219,7 +216234,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -194340,6 +216361,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -194454,7 +216481,18 @@
"inclusive",
"percentage"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "country",
+ "description",
+ "display_name",
+ "inclusive",
+ "jurisdiction",
+ "metadata",
+ "percentage",
+ "state"
+ ]
}
}
},
@@ -194656,7 +216694,16 @@
"x-stripeBypassValidation": true
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "active",
+ "country",
+ "description",
+ "display_name",
+ "jurisdiction",
+ "metadata",
+ "state"
+ ]
}
}
},
@@ -194803,6 +216850,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -194879,7 +216932,10 @@
}
},
"title": "bbpos_wise_pose",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "splashscreen"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -194907,7 +216963,10 @@
"enabled"
],
"title": "offline",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
{
"enum": [
@@ -194935,7 +216994,12 @@
"start_hour"
],
"title": "reboot_window",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allow_reader_override",
+ "end_hour",
+ "start_hour"
+ ]
},
"stripe_s700": {
"description": "An object containing device type specific settings for Stripe S700 readers",
@@ -194956,7 +217020,10 @@
}
},
"title": "stripe_s700",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "splashscreen"
+ ]
},
"tipping": {
"anyOf": [
@@ -194985,7 +217052,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"cad": {
"description": "Tipping configuration for CAD",
@@ -195010,7 +217082,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"chf": {
"description": "Tipping configuration for CHF",
@@ -195035,7 +217112,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"czk": {
"description": "Tipping configuration for CZK",
@@ -195060,7 +217142,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"dkk": {
"description": "Tipping configuration for DKK",
@@ -195085,7 +217172,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"eur": {
"description": "Tipping configuration for EUR",
@@ -195110,7 +217202,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"gbp": {
"description": "Tipping configuration for GBP",
@@ -195135,7 +217232,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"hkd": {
"description": "Tipping configuration for HKD",
@@ -195160,7 +217262,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"myr": {
"description": "Tipping configuration for MYR",
@@ -195185,7 +217292,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"nok": {
"description": "Tipping configuration for NOK",
@@ -195210,7 +217322,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"nzd": {
"description": "Tipping configuration for NZD",
@@ -195235,7 +217352,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"sek": {
"description": "Tipping configuration for SEK",
@@ -195260,7 +217382,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"sgd": {
"description": "Tipping configuration for SGD",
@@ -195285,7 +217412,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"usd": {
"description": "Tipping configuration for USD",
@@ -195310,11 +217442,32 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
}
},
"title": "tipping",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "aud",
+ "cad",
+ "chf",
+ "czk",
+ "dkk",
+ "eur",
+ "gbp",
+ "hkd",
+ "myr",
+ "nok",
+ "nzd",
+ "sek",
+ "sgd",
+ "usd"
+ ]
},
{
"enum": [
@@ -195344,10 +217497,19 @@
}
},
"title": "verifone_p400",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "splashscreen"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bbpos_wisepos_e",
+ "stripe_s700",
+ "tipping",
+ "verifone_p400"
+ ]
}
}
},
@@ -195573,7 +217735,10 @@
}
},
"title": "bbpos_wise_pose",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "splashscreen"
+ ]
},
{
"enum": [
@@ -195610,7 +217775,10 @@
"enabled"
],
"title": "offline",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enabled"
+ ]
},
{
"enum": [
@@ -195639,7 +217807,12 @@
"start_hour"
],
"title": "reboot_window",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "allow_reader_override",
+ "end_hour",
+ "start_hour"
+ ]
},
{
"enum": [
@@ -195670,7 +217843,10 @@
}
},
"title": "stripe_s700",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "splashscreen"
+ ]
},
{
"enum": [
@@ -195708,7 +217884,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"cad": {
"description": "Tipping configuration for CAD",
@@ -195733,7 +217914,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"chf": {
"description": "Tipping configuration for CHF",
@@ -195758,7 +217944,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"czk": {
"description": "Tipping configuration for CZK",
@@ -195783,7 +217974,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"dkk": {
"description": "Tipping configuration for DKK",
@@ -195808,7 +218004,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"eur": {
"description": "Tipping configuration for EUR",
@@ -195833,7 +218034,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"gbp": {
"description": "Tipping configuration for GBP",
@@ -195858,7 +218064,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"hkd": {
"description": "Tipping configuration for HKD",
@@ -195883,7 +218094,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"myr": {
"description": "Tipping configuration for MYR",
@@ -195908,7 +218124,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"nok": {
"description": "Tipping configuration for NOK",
@@ -195933,7 +218154,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"nzd": {
"description": "Tipping configuration for NZD",
@@ -195958,7 +218184,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"sek": {
"description": "Tipping configuration for SEK",
@@ -195983,7 +218214,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"sgd": {
"description": "Tipping configuration for SGD",
@@ -196008,7 +218244,12 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
},
"usd": {
"description": "Tipping configuration for USD",
@@ -196033,11 +218274,32 @@
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fixed_amounts",
+ "percentages",
+ "smart_tip_threshold"
+ ]
}
},
"title": "tipping",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "aud",
+ "cad",
+ "chf",
+ "czk",
+ "dkk",
+ "eur",
+ "gbp",
+ "hkd",
+ "myr",
+ "nok",
+ "nzd",
+ "sek",
+ "sgd",
+ "usd"
+ ]
},
{
"enum": [
@@ -196068,7 +218330,10 @@
}
},
"title": "verifone_p400",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "splashscreen"
+ ]
},
{
"enum": [
@@ -196080,7 +218345,13 @@
"description": "An object containing device type specific settings for Verifone P400 readers"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bbpos_wisepos_e",
+ "stripe_s700",
+ "tipping",
+ "verifone_p400"
+ ]
}
}
},
@@ -196147,7 +218418,10 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "location"
+ ]
}
}
},
@@ -196284,6 +218558,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -196363,7 +218643,15 @@
"country"
],
"title": "create_location_address_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"configuration_overrides": {
"description": "The ID of a configuration that will be used to customize all readers in this location.",
@@ -196405,7 +218693,12 @@
"address",
"display_name"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "display_name",
+ "metadata"
+ ]
}
}
},
@@ -196634,7 +218927,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"configuration_overrides": {
"anyOf": [
@@ -196682,7 +218983,12 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "display_name",
+ "metadata"
+ ]
}
}
},
@@ -196719,6 +219025,75 @@
}
}
},
+ "/v1/terminal/reader_collected_data/{reader_collected_data}": {
+ "get": {
+ "description": "Retrieve data collected using Reader hardware.
",
+ "operationId": "GetTerminalReaderCollectedDataReaderCollectedData",
+ "parameters": [
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ },
+ {
+ "description": "The ID of the ReaderCollectedData to retrieve.",
+ "in": "path",
+ "name": "reader_collected_data",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {},
+ "schema": {
+ "additionalProperties": false,
+ "properties": {},
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/terminal.reader_collected_data"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
"/v1/terminal/readers": {
"get": {
"description": "Returns a list of Reader objects.
",
@@ -196883,6 +219258,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -196964,7 +219345,13 @@
"required": [
"registration_code"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "label",
+ "location",
+ "metadata",
+ "registration_code"
+ ]
}
}
},
@@ -197195,7 +219582,11 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "label",
+ "metadata"
+ ]
}
}
},
@@ -197375,7 +219766,13 @@
"title"
],
"title": "custom_text_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "skip_button",
+ "submit_button",
+ "title"
+ ]
},
"required": {
"description": "Indicate that this input is required, disabling the skip button",
@@ -197406,7 +219803,11 @@
"value"
],
"title": "choice_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "style",
+ "value"
+ ]
},
"type": "array"
}
@@ -197415,7 +219816,10 @@
"choices"
],
"title": "selection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "choices"
+ ]
},
"toggles": {
"description": "List of toggles to be displayed and customization for the toggles",
@@ -197441,7 +219845,12 @@
}
},
"title": "toggle_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "default_value",
+ "description",
+ "title"
+ ]
},
"type": "array"
},
@@ -197463,7 +219872,12 @@
"type"
],
"title": "input_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "custom_text",
+ "required",
+ "type"
+ ]
},
"type": "array"
},
@@ -197478,7 +219892,11 @@
"required": [
"inputs"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "inputs",
+ "metadata"
+ ]
}
}
},
@@ -197560,11 +219978,22 @@
}
},
"title": "tipping_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_eligible"
+ ]
}
},
"title": "collect_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enable_customer_cancellation",
+ "moto",
+ "request_dynamic_currency_conversion",
+ "skip_tipping",
+ "surcharge_notice",
+ "tipping"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -197583,7 +220012,10 @@
"required": [
"payment_intent"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment_intent"
+ ]
}
}
},
@@ -197658,7 +220090,10 @@
"required": [
"payment_intent"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment_intent"
+ ]
}
}
},
@@ -197753,17 +220188,31 @@
}
},
"title": "tipping_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount_eligible"
+ ]
}
},
"title": "process_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enable_customer_cancellation",
+ "moto",
+ "request_dynamic_currency_conversion",
+ "return_url",
+ "skip_tipping",
+ "tipping"
+ ]
}
},
"required": [
"payment_intent"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment_intent"
+ ]
}
}
},
@@ -197846,7 +220295,11 @@
}
},
"title": "process_setup_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enable_customer_cancellation",
+ "moto"
+ ]
},
"setup_intent": {
"description": "SetupIntent ID",
@@ -197855,10 +220308,13 @@
}
},
"required": [
- "customer_consent_collected",
"setup_intent"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "customer_consent_collected",
+ "setup_intent"
+ ]
}
}
},
@@ -197966,14 +220422,25 @@
}
},
"title": "refund_payment_config",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "enable_customer_cancellation"
+ ]
},
"reverse_transfer": {
"description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.",
"type": "boolean"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "charge",
+ "metadata",
+ "payment_intent",
+ "refund_application_fee",
+ "reverse_transfer"
+ ]
}
}
},
@@ -198066,7 +220533,12 @@
"quantity"
],
"title": "line_item",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "description",
+ "quantity"
+ ]
},
"type": "array"
},
@@ -198085,7 +220557,13 @@
"total"
],
"title": "cart",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "currency",
+ "line_items",
+ "tax",
+ "total"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -198106,7 +220584,11 @@
"required": [
"type"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cart",
+ "type"
+ ]
}
}
},
@@ -198201,7 +220683,12 @@
"transit_number"
],
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "institution_number",
+ "transit_number"
+ ]
},
"affirm": {
"description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.",
@@ -198255,7 +220742,11 @@
"bsb_number"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number"
+ ]
},
"bacs_debit": {
"description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.",
@@ -198272,7 +220763,11 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "sort_code"
+ ]
},
"bancontact": {
"description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.",
@@ -198319,7 +220814,15 @@
}
},
"title": "billing_details_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
{
"enum": [
@@ -198376,7 +220879,13 @@
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
+ ]
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -198397,7 +220906,10 @@
"tax_id"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"cashapp": {
"description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.",
@@ -198451,7 +220963,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"fpx": {
"description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.",
@@ -198500,7 +221015,11 @@
"bank"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "bank"
+ ]
},
"giropay": {
"description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.",
@@ -198542,13 +221061,22 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"interac_present": {
"description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "device_identifier",
+ "device_type",
+ "emv",
+ "location"
+ ]
},
"klarna": {
"description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.",
@@ -198575,11 +221103,19 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"konbini": {
"description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.",
@@ -198593,6 +221129,12 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"metadata": {
"additionalProperties": {
"type": "string"
@@ -198656,7 +221198,10 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank"
+ ]
},
"paynow": {
"description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.",
@@ -198690,13 +221235,21 @@
}
},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_number",
+ "bsb_number",
+ "pay_id"
+ ]
},
"pix": {
"description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.",
"properties": {},
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tax_id"
+ ]
},
"promptpay": {
"description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.",
@@ -198714,7 +221267,11 @@
}
},
"title": "radar_options_with_hidden_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "session",
+ "skip_rules"
+ ]
},
"rechnung": {
"description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.",
@@ -198741,14 +221298,22 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
}
},
"required": [
"dob"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "dob"
+ ]
},
"revolut_pay": {
"description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
@@ -198769,7 +221334,10 @@
"iban"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "iban"
+ ]
},
"sofort": {
"description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.",
@@ -198791,7 +221359,10 @@
"country"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "country"
+ ]
},
"swish": {
"description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.",
@@ -198828,6 +221399,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -198886,7 +221458,14 @@
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "account_number",
+ "account_type",
+ "financial_connections_account",
+ "routing_number"
+ ]
},
"wechat_pay": {
"description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.",
@@ -198905,7 +221484,12 @@
"type"
],
"title": "payment_method_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_details",
+ "metadata",
+ "type"
+ ]
},
"return_url": {
"description": "Return URL used to confirm the Intent.",
@@ -198957,7 +221541,15 @@
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"name": {
"description": "Recipient name.",
@@ -198985,10 +221577,22 @@
"name"
],
"title": "recipient_shipping_with_optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "name",
+ "phone"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "payment_method",
+ "payment_method_data",
+ "return_url",
+ "setup_future_usage",
+ "shipping"
+ ]
}
}
},
@@ -199072,7 +221676,11 @@
"amount",
"currency"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency"
+ ]
}
}
},
@@ -199159,7 +221767,11 @@
}
},
"title": "amount_details_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "atm_fee",
+ "cashback_amount"
+ ]
},
"authorization_method": {
"description": "How the card details were provided. Defaults to online.",
@@ -199221,7 +221833,14 @@
}
},
"title": "fleet_cardholder_prompt_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "driver_id",
+ "odometer",
+ "unspecified_id",
+ "user_id",
+ "vehicle_number"
+ ]
},
"purchase_type": {
"description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.",
@@ -199246,7 +221865,10 @@
}
},
"title": "fleet_reported_breakdown_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gross_amount_decimal"
+ ]
},
"non_fuel": {
"description": "Breakdown of non-fuel portion of the purchase.",
@@ -199258,7 +221880,10 @@
}
},
"title": "fleet_reported_breakdown_non_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gross_amount_decimal"
+ ]
},
"tax": {
"description": "Information about tax included in this transaction.",
@@ -199275,11 +221900,20 @@
}
},
"title": "fleet_reported_breakdown_tax_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "local_amount_decimal",
+ "national_amount_decimal"
+ ]
}
},
"title": "fleet_reported_breakdown_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fuel",
+ "non_fuel",
+ "tax"
+ ]
},
"service_type": {
"description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.",
@@ -199293,7 +221927,14 @@
}
},
"title": "fleet_testmode_authorization_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cardholder_prompt_data",
+ "dynamic_purchase_controls_supported",
+ "purchase_type",
+ "reported_breakdown",
+ "service_type"
+ ]
},
"fuel": {
"description": "Information about fuel that was purchased with this transaction.",
@@ -199342,7 +221983,14 @@
}
},
"title": "fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "industry_product_code",
+ "quantity_decimal",
+ "type",
+ "unit",
+ "unit_cost_decimal"
+ ]
},
"is_amount_controllable": {
"description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.",
@@ -199694,7 +222342,18 @@
}
},
"title": "merchant_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "category",
+ "city",
+ "country",
+ "name",
+ "network_id",
+ "postal_code",
+ "state",
+ "terminal_id",
+ "url"
+ ]
},
"network_data": {
"description": "Details about the authorization, such as identifiers, set by the card network.",
@@ -199706,7 +222365,10 @@
}
},
"title": "network_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "acquiring_institution_id"
+ ]
},
"verification_data": {
"description": "Verifications that Stripe performed on information that the cardholder provided to the merchant.",
@@ -199756,7 +222418,11 @@
"type"
],
"title": "authentication_exemption_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "claimed_by",
+ "type"
+ ]
},
"cvc_check": {
"description": "Whether the cardholder provided a CVC and if it matched Stripe’s record.",
@@ -199795,11 +222461,22 @@
"result"
],
"title": "three_d_secure_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "result"
+ ]
}
},
"title": "verification_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address_line1_check",
+ "address_postal_code_check",
+ "authentication_exemption",
+ "cvc_check",
+ "expiry_check",
+ "three_d_secure"
+ ]
},
"wallet": {
"description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.",
@@ -199815,7 +222492,12 @@
"amount",
"card"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "card",
+ "currency"
+ ]
}
}
},
@@ -199928,7 +222610,14 @@
}
},
"title": "fleet_cardholder_prompt_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "driver_id",
+ "odometer",
+ "unspecified_id",
+ "user_id",
+ "vehicle_number"
+ ]
},
"purchase_type": {
"description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.",
@@ -199953,7 +222642,10 @@
}
},
"title": "fleet_reported_breakdown_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gross_amount_decimal"
+ ]
},
"non_fuel": {
"description": "Breakdown of non-fuel portion of the purchase.",
@@ -199965,7 +222657,10 @@
}
},
"title": "fleet_reported_breakdown_non_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gross_amount_decimal"
+ ]
},
"tax": {
"description": "Information about tax included in this transaction.",
@@ -199982,11 +222677,20 @@
}
},
"title": "fleet_reported_breakdown_tax_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "local_amount_decimal",
+ "national_amount_decimal"
+ ]
}
},
"title": "fleet_reported_breakdown_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fuel",
+ "non_fuel",
+ "tax"
+ ]
},
"service_type": {
"description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.",
@@ -200000,7 +222704,13 @@
}
},
"title": "fleet_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cardholder_prompt_data",
+ "purchase_type",
+ "reported_breakdown",
+ "service_type"
+ ]
},
"flight": {
"description": "Information about the flight that was purchased with this transaction.",
@@ -200054,7 +222764,15 @@
}
},
"title": "flight_segment_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "arrival_airport_code",
+ "carrier",
+ "departure_airport_code",
+ "flight_number",
+ "service_class",
+ "stopover_allowed"
+ ]
},
"type": "array"
},
@@ -200065,7 +222783,14 @@
}
},
"title": "flight_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "departure_at",
+ "passenger_name",
+ "refundable",
+ "segments",
+ "travel_agency"
+ ]
},
"fuel": {
"description": "Information about fuel that was purchased with this transaction.",
@@ -200114,7 +222839,14 @@
}
},
"title": "fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "industry_product_code",
+ "quantity_decimal",
+ "type",
+ "unit",
+ "unit_cost_decimal"
+ ]
},
"lodging": {
"description": "Information about lodging that was purchased with this transaction.",
@@ -200130,7 +222862,11 @@
}
},
"title": "lodging_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "check_in_at",
+ "nights"
+ ]
},
"receipt": {
"description": "The line items in the purchase.",
@@ -200152,7 +222888,13 @@
}
},
"title": "receipt_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "quantity",
+ "total",
+ "unit_cost"
+ ]
},
"type": "array"
},
@@ -200163,10 +222905,23 @@
}
},
"title": "purchase_details_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fleet",
+ "flight",
+ "fuel",
+ "lodging",
+ "receipt",
+ "reference"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "capture_amount",
+ "close_authorization",
+ "purchase_details"
+ ]
}
}
},
@@ -200343,7 +223098,14 @@
}
},
"title": "fleet_cardholder_prompt_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "driver_id",
+ "odometer",
+ "unspecified_id",
+ "user_id",
+ "vehicle_number"
+ ]
},
"purchase_type": {
"description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.",
@@ -200368,7 +223130,10 @@
}
},
"title": "fleet_reported_breakdown_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gross_amount_decimal"
+ ]
},
"non_fuel": {
"description": "Breakdown of non-fuel portion of the purchase.",
@@ -200380,7 +223145,10 @@
}
},
"title": "fleet_reported_breakdown_non_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gross_amount_decimal"
+ ]
},
"tax": {
"description": "Information about tax included in this transaction.",
@@ -200397,11 +223165,20 @@
}
},
"title": "fleet_reported_breakdown_tax_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "local_amount_decimal",
+ "national_amount_decimal"
+ ]
}
},
"title": "fleet_reported_breakdown_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fuel",
+ "non_fuel",
+ "tax"
+ ]
},
"service_type": {
"description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.",
@@ -200415,7 +223192,13 @@
}
},
"title": "fleet_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cardholder_prompt_data",
+ "purchase_type",
+ "reported_breakdown",
+ "service_type"
+ ]
},
"fuel": {
"description": "Information about fuel that was purchased with this transaction.",
@@ -200464,13 +223247,23 @@
}
},
"title": "fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "industry_product_code",
+ "quantity_decimal",
+ "type",
+ "unit",
+ "unit_cost_decimal"
+ ]
}
},
"required": [
"final_amount"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "final_amount"
+ ]
}
}
},
@@ -200548,7 +223341,11 @@
"required": [
"increment_amount"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "increment_amount",
+ "is_amount_controllable"
+ ]
}
}
},
@@ -200619,7 +223416,10 @@
"type": "integer"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "reverse_amount"
+ ]
}
}
},
@@ -201129,13 +223929,20 @@
}
},
"title": "rejection_reasons_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "card_logo",
+ "carrier_text"
+ ]
}
},
"required": [
"rejection_reasons"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "rejection_reasons"
+ ]
}
}
},
@@ -201556,7 +224363,18 @@
}
},
"title": "merchant_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "category",
+ "city",
+ "country",
+ "name",
+ "network_id",
+ "postal_code",
+ "state",
+ "terminal_id",
+ "url"
+ ]
},
"purchase_details": {
"description": "Additional purchase information that is optionally provided by the merchant.",
@@ -201593,7 +224411,14 @@
}
},
"title": "fleet_cardholder_prompt_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "driver_id",
+ "odometer",
+ "unspecified_id",
+ "user_id",
+ "vehicle_number"
+ ]
},
"purchase_type": {
"description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.",
@@ -201618,7 +224443,10 @@
}
},
"title": "fleet_reported_breakdown_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gross_amount_decimal"
+ ]
},
"non_fuel": {
"description": "Breakdown of non-fuel portion of the purchase.",
@@ -201630,7 +224458,10 @@
}
},
"title": "fleet_reported_breakdown_non_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gross_amount_decimal"
+ ]
},
"tax": {
"description": "Information about tax included in this transaction.",
@@ -201647,11 +224478,20 @@
}
},
"title": "fleet_reported_breakdown_tax_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "local_amount_decimal",
+ "national_amount_decimal"
+ ]
}
},
"title": "fleet_reported_breakdown_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fuel",
+ "non_fuel",
+ "tax"
+ ]
},
"service_type": {
"description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.",
@@ -201665,7 +224505,13 @@
}
},
"title": "fleet_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cardholder_prompt_data",
+ "purchase_type",
+ "reported_breakdown",
+ "service_type"
+ ]
},
"flight": {
"description": "Information about the flight that was purchased with this transaction.",
@@ -201719,7 +224565,15 @@
}
},
"title": "flight_segment_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "arrival_airport_code",
+ "carrier",
+ "departure_airport_code",
+ "flight_number",
+ "service_class",
+ "stopover_allowed"
+ ]
},
"type": "array"
},
@@ -201730,7 +224584,14 @@
}
},
"title": "flight_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "departure_at",
+ "passenger_name",
+ "refundable",
+ "segments",
+ "travel_agency"
+ ]
},
"fuel": {
"description": "Information about fuel that was purchased with this transaction.",
@@ -201779,7 +224640,14 @@
}
},
"title": "fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "industry_product_code",
+ "quantity_decimal",
+ "type",
+ "unit",
+ "unit_cost_decimal"
+ ]
},
"lodging": {
"description": "Information about lodging that was purchased with this transaction.",
@@ -201795,7 +224663,11 @@
}
},
"title": "lodging_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "check_in_at",
+ "nights"
+ ]
},
"receipt": {
"description": "The line items in the purchase.",
@@ -201817,7 +224689,13 @@
}
},
"title": "receipt_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "quantity",
+ "total",
+ "unit_cost"
+ ]
},
"type": "array"
},
@@ -201828,14 +224706,27 @@
}
},
"title": "purchase_details_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fleet",
+ "flight",
+ "fuel",
+ "lodging",
+ "receipt",
+ "reference"
+ ]
}
},
"required": [
"amount",
"card"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "card",
+ "currency"
+ ]
}
}
},
@@ -202256,7 +225147,18 @@
}
},
"title": "merchant_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "category",
+ "city",
+ "country",
+ "name",
+ "network_id",
+ "postal_code",
+ "state",
+ "terminal_id",
+ "url"
+ ]
},
"purchase_details": {
"description": "Additional purchase information that is optionally provided by the merchant.",
@@ -202293,7 +225195,14 @@
}
},
"title": "fleet_cardholder_prompt_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "driver_id",
+ "odometer",
+ "unspecified_id",
+ "user_id",
+ "vehicle_number"
+ ]
},
"purchase_type": {
"description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.",
@@ -202318,7 +225227,10 @@
}
},
"title": "fleet_reported_breakdown_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gross_amount_decimal"
+ ]
},
"non_fuel": {
"description": "Breakdown of non-fuel portion of the purchase.",
@@ -202330,7 +225242,10 @@
}
},
"title": "fleet_reported_breakdown_non_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gross_amount_decimal"
+ ]
},
"tax": {
"description": "Information about tax included in this transaction.",
@@ -202347,11 +225262,20 @@
}
},
"title": "fleet_reported_breakdown_tax_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "local_amount_decimal",
+ "national_amount_decimal"
+ ]
}
},
"title": "fleet_reported_breakdown_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fuel",
+ "non_fuel",
+ "tax"
+ ]
},
"service_type": {
"description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.",
@@ -202365,7 +225289,13 @@
}
},
"title": "fleet_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cardholder_prompt_data",
+ "purchase_type",
+ "reported_breakdown",
+ "service_type"
+ ]
},
"flight": {
"description": "Information about the flight that was purchased with this transaction.",
@@ -202419,7 +225349,15 @@
}
},
"title": "flight_segment_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "arrival_airport_code",
+ "carrier",
+ "departure_airport_code",
+ "flight_number",
+ "service_class",
+ "stopover_allowed"
+ ]
},
"type": "array"
},
@@ -202430,7 +225368,14 @@
}
},
"title": "flight_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "departure_at",
+ "passenger_name",
+ "refundable",
+ "segments",
+ "travel_agency"
+ ]
},
"fuel": {
"description": "Information about fuel that was purchased with this transaction.",
@@ -202479,7 +225424,14 @@
}
},
"title": "fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "industry_product_code",
+ "quantity_decimal",
+ "type",
+ "unit",
+ "unit_cost_decimal"
+ ]
},
"lodging": {
"description": "Information about lodging that was purchased with this transaction.",
@@ -202495,7 +225447,11 @@
}
},
"title": "lodging_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "check_in_at",
+ "nights"
+ ]
},
"receipt": {
"description": "The line items in the purchase.",
@@ -202517,7 +225473,13 @@
}
},
"title": "receipt_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "quantity",
+ "total",
+ "unit_cost"
+ ]
},
"type": "array"
},
@@ -202528,14 +225490,27 @@
}
},
"title": "purchase_details_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "fleet",
+ "flight",
+ "fuel",
+ "lodging",
+ "receipt",
+ "reference"
+ ]
}
},
"required": [
"amount",
"card"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "card",
+ "currency"
+ ]
}
}
},
@@ -202606,7 +225581,10 @@
"type": "integer"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "refund_amount"
+ ]
}
}
},
@@ -202752,7 +225730,10 @@
}
},
"title": "card_present",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "number"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -202772,7 +225753,10 @@
}
},
"title": "interac_present",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "number"
+ ]
},
"type": {
"description": "Simulated payment type.",
@@ -202784,7 +225768,11 @@
"x-stripeBypassValidation": true
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "card_present",
+ "type"
+ ]
}
}
},
@@ -202921,6 +225909,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -202976,7 +225970,11 @@
"required": [
"frozen_time"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "frozen_time",
+ "name"
+ ]
}
}
},
@@ -203170,7 +226168,10 @@
"required": [
"frozen_time"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "frozen_time"
+ ]
}
}
},
@@ -203264,10 +226265,16 @@
}
},
"title": "failure_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "code"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "failure_details"
+ ]
}
}
},
@@ -203487,7 +226494,10 @@
"trace_id"
],
"title": "ach_tracking_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "trace_id"
+ ]
},
"type": {
"description": "The US bank account network used to send funds.",
@@ -203517,20 +226527,33 @@
}
},
"title": "us_domestic_wire_tracking_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "chips",
+ "imad",
+ "omad"
+ ]
}
},
"required": [
"type"
],
"title": "tracking_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach",
+ "type",
+ "us_domestic_wire"
+ ]
}
},
"required": [
"tracking_details"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tracking_details"
+ ]
}
}
},
@@ -203755,10 +226778,16 @@
}
},
"title": "returned_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "code"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "returned_details"
+ ]
}
}
},
@@ -203844,7 +226873,10 @@
"trace_id"
],
"title": "ach_tracking_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "trace_id"
+ ]
},
"type": {
"description": "The US bank account network used to send funds.",
@@ -203874,20 +226906,33 @@
}
},
"title": "us_domestic_wire_tracking_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "chips",
+ "imad",
+ "omad"
+ ]
}
},
"required": [
"type"
],
"title": "tracking_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach",
+ "type",
+ "us_domestic_wire"
+ ]
}
},
"required": [
"tracking_details"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "tracking_details"
+ ]
}
}
},
@@ -204112,10 +227157,16 @@
}
},
"title": "returned_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "code"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "returned_details"
+ ]
}
}
},
@@ -204224,14 +227275,23 @@
}
},
"title": "us_bank_account_source_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_name",
+ "account_number",
+ "routing_number"
+ ]
}
},
"required": [
"type"
],
"title": "source_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type",
+ "us_bank_account"
+ ]
},
"network": {
"description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.",
@@ -204254,7 +227314,10 @@
}
},
"title": "ach_network_details_source",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "addenda"
+ ]
},
"type": {
"description": "The type of flow that originated the ReceivedCredit.",
@@ -204268,7 +227331,11 @@
"type"
],
"title": "network_details_source",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach",
+ "type"
+ ]
}
},
"required": [
@@ -204277,7 +227344,16 @@
"financial_account",
"network"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "financial_account",
+ "initiating_payment_method_details",
+ "network",
+ "network_details"
+ ]
}
}
},
@@ -204386,14 +227462,23 @@
}
},
"title": "us_bank_account_source_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_name",
+ "account_number",
+ "routing_number"
+ ]
}
},
"required": [
"type"
],
"title": "source_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "type",
+ "us_bank_account"
+ ]
},
"network": {
"description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.",
@@ -204415,7 +227500,10 @@
}
},
"title": "ach_network_details_source",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "addenda"
+ ]
},
"type": {
"description": "The type of flow that originated the ReceivedDebit.",
@@ -204429,7 +227517,11 @@
"type"
],
"title": "network_details_source",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach",
+ "type"
+ ]
}
},
"required": [
@@ -204438,7 +227530,16 @@
"financial_account",
"network"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "financial_account",
+ "initiating_payment_method_details",
+ "network",
+ "network_details"
+ ]
}
}
},
@@ -204560,7 +227661,15 @@
}
},
"title": "legal_entity_and_kyc_address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"address_kana": {
"description": "The Kana variation of the company's primary address (Japan only).",
@@ -204602,7 +227711,17 @@
}
},
"title": "japan_address_kana_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"address_kanji": {
"description": "The Kanji variation of the company's primary address (Japan only).",
@@ -204644,7 +227763,17 @@
}
},
"title": "japan_address_kanji_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"directors_provided": {
"description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/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.",
@@ -204702,7 +227831,12 @@
}
},
"title": "company_ownership_declaration",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
},
"ownership_declaration_shown_and_signed": {
"description": "Whether the user described by the data in the token has been shown the Ownership Declaration and indicated that it is correct.",
@@ -204782,15 +227916,54 @@
}
},
"title": "verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
}
},
"title": "verification_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "document"
+ ]
}
},
"title": "connect_js_account_token_company_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "address_kana",
+ "address_kanji",
+ "contact_point_verification_address",
+ "cross_border_transaction_classifications",
+ "directors_provided",
+ "executives_provided",
+ "export_license_id",
+ "export_purpose_code",
+ "fiscal_code",
+ "invoicing_recipient_code",
+ "name",
+ "name_kana",
+ "name_kanji",
+ "owners_provided",
+ "ownership_declaration",
+ "ownership_declaration_shown_and_signed",
+ "pan",
+ "phone",
+ "registered_email",
+ "registration_date",
+ "registration_number",
+ "stock_data",
+ "structure",
+ "tax_deduction_account_number",
+ "tax_id",
+ "tax_id_registrar",
+ "vat_id",
+ "vat_registration_status",
+ "verification"
+ ]
},
"individual": {
"description": "Information about the person represented by the account.",
@@ -204830,7 +228003,15 @@
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"address_kana": {
"description": "The Kana variation of the individual's primary address (Japan only).",
@@ -204872,7 +228053,17 @@
}
},
"title": "japan_address_kana_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"address_kanji": {
"description": "The Kanji variation of the individual's primary address (Japan only).",
@@ -204914,7 +228105,17 @@
}
},
"title": "japan_address_kanji_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"dob": {
"anyOf": [
@@ -204939,7 +228140,12 @@
"year"
],
"title": "date_of_birth_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
{
"enum": [
@@ -205085,7 +228291,15 @@
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"relationship": {
"description": "Describes the person’s relationship to the account.",
@@ -205123,7 +228337,17 @@
}
},
"title": "individual_relationship_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "controller",
+ "director",
+ "executive",
+ "officer",
+ "owner",
+ "partner",
+ "percent_ownership",
+ "title"
+ ]
},
"ssn_last_4": {
"description": "The last four digits of the individual's Social Security Number (U.S. only).",
@@ -205148,7 +228372,11 @@
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
},
"document": {
"description": "An identifying document, either a passport or local ID card.",
@@ -205165,15 +228393,50 @@
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
}
},
"title": "person_verification_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_document",
+ "document"
+ ]
}
},
"title": "individual_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "address_kana",
+ "address_kanji",
+ "birth_city",
+ "birth_country",
+ "dob",
+ "email",
+ "first_name",
+ "first_name_kana",
+ "first_name_kanji",
+ "full_name_aliases",
+ "gender",
+ "id_number",
+ "id_number_secondary",
+ "last_name",
+ "last_name_kana",
+ "last_name_kanji",
+ "maiden_name",
+ "metadata",
+ "phone",
+ "political_exposure",
+ "registered_address",
+ "relationship",
+ "ssn_last_4",
+ "verification"
+ ]
},
"tos_shown_and_accepted": {
"description": "Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.",
@@ -205181,7 +228444,13 @@
}
},
"title": "connect_js_account_token_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "business_type",
+ "company",
+ "individual",
+ "tos_shown_and_accepted"
+ ]
},
"bank_account": {
"description": "The bank account this token will represent.",
@@ -205242,7 +228511,19 @@
],
"title": "token_create_bank_account",
"type": "object",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeMostCommon": [
+ "account_holder_name",
+ "account_holder_type",
+ "account_number",
+ "account_type",
+ "country",
+ "currency",
+ "debit_agreement_shown_and_accepted",
+ "debit_agreement_type",
+ "payment_method",
+ "routing_number"
+ ]
},
"card": {
"anyOf": [
@@ -205317,7 +228598,10 @@
}
},
"title": "networks_param_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "preferred"
+ ]
},
"number": {
"description": "The card number, as a string without any separators.",
@@ -205332,6 +228616,21 @@
],
"title": "credit_card_specs",
"type": "object",
+ "x-stripeMostCommon": [
+ "address_city",
+ "address_country",
+ "address_line1",
+ "address_line2",
+ "address_state",
+ "address_zip",
+ "currency",
+ "cvc",
+ "exp_month",
+ "exp_year",
+ "name",
+ "networks",
+ "number"
+ ],
"x-stripeParam": {
"class_name": "Card"
}
@@ -205362,7 +228661,10 @@
"cvc"
],
"title": "cvc_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "cvc"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -205376,7 +228678,7 @@
"description": "Information for the person this token represents.",
"properties": {
"additional_tos_acceptances": {
- "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
"properties": {
"account": {
"description": "Details on the legal guardian's acceptance of the main Stripe service agreement.",
@@ -205407,11 +228709,20 @@
}
},
"title": "settings_terms_of_service_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "date",
+ "ip",
+ "user_agent"
+ ]
}
},
"title": "person_additional_tos_acceptances_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "representative"
+ ]
},
"address": {
"description": "The person's address.",
@@ -205448,7 +228759,15 @@
}
},
"title": "legal_entity_and_kyc_address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"address_kana": {
"description": "The Kana variation of the person's address (Japan only).",
@@ -205490,7 +228809,17 @@
}
},
"title": "japan_address_kana_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"address_kanji": {
"description": "The Kanji variation of the person's address (Japan only).",
@@ -205532,7 +228861,17 @@
}
},
"title": "japan_address_kanji_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "db_code",
+ "line1",
+ "line2",
+ "postal_code",
+ "state",
+ "town"
+ ]
},
"dob": {
"anyOf": [
@@ -205557,7 +228896,12 @@
"year"
],
"title": "date_of_birth_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "day",
+ "month",
+ "year"
+ ]
},
{
"enum": [
@@ -205594,7 +228938,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"passport": {
"description": "One or more documents showing the person's passport page with photo and personal data.",
@@ -205619,7 +228966,10 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
},
"visa": {
"description": "One or more documents showing the person's visa required for living in the country where they are residing.",
@@ -205644,11 +228994,20 @@
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "files"
+ ]
}
},
"title": "person_documents_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "DASHBOARD_proof_of_liveness",
+ "company_authorization",
+ "passport",
+ "visa"
+ ]
},
"email": {
"description": "The person's email address.",
@@ -205787,7 +229146,15 @@
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
"relationship": {
"description": "The relationship that this person has with the account's legal entity.",
@@ -205833,7 +229200,20 @@
}
},
"title": "relationship_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "authorizer",
+ "controller",
+ "director",
+ "executive",
+ "legal_guardian",
+ "officer",
+ "owner",
+ "partner",
+ "percent_ownership",
+ "representative",
+ "title"
+ ]
},
"ssn_last_4": {
"description": "The last four digits of the person's Social Security number (U.S. only).",
@@ -205857,7 +229237,11 @@
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
},
"document": {
"description": "An identifying document, either a passport or local ID card.",
@@ -205874,15 +229258,35 @@
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "back",
+ "front"
+ ]
}
},
"title": "person_verification_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "additional_document",
+ "document"
+ ]
}
},
"title": "person_token_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "dob",
+ "email",
+ "first_name",
+ "id_number",
+ "last_name",
+ "metadata",
+ "phone",
+ "relationship",
+ "ssn_last_4"
+ ]
},
"pii": {
"description": "The PII this token represents.",
@@ -205894,10 +229298,21 @@
}
},
"title": "pii_token_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "id_number"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account",
+ "bank_account",
+ "card",
+ "cvc_update",
+ "person",
+ "pii"
+ ]
}
}
},
@@ -206028,7 +229443,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -206065,7 +229486,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -206193,6 +229620,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -206287,7 +229720,13 @@
"amount",
"currency"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "metadata"
+ ]
}
}
},
@@ -206446,7 +229885,11 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "metadata"
+ ]
}
}
},
@@ -206576,7 +230019,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -206710,6 +230159,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -206803,7 +230258,14 @@
"currency",
"destination"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "destination",
+ "metadata"
+ ]
}
}
},
@@ -206950,6 +230412,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -207038,7 +230506,12 @@
"type": "boolean"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "description",
+ "metadata"
+ ]
}
}
},
@@ -207197,7 +230670,11 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "metadata"
+ ]
}
}
},
@@ -207371,7 +230848,10 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata"
+ ]
}
}
},
@@ -207544,6 +231024,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -207605,7 +231091,11 @@
"required": [
"received_credit"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata",
+ "received_credit"
+ ]
}
}
},
@@ -207860,6 +231350,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -207921,7 +231417,11 @@
"required": [
"received_debit"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "metadata",
+ "received_debit"
+ ]
}
}
},
@@ -208052,7 +231552,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -208163,6 +231669,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -208254,7 +231766,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"deposit_insurance": {
"description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.",
@@ -208268,7 +231783,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"financial_addresses": {
"description": "Contains Features that add FinancialAddresses to the FinancialAccount.",
@@ -208285,11 +231803,19 @@
"requested"
],
"title": "aba_access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank",
+ "forwarding",
+ "requested"
+ ]
}
},
"title": "financial_addresses",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "aba"
+ ]
},
"inbound_transfers": {
"description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.",
@@ -208306,11 +231832,18 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested",
+ "same_day"
+ ]
}
},
"title": "inbound_transfers",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach"
+ ]
},
"intra_stripe_flows": {
"description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).",
@@ -208324,7 +231857,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"outbound_payments": {
"description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.",
@@ -208341,7 +231877,11 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested",
+ "same_day"
+ ]
},
"us_domestic_wire": {
"description": "Enables US domestic wire transfers via the OutboundPayments API.",
@@ -208355,11 +231895,18 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
}
},
"title": "outbound_payments",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach",
+ "us_domestic_wire"
+ ]
},
"outbound_transfers": {
"description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.",
@@ -208376,7 +231923,11 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested",
+ "same_day"
+ ]
},
"us_domestic_wire": {
"description": "Enables US domestic wire transfers via the OutboundTransfers API.",
@@ -208390,15 +231941,31 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
}
},
"title": "outbound_transfers",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach",
+ "us_domestic_wire"
+ ]
}
},
"title": "feature_access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "card_issuing",
+ "deposit_insurance",
+ "financial_addresses",
+ "inbound_transfers",
+ "intra_stripe_flows",
+ "outbound_payments",
+ "outbound_transfers"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -208428,7 +231995,13 @@
}
},
"title": "platform_restrictions",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "inbound_flows",
+ "outbound_flows",
+ "received_credits",
+ "received_debits"
+ ]
},
"supported_currencies": {
"description": "The currencies the FinancialAccount can hold a balance in.",
@@ -208442,7 +232015,14 @@
"required": [
"supported_currencies"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_name",
+ "features",
+ "metadata",
+ "platform_restrictions",
+ "supported_currencies"
+ ]
}
}
},
@@ -208620,7 +232200,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"deposit_insurance": {
"description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.",
@@ -208634,7 +232217,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"financial_addresses": {
"description": "Contains Features that add FinancialAddresses to the FinancialAccount.",
@@ -208651,11 +232237,19 @@
"requested"
],
"title": "aba_access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank",
+ "forwarding",
+ "requested"
+ ]
}
},
"title": "financial_addresses",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "aba"
+ ]
},
"inbound_transfers": {
"description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.",
@@ -208672,11 +232266,18 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested",
+ "same_day"
+ ]
}
},
"title": "inbound_transfers",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach"
+ ]
},
"intra_stripe_flows": {
"description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).",
@@ -208690,7 +232291,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"outbound_payments": {
"description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.",
@@ -208707,7 +232311,11 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested",
+ "same_day"
+ ]
},
"us_domestic_wire": {
"description": "Enables US domestic wire transfers via the OutboundPayments API.",
@@ -208721,11 +232329,18 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
}
},
"title": "outbound_payments",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach",
+ "us_domestic_wire"
+ ]
},
"outbound_transfers": {
"description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.",
@@ -208742,7 +232357,11 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested",
+ "same_day"
+ ]
},
"us_domestic_wire": {
"description": "Enables US domestic wire transfers via the OutboundTransfers API.",
@@ -208756,15 +232375,31 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
}
},
"title": "outbound_transfers",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach",
+ "us_domestic_wire"
+ ]
}
},
"title": "feature_access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "card_issuing",
+ "deposit_insurance",
+ "financial_addresses",
+ "inbound_transfers",
+ "intra_stripe_flows",
+ "outbound_payments",
+ "outbound_transfers"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -208794,10 +232429,22 @@
}
},
"title": "platform_restrictions",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "inbound_flows",
+ "outbound_flows",
+ "received_credits",
+ "received_debits"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "display_name",
+ "features",
+ "metadata",
+ "platform_restrictions"
+ ]
}
}
},
@@ -208961,7 +232608,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"deposit_insurance": {
"description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.",
@@ -208975,7 +232625,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -209000,11 +232653,19 @@
"requested"
],
"title": "aba_access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "bank",
+ "forwarding",
+ "requested"
+ ]
}
},
"title": "financial_addresses",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "aba"
+ ]
},
"inbound_transfers": {
"description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.",
@@ -209021,11 +232682,18 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested",
+ "same_day"
+ ]
}
},
"title": "inbound_transfers",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach"
+ ]
},
"intra_stripe_flows": {
"description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).",
@@ -209039,7 +232707,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
},
"outbound_payments": {
"description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.",
@@ -209056,7 +232727,11 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested",
+ "same_day"
+ ]
},
"us_domestic_wire": {
"description": "Enables US domestic wire transfers via the OutboundPayments API.",
@@ -209070,11 +232745,18 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
}
},
"title": "outbound_payments",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach",
+ "us_domestic_wire"
+ ]
},
"outbound_transfers": {
"description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.",
@@ -209091,7 +232773,11 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested",
+ "same_day"
+ ]
},
"us_domestic_wire": {
"description": "Enables US domestic wire transfers via the OutboundTransfers API.",
@@ -209105,14 +232791,30 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "requested"
+ ]
}
},
"title": "outbound_transfers",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach",
+ "us_domestic_wire"
+ ]
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "card_issuing",
+ "deposit_insurance",
+ "financial_addresses",
+ "inbound_transfers",
+ "intra_stripe_flows",
+ "outbound_payments",
+ "outbound_transfers"
+ ]
}
}
},
@@ -209275,6 +232977,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -209361,7 +233069,16 @@
"financial_account",
"origin_payment_method"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "financial_account",
+ "metadata",
+ "origin_payment_method",
+ "statement_descriptor"
+ ]
}
}
},
@@ -209559,7 +233276,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -209709,6 +233432,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -209823,7 +233552,15 @@
}
},
"title": "billing_details_address",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "city",
+ "country",
+ "line1",
+ "line2",
+ "postal_code",
+ "state"
+ ]
},
{
"enum": [
@@ -209880,7 +233617,13 @@
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "address",
+ "email",
+ "name",
+ "phone"
+ ]
},
"financial_account": {
"description": "Required if type is set to `financial_account`. The FinancialAccount ID to send funds to.",
@@ -209937,14 +233680,26 @@
}
},
"title": "payment_method_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "account_holder_type",
+ "account_number",
+ "account_type",
+ "financial_connections_account",
+ "routing_number"
+ ]
}
},
"required": [
"type"
],
"title": "payment_method_data",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "billing_details",
+ "metadata",
+ "type"
+ ]
},
"destination_payment_method_options": {
"description": "Payment method-specific configuration for this OutboundPayment.",
@@ -209963,7 +233718,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach",
+ "network"
+ ]
},
{
"enum": [
@@ -209976,7 +233735,10 @@
}
},
"title": "payment_method_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "us_bank_account"
+ ]
},
"end_user_details": {
"description": "End user details.",
@@ -209994,7 +233756,11 @@
"present"
],
"title": "end_user_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ip_address",
+ "present"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -210026,7 +233792,20 @@
"currency",
"financial_account"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "customer",
+ "description",
+ "destination_payment_method",
+ "destination_payment_method_data",
+ "destination_payment_method_options",
+ "end_user_details",
+ "financial_account",
+ "metadata",
+ "statement_descriptor"
+ ]
}
}
},
@@ -210325,6 +234104,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -210405,7 +234190,11 @@
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach",
+ "network"
+ ]
},
{
"enum": [
@@ -210418,7 +234207,10 @@
}
},
"title": "payment_method_options",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "us_bank_account"
+ ]
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -210452,7 +234244,10 @@
}
},
"title": "ach_network_details_source",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "addenda"
+ ]
},
"type": {
"description": "The type of flow that originated the OutboundTransfer.",
@@ -210466,7 +234261,11 @@
"type"
],
"title": "network_details_source",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "ach",
+ "type"
+ ]
},
"statement_descriptor": {
"description": "Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is \"transfer\".",
@@ -210479,7 +234278,18 @@
"currency",
"financial_account"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "amount",
+ "currency",
+ "description",
+ "destination_payment_method",
+ "destination_payment_method_options",
+ "financial_account",
+ "metadata",
+ "network_details",
+ "statement_descriptor"
+ ]
}
}
},
@@ -210719,7 +234529,10 @@
"source_flow_type"
],
"title": "linked_flows_param",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "source_flow_type"
+ ]
},
"style": "deepObject"
},
@@ -210804,6 +234617,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -211023,6 +234842,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -211143,7 +234968,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -211179,7 +235010,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -211326,6 +235163,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -211446,7 +235289,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -211572,7 +235421,13 @@
}
},
"title": "range_query_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
},
{
"type": "integer"
@@ -211582,7 +235437,10 @@
}
},
"title": "status_transition_timestamp_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "posted_at"
+ ]
},
"style": "deepObject"
}
@@ -211641,6 +235499,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -211835,6 +235699,12 @@
"type": "object",
"x-expandableFields": [
"data"
+ ],
+ "x-stripeMostCommon": [
+ "data",
+ "has_more",
+ "object",
+ "url"
]
}
}
@@ -212027,6 +235897,7 @@
"application_fee.refunded",
"balance.available",
"billing.alert.triggered",
+ "billing.meter_error_report.triggered",
"billing_portal.configuration.created",
"billing_portal.configuration.updated",
"billing_portal.session.created",
@@ -212318,7 +236189,14 @@
"enabled_events",
"url"
],
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "api_version",
+ "description",
+ "enabled_events",
+ "metadata",
+ "url"
+ ]
}
}
},
@@ -212542,6 +236420,7 @@
"application_fee.refunded",
"balance.available",
"billing.alert.triggered",
+ "billing.meter_error_report.triggered",
"billing_portal.configuration.created",
"billing_portal.configuration.updated",
"billing_portal.session.created",
@@ -212829,7 +236708,13 @@
"type": "string"
}
},
- "type": "object"
+ "type": "object",
+ "x-stripeMostCommon": [
+ "description",
+ "enabled_events",
+ "metadata",
+ "url"
+ ]
}
}
},
diff --git a/embedded/openapi/spec3.json b/embedded/openapi/spec3.json
index cb13f760..7ea07f61 100644
--- a/embedded/openapi/spec3.json
+++ b/embedded/openapi/spec3.json
@@ -3234,7 +3234,8 @@
"enum": [
"usage_threshold"
],
- "type": "string"
+ "type": "string",
+ "x-stripeBypassValidation": true
},
"filter": {
"anyOf": [
@@ -3562,6 +3563,35 @@
"x-expandableFields": [],
"x-resourceId": "billing.meter_event_summary"
},
+ "billing_clocks_resource_status_details_advancing_status_details": {
+ "description": "",
+ "properties": {
+ "target_frozen_time": {
+ "description": "The `frozen_time` that the Test Clock is advancing towards.",
+ "format": "unix-time",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "target_frozen_time"
+ ],
+ "title": "BillingClocksResourceStatusDetailsAdvancingStatusDetails",
+ "type": "object",
+ "x-expandableFields": []
+ },
+ "billing_clocks_resource_status_details_status_details": {
+ "description": "",
+ "properties": {
+ "advancing": {
+ "$ref": "#/components/schemas/billing_clocks_resource_status_details_advancing_status_details"
+ }
+ },
+ "title": "BillingClocksResourceStatusDetailsStatusDetails",
+ "type": "object",
+ "x-expandableFields": [
+ "advancing"
+ ]
+ },
"billing_details": {
"description": "",
"properties": {
@@ -4777,7 +4807,7 @@
"$ref": "#/components/schemas/transfer"
}
],
- "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.",
+ "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -4788,13 +4818,13 @@
}
},
"statement_descriptor": {
- "description": "For a non-card charge, text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors). This value overrides the account's default statement descriptor. For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
+ "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -5408,7 +5438,7 @@
"type": "string"
},
"redirect_on_completion": {
- "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`.",
+ "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.",
"enum": [
"always",
"if_required",
@@ -9568,7 +9598,7 @@
"x-resourceId": "customer_cash_balance_transaction"
},
"customer_session": {
- "description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.",
+ "description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.\n\nRelated guides: [Customer Session with the Payment Element](/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),\n[Customer Session with the Pricing Table](/payments/checkout/pricing-table#customer-session),\n[Customer Session with the Buy Button](/payment-links/buy-button#pass-an-existing-customer).",
"properties": {
"client_secret": {
"description": "The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.",
@@ -12179,6 +12209,7 @@
"finance_report_run",
"identity_document",
"identity_document_downloadable",
+ "issuing_regulatory_reporting",
"pci_document",
"selfie",
"sigma_scheduled_query",
@@ -16640,7 +16671,7 @@
"description": "",
"properties": {
"type": {
- "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
+ "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -16674,6 +16705,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -17877,6 +17909,14 @@
"maxLength": 5000,
"type": "string"
},
+ "status": {
+ "description": "The current processing status of this settlement.",
+ "enum": [
+ "complete",
+ "pending"
+ ],
+ "type": "string"
+ },
"transaction_count": {
"description": "The total number of transactions reflected in this settlement.",
"type": "integer"
@@ -17901,6 +17941,7 @@
"network_settlement_identifier",
"object",
"settlement_service",
+ "status",
"transaction_count",
"transaction_volume"
],
@@ -22919,7 +22960,6 @@
"amount_tax",
"amount_total",
"currency",
- "description",
"id",
"object"
],
@@ -23359,7 +23399,7 @@
"x-expandableFields": []
},
"line_item": {
- "description": "",
+ "description": "Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice.\n\nEach line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items).",
"properties": {
"amount": {
"description": "The amount, in cents (or local equivalent).",
@@ -23572,6 +23612,8 @@
"object",
"period",
"proration",
+ "tax_amounts",
+ "tax_rates",
"type"
],
"title": "InvoiceLineItem",
@@ -24683,6 +24725,27 @@
"type": "object",
"x-expandableFields": []
},
+ "payment_flows_private_payment_methods_card_present_common_wallet": {
+ "description": "",
+ "properties": {
+ "type": {
+ "description": "The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.",
+ "enum": [
+ "apple_pay",
+ "google_pay",
+ "samsung_pay",
+ "unknown"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet",
+ "type": "object",
+ "x-expandableFields": []
+ },
"payment_flows_private_payment_methods_klarna_dob": {
"description": "",
"properties": {
@@ -24842,7 +24905,7 @@
"$ref": "#/components/schemas/deleted_customer"
}
],
- "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
+ "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -25063,13 +25126,13 @@
"nullable": true
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -28962,6 +29025,9 @@
],
"nullable": true,
"type": "string"
+ },
+ "wallet": {
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet"
}
},
"required": [
@@ -28972,7 +29038,8 @@
"type": "object",
"x-expandableFields": [
"networks",
- "offline"
+ "offline",
+ "wallet"
]
},
"payment_method_card_present_networks": {
@@ -30371,7 +30438,7 @@
"type": "string"
},
"network_transaction_id": {
- "description": "This is used by the financial networks to identify a transaction.\nVisa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.\nThe first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD).\nThis field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
+ "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -30418,6 +30485,9 @@
],
"description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.",
"nullable": true
+ },
+ "wallet": {
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet"
}
},
"required": [
@@ -30430,7 +30500,8 @@
"type": "object",
"x-expandableFields": [
"offline",
- "receipt"
+ "receipt",
+ "wallet"
]
},
"payment_method_details_card_present_offline": {
@@ -31053,7 +31124,7 @@
"type": "string"
},
"network_transaction_id": {
- "description": "This is used by the financial networks to identify a transaction.\nVisa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.\nThe first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD).\nThis field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
+ "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -34313,7 +34384,7 @@
"description": "",
"properties": {
"type": {
- "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
+ "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -34347,6 +34418,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -39938,7 +40010,7 @@
"$ref": "#/components/schemas/payment_method"
}
],
- "description": "ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.corp.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.",
+ "description": "ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -45045,7 +45117,7 @@
"nullable": true
},
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -45079,6 +45151,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -45672,7 +45745,7 @@
"description": "",
"properties": {
"type": {
- "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
+ "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -45706,6 +45779,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -47266,6 +47340,9 @@
"ready"
],
"type": "string"
+ },
+ "status_details": {
+ "$ref": "#/components/schemas/billing_clocks_resource_status_details_status_details"
}
},
"required": [
@@ -47279,7 +47356,9 @@
],
"title": "TestClock",
"type": "object",
- "x-expandableFields": [],
+ "x-expandableFields": [
+ "status_details"
+ ],
"x-resourceId": "test_helpers.test_clock"
},
"three_d_secure_details": {
@@ -47907,7 +47986,7 @@
"$ref": "#/components/schemas/charge"
}
],
- "description": "ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.",
+ "description": "ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -48664,7 +48743,7 @@
"x-resourceId": "treasury.financial_account_features"
},
"treasury.inbound_transfer": {
- "description": "Use [InboundTransfers](https://stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.",
+ "description": "Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.\n\nRelated guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)",
"properties": {
"amount": {
"description": "Amount (in cents) transferred.",
@@ -48822,7 +48901,7 @@
"x-resourceId": "treasury.inbound_transfer"
},
"treasury.outbound_payment": {
- "description": "Use OutboundPayments to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.",
+ "description": "Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)",
"properties": {
"amount": {
"description": "Amount (in cents) transferred.",
@@ -49003,7 +49082,7 @@
"x-resourceId": "treasury.outbound_payment"
},
"treasury.outbound_transfer": {
- "description": "Use OutboundTransfers to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.",
+ "description": "Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)",
"properties": {
"amount": {
"description": "Amount (in cents) transferred.",
@@ -51310,9 +51389,6 @@
"type": "string"
}
},
- "required": [
- "fields"
- ],
"title": "collection_options_params",
"type": "object"
},
@@ -57031,7 +57107,7 @@
"additionalProperties": false,
"properties": {
"additional_tos_acceptances": {
- "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
"properties": {
"account": {
"properties": {
@@ -57747,7 +57823,7 @@
"additionalProperties": false,
"properties": {
"additional_tos_acceptances": {
- "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
"properties": {
"account": {
"properties": {
@@ -58478,7 +58554,7 @@
"additionalProperties": false,
"properties": {
"additional_tos_acceptances": {
- "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
"properties": {
"account": {
"properties": {
@@ -59194,7 +59270,7 @@
"additionalProperties": false,
"properties": {
"additional_tos_acceptances": {
- "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
"properties": {
"account": {
"properties": {
@@ -61831,7 +61907,8 @@
"enum": [
"usage_threshold"
],
- "type": "string"
+ "type": "string",
+ "x-stripeBypassValidation": true
},
"style": "form"
},
@@ -61994,7 +62071,8 @@
"enum": [
"usage_threshold"
],
- "type": "string"
+ "type": "string",
+ "x-stripeBypassValidation": true
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -62010,6 +62088,14 @@
"customer": {
"maxLength": 5000,
"type": "string"
+ },
+ "subscription": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "subscription_item": {
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "alert_filter",
@@ -64965,12 +65051,12 @@
"x-stripeBypassValidation": true
},
"statement_descriptor": {
- "description": "For a non-card charge, text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors). This value overrides the account's default statement descriptor. For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
+ "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
"maxLength": 22,
"type": "string"
},
@@ -65472,12 +65558,12 @@
"type": "string"
},
"statement_descriptor": {
- "description": "For a non-card charge, text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors). This value overrides the account's default statement descriptor. For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
+ "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
"maxLength": 22,
"type": "string"
},
@@ -68370,7 +68456,7 @@
"type": "object"
},
"redirect_on_completion": {
- "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`.",
+ "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.",
"enum": [
"always",
"if_required",
@@ -73215,6 +73301,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -80676,7 +80763,7 @@
"type": "array"
},
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -80710,6 +80797,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -82852,7 +82940,7 @@
"type": "integer"
},
"file": {
- "description": "The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.",
+ "description": "The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.",
"maxLength": 5000,
"type": "string"
},
@@ -83176,6 +83264,7 @@
"finance_report_run",
"identity_document",
"identity_document_downloadable",
+ "issuing_regulatory_reporting",
"pci_document",
"selfie",
"sigma_scheduled_query",
@@ -83347,6 +83436,7 @@
"customer_signature",
"dispute_evidence",
"identity_document",
+ "issuing_regulatory_reporting",
"pci_document",
"tax_document_user_upload",
"terminal_reader_splashscreen"
@@ -88260,6 +88350,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -88364,7 +88455,7 @@
"type": "array"
},
"invoice_items": {
- "description": "List of invoice items to add or update in the upcoming invoice preview.",
+ "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).",
"items": {
"properties": {
"amount": {
@@ -89799,6 +89890,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -89919,7 +90011,7 @@
"style": "deepObject"
},
{
- "description": "List of invoice items to add or update in the upcoming invoice preview.",
+ "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).",
"explode": true,
"in": "query",
"name": "invoice_items",
@@ -91621,6 +91713,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -91752,7 +91845,7 @@
"style": "deepObject"
},
{
- "description": "List of invoice items to add or update in the upcoming invoice preview.",
+ "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).",
"explode": true,
"in": "query",
"name": "invoice_items",
@@ -106773,7 +106866,7 @@
"type": "string"
},
"customer": {
- "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
+ "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
"maxLength": 5000,
"type": "string"
},
@@ -109293,12 +109386,12 @@
"type": "object"
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
"type": "string"
},
@@ -109662,7 +109755,7 @@
"type": "string"
},
"customer": {
- "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
+ "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
"maxLength": 5000,
"type": "string"
},
@@ -112106,12 +112199,12 @@
"description": "Shipping information for this PaymentIntent."
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
"type": "string"
},
@@ -112388,12 +112481,12 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
"type": "string"
},
@@ -112440,7 +112533,7 @@
},
"/v1/payment_intents/{intent}/confirm": {
"post": {
- "description": "Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\nIf the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent transitions to the requires_payment_method status or the\ncanceled status if the confirmation limit is reached. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).\nIf the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.\nIf the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.\nIf any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt.
",
+ "description": "Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\nIf the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent transitions to the requires_payment_method status or the\ncanceled status if the confirmation limit is reached. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).\nIf the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.\nIf the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.\nIf any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt.\nThere is a variable upper limit on how many times a PaymentIntent can be confirmed.\nAfter this limit is reached, any further calls to this endpoint will\ntransition the PaymentIntent to the canceled state.
",
"operationId": "PostPaymentIntentsIntentConfirm",
"parameters": [
{
@@ -115171,7 +115264,7 @@
"type": "object"
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).",
"maxLength": 22,
"type": "string"
},
@@ -127005,7 +127098,7 @@
"type": "string"
}
],
- "description": "The discounts applied to the quote. You can only set up to one discount."
+ "description": "The discounts applied to the quote."
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -127637,7 +127730,7 @@
"type": "string"
}
],
- "description": "The discounts applied to the quote. You can only set up to one discount."
+ "description": "The discounts applied to the quote."
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -128455,7 +128548,7 @@
},
"/v1/quotes/{quote}/pdf": {
"get": {
- "description": "Download the PDF for a finalized quote. Explanation for special handling can be found here
",
+ "description": "Download the PDF for a finalized quote. Explanation for special handling can be found here
",
"operationId": "GetQuotesQuotePdf",
"parameters": [
{
@@ -140945,6 +141038,7 @@
"style": "deepObject"
},
{
+ "description": "Only return subscriptions whose current_period_end falls within the given date interval.",
"explode": true,
"in": "query",
"name": "current_period_end",
@@ -140977,6 +141071,7 @@
"style": "deepObject"
},
{
+ "description": "Only return subscriptions whose current_period_start falls within the given date interval.",
"explode": true,
"in": "query",
"name": "current_period_start",
@@ -144127,6 +144222,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -147454,7 +147550,7 @@
"type": "object"
},
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -147488,6 +147584,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -150837,7 +150934,6 @@
}
},
"required": [
- "customer_consent_collected",
"setup_intent"
],
"type": "object"