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 cannot 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. Will not be 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_wisepos_e",
"stripe_m2",
"stripe_s700",
"stripe_s710",
"verifone_P400"
],
"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 cannot 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. Will not be 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": [
"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"
},
"visa_compelling_evidence_3": {
"$ref": "#/components/schemas/dispute_enhanced_eligibility_visa_compelling_evidence3"
}
},
"description": "",
"x-expandableFields": [
"visa_compelling_evidence_3",
"visa_compliance"
]
}
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"
},
"visa_compelling_evidence_3": {
"$ref": "#/components/schemas/dispute_enhanced_evidence_visa_compelling_evidence3"
}
},
"description": "",
"x-expandableFields": [
"visa_compelling_evidence_3",
"visa_compliance"
]
}
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"
]
}
dispute_enhanced_evidence_visa_compliance
{
"type": "object",
"title": "DisputeEnhancedEvidenceVisaCompliance",
"required": [
"fee_acknowledged"
],
"properties": {
"fee_acknowledged": {
"type": "boolean",
"description": "A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute."
}
},
"description": "",
"x-expandableFields": []
}
dispute_evidence
{
"type": "object",
"title": "DisputeEvidence",
"required": [
"enhanced_evidence"
],
"properties": {
"receipt": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"service_date": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The date on which the customer received or began receiving the purchased service, in a clear human-readable format."
},
"customer_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The name of the customer."
},
"refund_policy": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"shipping_date": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The date on which a physical product began its route to the shipping address, in a clear human-readable format."
},
"billing_address": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The billing address provided by the customer."
},
"shipping_address": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The address to which a physical product was shipped. You should try to include as complete address information as possible."
},
"shipping_carrier": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas."
},
"enhanced_evidence": {
"$ref": "#/components/schemas/dispute_enhanced_evidence"
},
"customer_signature": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"uncategorized_file": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"uncategorized_text": {
"type": "string",
"nullable": true,
"maxLength": 150000,
"description": "Any additional evidence or statements."
},
"access_activity_log": {
"type": "string",
"nullable": true,
"maxLength": 150000,
"description": "Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity."
},
"cancellation_policy": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"duplicate_charge_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge."
},
"product_description": {
"type": "string",
"nullable": true,
"maxLength": 150000,
"description": "A description of the product or service that was sold."
},
"customer_purchase_ip": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The IP address that the customer used when making the purchase."
},
"cancellation_rebuttal": {
"type": "string",
"nullable": true,
"maxLength": 150000,
"description": "A justification for why the customer's subscription was not canceled."
},
"service_documentation": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"customer_communication": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"customer_email_address": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The email address of the customer."
},
"shipping_documentation": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"refund_policy_disclosure": {
"type": "string",
"nullable": true,
"maxLength": 150000,
"description": "Documentation demonstrating that the customer was shown your refund policy prior to purchase."
},
"shipping_tracking_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas."
},
"refund_refusal_explanation": {
"type": "string",
"nullable": true,
"maxLength": 150000,
"description": "A justification for why the customer is not entitled to a refund."
},
"duplicate_charge_explanation": {
"type": "string",
"nullable": true,
"maxLength": 150000,
"description": "An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate."
},
"cancellation_policy_disclosure": {
"type": "string",
"nullable": true,
"maxLength": 150000,
"description": "An explanation of how and when the customer was shown your refund policy prior to purchase."
},
"duplicate_charge_documentation": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"cancellation_policy",
"customer_communication",
"customer_signature",
"duplicate_charge_documentation",
"enhanced_evidence",
"receipt",
"refund_policy",
"service_documentation",
"shipping_documentation",
"uncategorized_file"
]
}
dispute_evidence_details
{
"type": "object",
"title": "DisputeEvidenceDetails",
"required": [
"enhanced_eligibility",
"has_evidence",
"past_due",
"submission_count"
],
"properties": {
"due_by": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute."
},
"past_due": {
"type": "boolean",
"description": "Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed."
},
"has_evidence": {
"type": "boolean",
"description": "Whether evidence has been staged for this dispute."
},
"submission_count": {
"type": "integer",
"description": "The number of times evidence has been submitted. Typically, you may only submit evidence once."
},
"enhanced_eligibility": {
"$ref": "#/components/schemas/dispute_enhanced_eligibility"
}
},
"description": "",
"x-expandableFields": [
"enhanced_eligibility"
]
}
dispute_payment_method_details
{
"type": "object",
"title": "DisputePaymentMethodDetails",
"required": [
"type"
],
"properties": {
"card": {
"$ref": "#/components/schemas/dispute_payment_method_details_card"
},
"type": {
"enum": [
"amazon_pay",
"card",
"klarna",
"paypal"
],
"type": "string",
"description": "Payment method type."
},
"klarna": {
"$ref": "#/components/schemas/dispute_payment_method_details_klarna"
},
"paypal": {
"$ref": "#/components/schemas/dispute_payment_method_details_paypal"
},
"amazon_pay": {
"$ref": "#/components/schemas/dispute_payment_method_details_amazon_pay"
}
},
"description": "",
"x-expandableFields": [
"amazon_pay",
"card",
"klarna",
"paypal"
]
}
dispute_payment_method_details_amazon_pay
{
"type": "object",
"title": "DisputePaymentMethodDetailsAmazonPay",
"properties": {
"dispute_type": {
"enum": [
"chargeback",
"claim"
],
"type": "string",
"nullable": true,
"description": "The AmazonPay dispute type, chargeback or claim"
}
},
"description": "",
"x-expandableFields": []
}
dispute_payment_method_details_card
{
"type": "object",
"title": "DisputePaymentMethodDetailsCard",
"required": [
"brand",
"case_type"
],
"properties": {
"brand": {
"type": "string",
"maxLength": 5000,
"description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
},
"case_type": {
"enum": [
"block",
"chargeback",
"compliance",
"inquiry",
"resolution"
],
"type": "string",
"description": "The type of dispute opened. Different case types may have varying fees and financial impact."
},
"network_reason_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network."
}
},
"description": "",
"x-expandableFields": []
}
dispute_payment_method_details_klarna
{
"type": "object",
"title": "DisputePaymentMethodDetailsKlarna",
"properties": {
"reason_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The reason for the dispute as defined by Klarna"
},
"chargeback_loss_reason_code": {
"type": "string",
"maxLength": 5000,
"description": "Chargeback loss reason mapped by Stripe from Klarna's chargeback loss reason"
}
},
"description": "",
"x-expandableFields": []
}
dispute_payment_method_details_paypal
{
"type": "object",
"title": "DisputePaymentMethodDetailsPaypal",
"properties": {
"case_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of the dispute in PayPal."
},
"reason_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The reason for the dispute as defined by PayPal"
}
},
"description": "",
"x-expandableFields": []
}
dispute_transaction_shipping_address
{
"type": "object",
"title": "DisputeTransactionShippingAddress",
"properties": {
"city": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "City, district, suburb, town, or village."
},
"line1": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Address line 1, such as the street, PO Box, or company name."
},
"line2": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Address line 2, such as the apartment, suite, unit, or building."
},
"state": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
},
"postal_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ZIP or postal code."
}
},
"description": "",
"x-expandableFields": []
}
dispute_visa_compelling_evidence3_disputed_transaction
{
"type": "object",
"title": "DisputeVisaCompellingEvidence3DisputedTransaction",
"properties": {
"shipping_address": {
"anyOf": [
{
"$ref": "#/components/schemas/dispute_transaction_shipping_address"
}
],
"nullable": true,
"description": "The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission."
},
"customer_device_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters."
},
"customer_account_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "User Account ID used to log into business platform. Must be recognizable by the user."
},
"product_description": {
"type": "string",
"nullable": true,
"maxLength": 150000,
"description": "A description of the product or service that was sold."
},
"customer_purchase_ip": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The IP address that the customer used when making the purchase."
},
"customer_email_address": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The email address of the customer."
},
"merchandise_or_services": {
"enum": [
"merchandise",
"services"
],
"type": "string",
"nullable": true,
"description": "Categorization of disputed payment."
},
"customer_device_fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters."
}
},
"description": "",
"x-expandableFields": [
"shipping_address"
]
}