customer_session_resource_components
{
"type": "object",
"title": "CustomerSessionResourceComponents",
"required": [
"buy_button",
"customer_sheet",
"mobile_payment_element",
"payment_element",
"pricing_table"
],
"properties": {
"buy_button": {
"$ref": "#/components/schemas/customer_session_resource_components_resource_buy_button"
},
"pricing_table": {
"$ref": "#/components/schemas/customer_session_resource_components_resource_pricing_table"
},
"customer_sheet": {
"$ref": "#/components/schemas/customer_session_resource_components_resource_customer_sheet"
},
"payment_element": {
"$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element"
},
"mobile_payment_element": {
"$ref": "#/components/schemas/customer_session_resource_components_resource_mobile_payment_element"
}
},
"description": "Configuration for the components supported by this Customer Session.",
"x-expandableFields": [
"buy_button",
"customer_sheet",
"mobile_payment_element",
"payment_element",
"pricing_table"
]
}
customer_session_resource_components_resource_buy_button
{
"type": "object",
"title": "CustomerSessionResourceComponentsResourceBuyButton",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the buy button is enabled."
}
},
"description": "This hash contains whether the buy button is enabled.",
"x-expandableFields": []
}
customer_session_resource_components_resource_customer_sheet
{
"type": "object",
"title": "CustomerSessionResourceComponentsResourceCustomerSheet",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the customer sheet is enabled."
},
"features": {
"anyOf": [
{
"$ref": "#/components/schemas/customer_session_resource_components_resource_customer_sheet_resource_features"
}
],
"nullable": true,
"description": "This hash defines whether the customer sheet supports certain features."
}
},
"description": "This hash contains whether the customer sheet is enabled and the features it supports.",
"x-expandableFields": [
"features"
]
}
customer_session_resource_components_resource_customer_sheet_resource_features
{
"type": "object",
"title": "CustomerSessionResourceComponentsResourceCustomerSheetResourceFeatures",
"properties": {
"payment_method_remove": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"nullable": true,
"description": "Controls whether the customer sheet displays the option to remove a saved payment method.\"\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).",
"x-stripeBypassValidation": true
},
"payment_method_allow_redisplay_filters": {
"type": "array",
"items": {
"enum": [
"always",
"limited",
"unspecified"
],
"type": "string"
},
"nullable": true,
"description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the customer sheet displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"]."
}
},
"description": "This hash contains the features the customer sheet supports.",
"x-expandableFields": []
}
customer_session_resource_components_resource_mobile_payment_element
{
"type": "object",
"title": "CustomerSessionResourceComponentsResourceMobilePaymentElement",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the mobile payment element is enabled."
},
"features": {
"anyOf": [
{
"$ref": "#/components/schemas/customer_session_resource_components_resource_mobile_payment_element_resource_features"
}
],
"nullable": true,
"description": "This hash defines whether the mobile payment element supports certain features."
}
},
"description": "This hash contains whether the mobile payment element is enabled and the features it supports.",
"x-expandableFields": [
"features"
]
}
customer_session_resource_components_resource_mobile_payment_element_resource_features
{
"type": "object",
"title": "CustomerSessionResourceComponentsResourceMobilePaymentElementResourceFeatures",
"properties": {
"payment_method_save": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"nullable": true,
"description": "Controls whether the mobile payment element displays a checkbox offering to save a new payment method.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.",
"x-stripeBypassValidation": true
},
"payment_method_remove": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"nullable": true,
"description": "Controls whether the mobile payment element displays the option to remove a saved payment method.\"\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).",
"x-stripeBypassValidation": true
},
"payment_method_redisplay": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"nullable": true,
"description": "Controls whether or not the mobile payment element shows saved payment methods.",
"x-stripeBypassValidation": true
},
"payment_method_allow_redisplay_filters": {
"type": "array",
"items": {
"enum": [
"always",
"limited",
"unspecified"
],
"type": "string"
},
"nullable": true,
"description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the mobile payment element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"]."
},
"payment_method_save_allow_redisplay_override": {
"enum": [
"always",
"limited",
"unspecified"
],
"type": "string",
"nullable": true,
"description": "Allows overriding the value of allow_override when saving a new payment method when payment_method_save is set to disabled. Use values: \"always\", \"limited\", or \"unspecified\".\n\nIf not specified, defaults to `nil` (no override value)."
}
},
"description": "This hash contains the features the mobile payment element supports.",
"x-expandableFields": []
}
customer_session_resource_components_resource_payment_element
{
"type": "object",
"title": "CustomerSessionResourceComponentsResourcePaymentElement",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the Payment Element is enabled."
},
"features": {
"anyOf": [
{
"$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element_resource_features"
}
],
"nullable": true,
"description": "This hash defines whether the Payment Element supports certain features."
}
},
"description": "This hash contains whether the Payment Element is enabled and the features it supports.",
"x-expandableFields": [
"features"
]
}
customer_session_resource_components_resource_payment_element_resource_features
{
"type": "object",
"title": "CustomerSessionResourceComponentsResourcePaymentElementResourceFeatures",
"required": [
"payment_method_allow_redisplay_filters",
"payment_method_redisplay",
"payment_method_remove",
"payment_method_save"
],
"properties": {
"payment_method_save": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"description": "Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.",
"x-stripeBypassValidation": true
},
"payment_method_remove": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"description": "Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).",
"x-stripeBypassValidation": true
},
"payment_method_redisplay": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"description": "Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.",
"x-stripeBypassValidation": true
},
"payment_method_save_usage": {
"enum": [
"off_session",
"on_session"
],
"type": "string",
"nullable": true,
"description": "When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.\n\nWhen using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation."
},
"payment_method_redisplay_limit": {
"type": "integer",
"nullable": true,
"description": "Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`."
},
"payment_method_allow_redisplay_filters": {
"type": "array",
"items": {
"enum": [
"always",
"limited",
"unspecified"
],
"type": "string"
},
"description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"]."
}
},
"description": "This hash contains the features the Payment Element supports.",
"x-expandableFields": []
}
customer_session_resource_components_resource_pricing_table
{
"type": "object",
"title": "CustomerSessionResourceComponentsResourcePricingTable",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the pricing table is enabled."
}
},
"description": "This hash contains whether the pricing table is enabled.",
"x-expandableFields": []
}
customer_tax
{
"type": "object",
"title": "CustomerTax",
"required": [
"automatic_tax",
"provider"
],
"properties": {
"location": {
"anyOf": [
{
"$ref": "#/components/schemas/customer_tax_location"
}
],
"nullable": true,
"description": "The identified tax location of the customer."
},
"provider": {
"enum": [
"anrok",
"avalara",
"sphere",
"stripe"
],
"type": "string",
"description": "The tax calculation provider used for location resolution. Defaults to `stripe` when not using a [third-party provider](/tax/third-party-apps)."
},
"ip_address": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A recent IP address of the customer used for tax reporting and tax location inference."
},
"automatic_tax": {
"enum": [
"failed",
"not_collecting",
"supported",
"unrecognized_location"
],
"type": "string",
"description": "Surfaces if automatic tax computation is possible given the current customer location information."
}
},
"description": "",
"x-expandableFields": [
"location"
]
}
customer_tax_location
{
"type": "object",
"title": "CustomerTaxLocation",
"required": [
"country",
"source"
],
"properties": {
"state": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The identified tax state, county, province, or region of the customer."
},
"source": {
"enum": [
"billing_address",
"ip_address",
"payment_method",
"shipping_destination"
],
"type": "string",
"description": "The data source used to infer the customer's location."
},
"country": {
"type": "string",
"maxLength": 5000,
"description": "The identified tax country of the customer."
}
},
"description": "",
"x-expandableFields": []
}
deleted_account
{
"type": "object",
"title": "DeletedAccount",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"account"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_account",
"x-expandableFields": []
}
deleted_apple_pay_domain
{
"type": "object",
"title": "DeletedApplePayDomain",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"apple_pay_domain"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_apple_pay_domain",
"x-expandableFields": []
}
deleted_application
{
"type": "object",
"title": "DeletedApplication",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The name of the application."
},
"object": {
"enum": [
"application"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-expandableFields": []
}
deleted_bank_account
{
"type": "object",
"title": "DeletedBankAccount",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"bank_account"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
},
"currency": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account."
}
},
"description": "",
"x-expandableFields": []
}
deleted_card
{
"type": "object",
"title": "DeletedCard",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"card"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
},
"currency": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account."
}
},
"description": "",
"x-expandableFields": []
}
deleted_coupon
{
"type": "object",
"title": "DeletedCoupon",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"coupon"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_coupon",
"x-expandableFields": []
}
deleted_customer
{
"type": "object",
"title": "DeletedCustomer",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"customer"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_customer",
"x-expandableFields": []
}
deleted_discount
{
"type": "object",
"title": "DeletedDiscount",
"required": [
"deleted",
"id",
"object",
"source",
"start"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array."
},
"start": {
"type": "integer",
"format": "unix-time",
"description": "Date that the coupon was applied."
},
"object": {
"enum": [
"discount"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"source": {
"$ref": "#/components/schemas/discount_source"
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
},
"invoice": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice."
},
"customer": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/customer"
},
{
"$ref": "#/components/schemas/deleted_customer"
}
],
"nullable": true,
"description": "The ID of the customer associated with this discount.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
},
{
"$ref": "#/components/schemas/deleted_customer"
}
]
}
},
"invoice_item": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item."
},
"subscription": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The subscription that this coupon is applied to, if it is applied to a particular subscription."
},
"promotion_code": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/promotion_code"
}
],
"nullable": true,
"description": "The promotion code applied to create this discount.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/promotion_code"
}
]
}
},
"checkout_session": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode."
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of the account representing the customer associated with this discount."
},
"subscription_item": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The subscription item that this coupon is applied to, if it is applied to a particular subscription item."
}
},
"description": "",
"x-resourceId": "deleted_discount",
"x-expandableFields": [
"customer",
"promotion_code",
"source"
]
}
deleted_external_account
{
"anyOf": [
{
"$ref": "#/components/schemas/deleted_bank_account"
},
{
"$ref": "#/components/schemas/deleted_card"
}
],
"title": "Polymorphic",
"x-resourceId": "deleted_external_account",
"x-stripeBypassValidation": true
}
deleted_invoice
{
"type": "object",
"title": "DeletedInvoice",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"invoice"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_invoice",
"x-expandableFields": []
}
deleted_invoiceitem
{
"type": "object",
"title": "DeletedInvoiceItem",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"invoiceitem"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_invoiceitem",
"x-expandableFields": []
}
deleted_payment_source
{
"anyOf": [
{
"$ref": "#/components/schemas/deleted_bank_account"
},
{
"$ref": "#/components/schemas/deleted_card"
}
],
"title": "Polymorphic",
"x-resourceId": "deleted_payment_source",
"x-stripeBypassValidation": true
}
deleted_person
{
"type": "object",
"title": "DeletedPerson",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"person"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_person",
"x-expandableFields": []
}
deleted_plan
{
"type": "object",
"title": "DeletedPlan",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"plan"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_plan",
"x-expandableFields": []
}
deleted_price
{
"type": "object",
"title": "DeletedPrice",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"price"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-expandableFields": []
}
deleted_product
{
"type": "object",
"title": "DeletedProduct",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"product"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_product",
"x-expandableFields": []
}
deleted_product_feature
{
"type": "object",
"title": "DeletedProductFeature",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"product_feature"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_product_feature",
"x-expandableFields": []
}
deleted_radar.value_list
{
"type": "object",
"title": "RadarListDeletedList",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"radar.value_list"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_radar.value_list",
"x-expandableFields": []
}
deleted_radar.value_list_item
{
"type": "object",
"title": "RadarListDeletedListItem",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"radar.value_list_item"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_radar.value_list_item",
"x-expandableFields": []
}
deleted_subscription_item
{
"type": "object",
"title": "DeletedSubscriptionItem",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"subscription_item"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_subscription_item",
"x-expandableFields": []
}
deleted_tax_id
{
"type": "object",
"title": "deleted_tax_id",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"tax_id"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_tax_id",
"x-expandableFields": []
}
deleted_terminal.configuration
{
"type": "object",
"title": "TerminalConfigurationDeletedConfiguration",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"terminal.configuration"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_terminal.configuration",
"x-expandableFields": []
}
deleted_terminal.location
{
"type": "object",
"title": "TerminalLocationDeletedLocation",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"terminal.location"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_terminal.location",
"x-expandableFields": []
}
deleted_terminal.reader
{
"type": "object",
"title": "TerminalReaderDeletedReader",
"required": [
"deleted",
"device_type",
"id",
"object",
"serial_number"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"terminal.reader"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
},
"device_type": {
"enum": [
"bbpos_chipper2x",
"bbpos_wisepad3",
"bbpos_wisepos_e",
"mobile_phone_reader",
"simulated_stripe_s700",
"simulated_stripe_s710",
"simulated_verifone_m425",
"simulated_verifone_p630",
"simulated_verifone_ux700",
"simulated_verifone_v660p",
"simulated_wisepos_e",
"stripe_m2",
"stripe_s700",
"stripe_s710",
"verifone_P400",
"verifone_m425",
"verifone_p630",
"verifone_ux700",
"verifone_v660p"
],
"type": "string",
"description": "Device type of the reader.",
"x-stripeBypassValidation": true
},
"serial_number": {
"type": "string",
"maxLength": 5000,
"description": "Serial number of the reader."
}
},
"description": "",
"x-resourceId": "deleted_terminal.reader",
"x-expandableFields": []
}
deleted_test_helpers.test_clock
{
"type": "object",
"title": "DeletedTestClock",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"test_helpers.test_clock"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_test_helpers.test_clock",
"x-expandableFields": []
}
deleted_webhook_endpoint
{
"type": "object",
"title": "NotificationWebhookEndpointDeleted",
"required": [
"deleted",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"webhook_endpoint"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"deleted": {
"enum": [
true
],
"type": "boolean",
"description": "Always true for a deleted object"
}
},
"description": "",
"x-resourceId": "deleted_webhook_endpoint",
"x-expandableFields": []
}
destination_details_unimplemented
{
"type": "object",
"title": "destination_details_unimplemented",
"properties": {},
"description": "",
"x-expandableFields": []
}
discount
{
"type": "object",
"title": "Discount",
"required": [
"id",
"object",
"source",
"start"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array."
},
"end": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null."
},
"start": {
"type": "integer",
"format": "unix-time",
"description": "Date that the coupon was applied."
},
"object": {
"enum": [
"discount"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"source": {
"$ref": "#/components/schemas/discount_source"
},
"invoice": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice."
},
"customer": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/customer"
},
{
"$ref": "#/components/schemas/deleted_customer"
}
],
"nullable": true,
"description": "The ID of the customer associated with this discount.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
},
{
"$ref": "#/components/schemas/deleted_customer"
}
]
}
},
"invoice_item": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item."
},
"subscription": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The subscription that this coupon is applied to, if it is applied to a particular subscription."
},
"promotion_code": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/promotion_code"
}
],
"nullable": true,
"description": "The promotion code applied to create this discount.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/promotion_code"
}
]
}
},
"checkout_session": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode."
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of the account representing the customer associated with this discount."
},
"subscription_item": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The subscription item that this coupon is applied to, if it is applied to a particular subscription item."
}
},
"description": "A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).\nIt contains information about when the discount began, when it will end, and what it is applied to.\n\nRelated guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)",
"x-resourceId": "discount",
"x-expandableFields": [
"customer",
"promotion_code",
"source"
]
}
discount_source
{
"type": "object",
"title": "DiscountSource",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"coupon"
],
"type": "string",
"description": "The source type of the discount."
},
"coupon": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/coupon"
}
],
"nullable": true,
"description": "The coupon that was redeemed to create this discount.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/coupon"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"coupon"
]
}
discounts_resource_discount_amount
{
"type": "object",
"title": "DiscountsResourceDiscountAmount",
"required": [
"amount",
"discount"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount, in cents (or local equivalent), of the discount."
},
"discount": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/discount"
},
{
"$ref": "#/components/schemas/deleted_discount"
}
],
"description": "The discount that was applied to get this discount amount.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/discount"
},
{
"$ref": "#/components/schemas/deleted_discount"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"discount"
]
}
discounts_resource_stackable_discount_with_discount_end
{
"type": "object",
"title": "DiscountsResourceStackableDiscountWithDiscountEnd",
"properties": {
"coupon": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/coupon"
}
],
"nullable": true,
"description": "ID of the coupon to create a new discount for.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/coupon"
}
]
}
},
"discount": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/discount"
}
],
"nullable": true,
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/discount"
}
]
}
},
"promotion_code": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/promotion_code"
}
],
"nullable": true,
"description": "ID of the promotion code to create a new discount for.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/promotion_code"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"coupon",
"discount",
"promotion_code"
]
}
dispute
{
"type": "object",
"title": "Dispute",
"required": [
"amount",
"balance_transactions",
"charge",
"created",
"currency",
"enhanced_eligibility_types",
"evidence",
"evidence_details",
"id",
"is_charge_refundable",
"livemode",
"metadata",
"object",
"reason",
"status"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed)."
},
"charge": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/charge"
}
],
"description": "ID of the charge that's disputed.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/charge"
}
]
}
},
"object": {
"enum": [
"dispute"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"reason": {
"type": "string",
"maxLength": 5000,
"description": "Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://docs.stripe.com/disputes/categories)."
},
"status": {
"enum": [
"lost",
"needs_response",
"prevented",
"under_review",
"warning_closed",
"warning_needs_response",
"warning_under_review",
"won"
],
"type": "string",
"description": "The current status of a dispute. Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`.",
"x-stripeBypassValidation": true
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"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)."
},
"evidence": {
"$ref": "#/components/schemas/dispute_evidence"
},
"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`."
},
"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
}
},
"payment_intent": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_intent"
}
],
"nullable": true,
"description": "ID of the PaymentIntent that's disputed.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_intent"
}
]
}
},
"evidence_details": {
"$ref": "#/components/schemas/dispute_evidence_details"
},
"balance_transactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/balance_transaction"
},
"description": "List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute."
},
"is_charge_refundable": {
"type": "boolean",
"description": "If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute."
},
"payment_method_details": {
"$ref": "#/components/schemas/dispute_payment_method_details"
},
"enhanced_eligibility_types": {
"type": "array",
"items": {
"enum": [
"mastercard_compliance",
"visa_compelling_evidence_3",
"visa_compliance"
],
"type": "string"
},
"description": "List of eligibility types that are included in `enhanced_evidence`."
}
},
"description": "A dispute occurs when a customer questions your charge with their card issuer.\nWhen this happens, you have the opportunity to respond to the dispute with\nevidence that shows that the charge is legitimate.\n\nRelated guide: [Disputes and fraud](https://docs.stripe.com/disputes)",
"x-resourceId": "dispute",
"x-expandableFields": [
"balance_transactions",
"charge",
"evidence",
"evidence_details",
"payment_intent",
"payment_method_details"
]
}
dispute_enhanced_eligibility
{
"type": "object",
"title": "DisputeEnhancedEligibility",
"properties": {
"visa_compliance": {
"$ref": "#/components/schemas/dispute_enhanced_eligibility_visa_compliance"
},
"mastercard_compliance": {
"$ref": "#/components/schemas/dispute_enhanced_eligibility_mastercard_compliance"
},
"visa_compelling_evidence_3": {
"$ref": "#/components/schemas/dispute_enhanced_eligibility_visa_compelling_evidence3"
}
},
"description": "",
"x-expandableFields": [
"mastercard_compliance",
"visa_compelling_evidence_3",
"visa_compliance"
]
}
dispute_enhanced_eligibility_mastercard_compliance
{
"type": "object",
"title": "DisputeEnhancedEligibilityMastercardCompliance",
"required": [
"status"
],
"properties": {
"status": {
"enum": [
"fee_acknowledged",
"requires_fee_acknowledgement"
],
"type": "string",
"description": "Mastercard compliance eligibility status."
}
},
"description": "",
"x-expandableFields": []
}
dispute_enhanced_eligibility_visa_compelling_evidence3
{
"type": "object",
"title": "DisputeEnhancedEligibilityVisaCompellingEvidence3",
"required": [
"required_actions",
"status"
],
"properties": {
"status": {
"enum": [
"not_qualified",
"qualified",
"requires_action"
],
"type": "string",
"description": "Visa Compelling Evidence 3.0 eligibility status."
},
"required_actions": {
"type": "array",
"items": {
"enum": [
"missing_customer_identifiers",
"missing_disputed_transaction_description",
"missing_merchandise_or_services",
"missing_prior_undisputed_transaction_description",
"missing_prior_undisputed_transactions"
],
"type": "string"
},
"description": "List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission."
}
},
"description": "",
"x-expandableFields": []
}
dispute_enhanced_eligibility_visa_compliance
{
"type": "object",
"title": "DisputeEnhancedEligibilityVisaCompliance",
"required": [
"status"
],
"properties": {
"status": {
"enum": [
"fee_acknowledged",
"requires_fee_acknowledgement"
],
"type": "string",
"description": "Visa compliance eligibility status."
}
},
"description": "",
"x-expandableFields": []
}
dispute_enhanced_evidence
{
"type": "object",
"title": "DisputeEnhancedEvidence",
"properties": {
"visa_compliance": {
"$ref": "#/components/schemas/dispute_enhanced_evidence_visa_compliance"
},
"mastercard_compliance": {
"$ref": "#/components/schemas/dispute_enhanced_evidence_mastercard_compliance"
},
"visa_compelling_evidence_3": {
"$ref": "#/components/schemas/dispute_enhanced_evidence_visa_compelling_evidence3"
}
},
"description": "",
"x-expandableFields": [
"mastercard_compliance",
"visa_compelling_evidence_3",
"visa_compliance"
]
}
dispute_enhanced_evidence_mastercard_compliance
{
"type": "object",
"title": "DisputeEnhancedEvidenceMastercardCompliance",
"required": [
"fee_acknowledged"
],
"properties": {
"fee_acknowledged": {
"type": "boolean",
"description": "A field acknowledging the fee incurred when countering a Mastercard compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute."
}
},
"description": "",
"x-expandableFields": []
}
dispute_enhanced_evidence_visa_compelling_evidence3
{
"type": "object",
"title": "DisputeEnhancedEvidenceVisaCompellingEvidence3",
"required": [
"prior_undisputed_transactions"
],
"properties": {
"disputed_transaction": {
"anyOf": [
{
"$ref": "#/components/schemas/dispute_visa_compelling_evidence3_disputed_transaction"
}
],
"nullable": true,
"description": "Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission."
},
"prior_undisputed_transactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dispute_visa_compelling_evidence3_prior_undisputed_transaction"
},
"description": "List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission."
}
},
"description": "",
"x-expandableFields": [
"disputed_transaction",
"prior_undisputed_transactions"
]
}