payments_primitives_payment_records_resource_amount
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourceAmount",
"required": [
"currency",
"value"
],
"properties": {
"value": {
"type": "integer",
"description": "A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY."
},
"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)."
}
},
"description": "A representation of an amount of money, consisting of an amount and a currency.",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_billing_details
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourceBillingDetails",
"required": [
"address"
],
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The billing name associated with the method of payment."
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The billing email associated with the method of payment."
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The billing phone number associated with the method of payment."
},
"address": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_address"
}
},
"description": "Billing details used by the customer for this payment.",
"x-expandableFields": [
"address"
]
}
payments_primitives_payment_records_resource_customer_details
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourceCustomerDetails",
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The customer's name."
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The customer's email address."
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The customer's phone number."
},
"customer": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the Stripe Customer associated with this payment."
}
},
"description": "Information about the customer for this payment.",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_payment_method_alma_details_resource_installments
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodAlmaDetailsResourceInstallments",
"required": [
"count"
],
"properties": {
"count": {
"type": "integer",
"description": "The number of installments."
}
},
"description": "",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_payment_method_amazon_pay_details_resource_funding
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodAmazonPayDetailsResourceFunding",
"properties": {
"card": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_amazon_pay_details_resource_funding_resource_funding_card"
},
"type": {
"enum": [
"card"
],
"type": "string",
"nullable": true,
"description": "funding type of the underlying payment method."
}
},
"description": "",
"x-expandableFields": [
"card"
]
}
payments_primitives_payment_records_resource_payment_method_amazon_pay_details_resource_funding_resource_funding_card
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodAmazonPayDetailsResourceFundingResourceFundingCard",
"properties": {
"brand": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
},
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The last four digits of the card."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."
},
"funding": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
},
"exp_year": {
"type": "integer",
"nullable": true,
"description": "Four-digit number representing the card's expiration year."
},
"exp_month": {
"type": "integer",
"nullable": true,
"description": "Two-digit number representing the card's expiration month."
}
},
"description": "",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_payment_method_card_details
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetails",
"properties": {
"brand": {
"enum": [
"amex",
"cartes_bancaires",
"diners",
"discover",
"eftpos_au",
"interac",
"jcb",
"link",
"mastercard",
"unionpay",
"unknown",
"visa"
],
"type": "string",
"nullable": true,
"description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
},
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The last four digits of the card."
},
"checks": {
"anyOf": [
{
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_checks"
}
],
"nullable": true,
"description": "Check results by Card networks on Card address and CVC at time of payment."
},
"wallet": {
"anyOf": [
{
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet"
}
],
"nullable": true,
"description": "If this Card is part of a card wallet, this contains the details of the card wallet."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."
},
"funding": {
"enum": [
"credit",
"debit",
"prepaid",
"unknown"
],
"type": "string",
"nullable": true,
"description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
},
"network": {
"enum": [
"amex",
"cartes_bancaires",
"diners",
"discover",
"eftpos_au",
"interac",
"jcb",
"link",
"mastercard",
"unionpay",
"unknown",
"visa"
],
"type": "string",
"nullable": true,
"description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`."
},
"exp_year": {
"type": "integer",
"nullable": true,
"description": "Four-digit number representing the card's expiration year."
},
"exp_month": {
"type": "integer",
"nullable": true,
"description": "Two-digit number representing the card's expiration month."
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"
},
"installments": {
"anyOf": [
{
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_installments"
}
],
"nullable": true,
"description": "Installment details for this payment."
},
"network_token": {
"anyOf": [
{
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_network_token"
}
],
"nullable": true,
"description": "If this card has network token credentials, this contains the details of the network token credentials."
},
"capture_before": {
"type": "integer",
"format": "unix-time",
"description": "When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured."
},
"three_d_secure": {
"anyOf": [
{
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_three_d_secure"
}
],
"nullable": true,
"description": "Populated if this transaction used 3D Secure authentication."
},
"authorization_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The authorization code of the payment."
},
"network_advice_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Advice code from the card network for the failed payment."
},
"network_decline_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Decline code from the card network for the failed payment."
},
"network_transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise."
}
},
"description": "Details of the card used for this payment attempt.",
"x-expandableFields": [
"checks",
"installments",
"network_token",
"three_d_secure",
"wallet"
]
}
payments_primitives_payment_records_resource_payment_method_card_details_resource_checks
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceChecks",
"properties": {
"cvc_check": {
"enum": [
"fail",
"pass",
"unavailable",
"unchecked"
],
"type": "string",
"nullable": true,
"description": "If you provide a CVC, the check results is one of `pass`, `fail`, `unavailable`, or `unchecked`."
},
"address_line1_check": {
"enum": [
"fail",
"pass",
"unavailable",
"unchecked"
],
"type": "string",
"nullable": true,
"description": "If you provide a value for `address.line1`, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`."
},
"address_postal_code_check": {
"enum": [
"fail",
"pass",
"unavailable",
"unchecked"
],
"type": "string",
"nullable": true,
"description": "If you provide a address postal code, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`."
}
},
"description": "",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_payment_method_card_details_resource_installment_plan
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceInstallmentPlan",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"bonus",
"fixed_count",
"revolving"
],
"type": "string",
"description": "Type of installment plan, one of `fixed_count`, `revolving`, or `bonus`."
},
"count": {
"type": "integer",
"nullable": true,
"description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card."
},
"interval": {
"enum": [
"month"
],
"type": "string",
"nullable": true,
"description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. One of `month`."
}
},
"description": "",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_payment_method_card_details_resource_installments
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceInstallments",
"properties": {
"plan": {
"anyOf": [
{
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_installment_plan"
}
],
"nullable": true,
"description": "Installment plan selected for the payment."
}
},
"description": "",
"x-expandableFields": [
"plan"
]
}
payments_primitives_payment_records_resource_payment_method_card_details_resource_network_token
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceNetworkToken",
"required": [
"used"
],
"properties": {
"used": {
"type": "boolean",
"description": "Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction."
}
},
"description": "",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_payment_method_card_details_resource_three_d_secure
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceThreeDSecure",
"properties": {
"result": {
"enum": [
"attempt_acknowledged",
"authenticated",
"exempted",
"failed",
"not_supported",
"processing_error"
],
"type": "string",
"nullable": true,
"description": "Indicates the outcome of 3D Secure authentication."
},
"version": {
"enum": [
"1.0.2",
"2.1.0",
"2.2.0"
],
"type": "string",
"nullable": true,
"description": "The version of 3D Secure that was used."
},
"cryptogram": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The 3D Secure cryptogram, also known as the \"authentication value\" (AAV, CAVV or AEVV)."
},
"result_reason": {
"enum": [
"abandoned",
"bypassed",
"canceled",
"card_not_enrolled",
"network_not_supported",
"protocol_error",
"rejected"
],
"type": "string",
"nullable": true,
"description": "Additional information about why 3D Secure succeeded or failed, based on the `result`."
},
"authentication_flow": {
"enum": [
"challenge",
"frictionless"
],
"type": "string",
"nullable": true,
"description": "For authenticated transactions: Indicates how the issuing bank authenticated the customer."
},
"exemption_indicator": {
"enum": [
"low_risk",
"none"
],
"type": "string",
"nullable": true,
"description": "The exemption requested via 3DS and accepted by the issuer at authentication time."
},
"exemption_indicator_applied": {
"type": "boolean",
"nullable": true,
"description": "Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on the outcome of Stripe's internal risk assessment."
},
"electronic_commerce_indicator": {
"enum": [
"01",
"02",
"03",
"04",
"05",
"06",
"07"
],
"type": "string",
"nullable": true,
"description": "The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed."
}
},
"description": "",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWallet",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"maxLength": 5000,
"description": "The type of the card wallet, one of `apple_pay` or `google_pay`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type."
},
"apple_pay": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_apple_pay"
},
"google_pay": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_google_pay"
},
"dynamic_last4": {
"type": "string",
"maxLength": 5000,
"description": "(For tokenized numbers only.) The last four digits of the device account number."
}
},
"description": "",
"x-expandableFields": [
"apple_pay",
"google_pay"
]
}
payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_apple_pay
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWalletResourceApplePay",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"maxLength": 5000,
"description": "Type of the apple_pay transaction, one of `apple_pay` or `apple_pay_later`."
}
},
"description": "",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_google_pay
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWalletResourceGooglePay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_payment_method_custom_details
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCustomDetails",
"required": [
"display_name"
],
"properties": {
"type": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The custom payment method type associated with this payment."
},
"display_name": {
"type": "string",
"maxLength": 5000,
"description": "Display name for the custom (user-defined) payment method type used to make this payment."
}
},
"description": "Custom Payment Methods represent Payment Method types not modeled directly in\nthe Stripe API. This resource consists of details about the custom payment method\nused for this payment attempt.",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_payment_method_details
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails",
"required": [
"type"
],
"properties": {
"eps": {
"$ref": "#/components/schemas/payment_method_details_payment_record_eps"
},
"fpx": {
"$ref": "#/components/schemas/payment_method_details_fpx"
},
"p24": {
"$ref": "#/components/schemas/payment_method_details_payment_record_p24"
},
"pix": {
"$ref": "#/components/schemas/payment_method_details_payment_record_pix"
},
"upi": {
"$ref": "#/components/schemas/payment_method_details_payment_record_upi"
},
"zip": {
"$ref": "#/components/schemas/payment_method_details_payment_record_zip"
},
"alma": {
"$ref": "#/components/schemas/payment_method_details_payment_record_alma"
},
"blik": {
"$ref": "#/components/schemas/payment_method_details_payment_record_blik"
},
"card": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details"
},
"link": {
"$ref": "#/components/schemas/payment_method_details_payment_record_link"
},
"oxxo": {
"$ref": "#/components/schemas/payment_method_details_payment_record_oxxo"
},
"type": {
"type": "string",
"maxLength": 5000,
"description": "The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) for the full list of possible types.\nAn additional hash is included on `payment_method_details` with a name matching this value.\nIt contains information specific to the payment method."
},
"bizum": {
"$ref": "#/components/schemas/payment_method_details_payment_record_bizum"
},
"ideal": {
"$ref": "#/components/schemas/payment_method_details_payment_record_ideal"
},
"payco": {
"$ref": "#/components/schemas/payment_method_details_payment_record_payco"
},
"payto": {
"$ref": "#/components/schemas/payment_method_details_payment_record_payto"
},
"swish": {
"$ref": "#/components/schemas/payment_method_details_payment_record_swish"
},
"twint": {
"$ref": "#/components/schemas/payment_method_details_payment_record_twint"
},
"affirm": {
"$ref": "#/components/schemas/payment_method_details_payment_record_affirm"
},
"alipay": {
"$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay_details"
},
"billie": {
"$ref": "#/components/schemas/payment_method_details_payment_record_billie"
},
"boleto": {
"$ref": "#/components/schemas/payment_method_details_payment_record_boleto"
},
"crypto": {
"$ref": "#/components/schemas/payment_method_details_crypto"
},
"custom": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_custom_details"
},
"klarna": {
"$ref": "#/components/schemas/payment_method_details_payment_record_klarna"
},
"mb_way": {
"$ref": "#/components/schemas/payment_method_details_payment_record_mb_way"
},
"paynow": {
"$ref": "#/components/schemas/payment_method_details_payment_record_paynow"
},
"paypal": {
"$ref": "#/components/schemas/payment_method_details_paypal"
},
"sofort": {
"$ref": "#/components/schemas/payment_method_details_payment_record_sofort"
},
"sunbit": {
"$ref": "#/components/schemas/payment_method_details_payment_record_sunbit"
},
"wechat": {
"$ref": "#/components/schemas/payment_method_details_wechat"
},
"cashapp": {
"$ref": "#/components/schemas/payment_method_details_payment_record_cashapp"
},
"giropay": {
"$ref": "#/components/schemas/payment_method_details_payment_record_giropay"
},
"grabpay": {
"$ref": "#/components/schemas/payment_method_details_grabpay"
},
"konbini": {
"$ref": "#/components/schemas/payment_method_details_payment_record_konbini"
},
"kr_card": {
"$ref": "#/components/schemas/payment_method_details_kr_card"
},
"satispay": {
"$ref": "#/components/schemas/payment_method_details_payment_record_satispay"
},
"scalapay": {
"$ref": "#/components/schemas/payment_method_details_payment_record_scalapay"
},
"ach_debit": {
"$ref": "#/components/schemas/payment_method_details_ach_debit"
},
"kakao_pay": {
"$ref": "#/components/schemas/payment_method_details_payment_record_kakao_pay"
},
"mobilepay": {
"$ref": "#/components/schemas/payment_method_details_payment_record_mobilepay"
},
"naver_pay": {
"$ref": "#/components/schemas/payment_method_details_payment_record_naver_pay"
},
"promptpay": {
"$ref": "#/components/schemas/payment_method_details_payment_record_promptpay"
},
"acss_debit": {
"$ref": "#/components/schemas/payment_method_details_payment_record_acss_debit"
},
"amazon_pay": {
"$ref": "#/components/schemas/payment_method_details_payment_record_amazon_pay"
},
"bacs_debit": {
"$ref": "#/components/schemas/payment_method_details_bacs_debit"
},
"bancontact": {
"$ref": "#/components/schemas/payment_method_details_payment_record_bancontact"
},
"multibanco": {
"$ref": "#/components/schemas/payment_method_details_payment_record_multibanco"
},
"sepa_debit": {
"$ref": "#/components/schemas/payment_method_details_payment_record_sepa_debit"
},
"wechat_pay": {
"$ref": "#/components/schemas/payment_method_details_payment_record_wechat_pay"
},
"pay_by_bank": {
"$ref": "#/components/schemas/payment_method_details_payment_record_pay_by_bank"
},
"revolut_pay": {
"$ref": "#/components/schemas/payment_method_details_payment_record_revolut_pay"
},
"samsung_pay": {
"$ref": "#/components/schemas/payment_method_details_payment_record_samsung_pay"
},
"card_present": {
"$ref": "#/components/schemas/payment_method_details_card_present"
},
"au_becs_debit": {
"$ref": "#/components/schemas/payment_method_details_au_becs_debit"
},
"payment_method": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the Stripe PaymentMethod used to make this payment."
},
"stripe_account": {
"$ref": "#/components/schemas/payment_method_details_stripe_account"
},
"billing_details": {
"anyOf": [
{
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_billing_details"
}
],
"nullable": true,
"description": "The billing details associated with the method of payment."
},
"interac_present": {
"$ref": "#/components/schemas/payment_method_details_interac_present"
},
"nz_bank_account": {
"$ref": "#/components/schemas/payment_method_details_nz_bank_account"
},
"us_bank_account": {
"$ref": "#/components/schemas/payment_method_details_payment_record_us_bank_account"
},
"customer_balance": {
"$ref": "#/components/schemas/payment_method_details_customer_balance"
},
"afterpay_clearpay": {
"$ref": "#/components/schemas/payment_method_details_payment_record_afterpay_clearpay"
},
"ach_credit_transfer": {
"$ref": "#/components/schemas/payment_method_details_ach_credit_transfer"
}
},
"description": "Details about the Payment Method used in this payment attempt.",
"x-expandableFields": [
"ach_credit_transfer",
"ach_debit",
"acss_debit",
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"billing_details",
"bizum",
"blik",
"boleto",
"card",
"card_present",
"cashapp",
"crypto",
"custom",
"customer_balance",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"interac_present",
"kakao_pay",
"klarna",
"konbini",
"kr_card",
"link",
"mb_way",
"mobilepay",
"multibanco",
"naver_pay",
"nz_bank_account",
"oxxo",
"p24",
"pay_by_bank",
"payco",
"paynow",
"paypal",
"payto",
"pix",
"promptpay",
"revolut_pay",
"samsung_pay",
"satispay",
"scalapay",
"sepa_debit",
"sofort",
"stripe_account",
"sunbit",
"swish",
"twint",
"upi",
"us_bank_account",
"wechat",
"wechat_pay",
"zip"
]
}
payments_primitives_payment_records_resource_payment_method_klarna_details_resource_payer_details
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodKlarnaDetailsResourcePayerDetails",
"properties": {
"address": {
"anyOf": [
{
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_klarna_details_resource_payer_details_resource_payer_details_address"
}
],
"nullable": true,
"description": "The payer's address"
}
},
"description": "",
"x-expandableFields": [
"address"
]
}
payments_primitives_payment_records_resource_payment_method_klarna_details_resource_payer_details_resource_payer_details_address
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodKlarnaDetailsResourcePayerDetailsResourcePayerDetailsAddress",
"properties": {
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The payer address country"
}
},
"description": "",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_payment_method_konbini_details_resource_store
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodKonbiniDetailsResourceStore",
"properties": {
"chain": {
"enum": [
"familymart",
"lawson",
"ministop",
"seicomart"
],
"type": "string",
"nullable": true,
"description": "The name of the convenience store chain where the payment was completed.",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_payment_method_mobilepay_details_resource_card
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodMobilepayDetailsResourceCard",
"properties": {
"brand": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Brand of the card used in the transaction"
},
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The last 4 digits of the card"
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter ISO code representing the country of the card"
},
"exp_year": {
"type": "integer",
"nullable": true,
"description": "Two digit number representing the card's expiration year"
},
"exp_month": {
"type": "integer",
"nullable": true,
"description": "Two digit number representing the card's expiration month"
}
},
"description": "",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_payment_method_revolut_pay_details_resource_funding
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodRevolutPayDetailsResourceFunding",
"properties": {
"card": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_revolut_pay_details_resource_funding_resource_funding_card"
},
"type": {
"enum": [
"card"
],
"type": "string",
"nullable": true,
"description": "Funding type of the underlying payment method."
}
},
"description": "",
"x-expandableFields": [
"card"
]
}
payments_primitives_payment_records_resource_payment_method_revolut_pay_details_resource_funding_resource_funding_card
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodRevolutPayDetailsResourceFundingResourceFundingCard",
"properties": {
"brand": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
},
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The last four digits of the card."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."
},
"funding": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
},
"exp_year": {
"type": "integer",
"nullable": true,
"description": "Four-digit number representing the card's expiration year."
},
"exp_month": {
"type": "integer",
"nullable": true,
"description": "Two-digit number representing the card's expiration month."
}
},
"description": "",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_processor_details
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourceProcessorDetails",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"custom"
],
"type": "string",
"description": "The processor used for this payment attempt.",
"x-stripeBypassValidation": true
},
"custom": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_processor_details_resource_custom_details"
}
},
"description": "Processor information associated with this payment.",
"x-expandableFields": [
"custom"
]
}
payments_primitives_payment_records_resource_processor_details_resource_custom_details
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourceProcessorDetailsResourceCustomDetails",
"properties": {
"payment_reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID."
}
},
"description": "Custom processors represent payment processors not modeled directly in\nthe Stripe API. This resource consists of details about the custom processor\nused for this payment attempt.",
"x-expandableFields": []
}
payments_primitives_payment_records_resource_shipping_details
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourceShippingDetails",
"required": [
"address"
],
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The shipping recipient's name."
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The shipping recipient's phone number."
},
"address": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_address"
}
},
"description": "The customer's shipping information associated with this payment.",
"x-expandableFields": [
"address"
]
}
payout
{
"type": "object",
"title": "Payout",
"required": [
"amount",
"arrival_date",
"automatic",
"created",
"currency",
"id",
"livemode",
"method",
"object",
"reconciliation_status",
"source_type",
"status",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"type": {
"enum": [
"bank_account",
"card"
],
"type": "string",
"description": "Can be `bank_account` or `card`.",
"x-stripeBypassValidation": true
},
"amount": {
"type": "integer",
"description": "The amount (in cents (or local equivalent)) that transfers to your bank account or debit card."
},
"method": {
"type": "string",
"maxLength": 5000,
"description": "The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks)."
},
"object": {
"enum": [
"payout"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"type": "string",
"maxLength": 5000,
"description": "Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"currency": {
"type": "string",
"format": "currency",
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
},
"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
}
},
"trace_id": {
"anyOf": [
{
"$ref": "#/components/schemas/payouts_trace_id"
}
],
"nullable": true,
"description": "A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a \"reference number\" or something similar."
},
"automatic": {
"type": "boolean",
"description": "Returns `true` if the payout is created by an [automated payout schedule](https://docs.stripe.com/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts)."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"destination": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/bank_account"
},
{
"$ref": "#/components/schemas/card"
},
{
"$ref": "#/components/schemas/deleted_bank_account"
},
{
"$ref": "#/components/schemas/deleted_card"
}
],
"nullable": true,
"description": "ID of the bank account or card the payout is sent to.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/bank_account"
},
{
"$ref": "#/components/schemas/card"
},
{
"$ref": "#/components/schemas/deleted_bank_account"
},
{
"$ref": "#/components/schemas/deleted_card"
}
]
},
"x-stripeBypassValidation": true
},
"reversed_by": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payout"
}
],
"nullable": true,
"description": "If the payout reverses, this is the ID of the payout that reverses this payout.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payout"
}
]
}
},
"source_type": {
"type": "string",
"maxLength": 5000,
"description": "The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`."
},
"arrival_date": {
"type": "integer",
"format": "unix-time",
"description": "Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays."
},
"failure_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://docs.stripe.com/api#payout_failures)."
},
"payout_method": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the v2 FinancialAccount the funds are sent to."
},
"application_fee": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/application_fee"
}
],
"nullable": true,
"description": "The application fee (if any) for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/application_fee"
}
]
}
},
"failure_message": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Message that provides the reason for a payout failure, if available."
},
"original_payout": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payout"
}
],
"nullable": true,
"description": "If the payout reverses another, this is the ID of the original payout.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payout"
}
]
}
},
"balance_transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/balance_transaction"
}
],
"nullable": true,
"description": "ID of the balance transaction that describes the impact of this payout on your account balance.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/balance_transaction"
}
]
}
},
"statement_descriptor": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Extra information about a payout that displays on the user's bank statement."
},
"reconciliation_status": {
"enum": [
"completed",
"in_progress",
"not_applicable"
],
"type": "string",
"description": "If `completed`, you can use the [Balance Transactions API](https://docs.stripe.com/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout."
},
"application_fee_amount": {
"type": "integer",
"nullable": true,
"description": "The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details."
},
"failure_balance_transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/balance_transaction"
}
],
"nullable": true,
"description": "If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/balance_transaction"
}
]
}
}
},
"description": "A `Payout` object is created when you receive funds from Stripe, or when you\ninitiate a payout to either a bank account or debit card of a [connected\nStripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,\nand list all payouts. Payouts are made on [varying\nschedules](/docs/connect/manage-payout-schedule), depending on your country and\nindustry.\n\nRelated guide: [Receiving payouts](https://docs.stripe.com/payouts)",
"x-resourceId": "payout",
"x-expandableFields": [
"application_fee",
"balance_transaction",
"destination",
"failure_balance_transaction",
"original_payout",
"reversed_by",
"trace_id"
]
}
payouts_trace_id
{
"type": "object",
"title": "PayoutsTraceID",
"required": [
"status"
],
"properties": {
"value": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The trace ID value if `trace_id.status` is `supported`, otherwise `nil`."
},
"status": {
"type": "string",
"maxLength": 5000,
"description": "Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`."
}
},
"description": "",
"x-expandableFields": []
}
paypal_seller_protection
{
"type": "object",
"title": "paypal_seller_protection",
"required": [
"status"
],
"properties": {
"status": {
"enum": [
"eligible",
"not_eligible",
"partially_eligible"
],
"type": "string",
"description": "Indicates whether the transaction is eligible for PayPal's seller protection."
},
"dispute_categories": {
"type": "array",
"items": {
"enum": [
"fraudulent",
"product_not_received"
],
"type": "string",
"x-stripeBypassValidation": true
},
"nullable": true,
"description": "An array of conditions that are covered for the transaction, if applicable."
}
},
"description": "",
"x-expandableFields": []
}
person
{
"type": "object",
"title": "Person",
"required": [
"account",
"created",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"dob": {
"$ref": "#/components/schemas/legal_entity_dob"
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The person's email address. 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 person's phone number."
},
"gender": {
"type": "string",
"nullable": true,
"description": "The person's gender."
},
"object": {
"enum": [
"person"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"account": {
"type": "string",
"maxLength": 5000,
"description": "The account the person is associated with."
},
"address": {
"$ref": "#/components/schemas/address"
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"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
}
},
"last_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The person's last name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
},
"first_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The person's first name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
},
"maiden_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The person's maiden name."
},
"nationality": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The country where the person is a national."
},
"address_kana": {
"anyOf": [
{
"$ref": "#/components/schemas/legal_entity_japan_address"
}
],
"nullable": true
},
"relationship": {
"$ref": "#/components/schemas/person_relationship"
},
"requirements": {
"anyOf": [
{
"$ref": "#/components/schemas/person_requirements"
}
],
"nullable": true
},
"us_cfpb_data": {
"anyOf": [
{
"$ref": "#/components/schemas/person_us_cfpb_data"
}
],
"nullable": true,
"description": "Demographic data related to the person."
},
"verification": {
"$ref": "#/components/schemas/legal_entity_person_verification"
},
"address_kanji": {
"anyOf": [
{
"$ref": "#/components/schemas/legal_entity_japan_address"
}
],
"nullable": true
},
"last_name_kana": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
},
"first_name_kana": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
},
"last_name_kanji": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
},
"first_name_kanji": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
},
"full_name_aliases": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
},
"id_number_provided": {
"type": "boolean",
"description": "Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`)."
},
"political_exposure": {
"enum": [
"existing",
"none"
],
"type": "string",
"description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction."
},
"registered_address": {
"$ref": "#/components/schemas/address"
},
"future_requirements": {
"anyOf": [
{
"$ref": "#/components/schemas/person_future_requirements"
}
],
"nullable": true
},
"ssn_last_4_provided": {
"type": "boolean",
"description": "Whether the last four digits of the person's Social Security number have been provided (U.S. only)."
},
"additional_tos_acceptances": {
"$ref": "#/components/schemas/person_additional_tos_acceptances"
},
"id_number_secondary_provided": {
"type": "boolean",
"description": "Whether the person's `id_number_secondary` was provided."
}
},
"description": "This is an object representing a person associated with a Stripe account.\n\nA platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.\n\nSee the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information).",
"x-resourceId": "person",
"x-expandableFields": [
"additional_tos_acceptances",
"address",
"address_kana",
"address_kanji",
"dob",
"future_requirements",
"registered_address",
"relationship",
"requirements",
"us_cfpb_data",
"verification"
]
}
person_additional_tos_acceptance
{
"type": "object",
"title": "PersonAdditionalTOSAcceptance",
"properties": {
"ip": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The IP address from which the legal guardian accepted the service agreement."
},
"date": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The Unix timestamp marking when the legal guardian accepted the service agreement."
},
"user_agent": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user agent of the browser from which the legal guardian accepted the service agreement."
}
},
"description": "",
"x-expandableFields": []
}
person_additional_tos_acceptances
{
"type": "object",
"title": "PersonAdditionalTOSAcceptances",
"properties": {
"account": {
"anyOf": [
{
"$ref": "#/components/schemas/person_additional_tos_acceptance"
}
],
"nullable": true,
"description": "Details on the legal guardian's acceptance of the main Stripe service agreement."
}
},
"description": "",
"x-expandableFields": [
"account"
]
}
person_ethnicity_details
{
"type": "object",
"title": "PersonEthnicityDetails",
"properties": {
"ethnicity": {
"type": "array",
"items": {
"enum": [
"cuban",
"hispanic_or_latino",
"mexican",
"not_hispanic_or_latino",
"other_hispanic_or_latino",
"prefer_not_to_answer",
"puerto_rican"
],
"type": "string"
},
"nullable": true,
"description": "The persons ethnicity"
},
"ethnicity_other": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Please specify your origin, when other is selected."
}
},
"description": "",
"x-expandableFields": []
}
person_future_requirements
{
"type": "object",
"title": "PersonFutureRequirements",
"required": [
"currently_due",
"errors",
"eventually_due",
"past_due",
"pending_verification"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/account_requirements_error"
},
"description": "Details about validation and verification failures for `due` requirements that must be resolved."
},
"past_due": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "Fields that haven't been resolved by the account's `requirements.current_deadline`. These fields need to be resolved to enable the person's account. `future_requirements.past_due` is a subset of `requirements.past_due`."
},
"alternatives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/account_requirements_alternative"
},
"nullable": true,
"description": "Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again."
},
"currently_due": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition."
},
"eventually_due": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set."
},
"pending_verification": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending."
}
},
"description": "",
"x-expandableFields": [
"alternatives",
"errors"
]
}
person_race_details
{
"type": "object",
"title": "PersonRaceDetails",
"properties": {
"race": {
"type": "array",
"items": {
"enum": [
"african_american",
"american_indian_or_alaska_native",
"asian",
"asian_indian",
"black_or_african_american",
"chinese",
"ethiopian",
"filipino",
"guamanian_or_chamorro",
"haitian",
"jamaican",
"japanese",
"korean",
"native_hawaiian",
"native_hawaiian_or_other_pacific_islander",
"nigerian",
"other_asian",
"other_black_or_african_american",
"other_pacific_islander",
"prefer_not_to_answer",
"samoan",
"somali",
"vietnamese",
"white"
],
"type": "string"
},
"nullable": true,
"description": "The persons race."
},
"race_other": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Please specify your race, when other is selected."
}
},
"description": "",
"x-expandableFields": []
}
person_relationship
{
"type": "object",
"title": "PersonRelationship",
"properties": {
"owner": {
"type": "boolean",
"nullable": true,
"description": "Whether the person is an owner of the account’s legal entity."
},
"title": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The person's title (e.g., CEO, Support Engineer)."
},
"director": {
"type": "boolean",
"nullable": true,
"description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations."
},
"executive": {
"type": "boolean",
"nullable": true,
"description": "Whether the person has significant responsibility to control, manage, or direct the organization."
},
"authorizer": {
"type": "boolean",
"nullable": true,
"description": "Whether the person is the authorizer of the account's representative."
},
"legal_guardian": {
"type": "boolean",
"nullable": true,
"description": "Whether the person is the legal guardian of the account's representative."
},
"representative": {
"type": "boolean",
"nullable": true,
"description": "Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account."
},
"percent_ownership": {
"type": "number",
"nullable": true,
"description": "The percent owned by the person of the account's legal entity."
}
},
"description": "",
"x-expandableFields": []
}
person_requirements
{
"type": "object",
"title": "PersonRequirements",
"required": [
"currently_due",
"errors",
"eventually_due",
"past_due",
"pending_verification"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/account_requirements_error"
},
"description": "Details about validation and verification failures for `due` requirements that must be resolved."
},
"past_due": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the person's account."
},
"alternatives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/account_requirements_alternative"
},
"nullable": true,
"description": "Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again."
},
"currently_due": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled."
},
"eventually_due": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set."
},
"pending_verification": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending."
}
},
"description": "",
"x-expandableFields": [
"alternatives",
"errors"
]
}
person_us_cfpb_data
{
"type": "object",
"title": "PersonUSCfpbData",
"properties": {
"race_details": {
"anyOf": [
{
"$ref": "#/components/schemas/person_race_details"
}
],
"nullable": true,
"description": "The persons race details"
},
"ethnicity_details": {
"anyOf": [
{
"$ref": "#/components/schemas/person_ethnicity_details"
}
],
"nullable": true,
"description": "The persons ethnicity details"
},
"self_identified_gender": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The persons self-identified gender"
}
},
"description": "",
"x-expandableFields": [
"ethnicity_details",
"race_details"
]
}
plan
{
"type": "object",
"title": "Plan",
"required": [
"active",
"billing_scheme",
"created",
"currency",
"id",
"interval",
"interval_count",
"livemode",
"object",
"usage_type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"meter": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The meter tracking the usage of a metered price"
},
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/plan_tier"
},
"description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`."
},
"active": {
"type": "boolean",
"description": "Whether the plan can be used for new purchases."
},
"amount": {
"type": "integer",
"nullable": true,
"description": "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`."
},
"object": {
"enum": [
"plan"
],
"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."
},
"product": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/product"
},
{
"$ref": "#/components/schemas/deleted_product"
}
],
"nullable": true,
"description": "The product whose pricing this plan determines.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/product"
},
{
"$ref": "#/components/schemas/deleted_product"
}
]
}
},
"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)."
},
"interval": {
"enum": [
"day",
"month",
"week",
"year"
],
"type": "string",
"description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`."
},
"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 plan, hidden from customers."
},
"tiers_mode": {
"enum": [
"graduated",
"volume"
],
"type": "string",
"nullable": true,
"description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows."
},
"usage_type": {
"enum": [
"licensed",
"metered"
],
"type": "string",
"description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`."
},
"amount_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`."
},
"billing_scheme": {
"enum": [
"per_unit",
"tiered"
],
"type": "string",
"description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes."
},
"interval_count": {
"type": "integer",
"description": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months."
},
"transform_usage": {
"anyOf": [
{
"$ref": "#/components/schemas/transform_usage"
}
],
"nullable": true,
"description": "Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`."
},
"trial_period_days": {
"type": "integer",
"nullable": true,
"description": "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan)."
}
},
"description": "You can now model subscriptions more flexibly using the [Prices API](https://api.stripe.com#prices). It replaces the Plans API and is backwards compatible to simplify your migration.\n\nPlans define the base price, currency, and billing cycle for recurring purchases of products.\n[Products](https://api.stripe.com#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has plans for $10/month, $100/year, €9/month, and €90/year.\n\nRelated guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription) and more about [products and prices](https://docs.stripe.com/products-prices/overview).",
"x-resourceId": "plan",
"x-expandableFields": [
"product",
"tiers",
"transform_usage"
]
}
plan_tier
{
"type": "object",
"title": "PlanTier",
"properties": {
"up_to": {
"type": "integer",
"nullable": true,
"description": "Up to and including to this quantity will be contained in the tier."
},
"flat_amount": {
"type": "integer",
"nullable": true,
"description": "Price for the entire tier."
},
"unit_amount": {
"type": "integer",
"nullable": true,
"description": "Per unit price for units relevant to the tier."
},
"flat_amount_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "Same as `flat_amount`, but contains a decimal value with at most 12 decimal places."
},
"unit_amount_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places."
}
},
"description": "",
"x-expandableFields": []
}
platform_earning_fee_source
{
"type": "object",
"title": "PlatformEarningFeeSource",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"charge",
"payout"
],
"type": "string",
"description": "Type of object that created the application fee.",
"x-stripeBypassValidation": true
},
"charge": {
"type": "string",
"maxLength": 5000,
"description": "Charge ID that created this application fee."
},
"payout": {
"type": "string",
"maxLength": 5000,
"description": "Payout ID that created this application fee."
}
},
"description": "",
"x-expandableFields": []
}
portal_business_profile
{
"type": "object",
"title": "PortalBusinessProfile",
"properties": {
"headline": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The messaging shown to customers in the portal."
},
"privacy_policy_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A link to the business’s publicly available privacy policy."
},
"terms_of_service_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A link to the business’s publicly available terms of service."
}
},
"description": "",
"x-expandableFields": []
}
portal_customer_update
{
"type": "object",
"title": "PortalCustomerUpdate",
"required": [
"allowed_updates",
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the feature is enabled."
},
"allowed_updates": {
"type": "array",
"items": {
"enum": [
"address",
"email",
"name",
"phone",
"shipping",
"tax_id"
],
"type": "string"
},
"description": "The types of customer updates that are supported. When empty, customers are not updateable."
}
},
"description": "",
"x-expandableFields": []
}
portal_features
{
"type": "object",
"title": "PortalFeatures",
"required": [
"customer_update",
"invoice_history",
"payment_method_update",
"subscription_cancel",
"subscription_update"
],
"properties": {
"customer_update": {
"$ref": "#/components/schemas/portal_customer_update"
},
"invoice_history": {
"$ref": "#/components/schemas/portal_invoice_list"
},
"subscription_cancel": {
"$ref": "#/components/schemas/portal_subscription_cancel"
},
"subscription_update": {
"$ref": "#/components/schemas/portal_subscription_update"
},
"payment_method_update": {
"$ref": "#/components/schemas/portal_payment_method_update"
}
},
"description": "",
"x-expandableFields": [
"customer_update",
"invoice_history",
"payment_method_update",
"subscription_cancel",
"subscription_update"
]
}
portal_flows_after_completion_hosted_confirmation
{
"type": "object",
"title": "PortalFlowsAfterCompletionHostedConfirmation",
"properties": {
"custom_message": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A custom message to display to the customer after the flow is completed."
}
},
"description": "",
"x-expandableFields": []
}
portal_flows_after_completion_redirect
{
"type": "object",
"title": "PortalFlowsAfterCompletionRedirect",
"required": [
"return_url"
],
"properties": {
"return_url": {
"type": "string",
"maxLength": 5000,
"description": "The URL the customer will be redirected to after the flow is completed."
}
},
"description": "",
"x-expandableFields": []
}
portal_flows_coupon_offer
{
"type": "object",
"title": "PortalFlowsCouponOffer",
"required": [
"coupon"
],
"properties": {
"coupon": {
"type": "string",
"maxLength": 5000,
"description": "The ID of the coupon to be offered."
}
},
"description": "",
"x-expandableFields": []
}
portal_flows_flow
{
"type": "object",
"title": "PortalFlowsFlow",
"required": [
"after_completion",
"type"
],
"properties": {
"type": {
"enum": [
"payment_method_update",
"subscription_cancel",
"subscription_update",
"subscription_update_confirm"
],
"type": "string",
"description": "Type of flow that the customer will go through."
},
"after_completion": {
"$ref": "#/components/schemas/portal_flows_flow_after_completion"
},
"subscription_cancel": {
"anyOf": [
{
"$ref": "#/components/schemas/portal_flows_flow_subscription_cancel"
}
],
"nullable": true,
"description": "Configuration when `flow.type=subscription_cancel`."
},
"subscription_update": {
"anyOf": [
{
"$ref": "#/components/schemas/portal_flows_flow_subscription_update"
}
],
"nullable": true,
"description": "Configuration when `flow.type=subscription_update`."
},
"subscription_update_confirm": {
"anyOf": [
{
"$ref": "#/components/schemas/portal_flows_flow_subscription_update_confirm"
}
],
"nullable": true,
"description": "Configuration when `flow.type=subscription_update_confirm`."
}
},
"description": "",
"x-expandableFields": [
"after_completion",
"subscription_cancel",
"subscription_update",
"subscription_update_confirm"
]
}
portal_flows_flow_after_completion
{
"type": "object",
"title": "PortalFlowsFlowAfterCompletion",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"hosted_confirmation",
"portal_homepage",
"redirect"
],
"type": "string",
"description": "The specified type of behavior after the flow is completed."
},
"redirect": {
"anyOf": [
{
"$ref": "#/components/schemas/portal_flows_after_completion_redirect"
}
],
"nullable": true,
"description": "Configuration when `after_completion.type=redirect`."
},
"hosted_confirmation": {
"anyOf": [
{
"$ref": "#/components/schemas/portal_flows_after_completion_hosted_confirmation"
}
],
"nullable": true,
"description": "Configuration when `after_completion.type=hosted_confirmation`."
}
},
"description": "",
"x-expandableFields": [
"hosted_confirmation",
"redirect"
]
}
portal_flows_flow_subscription_cancel
{
"type": "object",
"title": "PortalFlowsFlowSubscriptionCancel",
"required": [
"subscription"
],
"properties": {
"retention": {
"anyOf": [
{
"$ref": "#/components/schemas/portal_flows_retention"
}
],
"nullable": true,
"description": "Specify a retention strategy to be used in the cancellation flow."
},
"subscription": {
"type": "string",
"maxLength": 5000,
"description": "The ID of the subscription to be canceled."
}
},
"description": "",
"x-expandableFields": [
"retention"
]
}