invoice_payment_method_options_bancontact
{
"type": "object",
"title": "invoice_payment_method_options_bancontact",
"required": [
"preferred_language"
],
"properties": {
"preferred_language": {
"enum": [
"de",
"en",
"fr",
"nl"
],
"type": "string",
"description": "Preferred language of the Bancontact authorization page that the customer is redirected to."
}
},
"description": "",
"x-expandableFields": []
}
invoice_payment_method_options_card
{
"type": "object",
"title": "invoice_payment_method_options_card",
"properties": {
"installments": {
"$ref": "#/components/schemas/invoice_installments_card"
},
"request_three_d_secure": {
"enum": [
"any",
"automatic",
"challenge"
],
"type": "string",
"nullable": true,
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine."
}
},
"description": "",
"x-expandableFields": [
"installments"
]
}
invoice_payment_method_options_customer_balance
{
"type": "object",
"title": "invoice_payment_method_options_customer_balance",
"properties": {
"funding_type": {
"enum": [
"bank_transfer"
],
"type": "string",
"nullable": true,
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`."
},
"bank_transfer": {
"$ref": "#/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer"
}
},
"description": "",
"x-expandableFields": [
"bank_transfer"
]
}
invoice_payment_method_options_customer_balance_bank_transfer
{
"type": "object",
"title": "invoice_payment_method_options_customer_balance_bank_transfer",
"properties": {
"type": {
"type": "string",
"nullable": true,
"description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`."
},
"eu_bank_transfer": {
"$ref": "#/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer"
}
},
"description": "",
"x-expandableFields": [
"eu_bank_transfer"
]
}
invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer
{
"type": "object",
"title": "invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer",
"required": [
"country"
],
"properties": {
"country": {
"enum": [
"BE",
"DE",
"ES",
"FR",
"IE",
"NL"
],
"type": "string",
"description": "The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`."
}
},
"description": "",
"x-expandableFields": []
}
invoice_payment_method_options_konbini
{
"type": "object",
"title": "invoice_payment_method_options_konbini",
"properties": {},
"description": "",
"x-expandableFields": []
}
invoice_payment_method_options_mandate_options_upi
{
"type": "object",
"title": "invoice_payment_method_options_mandate_options_upi",
"properties": {
"amount": {
"type": "integer",
"nullable": true,
"description": "Amount to be charged for future payments."
},
"end_date": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "End date of the mandate or subscription."
},
"amount_type": {
"enum": [
"fixed",
"maximum"
],
"type": "string",
"nullable": true,
"description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 20,
"description": "A description of the mandate or subscription that is meant to be displayed to the customer."
}
},
"description": "",
"x-expandableFields": []
}
invoice_payment_method_options_payto
{
"type": "object",
"title": "invoice_payment_method_options_payto",
"properties": {
"mandate_options": {
"$ref": "#/components/schemas/invoice_mandate_options_payto"
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
invoice_payment_method_options_pix
{
"type": "object",
"title": "invoice_payment_method_options_pix",
"properties": {
"amount_includes_iof": {
"enum": [
"always",
"never"
],
"type": "string",
"nullable": true,
"description": "Determines if the amount includes the IOF tax."
},
"expires_after_seconds": {
"type": "integer",
"description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds."
}
},
"description": "",
"x-expandableFields": []
}
invoice_payment_method_options_sepa_debit
{
"type": "object",
"title": "invoice_payment_method_options_sepa_debit",
"properties": {},
"description": "",
"x-expandableFields": []
}
invoice_payment_method_options_upi
{
"type": "object",
"title": "invoice_payment_method_options_upi",
"properties": {
"mandate_options": {
"$ref": "#/components/schemas/invoice_payment_method_options_mandate_options_upi"
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
invoice_payment_method_options_us_bank_account
{
"type": "object",
"title": "invoice_payment_method_options_us_bank_account",
"properties": {
"verification_method": {
"enum": [
"automatic",
"instant",
"microdeposits"
],
"type": "string",
"description": "Bank account verification method. The default value is `automatic`.",
"x-stripeBypassValidation": true
},
"financial_connections": {
"$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options"
}
},
"description": "",
"x-expandableFields": [
"financial_connections"
]
}
invoice_payment_method_options_us_bank_account_linked_account_options
{
"type": "object",
"title": "invoice_payment_method_options_us_bank_account_linked_account_options",
"properties": {
"filters": {
"$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options_filters"
},
"prefetch": {
"type": "array",
"items": {
"enum": [
"balances",
"ownership",
"transactions"
],
"type": "string",
"x-stripeBypassValidation": true
},
"nullable": true,
"description": "Data features requested to be retrieved upon account creation."
},
"permissions": {
"type": "array",
"items": {
"enum": [
"balances",
"ownership",
"payment_method",
"transactions"
],
"type": "string"
},
"description": "The list of permissions to request. The `payment_method` permission must be included."
}
},
"description": "",
"x-expandableFields": [
"filters"
]
}
invoice_payment_method_options_us_bank_account_linked_account_options_filters
{
"type": "object",
"title": "invoice_payment_method_options_us_bank_account_linked_account_options_filters",
"properties": {
"account_subcategories": {
"type": "array",
"items": {
"enum": [
"checking",
"savings"
],
"type": "string"
},
"description": "The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`."
}
},
"description": "",
"x-expandableFields": []
}
invoice_rendering_pdf
{
"type": "object",
"title": "InvoiceRenderingPdf",
"properties": {
"page_size": {
"enum": [
"a4",
"auto",
"letter"
],
"type": "string",
"nullable": true,
"description": "Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale."
}
},
"description": "",
"x-expandableFields": []
}
invoice_rendering_template
{
"type": "object",
"title": "InvoiceRenderingTemplate",
"required": [
"created",
"id",
"livemode",
"object",
"status",
"version"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"invoice_rendering_template"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"active",
"archived"
],
"type": "string",
"description": "The status of the template, one of `active` or `archived`."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"version": {
"type": "integer",
"description": "Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering"
},
"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",
"nullable": true,
"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
}
},
"nickname": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A brief description of the template, hidden from customers"
}
},
"description": "Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates\ncan be created from within the Dashboard, and they can be used over the API when creating invoices.",
"x-resourceId": "invoice_rendering_template",
"x-expandableFields": []
}
invoice_setting_checkout_rendering_options
{
"type": "object",
"title": "invoice_setting_checkout_rendering_options",
"properties": {
"template": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the invoice rendering template to be used for the generated invoice."
},
"amount_tax_display": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs."
}
},
"description": "",
"x-expandableFields": []
}
invoice_setting_custom_field
{
"type": "object",
"title": "InvoiceSettingCustomField",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"maxLength": 5000,
"description": "The name of the custom field."
},
"value": {
"type": "string",
"maxLength": 5000,
"description": "The value of the custom field."
}
},
"description": "",
"x-expandableFields": []
}
invoice_setting_customer_rendering_options
{
"type": "object",
"title": "InvoiceSettingCustomerRenderingOptions",
"properties": {
"template": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice."
},
"amount_tax_display": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs."
}
},
"description": "",
"x-expandableFields": []
}
invoice_setting_customer_setting
{
"type": "object",
"title": "InvoiceSettingCustomerSetting",
"properties": {
"footer": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Default footer to be displayed on invoices for this customer."
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/invoice_setting_custom_field"
},
"nullable": true,
"description": "Default custom fields to be displayed on invoices for this customer."
},
"rendering_options": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_setting_customer_rendering_options"
}
],
"nullable": true,
"description": "Default options for invoice PDF rendering for this customer."
},
"default_payment_method": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"nullable": true,
"description": "ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"custom_fields",
"default_payment_method",
"rendering_options"
]
}
invoice_setting_quote_setting
{
"type": "object",
"title": "InvoiceSettingQuoteSetting",
"required": [
"issuer"
],
"properties": {
"issuer": {
"$ref": "#/components/schemas/connect_account_reference"
},
"days_until_due": {
"type": "integer",
"nullable": true,
"description": "Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`."
}
},
"description": "",
"x-expandableFields": [
"issuer"
]
}
invoice_setting_subscription_schedule_phase_setting
{
"type": "object",
"title": "InvoiceSettingSubscriptionSchedulePhaseSetting",
"properties": {
"issuer": {
"anyOf": [
{
"$ref": "#/components/schemas/connect_account_reference"
}
],
"nullable": true,
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account."
},
"days_until_due": {
"type": "integer",
"nullable": true,
"description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`."
},
"account_tax_ids": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/tax_id"
},
{
"$ref": "#/components/schemas/deleted_tax_id"
}
],
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/tax_id"
},
{
"$ref": "#/components/schemas/deleted_tax_id"
}
]
}
},
"nullable": true,
"description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule."
}
},
"description": "",
"x-expandableFields": [
"account_tax_ids",
"issuer"
]
}
invoice_setting_subscription_schedule_setting
{
"type": "object",
"title": "InvoiceSettingSubscriptionScheduleSetting",
"required": [
"issuer"
],
"properties": {
"issuer": {
"$ref": "#/components/schemas/connect_account_reference"
},
"days_until_due": {
"type": "integer",
"nullable": true,
"description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`."
},
"account_tax_ids": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/tax_id"
},
{
"$ref": "#/components/schemas/deleted_tax_id"
}
],
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/tax_id"
},
{
"$ref": "#/components/schemas/deleted_tax_id"
}
]
}
},
"nullable": true,
"description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule."
}
},
"description": "",
"x-expandableFields": [
"account_tax_ids",
"issuer"
]
}
invoice_threshold_reason
{
"type": "object",
"title": "InvoiceThresholdReason",
"required": [
"item_reasons"
],
"properties": {
"amount_gte": {
"type": "integer",
"nullable": true,
"description": "The total invoice amount threshold boundary if it triggered the threshold invoice."
},
"item_reasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/invoice_item_threshold_reason"
},
"description": "Indicates which line items triggered a threshold invoice."
}
},
"description": "",
"x-expandableFields": [
"item_reasons"
]
}
invoiceitem
{
"type": "object",
"title": "InvoiceItem",
"required": [
"amount",
"currency",
"customer",
"date",
"discountable",
"id",
"livemode",
"object",
"period",
"proration",
"quantity",
"quantity_decimal"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"date": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"amount": {
"type": "integer",
"description": "Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`."
},
"object": {
"enum": [
"invoiceitem"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"parent": {
"anyOf": [
{
"$ref": "#/components/schemas/billing_bill_resource_invoice_item_parents_invoice_item_parent"
}
],
"nullable": true,
"description": "The parent that generated this invoice item."
},
"period": {
"$ref": "#/components/schemas/invoice_line_item_period"
},
"invoice": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/invoice"
}
],
"nullable": true,
"description": "The ID of the invoice this invoice item belongs to.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/invoice"
}
]
}
},
"pricing": {
"anyOf": [
{
"$ref": "#/components/schemas/billing_bill_resource_invoicing_pricing_pricing"
}
],
"nullable": true,
"description": "The pricing information of the invoice item."
},
"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)."
},
"customer": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/customer"
},
{
"$ref": "#/components/schemas/deleted_customer"
}
],
"description": "The ID of the customer to bill for this invoice item.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
},
{
"$ref": "#/components/schemas/deleted_customer"
}
]
}
},
"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",
"nullable": true,
"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
}
},
"quantity": {
"type": "integer",
"description": "Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use `quantity_decimal`. This field will be deprecated in favor of `quantity_decimal` in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for."
},
"discounts": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/discount"
}
],
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/discount"
}
]
}
},
"nullable": true,
"description": "The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount."
},
"proration": {
"type": "boolean",
"description": "Whether the invoice item was created automatically as a proration adjustment when the customer switched plans."
},
"tax_rates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tax_rate"
},
"nullable": true,
"description": "The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item."
},
"net_amount": {
"type": "integer",
"description": "The amount after discounts, but before credits and taxes. This field is `null` for `discountable=true` items."
},
"test_clock": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/test_helpers.test_clock"
}
],
"nullable": true,
"description": "ID of the test clock this invoice item belongs to.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/test_helpers.test_clock"
}
]
}
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"discountable": {
"type": "boolean",
"description": "If true, discounts will apply to this invoice item. Always false for prorations."
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of the account to bill for this invoice item."
},
"quantity_decimal": {
"type": "string",
"format": "decimal",
"description": "Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item."
},
"proration_details": {
"$ref": "#/components/schemas/proration_details"
}
},
"description": "Invoice Items represent the component lines of an [invoice](https://docs.stripe.com/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://docs.stripe.com/api/invoices/line_item) within [invoice.lines](https://docs.stripe.com/api/invoices/object#invoice_object-lines).\n\nInvoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined\nwith a [subscription](https://docs.stripe.com/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge\nor credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges\n(to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.\n\nRelated guides: [Integrate with the Invoicing API](https://docs.stripe.com/invoicing/integration), [Subscription Invoices](https://docs.stripe.com/billing/invoices/subscription#adding-upcoming-invoice-items).",
"x-resourceId": "invoiceitem",
"x-expandableFields": [
"customer",
"discounts",
"invoice",
"parent",
"period",
"pricing",
"proration_details",
"tax_rates",
"test_clock"
]
}
invoices_payment_method_options
{
"type": "object",
"title": "InvoicesPaymentMethodOptions",
"properties": {
"pix": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_pix"
}
],
"nullable": true,
"description": "If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent."
},
"upi": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_upi"
}
],
"nullable": true,
"description": "If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent."
},
"card": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_card"
}
],
"nullable": true,
"description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent."
},
"payto": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_payto"
}
],
"nullable": true,
"description": "If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent."
},
"konbini": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_konbini"
}
],
"nullable": true,
"description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent."
},
"acss_debit": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_acss_debit"
}
],
"nullable": true,
"description": "If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent."
},
"bancontact": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_bancontact"
}
],
"nullable": true,
"description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent."
},
"sepa_debit": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_sepa_debit"
}
],
"nullable": true,
"description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent."
},
"us_bank_account": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account"
}
],
"nullable": true,
"description": "If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent."
},
"customer_balance": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_customer_balance"
}
],
"nullable": true,
"description": "If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent."
}
},
"description": "",
"x-expandableFields": [
"acss_debit",
"bancontact",
"card",
"customer_balance",
"konbini",
"payto",
"pix",
"sepa_debit",
"upi",
"us_bank_account"
]
}
invoices_payment_settings
{
"type": "object",
"title": "InvoicesPaymentSettings",
"properties": {
"default_mandate": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set."
},
"payment_method_types": {
"type": "array",
"items": {
"enum": [
"ach_credit_transfer",
"ach_debit",
"acss_debit",
"affirm",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"boleto",
"card",
"cashapp",
"crypto",
"custom",
"customer_balance",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"jp_credit_transfer",
"kakao_pay",
"klarna",
"konbini",
"kr_card",
"link",
"multibanco",
"naver_pay",
"nz_bank_account",
"p24",
"pay_by_bank",
"payco",
"paynow",
"paypal",
"payto",
"pix",
"promptpay",
"revolut_pay",
"sepa_credit_transfer",
"sepa_debit",
"sofort",
"swish",
"upi",
"us_bank_account",
"wechat_pay"
],
"type": "string",
"x-stripeBypassValidation": true
},
"nullable": true,
"description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice)."
},
"payment_method_options": {
"anyOf": [
{
"$ref": "#/components/schemas/invoices_payment_method_options"
}
],
"nullable": true,
"description": "Payment-method-specific configuration to provide to the invoice’s PaymentIntent."
}
},
"description": "",
"x-expandableFields": [
"payment_method_options"
]
}
invoices_payments_invoice_payment_associated_payment
{
"type": "object",
"title": "InvoicesPaymentsInvoicePaymentAssociatedPayment",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"charge",
"payment_intent",
"payment_record"
],
"type": "string",
"description": "Type of payment object associated with this invoice payment."
},
"charge": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/charge"
}
],
"description": "ID of the successful charge for this payment when `type` is `charge`.Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/charge"
}
]
}
},
"payment_intent": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_intent"
}
],
"description": "ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_intent"
}
]
}
},
"payment_record": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_record"
}
],
"description": "ID of the PaymentRecord associated with this payment when `type` is `payment_record`.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_record"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"charge",
"payment_intent",
"payment_record"
]
}
invoices_payments_invoice_payment_status_transitions
{
"type": "object",
"title": "InvoicesPaymentsInvoicePaymentStatusTransitions",
"properties": {
"paid_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The time that the payment succeeded."
},
"canceled_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The time that the payment was canceled."
}
},
"description": "",
"x-expandableFields": []
}
invoices_resource_confirmation_secret
{
"type": "object",
"title": "InvoicesResourceConfirmationSecret",
"required": [
"client_secret",
"type"
],
"properties": {
"type": {
"type": "string",
"maxLength": 5000,
"description": "The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization"
},
"client_secret": {
"type": "string",
"maxLength": 5000,
"description": "The client_secret of the payment that Stripe creates for the invoice after finalization."
}
},
"description": "",
"x-expandableFields": []
}
invoices_resource_from_invoice
{
"type": "object",
"title": "InvoicesResourceFromInvoice",
"required": [
"action",
"invoice"
],
"properties": {
"action": {
"type": "string",
"maxLength": 5000,
"description": "The relation between this invoice and the cloned invoice"
},
"invoice": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/invoice"
}
],
"description": "The invoice that was cloned.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/invoice"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"invoice"
]
}
invoices_resource_invoice_rendering
{
"type": "object",
"title": "InvoicesResourceInvoiceRendering",
"properties": {
"pdf": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_rendering_pdf"
}
],
"nullable": true,
"description": "Invoice pdf rendering options"
},
"template": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the rendering template that the invoice is formatted by."
},
"template_version": {
"type": "integer",
"nullable": true,
"description": "Version of the rendering template that the invoice is using."
},
"amount_tax_display": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs."
}
},
"description": "",
"x-expandableFields": [
"pdf"
]
}
invoices_resource_invoice_tax_id
{
"type": "object",
"title": "InvoicesResourceInvoiceTaxID",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"ad_nrt",
"ae_trn",
"al_tin",
"am_tin",
"ao_tin",
"ar_cuit",
"au_abn",
"au_arn",
"aw_tin",
"az_tin",
"ba_tin",
"bb_tin",
"bd_bin",
"bf_ifu",
"bg_uic",
"bh_vat",
"bj_ifu",
"bo_tin",
"br_cnpj",
"br_cpf",
"bs_tin",
"by_tin",
"ca_bn",
"ca_gst_hst",
"ca_pst_bc",
"ca_pst_mb",
"ca_pst_sk",
"ca_qst",
"cd_nif",
"ch_uid",
"ch_vat",
"cl_tin",
"cm_niu",
"cn_tin",
"co_nit",
"cr_tin",
"cv_nif",
"de_stn",
"do_rcn",
"ec_ruc",
"eg_tin",
"es_cif",
"et_tin",
"eu_oss_vat",
"eu_vat",
"fo_vat",
"gb_vat",
"ge_vat",
"gi_tin",
"gn_nif",
"hk_br",
"hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
"in_gst",
"is_vat",
"it_cf",
"jp_cn",
"jp_rn",
"jp_trn",
"ke_pin",
"kg_tin",
"kh_tin",
"kr_brn",
"kz_bin",
"la_tin",
"li_uid",
"li_vat",
"lk_vat",
"ma_vat",
"md_vat",
"me_pib",
"mk_vat",
"mr_nif",
"mx_rfc",
"my_frp",
"my_itn",
"my_sst",
"ng_tin",
"no_vat",
"no_voec",
"np_pan",
"nz_gst",
"om_vat",
"pe_ruc",
"ph_tin",
"pl_nip",
"py_ruc",
"ro_tin",
"rs_pib",
"ru_inn",
"ru_kpp",
"sa_vat",
"sg_gst",
"sg_uen",
"si_tin",
"sn_ninea",
"sr_fin",
"sv_nit",
"th_vat",
"tj_tin",
"tr_tin",
"tw_vat",
"tz_vat",
"ua_vat",
"ug_tin",
"unknown",
"us_ein",
"uy_ruc",
"uz_tin",
"uz_vat",
"ve_rif",
"vn_tin",
"za_vat",
"zm_tin",
"zw_tin"
],
"type": "string",
"description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`"
},
"value": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The value of the tax ID."
}
},
"description": "",
"x-expandableFields": []
}
invoices_resource_pretax_credit_amount
{
"type": "object",
"title": "InvoicesResourcePretaxCreditAmount",
"required": [
"amount",
"type"
],
"properties": {
"type": {
"enum": [
"credit_balance_transaction",
"discount"
],
"type": "string",
"description": "Type of the pretax credit amount referenced.",
"x-stripeBypassValidation": true
},
"amount": {
"type": "integer",
"description": "The amount, in cents (or local equivalent), of the pretax credit amount."
},
"discount": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/discount"
},
{
"$ref": "#/components/schemas/deleted_discount"
}
],
"description": "The discount that was applied to get this pretax credit amount.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/discount"
},
{
"$ref": "#/components/schemas/deleted_discount"
}
]
}
},
"credit_balance_transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/billing.credit_balance_transaction"
}
],
"nullable": true,
"description": "The credit balance transaction that was applied to get this pretax credit amount.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/billing.credit_balance_transaction"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"credit_balance_transaction",
"discount"
]
}
invoices_resource_shipping_cost
{
"type": "object",
"title": "InvoicesResourceShippingCost",
"required": [
"amount_subtotal",
"amount_tax",
"amount_total"
],
"properties": {
"taxes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/line_items_tax_amount"
},
"description": "The taxes applied to the shipping rate."
},
"amount_tax": {
"type": "integer",
"description": "Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0."
},
"amount_total": {
"type": "integer",
"description": "Total shipping cost after taxes are applied."
},
"shipping_rate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/shipping_rate"
}
],
"nullable": true,
"description": "The ID of the ShippingRate for this invoice.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/shipping_rate"
}
]
}
},
"amount_subtotal": {
"type": "integer",
"description": "Total shipping cost before any taxes are applied."
}
},
"description": "",
"x-expandableFields": [
"shipping_rate",
"taxes"
]
}
invoices_resource_status_transitions
{
"type": "object",
"title": "InvoicesResourceStatusTransitions",
"properties": {
"paid_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The time that the invoice was paid."
},
"voided_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The time that the invoice was voided."
},
"finalized_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The time that the invoice draft was finalized."
},
"marked_uncollectible_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The time that the invoice was marked uncollectible."
}
},
"description": "",
"x-expandableFields": []
}
issuing.authorization
{
"type": "object",
"title": "IssuingAuthorization",
"required": [
"amount",
"approved",
"authorization_method",
"balance_transactions",
"card",
"created",
"currency",
"id",
"livemode",
"merchant_amount",
"merchant_currency",
"merchant_data",
"metadata",
"object",
"request_history",
"status",
"transactions",
"verification_data"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"card": {
"$ref": "#/components/schemas/issuing.card"
},
"fuel": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_fuel_data"
}
],
"nullable": true,
"description": "Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed."
},
"fleet": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_fleet_data"
}
],
"nullable": true,
"description": "Fleet-specific information for authorizations using Fleet cards."
},
"token": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.token"
}
],
"nullable": true,
"description": "[Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.token"
}
]
}
},
"amount": {
"type": "integer",
"description": "The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different."
},
"object": {
"enum": [
"issuing.authorization"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"closed",
"expired",
"pending",
"reversed"
],
"type": "string",
"description": "The current status of the authorization in its lifecycle."
},
"wallet": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"approved": {
"type": "boolean",
"description": "Whether the authorization has been approved."
},
"currency": {
"type": "string",
"format": "currency",
"description": "The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"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
}
},
"treasury": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_treasury"
}
],
"nullable": true,
"description": "[Treasury](https://docs.stripe.com/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://docs.stripe.com/api/treasury/financial_accounts)."
},
"cardholder": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.cardholder"
}
],
"nullable": true,
"description": "The cardholder to whom this authorization belongs.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.cardholder"
}
]
}
},
"network_data": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_network_data"
}
],
"nullable": true,
"description": "Details about the authorization, such as identifiers, set by the card network."
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/issuing.transaction"
},
"description": "List of [transactions](https://docs.stripe.com/api/issuing/transactions) associated with this authorization."
},
"card_presence": {
"enum": [
"not_present",
"present"
],
"type": "string",
"nullable": true,
"description": "Whether the card was present at the point of sale for the authorization."
},
"merchant_data": {
"$ref": "#/components/schemas/issuing_authorization_merchant_data"
},
"amount_details": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_amount_details"
}
],
"nullable": true,
"description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
},
"merchant_amount": {
"type": "integer",
"description": "The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different."
},
"pending_request": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_pending_request"
}
],
"nullable": true,
"description": "The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook."
},
"request_history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/issuing_authorization_request"
},
"description": "History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined."
},
"fraud_challenges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/issuing_authorization_fraud_challenge"
},
"nullable": true,
"description": "Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons."
},
"merchant_currency": {
"type": "string",
"format": "currency",
"description": "The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. 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)."
},
"verification_data": {
"$ref": "#/components/schemas/issuing_authorization_verification_data"
},
"authorization_method": {
"enum": [
"chip",
"contactless",
"keyed_in",
"online",
"swipe"
],
"type": "string",
"description": "How the card details were provided."
},
"balance_transactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/balance_transaction"
},
"description": "List of balance transactions associated with this authorization."
},
"verified_by_fraud_challenge": {
"type": "boolean",
"nullable": true,
"description": "Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant."
}
},
"description": "When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization`\nobject is created. [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the\npurchase to be completed successfully.\n\nRelated guide: [Issued card authorizations](https://docs.stripe.com/issuing/purchases/authorizations)",
"x-resourceId": "issuing.authorization",
"x-expandableFields": [
"amount_details",
"balance_transactions",
"card",
"cardholder",
"fleet",
"fraud_challenges",
"fuel",
"merchant_data",
"network_data",
"pending_request",
"request_history",
"token",
"transactions",
"treasury",
"verification_data"
]
}
issuing.card
{
"type": "object",
"title": "IssuingCard",
"required": [
"brand",
"cardholder",
"created",
"currency",
"exp_month",
"exp_year",
"id",
"last4",
"livemode",
"metadata",
"object",
"spending_controls",
"status",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"cvc": {
"type": "string",
"maxLength": 5000,
"description": "The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint."
},
"type": {
"enum": [
"physical",
"virtual"
],
"type": "string",
"description": "The type of the card."
},
"brand": {
"type": "string",
"maxLength": 5000,
"description": "The brand of the card."
},
"last4": {
"type": "string",
"maxLength": 5000,
"description": "The last 4 digits of the card number."
},
"number": {
"type": "string",
"maxLength": 5000,
"description": "The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint."
},
"object": {
"enum": [
"issuing.card"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"active",
"canceled",
"inactive"
],
"type": "string",
"description": "Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.",
"x-stripeBypassValidation": true
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"wallets": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_card_wallets"
}
],
"nullable": true,
"description": "Information relating to digital wallets (like Apple Pay and Google Pay)."
},
"currency": {
"type": "string",
"format": "currency",
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK."
},
"exp_year": {
"type": "integer",
"description": "The expiration year of the card."
},
"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
}
},
"shipping": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_card_shipping"
}
],
"nullable": true,
"description": "Where and how the card will be shipped."
},
"exp_month": {
"type": "integer",
"description": "The expiration month of the card."
},
"cardholder": {
"$ref": "#/components/schemas/issuing.cardholder"
},
"replaced_by": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.card"
}
],
"nullable": true,
"description": "The latest card that replaces this card, if any.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.card"
}
]
}
},
"second_line": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Text separate from cardholder name, printed on the card."
},
"replacement_for": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.card"
}
],
"nullable": true,
"description": "The card this card replaces, if any.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.card"
}
]
}
},
"financial_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The financial account this card is attached to."
},
"spending_controls": {
"$ref": "#/components/schemas/issuing_card_authorization_controls"
},
"lifecycle_controls": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_card_lifecycle_controls"
}
],
"nullable": true,
"description": "Rules that control the lifecycle of this card, such as automatic cancellation. Refer to our [documentation](/issuing/controls/lifecycle-controls) for more details."
},
"replacement_reason": {
"enum": [
"damaged",
"expired",
"fulfillment_error",
"lost",
"stolen"
],
"type": "string",
"nullable": true,
"description": "The reason why the previous card needed to be replaced.",
"x-stripeBypassValidation": true
},
"cancellation_reason": {
"enum": [
"design_rejected",
"fulfillment_error",
"lost",
"stolen"
],
"type": "string",
"nullable": true,
"description": "The reason why the card was canceled.",
"x-stripeBypassValidation": true
},
"latest_fraud_warning": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_card_fraud_warning"
}
],
"nullable": true,
"description": "Stripe’s assessment of whether this card’s details have been compromised. If this property isn't null, cancel and reissue the card to prevent fraudulent activity risk."
},
"personalization_design": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.personalization_design"
}
],
"nullable": true,
"description": "The personalization design object belonging to this card.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.personalization_design"
}
]
}
}
},
"description": "You can [create physical or virtual cards](https://docs.stripe.com/issuing) that are issued to cardholders.",
"x-resourceId": "issuing.card",
"x-expandableFields": [
"cardholder",
"latest_fraud_warning",
"lifecycle_controls",
"personalization_design",
"replaced_by",
"replacement_for",
"shipping",
"spending_controls",
"wallets"
]
}
issuing.cardholder
{
"type": "object",
"title": "IssuingCardholder",
"required": [
"billing",
"created",
"id",
"livemode",
"metadata",
"name",
"object",
"requirements",
"status",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"name": {
"type": "string",
"maxLength": 5000,
"description": "The cardholder's name. This will be printed on cards issued to them."
},
"type": {
"enum": [
"company",
"individual"
],
"type": "string",
"description": "One of `individual` or `company`. See [Choose a cardholder type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details.",
"x-stripeBypassValidation": true
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The cardholder's email address."
},
"object": {
"enum": [
"issuing.cardholder"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"active",
"blocked",
"inactive"
],
"type": "string",
"description": "Specifies whether to permit authorizations on this cardholder's cards."
},
"billing": {
"$ref": "#/components/schemas/issuing_cardholder_address"
},
"company": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_cardholder_company"
}
],
"nullable": true,
"description": "Additional information about a `company` cardholder."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"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
}
},
"individual": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_cardholder_individual"
}
],
"nullable": true,
"description": "Additional information about an `individual` cardholder."
},
"phone_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details."
},
"requirements": {
"$ref": "#/components/schemas/issuing_cardholder_requirements"
},
"preferred_locales": {
"type": "array",
"items": {
"enum": [
"de",
"en",
"es",
"fr",
"it"
],
"type": "string",
"x-stripeBypassValidation": true
},
"nullable": true,
"description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `da`, `de`, `en`, `es`, `fr`, `it`, `pl`, or `sv`.\n This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder."
},
"spending_controls": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_cardholder_authorization_controls"
}
],
"nullable": true,
"description": "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details."
}
},
"description": "An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://docs.stripe.com/issuing) cards.\n\nRelated guide: [How to create a cardholder](https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder)",
"x-resourceId": "issuing.cardholder",
"x-expandableFields": [
"billing",
"company",
"individual",
"requirements",
"spending_controls"
]
}
issuing.dispute
{
"type": "object",
"title": "IssuingDispute",
"required": [
"amount",
"created",
"currency",
"evidence",
"id",
"livemode",
"metadata",
"object",
"status",
"transaction"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "Disputed amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation)."
},
"object": {
"enum": [
"issuing.dispute"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"expired",
"lost",
"submitted",
"unsubmitted",
"won"
],
"type": "string",
"description": "Current status of the dispute."
},
"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": "The currency the `transaction` was made in."
},
"evidence": {
"$ref": "#/components/schemas/issuing_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
}
},
"treasury": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_dispute_treasury"
}
],
"nullable": true,
"description": "[Treasury](https://docs.stripe.com/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts"
},
"loss_reason": {
"enum": [
"cardholder_authentication_issuer_liability",
"eci5_token_transaction_with_tavv",
"excess_disputes_in_timeframe",
"has_not_met_the_minimum_dispute_amount_requirements",
"invalid_duplicate_dispute",
"invalid_incorrect_amount_dispute",
"invalid_no_authorization",
"invalid_use_of_disputes",
"merchandise_delivered_or_shipped",
"merchandise_or_service_as_described",
"not_cancelled",
"other",
"refund_issued",
"submitted_beyond_allowable_time_limit",
"transaction_3ds_required",
"transaction_approved_after_prior_fraud_dispute",
"transaction_authorized",
"transaction_electronically_read",
"transaction_qualifies_for_visa_easy_payment_service",
"transaction_unattended"
],
"type": "string",
"description": "The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values."
},
"transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.transaction"
}
],
"description": "The transaction being disputed.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.transaction"
}
]
}
},
"balance_transactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/balance_transaction"
},
"nullable": true,
"description": "List of balance transactions associated with the dispute."
}
},
"description": "As a [card issuer](https://docs.stripe.com/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.\n\nRelated guide: [Issuing disputes](https://docs.stripe.com/issuing/purchases/disputes)",
"x-resourceId": "issuing.dispute",
"x-expandableFields": [
"balance_transactions",
"evidence",
"transaction",
"treasury"
]
}
issuing.personalization_design
{
"type": "object",
"title": "IssuingPersonalizationDesign",
"required": [
"created",
"id",
"livemode",
"metadata",
"object",
"physical_bundle",
"preferences",
"rejection_reasons",
"status"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Friendly display name."
},
"object": {
"enum": [
"issuing.personalization_design"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"active",
"inactive",
"rejected",
"review"
],
"type": "string",
"description": "Whether this personalization design can be used to create cards."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"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
}
},
"card_logo": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"lookup_key": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters."
},
"preferences": {
"$ref": "#/components/schemas/issuing_personalization_design_preferences"
},
"carrier_text": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_personalization_design_carrier_text"
}
],
"nullable": true,
"description": "Hash containing carrier text, for use with physical bundles that support carrier text."
},
"physical_bundle": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.physical_bundle"
}
],
"description": "The physical bundle object belonging to this personalization design.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.physical_bundle"
}
]
}
},
"rejection_reasons": {
"$ref": "#/components/schemas/issuing_personalization_design_rejection_reasons"
}
},
"description": "A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.",
"x-resourceId": "issuing.personalization_design",
"x-expandableFields": [
"card_logo",
"carrier_text",
"physical_bundle",
"preferences",
"rejection_reasons"
]
}
issuing.physical_bundle
{
"type": "object",
"title": "IssuingPhysicalBundle",
"required": [
"features",
"id",
"livemode",
"name",
"object",
"status",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"name": {
"type": "string",
"maxLength": 5000,
"description": "Friendly display name."
},
"type": {
"enum": [
"custom",
"standard"
],
"type": "string",
"description": "Whether this physical bundle is a standard Stripe offering or custom-made for you."
},
"object": {
"enum": [
"issuing.physical_bundle"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"active",
"inactive",
"review"
],
"type": "string",
"description": "Whether this physical bundle can be used to create cards."
},
"features": {
"$ref": "#/components/schemas/issuing_physical_bundle_features"
},
"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`."
}
},
"description": "A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.",
"x-resourceId": "issuing.physical_bundle",
"x-expandableFields": [
"features"
]
}
issuing.settlement
{
"type": "object",
"title": "IssuingSettlement",
"required": [
"bin",
"clearing_date",
"created",
"currency",
"id",
"interchange_fees_amount",
"livemode",
"metadata",
"net_total_amount",
"network",
"network_fees_amount",
"network_settlement_identifier",
"object",
"settlement_service",
"status",
"transaction_amount",
"transaction_count"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"bin": {
"type": "string",
"maxLength": 5000,
"description": "The Bank Identification Number reflecting this settlement record."
},
"object": {
"enum": [
"issuing.settlement"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"complete",
"pending"
],
"type": "string",
"description": "The current processing status of this settlement."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"network": {
"enum": [
"maestro",
"visa"
],
"type": "string",
"description": "The card network for this settlement report. One of [\"visa\", \"maestro\"]"
},
"currency": {
"type": "string",
"format": "currency",
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"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
}
},
"clearing_date": {
"type": "integer",
"format": "unix-time",
"description": "The date that the transactions are cleared and posted to user's accounts."
},
"net_total_amount": {
"type": "integer",
"description": "The total net amount required to settle with the network."
},
"transaction_count": {
"type": "integer",
"description": "The total number of transactions reflected in this settlement."
},
"settlement_service": {
"type": "string",
"maxLength": 5000,
"description": "One of `international` or `uk_national_net`."
},
"transaction_amount": {
"type": "integer",
"description": "The total transaction amount reflected in this settlement."
},
"network_fees_amount": {
"type": "integer",
"description": "The total amount of fees owed to the network."
},
"interchange_fees_amount": {
"type": "integer",
"description": "The total interchange received as reimbursement for the transactions."
},
"network_settlement_identifier": {
"type": "string",
"maxLength": 5000,
"description": "The Settlement Identification Number assigned by the network."
}
},
"description": "When a non-stripe BIN is used, any use of an [issued card](https://docs.stripe.com/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.",
"x-resourceId": "issuing.settlement",
"x-expandableFields": []
}
issuing.token
{
"type": "object",
"title": "IssuingNetworkToken",
"required": [
"card",
"created",
"id",
"livemode",
"network",
"network_updated_at",
"object",
"status"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"card": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.card"
}
],
"description": "Card associated with this token.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.card"
}
]
}
},
"last4": {
"type": "string",
"maxLength": 5000,
"description": "The last four digits of the token."
},
"object": {
"enum": [
"issuing.token"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"active",
"deleted",
"requested",
"suspended"
],
"type": "string",
"description": "The usage state of the token."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"network": {
"enum": [
"mastercard",
"visa"
],
"type": "string",
"description": "The token service provider / card network associated with the token."
},
"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`."
},
"network_data": {
"$ref": "#/components/schemas/issuing_network_token_network_data"
},
"wallet_provider": {
"enum": [
"apple_pay",
"google_pay",
"samsung_pay"
],
"type": "string",
"description": "The digital wallet for this token, if one was used."
},
"device_fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The hashed ID derived from the device ID from the card network associated with the token."
},
"network_updated_at": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch."
}
},
"description": "An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://docs.stripe.com/issuing), you can [view and manage these tokens](https://docs.stripe.com/issuing/controls/token-management) through Stripe.",
"x-resourceId": "issuing.token",
"x-expandableFields": [
"card",
"network_data"
]
}
issuing.transaction
{
"type": "object",
"title": "IssuingTransaction",
"required": [
"amount",
"card",
"created",
"currency",
"id",
"livemode",
"merchant_amount",
"merchant_currency",
"merchant_data",
"metadata",
"object",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"card": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.card"
}
],
"description": "The card used to make this transaction.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.card"
}
]
}
},
"type": {
"enum": [
"capture",
"refund"
],
"type": "string",
"description": "The nature of the transaction.",
"x-stripeBypassValidation": true
},
"token": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.token"
}
],
"nullable": true,
"description": "[Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.token"
}
]
}
},
"amount": {
"type": "integer",
"description": "The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
},
"object": {
"enum": [
"issuing.transaction"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"wallet": {
"enum": [
"apple_pay",
"google_pay",
"samsung_pay"
],
"type": "string",
"nullable": true,
"description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"dispute": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.dispute"
}
],
"nullable": true,
"description": "If you've disputed the transaction, the ID of the dispute.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.dispute"
}
]
}
},
"currency": {
"type": "string",
"format": "currency",
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"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
}
},
"treasury": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_treasury"
}
],
"nullable": true,
"description": "[Treasury](https://docs.stripe.com/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts"
},
"cardholder": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.cardholder"
}
],
"nullable": true,
"description": "The cardholder to whom this transaction belongs.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.cardholder"
}
]
}
},
"network_data": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_network_data"
}
],
"nullable": true,
"description": "Details about the transaction, such as processing dates, set by the card network."
},
"authorization": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.authorization"
}
],
"nullable": true,
"description": "The `Authorization` object that led to this transaction.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.authorization"
}
]
}
},
"merchant_data": {
"$ref": "#/components/schemas/issuing_authorization_merchant_data"
},
"amount_details": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_amount_details"
}
],
"nullable": true,
"description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
},
"merchant_amount": {
"type": "integer",
"description": "The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency."
},
"purchase_details": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_purchase_details"
}
],
"nullable": true,
"description": "Additional purchase information that is optionally provided by the merchant."
},
"merchant_currency": {
"type": "string",
"format": "currency",
"description": "The currency with which the merchant is taking payment."
},
"balance_transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/balance_transaction"
}
],
"nullable": true,
"description": "ID of the [balance transaction](https://docs.stripe.com/api/balance_transactions) associated with this transaction.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/balance_transaction"
}
]
}
}
},
"description": "Any use of an [issued card](https://docs.stripe.com/issuing) that results in funds entering or leaving\nyour Stripe account, such as a completed purchase or refund, is represented by an Issuing\n`Transaction` object.\n\nRelated guide: [Issued card transactions](https://docs.stripe.com/issuing/purchases/transactions)",
"x-resourceId": "issuing.transaction",
"x-expandableFields": [
"amount_details",
"authorization",
"balance_transaction",
"card",
"cardholder",
"dispute",
"merchant_data",
"network_data",
"purchase_details",
"token",
"treasury"
]
}
issuing_authorization_amount_details
{
"type": "object",
"title": "IssuingAuthorizationAmountDetails",
"properties": {
"atm_fee": {
"type": "integer",
"nullable": true,
"description": "The fee charged by the ATM for the cash withdrawal."
},
"cashback_amount": {
"type": "integer",
"nullable": true,
"description": "The amount of cash requested by the cardholder."
}
},
"description": "",
"x-expandableFields": []
}
issuing_authorization_authentication_exemption
{
"type": "object",
"title": "IssuingAuthorizationAuthenticationExemption",
"required": [
"claimed_by",
"type"
],
"properties": {
"type": {
"enum": [
"low_value_transaction",
"transaction_risk_analysis",
"unknown"
],
"type": "string",
"description": "The specific exemption claimed for this authorization.",
"x-stripeBypassValidation": true
},
"claimed_by": {
"enum": [
"acquirer",
"issuer"
],
"type": "string",
"description": "The entity that requested the exemption, either the acquiring merchant or the Issuing user."
}
},
"description": "",
"x-expandableFields": []
}
issuing_authorization_fleet_cardholder_prompt_data
{
"type": "object",
"title": "IssuingAuthorizationFleetCardholderPromptData",
"properties": {
"user_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "User ID."
},
"odometer": {
"type": "integer",
"nullable": true,
"description": "Odometer reading."
},
"driver_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Driver ID."
},
"unspecified_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type."
},
"vehicle_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Vehicle number."
},
"alphanumeric_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "[Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID."
}
},
"description": "",
"x-expandableFields": []
}
issuing_authorization_fleet_data
{
"type": "object",
"title": "IssuingAuthorizationFleetData",
"properties": {
"service_type": {
"enum": [
"full_service",
"non_fuel_transaction",
"self_service"
],
"type": "string",
"nullable": true,
"description": "The type of fuel service."
},
"purchase_type": {
"enum": [
"fuel_and_non_fuel_purchase",
"fuel_purchase",
"non_fuel_purchase"
],
"type": "string",
"nullable": true,
"description": "The type of purchase."
},
"reported_breakdown": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_fleet_reported_breakdown"
}
],
"nullable": true,
"description": "More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data."
},
"cardholder_prompt_data": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_fleet_cardholder_prompt_data"
}
],
"nullable": true,
"description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry."
}
},
"description": "",
"x-expandableFields": [
"cardholder_prompt_data",
"reported_breakdown"
]
}
issuing_authorization_fleet_fuel_price_data
{
"type": "object",
"title": "IssuingAuthorizationFleetFuelPriceData",
"properties": {
"gross_amount_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes."
}
},
"description": "",
"x-expandableFields": []
}