checkout_p24_payment_method_options
{
"type": "object",
"title": "CheckoutP24PaymentMethodOptions",
"properties": {
"setup_future_usage": {
"enum": [
"none"
],
"type": "string",
"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)."
}
},
"description": "",
"x-expandableFields": []
}
checkout_payco_payment_method_options
{
"type": "object",
"title": "CheckoutPaycoPaymentMethodOptions",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
}
},
"description": "",
"x-expandableFields": []
}
checkout_payment_method_options_mandate_options_bacs_debit
{
"type": "object",
"title": "checkout_payment_method_options_mandate_options_bacs_debit",
"properties": {
"reference_prefix": {
"type": "string",
"maxLength": 5000,
"description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'."
}
},
"description": "",
"x-expandableFields": []
}
checkout_payment_method_options_mandate_options_sepa_debit
{
"type": "object",
"title": "checkout_payment_method_options_mandate_options_sepa_debit",
"properties": {
"reference_prefix": {
"type": "string",
"maxLength": 5000,
"description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'."
}
},
"description": "",
"x-expandableFields": []
}
checkout_paynow_payment_method_options
{
"type": "object",
"title": "CheckoutPaynowPaymentMethodOptions",
"properties": {
"setup_future_usage": {
"enum": [
"none"
],
"type": "string",
"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)."
}
},
"description": "",
"x-expandableFields": []
}
checkout_paypal_payment_method_options
{
"type": "object",
"title": "CheckoutPaypalPaymentMethodOptions",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID."
},
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"preferred_locale": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Preferred locale of the PayPal checkout page that the customer is redirected to."
},
"setup_future_usage": {
"enum": [
"none",
"off_session"
],
"type": "string",
"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)."
}
},
"description": "",
"x-expandableFields": []
}
checkout_payto_payment_method_options
{
"type": "object",
"title": "CheckoutPaytoPaymentMethodOptions",
"properties": {
"mandate_options": {
"$ref": "#/components/schemas/mandate_options_payto"
},
"setup_future_usage": {
"enum": [
"none",
"off_session"
],
"type": "string",
"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)."
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
checkout_pix_payment_method_options
{
"type": "object",
"title": "CheckoutPixPaymentMethodOptions",
"properties": {
"mandate_options": {
"$ref": "#/components/schemas/payment_method_options_mandate_options_pix"
},
"setup_future_usage": {
"enum": [
"none",
"off_session"
],
"type": "string",
"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)."
},
"amount_includes_iof": {
"enum": [
"always",
"never"
],
"type": "string",
"description": "Determines if the amount includes the IOF tax."
},
"expires_after_seconds": {
"type": "integer",
"nullable": true,
"description": "The number of seconds after which Pix payment will expire."
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
checkout_revolut_pay_payment_method_options
{
"type": "object",
"title": "CheckoutRevolutPayPaymentMethodOptions",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"setup_future_usage": {
"enum": [
"none",
"off_session"
],
"type": "string",
"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).",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
checkout_samsung_pay_payment_method_options
{
"type": "object",
"title": "CheckoutSamsungPayPaymentMethodOptions",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
}
},
"description": "",
"x-expandableFields": []
}
checkout_satispay_payment_method_options
{
"type": "object",
"title": "CheckoutSatispayPaymentMethodOptions",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
}
},
"description": "",
"x-expandableFields": []
}
checkout_sepa_debit_payment_method_options
{
"type": "object",
"title": "CheckoutSepaDebitPaymentMethodOptions",
"properties": {
"target_date": {
"type": "string",
"maxLength": 5000,
"description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
},
"mandate_options": {
"$ref": "#/components/schemas/checkout_payment_method_options_mandate_options_sepa_debit"
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"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)."
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
checkout_session_payment_method_options
{
"type": "object",
"title": "CheckoutSessionPaymentMethodOptions",
"properties": {
"eps": {
"$ref": "#/components/schemas/checkout_eps_payment_method_options"
},
"fpx": {
"$ref": "#/components/schemas/checkout_fpx_payment_method_options"
},
"p24": {
"$ref": "#/components/schemas/checkout_p24_payment_method_options"
},
"pix": {
"$ref": "#/components/schemas/checkout_pix_payment_method_options"
},
"upi": {
"$ref": "#/components/schemas/checkout_upi_payment_method_options"
},
"alma": {
"$ref": "#/components/schemas/checkout_alma_payment_method_options"
},
"card": {
"$ref": "#/components/schemas/checkout_card_payment_method_options"
},
"link": {
"$ref": "#/components/schemas/checkout_link_payment_method_options"
},
"oxxo": {
"$ref": "#/components/schemas/checkout_oxxo_payment_method_options"
},
"ideal": {
"$ref": "#/components/schemas/checkout_ideal_payment_method_options"
},
"payco": {
"$ref": "#/components/schemas/checkout_payco_payment_method_options"
},
"payto": {
"$ref": "#/components/schemas/checkout_payto_payment_method_options"
},
"swish": {
"$ref": "#/components/schemas/checkout_swish_payment_method_options"
},
"twint": {
"$ref": "#/components/schemas/checkout_twint_payment_method_options"
},
"affirm": {
"$ref": "#/components/schemas/checkout_affirm_payment_method_options"
},
"alipay": {
"$ref": "#/components/schemas/checkout_alipay_payment_method_options"
},
"billie": {
"$ref": "#/components/schemas/checkout_billie_payment_method_options"
},
"boleto": {
"$ref": "#/components/schemas/checkout_boleto_payment_method_options"
},
"klarna": {
"$ref": "#/components/schemas/checkout_klarna_payment_method_options"
},
"paynow": {
"$ref": "#/components/schemas/checkout_paynow_payment_method_options"
},
"paypal": {
"$ref": "#/components/schemas/checkout_paypal_payment_method_options"
},
"sofort": {
"$ref": "#/components/schemas/checkout_sofort_payment_method_options"
},
"cashapp": {
"$ref": "#/components/schemas/checkout_cashapp_payment_method_options"
},
"giropay": {
"$ref": "#/components/schemas/checkout_giropay_payment_method_options"
},
"grabpay": {
"$ref": "#/components/schemas/checkout_grab_pay_payment_method_options"
},
"konbini": {
"$ref": "#/components/schemas/checkout_konbini_payment_method_options"
},
"kr_card": {
"$ref": "#/components/schemas/checkout_kr_card_payment_method_options"
},
"satispay": {
"$ref": "#/components/schemas/checkout_satispay_payment_method_options"
},
"kakao_pay": {
"$ref": "#/components/schemas/checkout_kakao_pay_payment_method_options"
},
"mobilepay": {
"$ref": "#/components/schemas/checkout_mobilepay_payment_method_options"
},
"naver_pay": {
"$ref": "#/components/schemas/checkout_naver_pay_payment_method_options"
},
"acss_debit": {
"$ref": "#/components/schemas/checkout_acss_debit_payment_method_options"
},
"amazon_pay": {
"$ref": "#/components/schemas/checkout_amazon_pay_payment_method_options"
},
"bacs_debit": {
"$ref": "#/components/schemas/checkout_bacs_debit_payment_method_options"
},
"bancontact": {
"$ref": "#/components/schemas/checkout_bancontact_payment_method_options"
},
"multibanco": {
"$ref": "#/components/schemas/checkout_multibanco_payment_method_options"
},
"sepa_debit": {
"$ref": "#/components/schemas/checkout_sepa_debit_payment_method_options"
},
"revolut_pay": {
"$ref": "#/components/schemas/checkout_revolut_pay_payment_method_options"
},
"samsung_pay": {
"$ref": "#/components/schemas/checkout_samsung_pay_payment_method_options"
},
"au_becs_debit": {
"$ref": "#/components/schemas/checkout_au_becs_debit_payment_method_options"
},
"us_bank_account": {
"$ref": "#/components/schemas/checkout_us_bank_account_payment_method_options"
},
"customer_balance": {
"$ref": "#/components/schemas/checkout_customer_balance_payment_method_options"
},
"afterpay_clearpay": {
"$ref": "#/components/schemas/checkout_afterpay_clearpay_payment_method_options"
}
},
"description": "",
"x-expandableFields": [
"acss_debit",
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"boleto",
"card",
"cashapp",
"customer_balance",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"kakao_pay",
"klarna",
"konbini",
"kr_card",
"link",
"mobilepay",
"multibanco",
"naver_pay",
"oxxo",
"p24",
"payco",
"paynow",
"paypal",
"payto",
"pix",
"revolut_pay",
"samsung_pay",
"satispay",
"sepa_debit",
"sofort",
"swish",
"twint",
"upi",
"us_bank_account"
]
}
checkout_session_wallet_options
{
"type": "object",
"title": "CheckoutSessionWalletOptions",
"properties": {
"link": {
"$ref": "#/components/schemas/checkout_link_wallet_options"
}
},
"description": "",
"x-expandableFields": [
"link"
]
}
checkout_sofort_payment_method_options
{
"type": "object",
"title": "CheckoutSofortPaymentMethodOptions",
"properties": {
"setup_future_usage": {
"enum": [
"none"
],
"type": "string",
"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)."
}
},
"description": "",
"x-expandableFields": []
}
checkout_swish_payment_method_options
{
"type": "object",
"title": "CheckoutSwishPaymentMethodOptions",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent."
}
},
"description": "",
"x-expandableFields": []
}
checkout_twint_payment_method_options
{
"type": "object",
"title": "CheckoutTwintPaymentMethodOptions",
"properties": {
"setup_future_usage": {
"enum": [
"none"
],
"type": "string",
"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).",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
checkout_upi_payment_method_options
{
"type": "object",
"title": "CheckoutUPIPaymentMethodOptions",
"properties": {
"mandate_options": {
"$ref": "#/components/schemas/mandate_options_upi"
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"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)."
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
checkout_us_bank_account_payment_method_options
{
"type": "object",
"title": "CheckoutUsBankAccountPaymentMethodOptions",
"properties": {
"target_date": {
"type": "string",
"maxLength": 5000,
"description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"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)."
},
"verification_method": {
"enum": [
"automatic",
"instant"
],
"type": "string",
"description": "Bank account verification method. The default value is `automatic`.",
"x-stripeBypassValidation": true
},
"financial_connections": {
"$ref": "#/components/schemas/linked_account_options_common"
}
},
"description": "",
"x-expandableFields": [
"financial_connections"
]
}
climate.order
{
"type": "object",
"title": "ClimateRemovalsOrders",
"required": [
"amount_fees",
"amount_subtotal",
"amount_total",
"created",
"currency",
"delivery_details",
"expected_delivery_year",
"id",
"livemode",
"metadata",
"metric_tons",
"object",
"product",
"status"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"climate.order"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"awaiting_funds",
"canceled",
"confirmed",
"delivered",
"open"
],
"type": "string",
"description": "The current status of this order."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"product": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/climate.product"
}
],
"description": "Unique ID for the Climate `Product` this order is purchasing.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/climate.product"
}
]
}
},
"currency": {
"type": "string",
"maxLength": 5000,
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order."
},
"livemode": {
"type": "boolean",
"description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
},
"metadata": {
"type": "object",
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"delayed_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch."
},
"amount_fees": {
"type": "integer",
"description": "Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit."
},
"beneficiary": {
"$ref": "#/components/schemas/climate_removals_beneficiary"
},
"canceled_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Time at which the order was canceled. Measured in seconds since the Unix epoch."
},
"certificate": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "For delivered orders, a URL to a delivery certificate for the order."
},
"metric_tons": {
"type": "string",
"format": "decimal",
"description": "Quantity of carbon removal that is included in this order."
},
"amount_total": {
"type": "integer",
"description": "Total amount of the order including fees in the currency's smallest unit."
},
"confirmed_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Time at which the order was confirmed. Measured in seconds since the Unix epoch."
},
"delivered_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Time at which the order was delivered. Measured in seconds since the Unix epoch."
},
"amount_subtotal": {
"type": "integer",
"description": "Total amount of the carbon removal in the currency's smallest unit."
},
"delivery_details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/climate_removals_order_deliveries"
},
"description": "Details about the delivery of carbon removal for this order."
},
"cancellation_reason": {
"enum": [
"expired",
"product_unavailable",
"requested"
],
"type": "string",
"nullable": true,
"description": "Reason for the cancellation of this order.",
"x-stripeBypassValidation": true
},
"expected_delivery_year": {
"type": "integer",
"description": "The year this order is expected to be delivered."
},
"product_substituted_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch."
}
},
"description": "Orders represent your intent to purchase a particular Climate product. When you create an order, the\npayment is deducted from your merchant balance.",
"x-resourceId": "climate.order",
"x-expandableFields": [
"beneficiary",
"delivery_details",
"product"
]
}
climate.product
{
"type": "object",
"title": "ClimateRemovalsProducts",
"required": [
"created",
"current_prices_per_metric_ton",
"id",
"livemode",
"metric_tons_available",
"name",
"object",
"suppliers"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object. For convenience, Climate product IDs are human-readable strings\nthat start with `climsku_`. See [carbon removal inventory](https://stripe.com/docs/climate/orders/carbon-removal-inventory)\nfor a list of available carbon removal products."
},
"name": {
"type": "string",
"maxLength": 5000,
"description": "The Climate product's name."
},
"object": {
"enum": [
"climate.product"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"livemode": {
"type": "boolean",
"description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
},
"suppliers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/climate.supplier"
},
"description": "The carbon removal suppliers that fulfill orders for this Climate product."
},
"delivery_year": {
"type": "integer",
"nullable": true,
"description": "The year in which the carbon removal is expected to be delivered."
},
"metric_tons_available": {
"type": "string",
"format": "decimal",
"description": "The quantity of metric tons available for reservation."
},
"current_prices_per_metric_ton": {
"type": "object",
"description": "Current prices for a metric ton of carbon removal in a currency's smallest unit.",
"additionalProperties": {
"$ref": "#/components/schemas/climate_removals_products_price"
}
}
},
"description": "A Climate product represents a type of carbon removal unit available for reservation.\nYou can retrieve it to see the current price and availability.",
"x-resourceId": "climate.product",
"x-expandableFields": [
"current_prices_per_metric_ton",
"suppliers"
]
}
climate.supplier
{
"type": "object",
"title": "ClimateRemovalsSuppliers",
"required": [
"id",
"info_url",
"livemode",
"locations",
"name",
"object",
"removal_pathway"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"name": {
"type": "string",
"maxLength": 5000,
"description": "Name of this carbon removal supplier."
},
"object": {
"enum": [
"climate.supplier"
],
"type": "string",
"description": "String representing the object’s type. Objects of the same type share the same value."
},
"info_url": {
"type": "string",
"maxLength": 5000,
"description": "Link to a webpage to learn more about the supplier."
},
"livemode": {
"type": "boolean",
"description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
},
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/climate_removals_location"
},
"description": "The locations in which this supplier operates."
},
"removal_pathway": {
"enum": [
"biomass_carbon_removal_and_storage",
"direct_air_capture",
"enhanced_weathering",
"marine_carbon_removal"
],
"type": "string",
"description": "The scientific pathway used for carbon removal.",
"x-stripeBypassValidation": true
}
},
"description": "A supplier of carbon removal.",
"x-resourceId": "climate.supplier",
"x-expandableFields": [
"locations"
]
}
climate_removals_beneficiary
{
"type": "object",
"title": "ClimateRemovalsBeneficiary",
"required": [
"public_name"
],
"properties": {
"public_name": {
"type": "string",
"maxLength": 5000,
"description": "Publicly displayable name for the end beneficiary of carbon removal."
}
},
"description": "",
"x-expandableFields": []
}
climate_removals_location
{
"type": "object",
"title": "ClimateRemovalsLocation",
"required": [
"country"
],
"properties": {
"city": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The city where the supplier is located."
},
"region": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The state/county/province/region where the supplier is located."
},
"country": {
"type": "string",
"maxLength": 5000,
"description": "Two-letter ISO code representing the country where the supplier is located."
},
"latitude": {
"type": "number",
"nullable": true,
"description": "The geographic latitude where the supplier is located."
},
"longitude": {
"type": "number",
"nullable": true,
"description": "The geographic longitude where the supplier is located."
}
},
"description": "",
"x-expandableFields": []
}
climate_removals_order_deliveries
{
"type": "object",
"title": "ClimateRemovalsOrderDeliveries",
"required": [
"delivered_at",
"metric_tons",
"supplier"
],
"properties": {
"location": {
"anyOf": [
{
"$ref": "#/components/schemas/climate_removals_location"
}
],
"nullable": true,
"description": "Specific location of this delivery."
},
"supplier": {
"$ref": "#/components/schemas/climate.supplier"
},
"metric_tons": {
"type": "string",
"maxLength": 5000,
"description": "Quantity of carbon removal supplied by this delivery."
},
"delivered_at": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the delivery occurred. Measured in seconds since the Unix epoch."
},
"registry_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Once retired, a URL to the registry entry for the tons from this delivery."
}
},
"description": "The delivery of a specified quantity of carbon for an order.",
"x-expandableFields": [
"location",
"supplier"
]
}
climate_removals_products_price
{
"type": "object",
"title": "ClimateRemovalsProductsPrice",
"required": [
"amount_fees",
"amount_subtotal",
"amount_total"
],
"properties": {
"amount_fees": {
"type": "integer",
"description": "Fees for one metric ton of carbon removal in the currency's smallest unit."
},
"amount_total": {
"type": "integer",
"description": "Total for one metric ton of carbon removal (including fees) in the currency's smallest unit."
},
"amount_subtotal": {
"type": "integer",
"description": "Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit."
}
},
"description": "",
"x-expandableFields": []
}
confirmation_token
{
"type": "object",
"title": "ConfirmationTokensResourceConfirmationToken",
"required": [
"created",
"id",
"livemode",
"object",
"use_stripe_sdk"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"confirmation_token"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"shipping": {
"anyOf": [
{
"$ref": "#/components/schemas/confirmation_tokens_resource_shipping"
}
],
"nullable": true,
"description": "Shipping information collected on this ConfirmationToken."
},
"expires_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent."
},
"return_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Return URL used to confirm the Intent."
},
"mandate_data": {
"anyOf": [
{
"$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data"
}
],
"nullable": true,
"description": "Data used for generating a Mandate."
},
"setup_intent": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used."
},
"payment_intent": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used."
},
"use_stripe_sdk": {
"type": "boolean",
"description": "Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken."
},
"setup_future_usage": {
"enum": [
"off_session",
"on_session"
],
"type": "string",
"nullable": true,
"description": "Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property will [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete."
},
"payment_method_options": {
"anyOf": [
{
"$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options"
}
],
"nullable": true,
"description": "Payment-method-specific configuration for this ConfirmationToken."
},
"payment_method_preview": {
"anyOf": [
{
"$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_preview"
}
],
"nullable": true,
"description": "Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken."
}
},
"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://docs.stripe.com/payments/finalize-payments-on-the-server)\n- [Build two-step confirmation](https://docs.stripe.com/payments/build-a-two-step-confirmation).",
"x-resourceId": "confirmation_token",
"x-expandableFields": [
"mandate_data",
"payment_method_options",
"payment_method_preview",
"shipping"
]
}
confirmation_tokens_resource_mandate_data
{
"type": "object",
"title": "ConfirmationTokensResourceMandateData",
"required": [
"customer_acceptance"
],
"properties": {
"customer_acceptance": {
"$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance"
}
},
"description": "Data used for generating a Mandate.",
"x-expandableFields": [
"customer_acceptance"
]
}
confirmation_tokens_resource_mandate_data_resource_customer_acceptance
{
"type": "object",
"title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptance",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"maxLength": 5000,
"description": "The type of customer acceptance information included with the Mandate."
},
"online": {
"anyOf": [
{
"$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online"
}
],
"nullable": true,
"description": "If this is a Mandate accepted online, this hash contains details about the online acceptance."
}
},
"description": "This hash contains details about the customer acceptance of the Mandate.",
"x-expandableFields": [
"online"
]
}
confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online
{
"type": "object",
"title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline",
"properties": {
"ip_address": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The IP address from which the Mandate was accepted by the customer."
},
"user_agent": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user agent of the browser from which the Mandate was accepted by the customer."
}
},
"description": "This hash contains details about the online acceptance.",
"x-expandableFields": []
}
confirmation_tokens_resource_payment_method_options
{
"type": "object",
"title": "ConfirmationTokensResourcePaymentMethodOptions",
"properties": {
"card": {
"anyOf": [
{
"$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options_resource_card"
}
],
"nullable": true,
"description": "This hash contains the card payment method options."
}
},
"description": "Payment-method-specific configuration",
"x-expandableFields": [
"card"
]
}
confirmation_tokens_resource_payment_method_options_resource_card
{
"type": "object",
"title": "ConfirmationTokensResourcePaymentMethodOptionsResourceCard",
"properties": {
"cvc_token": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The `cvc_update` Token collected from the Payment Element."
},
"installments": {
"$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options_resource_card_resource_installment"
}
},
"description": "This hash contains the card payment method options.",
"x-expandableFields": [
"installments"
]
}
confirmation_tokens_resource_payment_method_options_resource_card_resource_installment
{
"type": "object",
"title": "ConfirmationTokensResourcePaymentMethodOptionsResourceCardResourceInstallment",
"properties": {
"plan": {
"$ref": "#/components/schemas/payment_method_details_card_installments_plan"
}
},
"description": "Installment configuration for payments.",
"x-expandableFields": [
"plan"
]
}
confirmation_tokens_resource_payment_method_preview
{
"type": "object",
"title": "ConfirmationTokensResourcePaymentMethodPreview",
"required": [
"billing_details",
"type"
],
"properties": {
"eps": {
"$ref": "#/components/schemas/payment_method_eps"
},
"fpx": {
"$ref": "#/components/schemas/payment_method_fpx"
},
"p24": {
"$ref": "#/components/schemas/payment_method_p24"
},
"pix": {
"$ref": "#/components/schemas/payment_method_pix"
},
"upi": {
"$ref": "#/components/schemas/payment_method_upi"
},
"zip": {
"$ref": "#/components/schemas/payment_method_zip"
},
"alma": {
"$ref": "#/components/schemas/payment_method_alma"
},
"blik": {
"$ref": "#/components/schemas/payment_method_blik"
},
"card": {
"$ref": "#/components/schemas/payment_method_card"
},
"link": {
"$ref": "#/components/schemas/payment_method_link"
},
"oxxo": {
"$ref": "#/components/schemas/payment_method_oxxo"
},
"type": {
"enum": [
"acss_debit",
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"blik",
"boleto",
"card",
"card_present",
"cashapp",
"crypto",
"custom",
"customer_balance",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"interac_present",
"kakao_pay",
"klarna",
"konbini",
"kr_card",
"link",
"mb_way",
"mobilepay",
"multibanco",
"naver_pay",
"nz_bank_account",
"oxxo",
"p24",
"pay_by_bank",
"payco",
"paynow",
"paypal",
"payto",
"pix",
"promptpay",
"revolut_pay",
"samsung_pay",
"satispay",
"sepa_debit",
"sofort",
"sunbit",
"swish",
"twint",
"upi",
"us_bank_account",
"wechat_pay",
"zip"
],
"type": "string",
"description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.",
"x-stripeBypassValidation": true
},
"ideal": {
"$ref": "#/components/schemas/payment_method_ideal"
},
"payco": {
"$ref": "#/components/schemas/payment_method_payco"
},
"payto": {
"$ref": "#/components/schemas/payment_method_payto"
},
"swish": {
"$ref": "#/components/schemas/payment_method_swish"
},
"twint": {
"$ref": "#/components/schemas/payment_method_twint"
},
"affirm": {
"$ref": "#/components/schemas/payment_method_affirm"
},
"alipay": {
"$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay"
},
"billie": {
"$ref": "#/components/schemas/payment_method_billie"
},
"boleto": {
"$ref": "#/components/schemas/payment_method_boleto"
},
"crypto": {
"$ref": "#/components/schemas/payment_method_crypto"
},
"klarna": {
"$ref": "#/components/schemas/payment_method_klarna"
},
"mb_way": {
"$ref": "#/components/schemas/payment_method_mb_way"
},
"paynow": {
"$ref": "#/components/schemas/payment_method_paynow"
},
"paypal": {
"$ref": "#/components/schemas/payment_method_paypal"
},
"sofort": {
"$ref": "#/components/schemas/payment_method_sofort"
},
"sunbit": {
"$ref": "#/components/schemas/payment_method_sunbit"
},
"cashapp": {
"$ref": "#/components/schemas/payment_method_cashapp"
},
"giropay": {
"$ref": "#/components/schemas/payment_method_giropay"
},
"grabpay": {
"$ref": "#/components/schemas/payment_method_grabpay"
},
"konbini": {
"$ref": "#/components/schemas/payment_method_konbini"
},
"kr_card": {
"$ref": "#/components/schemas/payment_method_kr_card"
},
"customer": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/customer"
}
],
"nullable": true,
"description": "The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
}
]
}
},
"satispay": {
"$ref": "#/components/schemas/payment_method_satispay"
},
"kakao_pay": {
"$ref": "#/components/schemas/payment_method_kakao_pay"
},
"mobilepay": {
"$ref": "#/components/schemas/payment_method_mobilepay"
},
"naver_pay": {
"$ref": "#/components/schemas/payment_method_naver_pay"
},
"promptpay": {
"$ref": "#/components/schemas/payment_method_promptpay"
},
"acss_debit": {
"$ref": "#/components/schemas/payment_method_acss_debit"
},
"amazon_pay": {
"$ref": "#/components/schemas/payment_method_amazon_pay"
},
"bacs_debit": {
"$ref": "#/components/schemas/payment_method_bacs_debit"
},
"bancontact": {
"$ref": "#/components/schemas/payment_method_bancontact"
},
"multibanco": {
"$ref": "#/components/schemas/payment_method_multibanco"
},
"sepa_debit": {
"$ref": "#/components/schemas/payment_method_sepa_debit"
},
"wechat_pay": {
"$ref": "#/components/schemas/payment_method_wechat_pay"
},
"pay_by_bank": {
"$ref": "#/components/schemas/payment_method_pay_by_bank"
},
"revolut_pay": {
"$ref": "#/components/schemas/payment_method_revolut_pay"
},
"samsung_pay": {
"$ref": "#/components/schemas/payment_method_samsung_pay"
},
"card_present": {
"$ref": "#/components/schemas/payment_method_card_present"
},
"au_becs_debit": {
"$ref": "#/components/schemas/payment_method_au_becs_debit"
},
"allow_redisplay": {
"enum": [
"always",
"limited",
"unspecified"
],
"type": "string",
"description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”."
},
"billing_details": {
"$ref": "#/components/schemas/billing_details"
},
"interac_present": {
"$ref": "#/components/schemas/payment_method_interac_present"
},
"nz_bank_account": {
"$ref": "#/components/schemas/payment_method_nz_bank_account"
},
"us_bank_account": {
"$ref": "#/components/schemas/payment_method_us_bank_account"
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000
},
"customer_balance": {
"$ref": "#/components/schemas/payment_method_customer_balance"
},
"afterpay_clearpay": {
"$ref": "#/components/schemas/payment_method_afterpay_clearpay"
}
},
"description": "Details of the PaymentMethod collected by Payment Element",
"x-expandableFields": [
"acss_debit",
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"billing_details",
"blik",
"boleto",
"card",
"card_present",
"cashapp",
"crypto",
"customer",
"customer_balance",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"interac_present",
"kakao_pay",
"klarna",
"konbini",
"kr_card",
"link",
"mb_way",
"mobilepay",
"multibanco",
"naver_pay",
"nz_bank_account",
"oxxo",
"p24",
"pay_by_bank",
"payco",
"paynow",
"paypal",
"payto",
"pix",
"promptpay",
"revolut_pay",
"samsung_pay",
"satispay",
"sepa_debit",
"sofort",
"sunbit",
"swish",
"twint",
"upi",
"us_bank_account",
"wechat_pay",
"zip"
]
}
confirmation_tokens_resource_shipping
{
"type": "object",
"title": "ConfirmationTokensResourceShipping",
"required": [
"address",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 5000,
"description": "Recipient name."
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Recipient phone (including extension)."
},
"address": {
"$ref": "#/components/schemas/address"
}
},
"description": "",
"x-expandableFields": [
"address"
]
}
connect_account_reference
{
"type": "object",
"title": "ConnectAccountReference",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"account",
"self"
],
"type": "string",
"description": "Type of the account referenced.",
"x-stripeBypassValidation": true
},
"account": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/account"
}
],
"description": "The connected account being referenced when `type` is `account`.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/account"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"account"
]
}
connect_collection_transfer
{
"type": "object",
"title": "ConnectCollectionTransfer",
"required": [
"amount",
"currency",
"destination",
"id",
"livemode",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "Amount transferred, in cents (or local equivalent)."
},
"object": {
"enum": [
"connect_collection_transfer"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"currency": {
"type": "string",
"format": "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)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"destination": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/account"
}
],
"description": "ID of the account that funds are being collected for.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/account"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"destination"
]
}
connect_embedded_account_config_claim
{
"type": "object",
"title": "ConnectEmbeddedAccountConfigClaim",
"required": [
"enabled",
"features"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the embedded component is enabled."
},
"features": {
"$ref": "#/components/schemas/connect_embedded_account_features_claim"
}
},
"description": "",
"x-expandableFields": [
"features"
]
}
connect_embedded_account_features_claim
{
"type": "object",
"title": "ConnectEmbeddedAccountFeaturesClaim",
"required": [
"disable_stripe_user_authentication",
"external_account_collection"
],
"properties": {
"external_account_collection": {
"type": "boolean",
"description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`."
},
"disable_stripe_user_authentication": {
"type": "boolean",
"description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."
}
},
"description": "",
"x-expandableFields": []
}
connect_embedded_account_session_create_components
{
"type": "object",
"title": "ConnectEmbeddedAccountSessionCreateComponents",
"required": [
"account_management",
"account_onboarding",
"balance_report",
"balances",
"disputes_list",
"documents",
"financial_account",
"financial_account_transactions",
"instant_payouts_promotion",
"issuing_card",
"issuing_cards_list",
"notification_banner",
"payment_details",
"payment_disputes",
"payments",
"payout_details",
"payout_reconciliation_report",
"payouts",
"payouts_list",
"tax_registrations",
"tax_settings"
],
"properties": {
"payouts": {
"$ref": "#/components/schemas/connect_embedded_payouts_config"
},
"balances": {
"$ref": "#/components/schemas/connect_embedded_payouts_config"
},
"payments": {
"$ref": "#/components/schemas/connect_embedded_payments_config_claim"
},
"documents": {
"$ref": "#/components/schemas/connect_embedded_base_config_claim"
},
"issuing_card": {
"$ref": "#/components/schemas/connect_embedded_issuing_card_config_claim"
},
"payouts_list": {
"$ref": "#/components/schemas/connect_embedded_base_config_claim"
},
"tax_settings": {
"$ref": "#/components/schemas/connect_embedded_base_config_claim"
},
"disputes_list": {
"$ref": "#/components/schemas/connect_embedded_disputes_list_config"
},
"balance_report": {
"$ref": "#/components/schemas/connect_embedded_base_config_claim"
},
"payout_details": {
"$ref": "#/components/schemas/connect_embedded_base_config_claim"
},
"payment_details": {
"$ref": "#/components/schemas/connect_embedded_payments_config_claim"
},
"payment_disputes": {
"$ref": "#/components/schemas/connect_embedded_payment_disputes_config"
},
"financial_account": {
"$ref": "#/components/schemas/connect_embedded_financial_account_config_claim"
},
"tax_registrations": {
"$ref": "#/components/schemas/connect_embedded_base_config_claim"
},
"account_management": {
"$ref": "#/components/schemas/connect_embedded_account_config_claim"
},
"account_onboarding": {
"$ref": "#/components/schemas/connect_embedded_account_config_claim"
},
"issuing_cards_list": {
"$ref": "#/components/schemas/connect_embedded_issuing_cards_list_config_claim"
},
"notification_banner": {
"$ref": "#/components/schemas/connect_embedded_account_config_claim"
},
"instant_payouts_promotion": {
"$ref": "#/components/schemas/connect_embedded_instant_payouts_promotion_config"
},
"payout_reconciliation_report": {
"$ref": "#/components/schemas/connect_embedded_base_config_claim"
},
"financial_account_transactions": {
"$ref": "#/components/schemas/connect_embedded_financial_account_transactions_config_claim"
}
},
"description": "",
"x-expandableFields": [
"account_management",
"account_onboarding",
"balance_report",
"balances",
"disputes_list",
"documents",
"financial_account",
"financial_account_transactions",
"instant_payouts_promotion",
"issuing_card",
"issuing_cards_list",
"notification_banner",
"payment_details",
"payment_disputes",
"payments",
"payout_details",
"payout_reconciliation_report",
"payouts",
"payouts_list",
"tax_registrations",
"tax_settings"
]
}
connect_embedded_base_config_claim
{
"type": "object",
"title": "ConnectEmbeddedBaseConfigClaim",
"required": [
"enabled",
"features"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the embedded component is enabled."
},
"features": {
"$ref": "#/components/schemas/connect_embedded_base_features"
}
},
"description": "",
"x-expandableFields": [
"features"
]
}
connect_embedded_base_features
{
"type": "object",
"title": "ConnectEmbeddedBaseFeatures",
"properties": {},
"description": "",
"x-expandableFields": []
}
connect_embedded_disputes_list_config
{
"type": "object",
"title": "ConnectEmbeddedDisputesListConfig",
"required": [
"enabled",
"features"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the embedded component is enabled."
},
"features": {
"$ref": "#/components/schemas/connect_embedded_disputes_list_features"
}
},
"description": "",
"x-expandableFields": [
"features"
]
}
connect_embedded_disputes_list_features
{
"type": "object",
"title": "ConnectEmbeddedDisputesListFeatures",
"required": [
"capture_payments",
"destination_on_behalf_of_charge_management",
"dispute_management",
"refund_management"
],
"properties": {
"capture_payments": {
"type": "boolean",
"description": "Whether to allow capturing and cancelling payment intents. This is `true` by default."
},
"refund_management": {
"type": "boolean",
"description": "Whether sending refunds is enabled. This is `true` by default."
},
"dispute_management": {
"type": "boolean",
"description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default."
},
"destination_on_behalf_of_charge_management": {
"type": "boolean",
"description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default."
}
},
"description": "",
"x-expandableFields": []
}
connect_embedded_financial_account_config_claim
{
"type": "object",
"title": "ConnectEmbeddedFinancialAccountConfigClaim",
"required": [
"enabled",
"features"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the embedded component is enabled."
},
"features": {
"$ref": "#/components/schemas/connect_embedded_financial_account_features"
}
},
"description": "",
"x-expandableFields": [
"features"
]
}
connect_embedded_financial_account_features
{
"type": "object",
"title": "ConnectEmbeddedFinancialAccountFeatures",
"required": [
"disable_stripe_user_authentication",
"external_account_collection",
"send_money",
"transfer_balance"
],
"properties": {
"send_money": {
"type": "boolean",
"description": "Whether to allow sending money."
},
"transfer_balance": {
"type": "boolean",
"description": "Whether to allow transferring balance."
},
"external_account_collection": {
"type": "boolean",
"description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`."
},
"disable_stripe_user_authentication": {
"type": "boolean",
"description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."
}
},
"description": "",
"x-expandableFields": []
}
connect_embedded_financial_account_transactions_config_claim
{
"type": "object",
"title": "ConnectEmbeddedFinancialAccountTransactionsConfigClaim",
"required": [
"enabled",
"features"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the embedded component is enabled."
},
"features": {
"$ref": "#/components/schemas/connect_embedded_financial_account_transactions_features"
}
},
"description": "",
"x-expandableFields": [
"features"
]
}
connect_embedded_financial_account_transactions_features
{
"type": "object",
"title": "ConnectEmbeddedFinancialAccountTransactionsFeatures",
"required": [
"card_spend_dispute_management"
],
"properties": {
"card_spend_dispute_management": {
"type": "boolean",
"description": "Whether to allow card spend dispute management features."
}
},
"description": "",
"x-expandableFields": []
}
connect_embedded_instant_payouts_promotion_config
{
"type": "object",
"title": "ConnectEmbeddedInstantPayoutsPromotionConfig",
"required": [
"enabled",
"features"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the embedded component is enabled."
},
"features": {
"$ref": "#/components/schemas/connect_embedded_instant_payouts_promotion_features"
}
},
"description": "",
"x-expandableFields": [
"features"
]
}
connect_embedded_instant_payouts_promotion_features
{
"type": "object",
"title": "ConnectEmbeddedInstantPayoutsPromotionFeatures",
"required": [
"disable_stripe_user_authentication",
"external_account_collection",
"instant_payouts"
],
"properties": {
"instant_payouts": {
"type": "boolean",
"description": "Whether to allow creation of instant payouts. The default value is `enabled` when Stripe is responsible for negative account balances, and `use_dashboard_rules` otherwise."
},
"external_account_collection": {
"type": "boolean",
"description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`."
},
"disable_stripe_user_authentication": {
"type": "boolean",
"description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."
}
},
"description": "",
"x-expandableFields": []
}