issuing_personalization_design_carrier_text
{
"type": "object",
"title": "IssuingPersonalizationDesignCarrierText",
"properties": {
"footer_body": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The footer body text of the carrier letter."
},
"header_body": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The header body text of the carrier letter."
},
"footer_title": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The footer title text of the carrier letter."
},
"header_title": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The header title text of the carrier letter."
}
},
"description": "",
"x-expandableFields": []
}
issuing_personalization_design_preferences
{
"type": "object",
"title": "IssuingPersonalizationDesignPreferences",
"required": [
"is_default"
],
"properties": {
"is_default": {
"type": "boolean",
"description": "Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design."
},
"is_platform_default": {
"type": "boolean",
"nullable": true,
"description": "Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist."
}
},
"description": "",
"x-expandableFields": []
}
issuing_personalization_design_rejection_reasons
{
"type": "object",
"title": "IssuingPersonalizationDesignRejectionReasons",
"properties": {
"card_logo": {
"type": "array",
"items": {
"enum": [
"geographic_location",
"inappropriate",
"network_name",
"non_binary_image",
"non_fiat_currency",
"other",
"other_entity",
"promotional_material"
],
"type": "string"
},
"nullable": true,
"description": "The reason(s) the card logo was rejected."
},
"carrier_text": {
"type": "array",
"items": {
"enum": [
"geographic_location",
"inappropriate",
"network_name",
"non_fiat_currency",
"other",
"other_entity",
"promotional_material"
],
"type": "string"
},
"nullable": true,
"description": "The reason(s) the carrier text was rejected."
}
},
"description": "",
"x-expandableFields": []
}
issuing_physical_bundle_features
{
"type": "object",
"title": "IssuingPhysicalBundleFeatures",
"required": [
"card_logo",
"carrier_text",
"second_line"
],
"properties": {
"card_logo": {
"enum": [
"optional",
"required",
"unsupported"
],
"type": "string",
"description": "The policy for how to use card logo images in a card design with this physical bundle."
},
"second_line": {
"enum": [
"optional",
"required",
"unsupported"
],
"type": "string",
"description": "The policy for how to use a second line on a card with this physical bundle."
},
"carrier_text": {
"enum": [
"optional",
"required",
"unsupported"
],
"type": "string",
"description": "The policy for how to use carrier letter text in a card design with this physical bundle."
}
},
"description": "",
"x-expandableFields": []
}
issuing_transaction_amount_details
{
"type": "object",
"title": "IssuingTransactionAmountDetails",
"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_transaction_fleet_cardholder_prompt_data
{
"type": "object",
"title": "IssuingTransactionFleetCardholderPromptData",
"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."
}
},
"description": "",
"x-expandableFields": []
}
issuing_transaction_fleet_data
{
"type": "object",
"title": "IssuingTransactionFleetData",
"properties": {
"service_type": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`."
},
"purchase_type": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`."
},
"reported_breakdown": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_fleet_reported_breakdown"
}
],
"nullable": true,
"description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data."
},
"cardholder_prompt_data": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_fleet_cardholder_prompt_data"
}
],
"nullable": true,
"description": "Answers to prompts presented to cardholder at point of sale."
}
},
"description": "",
"x-expandableFields": [
"cardholder_prompt_data",
"reported_breakdown"
]
}
issuing_transaction_fleet_fuel_price_data
{
"type": "object",
"title": "IssuingTransactionFleetFuelPriceData",
"properties": {
"gross_amount_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes."
}
},
"description": "",
"x-expandableFields": []
}
issuing_transaction_fleet_non_fuel_price_data
{
"type": "object",
"title": "IssuingTransactionFleetNonFuelPriceData",
"properties": {
"gross_amount_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes."
}
},
"description": "",
"x-expandableFields": []
}
issuing_transaction_fleet_reported_breakdown
{
"type": "object",
"title": "IssuingTransactionFleetReportedBreakdown",
"properties": {
"tax": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_fleet_tax_data"
}
],
"nullable": true,
"description": "Information about tax included in this transaction."
},
"fuel": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_fleet_fuel_price_data"
}
],
"nullable": true,
"description": "Breakdown of fuel portion of the purchase."
},
"non_fuel": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_fleet_non_fuel_price_data"
}
],
"nullable": true,
"description": "Breakdown of non-fuel portion of the purchase."
}
},
"description": "",
"x-expandableFields": [
"fuel",
"non_fuel",
"tax"
]
}
issuing_transaction_fleet_tax_data
{
"type": "object",
"title": "IssuingTransactionFleetTaxData",
"properties": {
"local_amount_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax."
},
"national_amount_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax."
}
},
"description": "",
"x-expandableFields": []
}
issuing_transaction_flight_data
{
"type": "object",
"title": "IssuingTransactionFlightData",
"properties": {
"segments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/issuing_transaction_flight_data_leg"
},
"nullable": true,
"description": "The legs of the trip."
},
"refundable": {
"type": "boolean",
"nullable": true,
"description": "Whether the ticket is refundable."
},
"departure_at": {
"type": "integer",
"nullable": true,
"description": "The time that the flight departed."
},
"travel_agency": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The travel agency that issued the ticket."
},
"passenger_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The name of the passenger."
}
},
"description": "",
"x-expandableFields": [
"segments"
]
}
issuing_transaction_flight_data_leg
{
"type": "object",
"title": "IssuingTransactionFlightDataLeg",
"properties": {
"carrier": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The airline carrier code."
},
"flight_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The flight number."
},
"service_class": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The flight's service class."
},
"stopover_allowed": {
"type": "boolean",
"nullable": true,
"description": "Whether a stopover is allowed on this flight."
},
"arrival_airport_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The three-letter IATA airport code of the flight's destination."
},
"departure_airport_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The three-letter IATA airport code that the flight departed from."
}
},
"description": "",
"x-expandableFields": []
}
issuing_transaction_fuel_data
{
"type": "object",
"title": "IssuingTransactionFuelData",
"required": [
"type",
"unit",
"unit_cost_decimal"
],
"properties": {
"type": {
"type": "string",
"maxLength": 5000,
"description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`."
},
"unit": {
"type": "string",
"maxLength": 5000,
"description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`."
},
"quantity_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places."
},
"unit_cost_decimal": {
"type": "string",
"format": "decimal",
"description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places."
},
"industry_product_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased."
}
},
"description": "",
"x-expandableFields": []
}
issuing_transaction_lodging_data
{
"type": "object",
"title": "IssuingTransactionLodgingData",
"properties": {
"nights": {
"type": "integer",
"nullable": true,
"description": "The number of nights stayed at the lodging."
},
"check_in_at": {
"type": "integer",
"nullable": true,
"description": "The time of checking into the lodging."
}
},
"description": "",
"x-expandableFields": []
}
issuing_transaction_network_data
{
"type": "object",
"title": "IssuingTransactionNetworkData",
"properties": {
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions."
},
"processing_date": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network."
},
"authorization_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter \"S\", followed by a six-digit number. For example, \"S498162\". Please note that the code is not guaranteed to be unique across authorizations."
}
},
"description": "",
"x-expandableFields": []
}
issuing_transaction_purchase_details
{
"type": "object",
"title": "IssuingTransactionPurchaseDetails",
"properties": {
"fuel": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_fuel_data"
}
],
"nullable": true,
"description": "Information about fuel that was purchased with this transaction."
},
"fleet": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_fleet_data"
}
],
"nullable": true,
"description": "Fleet-specific information for transactions using Fleet cards."
},
"flight": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_flight_data"
}
],
"nullable": true,
"description": "Information about the flight that was purchased with this transaction."
},
"lodging": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_lodging_data"
}
],
"nullable": true,
"description": "Information about lodging that was purchased with this transaction."
},
"receipt": {
"type": "array",
"items": {
"$ref": "#/components/schemas/issuing_transaction_receipt_data"
},
"nullable": true,
"description": "The line items in the purchase."
},
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A merchant-specific order number."
}
},
"description": "",
"x-expandableFields": [
"fleet",
"flight",
"fuel",
"lodging",
"receipt"
]
}
issuing_transaction_receipt_data
{
"type": "object",
"title": "IssuingTransactionReceiptData",
"properties": {
"total": {
"type": "integer",
"nullable": true,
"description": "The total for this line item in cents."
},
"quantity": {
"type": "number",
"nullable": true,
"description": "The quantity of the item."
},
"unit_cost": {
"type": "integer",
"nullable": true,
"description": "The unit cost of the item in cents."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The description of the item. The maximum length of this field is 26 characters."
}
},
"description": "",
"x-expandableFields": []
}
issuing_transaction_treasury
{
"type": "object",
"title": "IssuingTransactionTreasury",
"properties": {
"received_debit": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Treasury [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) representing this Issuing transaction if it is a capture"
},
"received_credit": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Treasury [ReceivedCredit](https://docs.stripe.com/api/treasury/received_credits) representing this Issuing transaction if it is a refund"
}
},
"description": "",
"x-expandableFields": []
}
item
{
"type": "object",
"title": "LineItem",
"required": [
"amount_discount",
"amount_subtotal",
"amount_tax",
"amount_total",
"currency",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"price": {
"anyOf": [
{
"$ref": "#/components/schemas/price"
}
],
"nullable": true,
"description": "The price used to generate the line item."
},
"taxes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/line_items_tax_amount"
},
"description": "The taxes applied to the line item."
},
"object": {
"enum": [
"item"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"currency": {
"type": "string",
"format": "currency",
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
},
"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",
"nullable": true,
"description": "The quantity of products being purchased."
},
"discounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/line_items_discount_amount"
},
"description": "The discounts applied to the line item."
},
"amount_tax": {
"type": "integer",
"description": "Total tax amount applied. If no tax was applied, defaults to 0."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name."
},
"amount_total": {
"type": "integer",
"description": "Total after discounts and taxes."
},
"amount_discount": {
"type": "integer",
"description": "Total discount amount applied. If no discounts were applied, defaults to 0."
},
"amount_subtotal": {
"type": "integer",
"description": "Total before any discounts or taxes are applied."
},
"adjustable_quantity": {
"anyOf": [
{
"$ref": "#/components/schemas/line_items_adjustable_quantity"
}
],
"nullable": true
}
},
"description": "A line item.",
"x-resourceId": "item",
"x-expandableFields": [
"adjustable_quantity",
"discounts",
"price",
"taxes"
]
}
klarna_address
{
"type": "object",
"title": "klarna_address",
"properties": {
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The payer address country"
}
},
"description": "",
"x-expandableFields": []
}
klarna_payer_details
{
"type": "object",
"title": "klarna_payer_details",
"properties": {
"address": {
"anyOf": [
{
"$ref": "#/components/schemas/klarna_address"
}
],
"nullable": true,
"description": "The payer's address"
}
},
"description": "",
"x-expandableFields": [
"address"
]
}
legal_entity_company
{
"type": "object",
"title": "LegalEntityCompany",
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The company's legal name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The company's phone number (used for verification)."
},
"address": {
"$ref": "#/components/schemas/address"
},
"name_kana": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Kana variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
},
"structure": {
"enum": [
"free_zone_establishment",
"free_zone_llc",
"government_instrumentality",
"governmental_unit",
"incorporated_non_profit",
"incorporated_partnership",
"limited_liability_partnership",
"llc",
"multi_member_llc",
"private_company",
"private_corporation",
"private_partnership",
"public_company",
"public_corporation",
"public_partnership",
"registered_charity",
"single_member_llc",
"sole_establishment",
"sole_proprietorship",
"tax_exempt_government_instrumentality",
"unincorporated_association",
"unincorporated_non_profit",
"unincorporated_partnership"
],
"type": "string",
"description": "The category identifying the legal structure of the company or legal entity. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details.",
"x-stripeBypassValidation": true
},
"name_kanji": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Kanji variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
},
"address_kana": {
"anyOf": [
{
"$ref": "#/components/schemas/legal_entity_japan_address"
}
],
"nullable": true,
"description": "The Kana variation of the company's primary address (Japan only)."
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/legal_entity_company_verification"
}
],
"nullable": true,
"description": "Information on the verification state of the company."
},
"address_kanji": {
"anyOf": [
{
"$ref": "#/components/schemas/legal_entity_japan_address"
}
],
"nullable": true,
"description": "The Kanji variation of the company's primary address (Japan only)."
},
"owners_provided": {
"type": "boolean",
"description": "Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together)."
},
"tax_id_provided": {
"type": "boolean",
"description": "Whether the company's business ID number was provided."
},
"vat_id_provided": {
"type": "boolean",
"description": "Whether the company's business VAT number was provided."
},
"tax_id_registrar": {
"type": "string",
"maxLength": 5000,
"description": "The jurisdiction in which the `tax_id` is registered (Germany-based companies only)."
},
"export_license_id": {
"type": "string",
"maxLength": 5000,
"description": "The export license ID number of the company, also referred as Import Export Code (India only)."
},
"registration_date": {
"$ref": "#/components/schemas/legal_entity_registration_date"
},
"directors_provided": {
"type": "boolean",
"description": "Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-directors_provided)."
},
"executives_provided": {
"type": "boolean",
"description": "Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided."
},
"export_purpose_code": {
"type": "string",
"maxLength": 5000,
"description": "The purpose code to use for export transactions (India only)."
},
"ownership_declaration": {
"anyOf": [
{
"$ref": "#/components/schemas/legal_entity_ubo_declaration"
}
],
"nullable": true,
"description": "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct."
},
"directorship_declaration": {
"anyOf": [
{
"$ref": "#/components/schemas/legal_entity_directorship_declaration"
}
],
"nullable": true,
"description": "This hash is used to attest that the director information provided to Stripe is both current and correct."
},
"ownership_exemption_reason": {
"enum": [
"qualified_entity_exceeds_ownership_threshold",
"qualifies_as_financial_institution"
],
"type": "string",
"description": "This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details."
},
"representative_declaration": {
"anyOf": [
{
"$ref": "#/components/schemas/legal_entity_representative_declaration"
}
],
"nullable": true,
"description": "This hash is used to attest that the representative is authorized to act as the representative of their legal entity."
}
},
"description": "",
"x-expandableFields": [
"address",
"address_kana",
"address_kanji",
"directorship_declaration",
"ownership_declaration",
"registration_date",
"representative_declaration",
"verification"
]
}
legal_entity_company_verification
{
"type": "object",
"title": "LegalEntityCompanyVerification",
"required": [
"document"
],
"properties": {
"document": {
"$ref": "#/components/schemas/legal_entity_company_verification_document"
}
},
"description": "",
"x-expandableFields": [
"document"
]
}
legal_entity_company_verification_document
{
"type": "object",
"title": "LegalEntityCompanyVerificationDocument",
"properties": {
"back": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "The back of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file).",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"front": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "The front of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file).",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"details": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A user-displayable string describing the verification state of this document."
},
"details_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document."
}
},
"description": "",
"x-expandableFields": [
"back",
"front"
]
}
legal_entity_directorship_declaration
{
"type": "object",
"title": "LegalEntityDirectorshipDeclaration",
"properties": {
"ip": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The IP address from which the directorship declaration attestation was made."
},
"date": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The Unix timestamp marking when the directorship declaration attestation was made."
},
"user_agent": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user-agent string from the browser where the directorship declaration attestation was made."
}
},
"description": "",
"x-expandableFields": []
}
legal_entity_dob
{
"type": "object",
"title": "LegalEntityDOB",
"properties": {
"day": {
"type": "integer",
"nullable": true,
"description": "The day of birth, between 1 and 31."
},
"year": {
"type": "integer",
"nullable": true,
"description": "The four-digit year of birth."
},
"month": {
"type": "integer",
"nullable": true,
"description": "The month of birth, between 1 and 12."
}
},
"description": "",
"x-expandableFields": []
}
legal_entity_japan_address
{
"type": "object",
"title": "LegalEntityJapanAddress",
"properties": {
"city": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "City/Ward."
},
"town": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Town/cho-me."
},
"line1": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Block/Building number."
},
"line2": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Building details."
},
"state": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Prefecture."
},
"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": []
}
legal_entity_person_verification
{
"type": "object",
"title": "LegalEntityPersonVerification",
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"maxLength": 5000,
"description": "The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. Please refer [guide](https://docs.stripe.com/connect/handling-api-verification) to handle verification updates."
},
"details": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A user-displayable string describing the verification state for the person. For example, this may say \"Provided identity information could not be verified\"."
},
"document": {
"$ref": "#/components/schemas/legal_entity_person_verification_document"
},
"details_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person."
},
"additional_document": {
"anyOf": [
{
"$ref": "#/components/schemas/legal_entity_person_verification_document"
}
],
"nullable": true,
"description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company."
}
},
"description": "",
"x-expandableFields": [
"additional_document",
"document"
]
}
legal_entity_person_verification_document
{
"type": "object",
"title": "LegalEntityPersonVerificationDocument",
"properties": {
"back": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "The back of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"front": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "The front of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"details": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say \"Identity document is too unclear to read\"."
},
"details_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document."
}
},
"description": "",
"x-expandableFields": [
"back",
"front"
]
}
legal_entity_registration_date
{
"type": "object",
"title": "LegalEntityRegistrationDate",
"properties": {
"day": {
"type": "integer",
"nullable": true,
"description": "The day of registration, between 1 and 31."
},
"year": {
"type": "integer",
"nullable": true,
"description": "The four-digit year of registration."
},
"month": {
"type": "integer",
"nullable": true,
"description": "The month of registration, between 1 and 12."
}
},
"description": "",
"x-expandableFields": []
}
legal_entity_representative_declaration
{
"type": "object",
"title": "LegalEntityRepresentativeDeclaration",
"properties": {
"ip": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The IP address from which the representative declaration attestation was made."
},
"date": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The Unix timestamp marking when the representative declaration attestation was made."
},
"user_agent": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user-agent string from the browser where the representative declaration attestation was made."
}
},
"description": "",
"x-expandableFields": []
}
legal_entity_ubo_declaration
{
"type": "object",
"title": "LegalEntityUBODeclaration",
"properties": {
"ip": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The IP address from which the beneficial owner attestation was made."
},
"date": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The Unix timestamp marking when the beneficial owner attestation was made."
},
"user_agent": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user-agent string from the browser where the beneficial owner attestation was made."
}
},
"description": "",
"x-expandableFields": []
}
line_item
{
"type": "object",
"title": "InvoiceLineItem",
"required": [
"amount",
"currency",
"discountable",
"discounts",
"id",
"livemode",
"metadata",
"object",
"period",
"subtotal"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"taxes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax"
},
"nullable": true,
"description": "The tax information of the line item."
},
"amount": {
"type": "integer",
"description": "The amount, in cents (or local equivalent)."
},
"object": {
"enum": [
"line_item"
],
"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_invoicing_lines_parents_invoice_line_item_parent"
}
],
"nullable": true,
"description": "The parent that generated this line item."
},
"period": {
"$ref": "#/components/schemas/invoice_line_item_period"
},
"invoice": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of the invoice that contains this line item."
},
"pricing": {
"anyOf": [
{
"$ref": "#/components/schemas/billing_bill_resource_invoicing_pricing_pricing"
}
],
"nullable": true,
"description": "The pricing information of the line 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)."
},
"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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"quantity": {
"type": "integer",
"nullable": true,
"description": "Quantity of units for the invoice line item in integer format, with any decimal precision truncated. For the line 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 line item is a proration or subscription, the quantity of the subscription that the proration was computed for."
},
"subtotal": {
"type": "integer",
"description": "The subtotal of the line item, in cents (or local equivalent), before any discounts or taxes."
},
"discounts": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/discount"
}
],
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/discount"
}
]
}
},
"description": "The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount."
},
"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 line item. Always false for prorations."
},
"subscription": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/subscription"
}
],
"nullable": true,
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/subscription"
}
]
}
},
"discount_amounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/discounts_resource_discount_amount"
},
"nullable": true,
"description": "The amount of discount calculated per discount for this line item."
},
"quantity_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "Non-negative decimal with at most 12 decimal places. The quantity of units for the line item."
},
"pretax_credit_amounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/invoices_resource_pretax_credit_amount"
},
"nullable": true,
"description": "Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item."
}
},
"description": "Invoice Line Items represent the individual lines within an [invoice](https://docs.stripe.com/api/invoices) and only exist within the context of an invoice.\n\nEach line item is backed by either an [invoice item](https://docs.stripe.com/api/invoiceitems) or a [subscription item](https://docs.stripe.com/api/subscription_items).",
"x-resourceId": "line_item",
"x-expandableFields": [
"discount_amounts",
"discounts",
"parent",
"period",
"pretax_credit_amounts",
"pricing",
"subscription",
"taxes"
]
}
line_items_adjustable_quantity
{
"type": "object",
"title": "LineItemsAdjustableQuantity",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"maximum": {
"type": "integer",
"nullable": true
},
"minimum": {
"type": "integer",
"nullable": true
}
},
"description": "",
"x-expandableFields": []
}
line_items_discount_amount
{
"type": "object",
"title": "LineItemsDiscountAmount",
"required": [
"amount",
"discount"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount discounted."
},
"discount": {
"$ref": "#/components/schemas/discount"
}
},
"description": "",
"x-expandableFields": [
"discount"
]
}
line_items_tax_amount
{
"type": "object",
"title": "LineItemsTaxAmount",
"required": [
"amount",
"rate"
],
"properties": {
"rate": {
"$ref": "#/components/schemas/tax_rate"
},
"amount": {
"type": "integer",
"description": "Amount of tax applied for this rate."
},
"taxable_amount": {
"type": "integer",
"nullable": true,
"description": "The amount on which tax is calculated, in cents (or local equivalent)."
},
"taxability_reason": {
"enum": [
"customer_exempt",
"not_collecting",
"not_subject_to_tax",
"not_supported",
"portion_product_exempt",
"portion_reduced_rated",
"portion_standard_rated",
"product_exempt",
"product_exempt_holiday",
"proportionally_rated",
"reduced_rated",
"reverse_charge",
"standard_rated",
"taxable_basis_reduced",
"zero_rated"
],
"type": "string",
"nullable": true,
"description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": [
"rate"
]
}
linked_account_options_common
{
"type": "object",
"title": "linked_account_options_common",
"properties": {
"filters": {
"$ref": "#/components/schemas/payment_flows_private_payment_methods_financial_connections_common_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."
},
"return_url": {
"type": "string",
"maxLength": 5000,
"description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app."
},
"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"
]
}
login_link
{
"type": "object",
"title": "LoginLink",
"required": [
"created",
"object",
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 5000,
"description": "The URL for the login link."
},
"object": {
"enum": [
"login_link"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
}
},
"description": "Login Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard.\nA Login Link differs from an [Account Link](https://docs.stripe.com/api/account_links) in that it takes the user directly to their [Express dashboard for the specified account](https://docs.stripe.com/connect/integrate-express-dashboard#create-login-link)",
"x-resourceId": "login_link",
"x-expandableFields": []
}
mandate
{
"type": "object",
"title": "Mandate",
"required": [
"customer_acceptance",
"id",
"livemode",
"object",
"payment_method",
"payment_method_details",
"status",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"type": {
"enum": [
"multi_use",
"single_use"
],
"type": "string",
"description": "The type of the mandate."
},
"object": {
"enum": [
"mandate"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"active",
"inactive",
"pending"
],
"type": "string",
"description": "The mandate status indicates whether or not you can use it to initiate a payment."
},
"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`."
},
"multi_use": {
"$ref": "#/components/schemas/mandate_multi_use"
},
"single_use": {
"$ref": "#/components/schemas/mandate_single_use"
},
"on_behalf_of": {
"type": "string",
"maxLength": 5000,
"description": "The account (if any) that the mandate is intended for."
},
"payment_method": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"description": "ID of the payment method associated with this mandate.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
},
"customer_acceptance": {
"$ref": "#/components/schemas/customer_acceptance"
},
"payment_method_details": {
"$ref": "#/components/schemas/mandate_payment_method_details"
}
},
"description": "A Mandate is a record of the permission that your customer gives you to debit their payment method.",
"x-resourceId": "mandate",
"x-expandableFields": [
"customer_acceptance",
"multi_use",
"payment_method",
"payment_method_details",
"single_use"
]
}
mandate_acss_debit
{
"type": "object",
"title": "mandate_acss_debit",
"required": [
"payment_schedule",
"transaction_type"
],
"properties": {
"default_for": {
"type": "array",
"items": {
"enum": [
"invoice",
"subscription"
],
"type": "string"
},
"description": "List of Stripe products where this mandate can be selected automatically."
},
"payment_schedule": {
"enum": [
"combined",
"interval",
"sporadic"
],
"type": "string",
"description": "Payment schedule for the mandate."
},
"transaction_type": {
"enum": [
"business",
"personal"
],
"type": "string",
"description": "Transaction type of the mandate."
},
"interval_description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'."
}
},
"description": "",
"x-expandableFields": []
}
mandate_amazon_pay
{
"type": "object",
"title": "mandate_amazon_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
mandate_au_becs_debit
{
"type": "object",
"title": "mandate_au_becs_debit",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 5000,
"description": "The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively."
}
},
"description": "",
"x-expandableFields": []
}
mandate_bacs_debit
{
"type": "object",
"title": "mandate_bacs_debit",
"required": [
"network_status",
"reference",
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 5000,
"description": "The URL that will contain the mandate that the customer has signed."
},
"reference": {
"type": "string",
"maxLength": 5000,
"description": "The unique reference identifying the mandate on the Bacs network."
},
"display_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The display name for the account on this mandate."
},
"network_status": {
"enum": [
"accepted",
"pending",
"refused",
"revoked"
],
"type": "string",
"description": "The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`."
},
"revocation_reason": {
"enum": [
"account_closed",
"bank_account_restricted",
"bank_ownership_changed",
"could_not_process",
"debit_not_authorized"
],
"type": "string",
"nullable": true,
"description": "When the mandate is revoked on the Bacs network this field displays the reason for the revocation."
},
"service_user_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The service user number for the account on this mandate."
}
},
"description": "",
"x-expandableFields": []
}
mandate_cashapp
{
"type": "object",
"title": "mandate_cashapp",
"properties": {},
"description": "",
"x-expandableFields": []
}
mandate_kakao_pay
{
"type": "object",
"title": "mandate_kakao_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
mandate_klarna
{
"type": "object",
"title": "mandate_klarna",
"properties": {},
"description": "",
"x-expandableFields": []
}
mandate_kr_card
{
"type": "object",
"title": "mandate_kr_card",
"properties": {},
"description": "",
"x-expandableFields": []
}
mandate_link
{
"type": "object",
"title": "mandate_link",
"properties": {},
"description": "",
"x-expandableFields": []
}
mandate_multi_use
{
"type": "object",
"title": "mandate_multi_use",
"properties": {
"amount": {
"type": "integer",
"description": "The amount of the payment on a multi use mandate."
},
"currency": {
"type": "string",
"format": "currency",
"description": "The currency of the payment on a multi use mandate."
}
},
"description": "",
"x-expandableFields": []
}