gelato_report_id_number_options
{
"type": "object",
"title": "GelatoReportIdNumberOptions",
"properties": {},
"description": "",
"x-expandableFields": []
}
gelato_selfie_report
{
"type": "object",
"title": "GelatoSelfieReport",
"required": [
"status"
],
"properties": {
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_selfie_report_error"
}
],
"nullable": true,
"description": "Details on the verification error. Present when status is `unverified`."
},
"selfie": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the [File](https://docs.stripe.com/api/files) holding the image of the selfie used in this check."
},
"status": {
"enum": [
"unverified",
"verified"
],
"type": "string",
"description": "Status of this `selfie` check.",
"x-stripeBypassValidation": true
},
"document": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the [File](https://docs.stripe.com/api/files) holding the image of the identity document used in this check."
}
},
"description": "Result from a selfie check",
"x-expandableFields": [
"error"
]
}
gelato_selfie_report_error
{
"type": "object",
"title": "GelatoSelfieReportError",
"properties": {
"code": {
"enum": [
"selfie_document_missing_photo",
"selfie_face_mismatch",
"selfie_manipulated",
"selfie_unverified_other"
],
"type": "string",
"nullable": true,
"description": "A short machine-readable string giving the reason for the verification failure.",
"x-stripeBypassValidation": true
},
"reason": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A human-readable message giving the reason for the failure. These messages can be shown to your users."
}
},
"description": "",
"x-expandableFields": []
}
gelato_session_document_options
{
"type": "object",
"title": "GelatoSessionDocumentOptions",
"properties": {
"allowed_types": {
"type": "array",
"items": {
"enum": [
"driving_license",
"id_card",
"passport"
],
"type": "string"
},
"description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code."
},
"require_id_number": {
"type": "boolean",
"description": "Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth."
},
"require_live_capture": {
"type": "boolean",
"description": "Disable image uploads, identity document images have to be captured using the device’s camera."
},
"require_matching_selfie": {
"type": "boolean",
"description": "Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie)."
}
},
"description": "",
"x-expandableFields": []
}
gelato_session_email_options
{
"type": "object",
"title": "GelatoSessionEmailOptions",
"properties": {
"require_verification": {
"type": "boolean",
"description": "Request one time password verification of `provided_details.email`."
}
},
"description": "",
"x-expandableFields": []
}
gelato_session_id_number_options
{
"type": "object",
"title": "GelatoSessionIdNumberOptions",
"properties": {},
"description": "",
"x-expandableFields": []
}
gelato_session_last_error
{
"type": "object",
"title": "GelatoSessionLastError",
"properties": {
"code": {
"enum": [
"abandoned",
"consent_declined",
"country_not_supported",
"device_not_supported",
"document_expired",
"document_type_not_supported",
"document_unverified_other",
"email_unverified_other",
"email_verification_declined",
"id_number_insufficient_document_data",
"id_number_mismatch",
"id_number_unverified_other",
"phone_unverified_other",
"phone_verification_declined",
"selfie_document_missing_photo",
"selfie_face_mismatch",
"selfie_manipulated",
"selfie_unverified_other",
"under_supported_age"
],
"type": "string",
"nullable": true,
"description": "A short machine-readable string giving the reason for the verification or user-session failure.",
"x-stripeBypassValidation": true
},
"reason": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A message that explains the reason for verification or user-session failure."
}
},
"description": "Shows last VerificationSession error",
"x-expandableFields": []
}
gelato_session_matching_options
{
"type": "object",
"title": "GelatoSessionMatchingOptions",
"properties": {
"dob": {
"enum": [
"none",
"similar"
],
"type": "string",
"description": "Strictness of the DOB matching policy to apply."
},
"name": {
"enum": [
"none",
"similar"
],
"type": "string",
"description": "Strictness of the name matching policy to apply."
}
},
"description": "",
"x-expandableFields": []
}
gelato_session_phone_options
{
"type": "object",
"title": "GelatoSessionPhoneOptions",
"properties": {
"require_verification": {
"type": "boolean",
"description": "Request one time password verification of `provided_details.phone`."
}
},
"description": "",
"x-expandableFields": []
}
gelato_verification_report_options
{
"type": "object",
"title": "GelatoVerificationReportOptions",
"properties": {
"document": {
"$ref": "#/components/schemas/gelato_report_document_options"
},
"id_number": {
"$ref": "#/components/schemas/gelato_report_id_number_options"
}
},
"description": "",
"x-expandableFields": [
"document",
"id_number"
]
}
gelato_verification_session_options
{
"type": "object",
"title": "GelatoVerificationSessionOptions",
"properties": {
"email": {
"$ref": "#/components/schemas/gelato_session_email_options"
},
"phone": {
"$ref": "#/components/schemas/gelato_session_phone_options"
},
"document": {
"$ref": "#/components/schemas/gelato_session_document_options"
},
"matching": {
"$ref": "#/components/schemas/gelato_session_matching_options"
},
"id_number": {
"$ref": "#/components/schemas/gelato_session_id_number_options"
}
},
"description": "",
"x-expandableFields": [
"document",
"email",
"id_number",
"matching",
"phone"
]
}
gelato_verified_outputs
{
"type": "object",
"title": "GelatoVerifiedOutputs",
"properties": {
"dob": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_data_verified_outputs_date"
}
],
"nullable": true,
"description": "The user’s verified date of birth."
},
"sex": {
"enum": [
"[redacted]",
"female",
"male",
"unknown"
],
"type": "string",
"nullable": true,
"description": "The user's verified sex."
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user's verified email address"
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user's verified phone number"
},
"address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"nullable": true,
"description": "The user's verified address."
},
"id_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user's verified id number."
},
"last_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user's verified last name."
},
"first_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user's verified first name."
},
"unparsed_sex": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user's verified sex as it appears in the document."
},
"id_number_type": {
"enum": [
"br_cpf",
"sg_nric",
"us_ssn"
],
"type": "string",
"nullable": true,
"description": "The user's verified id number type."
},
"unparsed_place_of_birth": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user's verified place of birth as it appears in the document."
}
},
"description": "",
"x-expandableFields": [
"address",
"dob"
]
}
identity.verification_report
{
"type": "object",
"title": "GelatoVerificationReport",
"required": [
"created",
"id",
"livemode",
"object",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"type": {
"enum": [
"document",
"id_number",
"verification_flow"
],
"type": "string",
"description": "Type of report.",
"x-stripeBypassValidation": true
},
"email": {
"$ref": "#/components/schemas/gelato_email_report"
},
"phone": {
"$ref": "#/components/schemas/gelato_phone_report"
},
"object": {
"enum": [
"identity.verification_report"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"selfie": {
"$ref": "#/components/schemas/gelato_selfie_report"
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"options": {
"$ref": "#/components/schemas/gelato_verification_report_options"
},
"document": {
"$ref": "#/components/schemas/gelato_document_report"
},
"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`."
},
"id_number": {
"$ref": "#/components/schemas/gelato_id_number_report"
},
"verification_flow": {
"type": "string",
"maxLength": 5000,
"description": "The configuration token of a verification flow from the dashboard."
},
"client_reference_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems."
},
"verification_session": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the VerificationSession that created this report."
}
},
"description": "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://docs.stripe.com/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://docs.stripe.com/api/identity/verification_sessions) API.\n\nRelated guide: [Accessing verification results](https://docs.stripe.com/identity/verification-sessions#results).",
"x-resourceId": "identity.verification_report",
"x-expandableFields": [
"document",
"email",
"id_number",
"options",
"phone",
"selfie"
]
}
identity.verification_session
{
"type": "object",
"title": "GelatoVerificationSession",
"required": [
"created",
"id",
"livemode",
"metadata",
"object",
"status",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://docs.stripe.com/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe."
},
"type": {
"enum": [
"document",
"id_number",
"verification_flow"
],
"type": "string",
"description": "The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed.",
"x-stripeBypassValidation": true
},
"object": {
"enum": [
"identity.verification_session"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"canceled",
"processing",
"requires_input",
"verified"
],
"type": "string",
"description": "Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work)."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"options": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_verification_session_options"
}
],
"nullable": true,
"description": "A set of options for the session’s verification checks."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"redaction": {
"anyOf": [
{
"$ref": "#/components/schemas/verification_session_redaction"
}
],
"nullable": true,
"description": "Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null."
},
"last_error": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_session_last_error"
}
],
"nullable": true,
"description": "If present, this property tells you the last error encountered when processing the verification."
},
"client_secret": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The short-lived client secret used by Stripe.js to [show a verification modal](https://docs.stripe.com/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://docs.stripe.com/identity/verification-sessions#client-secret) to learn more."
},
"related_person": {
"$ref": "#/components/schemas/gelato_related_person"
},
"provided_details": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_provided_details"
}
],
"nullable": true,
"description": "Details provided about the user being verified. These details may be shown to the user."
},
"related_customer": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Customer ID"
},
"verified_outputs": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_verified_outputs"
}
],
"nullable": true,
"description": "The user’s verified data."
},
"verification_flow": {
"type": "string",
"maxLength": 5000,
"description": "The configuration token of a verification flow from the dashboard."
},
"client_reference_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems."
},
"last_verification_report": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/identity.verification_report"
}
],
"nullable": true,
"description": "ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://docs.stripe.com/identity/verification-sessions#results)",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/identity.verification_report"
}
]
}
},
"related_customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of the Account representing a customer."
}
},
"description": "A VerificationSession guides you through the process of collecting and verifying the identities\nof your users. It contains details about the type of verification, such as what [verification\ncheck](/docs/identity/verification-checks) to perform. Only create one VerificationSession for\neach verification in your system.\n\nA VerificationSession transitions through [multiple\nstatuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through\nthe verification flow. The VerificationSession contains the user's verified data after\nverification checks are complete.\n\nRelated guide: [The Verification Sessions API](https://docs.stripe.com/identity/verification-sessions)",
"x-resourceId": "identity.verification_session",
"x-expandableFields": [
"last_error",
"last_verification_report",
"options",
"provided_details",
"redaction",
"related_person",
"verified_outputs"
]
}
inbound_transfers
{
"type": "object",
"title": "InboundTransfers",
"required": [
"billing_details",
"type"
],
"properties": {
"type": {
"enum": [
"us_bank_account"
],
"type": "string",
"description": "The type of the payment method used in the InboundTransfer.",
"x-stripeBypassValidation": true
},
"billing_details": {
"$ref": "#/components/schemas/treasury_shared_resource_billing_details"
},
"us_bank_account": {
"$ref": "#/components/schemas/inbound_transfers_payment_method_details_us_bank_account"
}
},
"description": "",
"x-expandableFields": [
"billing_details",
"us_bank_account"
]
}
inbound_transfers_payment_method_details_us_bank_account
{
"type": "object",
"title": "inbound_transfers_payment_method_details_us_bank_account",
"required": [
"network"
],
"properties": {
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"mandate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/mandate"
}
],
"description": "ID of the mandate used to make this payment.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/mandate"
}
]
}
},
"network": {
"enum": [
"ach"
],
"type": "string",
"description": "The network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type."
},
"bank_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Name of the bank associated with the bank account."
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
},
"account_type": {
"enum": [
"checking",
"savings"
],
"type": "string",
"nullable": true,
"description": "Account type: checkings or savings. Defaults to checking if omitted."
},
"routing_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Routing number of the bank account."
},
"account_holder_type": {
"enum": [
"company",
"individual"
],
"type": "string",
"nullable": true,
"description": "Account holder type: individual or company."
}
},
"description": "",
"x-expandableFields": [
"mandate"
]
}
insights_resources_payment_evaluation_address
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationAddress",
"properties": {
"city": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "City, district, suburb, town, or village."
},
"line1": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Address line 1, such as the street, PO Box, or company name."
},
"line2": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Address line 2, such as the apartment, suite, unit, or building."
},
"state": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
},
"postal_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ZIP or postal code."
}
},
"description": "Address data.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_billing_details
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationBillingDetails",
"required": [
"address"
],
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Full name."
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Email address."
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Billing phone number (including extension)."
},
"address": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_address"
}
},
"description": "Billing details attached to this payment evaluation.",
"x-expandableFields": [
"address"
]
}
insights_resources_payment_evaluation_client_device_metadata
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationClientDeviceMetadata",
"required": [
"radar_session"
],
"properties": {
"radar_session": {
"type": "string",
"maxLength": 5000,
"description": "ID for the Radar Session associated with the payment evaluation. A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments."
}
},
"description": "Client device metadata attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_customer_details
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationCustomerDetails",
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The customer's full name or business 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": "The ID of the customer associated with the payment evaluation."
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of the Account representing the customer associated with the payment evaluation."
}
},
"description": "Customer details attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_dispute_opened
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationDisputeOpened",
"required": [
"amount",
"currency",
"reason"
],
"properties": {
"amount": {
"type": "integer",
"description": "Amount to dispute for this payment. A positive integer representing how much to charge in [the smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (for example, 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a zero-decimal currency)."
},
"reason": {
"enum": [
"account_not_available",
"credit_not_processed",
"customer_initiated",
"duplicate",
"fraudulent",
"general",
"noncompliant",
"product_not_received",
"product_unacceptable",
"subscription_canceled",
"unrecognized"
],
"type": "string",
"description": "Reason given by cardholder for dispute."
},
"currency": {
"type": "string",
"format": "currency",
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
}
},
"description": "Dispute opened event details attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_early_fraud_warning_received
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationEarlyFraudWarningReceived",
"required": [
"fraud_type"
],
"properties": {
"fraud_type": {
"enum": [
"made_with_lost_card",
"made_with_stolen_card",
"other",
"unauthorized_use_of_card"
],
"type": "string",
"description": "The type of fraud labeled by the issuer."
}
},
"description": "Early Fraud Warning Received event details attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_event
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationEvent",
"required": [
"occurred_at",
"type"
],
"properties": {
"type": {
"enum": [
"dispute_opened",
"early_fraud_warning_received",
"refunded",
"user_intervention_raised",
"user_intervention_resolved"
],
"type": "string",
"description": "Indicates the type of event attached to the payment evaluation."
},
"refunded": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_refunded"
},
"occurred_at": {
"type": "integer",
"format": "unix-time",
"description": "Timestamp when the event occurred."
},
"dispute_opened": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_dispute_opened"
},
"user_intervention_raised": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_user_intervention_raised"
},
"user_intervention_resolved": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_user_intervention_resolved"
},
"early_fraud_warning_received": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_early_fraud_warning_received"
}
},
"description": "Event reported for this payment evaluation.",
"x-expandableFields": [
"dispute_opened",
"early_fraud_warning_received",
"refunded",
"user_intervention_raised",
"user_intervention_resolved"
]
}
insights_resources_payment_evaluation_merchant_blocked
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationMerchantBlocked",
"required": [
"reason"
],
"properties": {
"reason": {
"enum": [
"authentication_required",
"blocked_for_fraud",
"invalid_payment",
"other"
],
"type": "string",
"description": "The reason the payment was blocked by the merchant."
}
},
"description": "Details of a merchant_blocked outcome attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_money_movement_card
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationMoneyMovementCard",
"properties": {
"payment_type": {
"enum": [
"one_off",
"recurring",
"setup_one_off",
"setup_recurring"
],
"type": "string",
"nullable": true,
"description": "Describes the type of payment."
},
"customer_presence": {
"enum": [
"off_session",
"on_session"
],
"type": "string",
"nullable": true,
"description": "Describes the presence of the customer during the payment."
}
},
"description": "Money Movement card details attached to this payment.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_money_movement_details
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationMoneyMovementDetails",
"required": [
"money_movement_type"
],
"properties": {
"card": {
"anyOf": [
{
"$ref": "#/components/schemas/insights_resources_payment_evaluation_money_movement_card"
}
],
"nullable": true,
"description": "Describes card money movement details for the payment evaluation."
},
"money_movement_type": {
"enum": [
"card"
],
"type": "string",
"description": "Describes the type of money movement. Currently only `card` is supported."
}
},
"description": "Money Movement details attached to this payment.",
"x-expandableFields": [
"card"
]
}
insights_resources_payment_evaluation_outcome
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationOutcome",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"failed",
"merchant_blocked",
"rejected",
"succeeded"
],
"type": "string",
"description": "Indicates the outcome of the payment evaluation."
},
"rejected": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_rejected"
},
"succeeded": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_succeeded"
},
"merchant_blocked": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_merchant_blocked"
},
"payment_intent_id": {
"type": "string",
"maxLength": 5000,
"description": "The PaymentIntent ID associated with the payment evaluation."
}
},
"description": "Outcome details for this payment evaluation.",
"x-expandableFields": [
"merchant_blocked",
"rejected",
"succeeded"
]
}
insights_resources_payment_evaluation_payment_details
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationPaymentDetails",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "integer",
"description": "Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."
},
"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": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"shipping_details": {
"anyOf": [
{
"$ref": "#/components/schemas/insights_resources_payment_evaluation_shipping"
}
],
"nullable": true,
"description": "Shipping details for the payment evaluation."
},
"statement_descriptor": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Payment statement descriptor."
},
"money_movement_details": {
"anyOf": [
{
"$ref": "#/components/schemas/insights_resources_payment_evaluation_money_movement_details"
}
],
"nullable": true,
"description": "Details about the payment's customer presence and type."
},
"payment_method_details": {
"anyOf": [
{
"$ref": "#/components/schemas/insights_resources_payment_evaluation_payment_method_details"
}
],
"nullable": true,
"description": "Details about the payment method used for the payment."
}
},
"description": "Payment details attached to this payment evaluation.",
"x-expandableFields": [
"money_movement_details",
"payment_method_details",
"shipping_details"
]
}
insights_resources_payment_evaluation_payment_method_details
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationPaymentMethodDetails",
"required": [
"payment_method"
],
"properties": {
"payment_method": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"description": "The payment method used in this payment evaluation.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
},
"billing_details": {
"anyOf": [
{
"$ref": "#/components/schemas/insights_resources_payment_evaluation_billing_details"
}
],
"nullable": true,
"description": "Billing information associated with the payment evaluation."
}
},
"description": "Payment method details attached to this payment evaluation.",
"x-expandableFields": [
"billing_details",
"payment_method"
]
}
insights_resources_payment_evaluation_refunded
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationRefunded",
"required": [
"amount",
"currency",
"reason"
],
"properties": {
"amount": {
"type": "integer",
"description": "Amount refunded for this payment. A positive integer representing how much to charge in [the smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (for example, 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a zero-decimal currency)."
},
"reason": {
"enum": [
"duplicate",
"fraudulent",
"other",
"requested_by_customer"
],
"type": "string",
"description": "Indicates the reason for the refund."
},
"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": "Refunded Event details attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_rejected
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationRejected",
"properties": {
"card": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_rejected_card"
}
},
"description": "Details of an rejected outcome attached to this payment evaluation.",
"x-expandableFields": [
"card"
]
}
insights_resources_payment_evaluation_rejected_card
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationRejectedCard",
"required": [
"address_line1_check",
"address_postal_code_check",
"cvc_check",
"reason"
],
"properties": {
"reason": {
"enum": [
"authentication_failed",
"do_not_honor",
"expired",
"incorrect_cvc",
"incorrect_number",
"incorrect_postal_code",
"insufficient_funds",
"invalid_account",
"lost_card",
"other",
"processing_error",
"reported_stolen",
"try_again_later"
],
"type": "string",
"description": "Card issuer's reason for the network decline."
},
"cvc_check": {
"enum": [
"fail",
"pass",
"unavailable",
"unchecked"
],
"type": "string",
"description": "Result of the CVC check."
},
"address_line1_check": {
"enum": [
"fail",
"pass",
"unavailable",
"unchecked"
],
"type": "string",
"description": "Result of the address line 1 check."
},
"address_postal_code_check": {
"enum": [
"fail",
"pass",
"unavailable",
"unchecked"
],
"type": "string",
"description": "Indicates whether the cardholder provided a postal code and if it matched the cardholder’s billing address."
}
},
"description": "Details of an rejected card outcome attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_shipping
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationShipping",
"required": [
"address"
],
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Shipping name."
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Shipping phone number."
},
"address": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_address"
}
},
"description": "Shipping details attached to this payment.",
"x-expandableFields": [
"address"
]
}
insights_resources_payment_evaluation_signal_v2
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationSignalV2",
"required": [
"evaluated_at",
"risk_level",
"score"
],
"properties": {
"score": {
"type": "number",
"description": "Score for this signal. Possible values for evaluated payments are between 0 and 100. The value is returned with two decimal places and higher scores indicate a higher likelihood of the signal being true. A score of -1 is returned when a model evaluation was not performed, such as requests from incomplete integrations."
},
"risk_level": {
"enum": [
"elevated",
"highest",
"low",
"normal",
"not_assessed",
"unknown"
],
"type": "string",
"description": "Risk level of this signal, based on the score."
},
"evaluated_at": {
"type": "integer",
"format": "unix-time",
"description": "The time when this signal was evaluated."
}
},
"description": "A payment evaluation signal with evaluated_at, risk_level, and score fields.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_signals
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationSignals",
"required": [
"fraudulent_payment"
],
"properties": {
"fraudulent_payment": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_signal_v2"
}
},
"description": "Collection of signals for this payment evaluation.",
"x-expandableFields": [
"fraudulent_payment"
]
}
insights_resources_payment_evaluation_succeeded
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationSucceeded",
"properties": {
"card": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_succeeded_card"
}
},
"description": "Details of a succeeded outcome attached to this payment evaluation.",
"x-expandableFields": [
"card"
]
}
insights_resources_payment_evaluation_succeeded_card
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationSucceededCard",
"required": [
"address_line1_check",
"address_postal_code_check",
"cvc_check"
],
"properties": {
"cvc_check": {
"enum": [
"fail",
"pass",
"unavailable",
"unchecked"
],
"type": "string",
"description": "Result of the CVC check."
},
"address_line1_check": {
"enum": [
"fail",
"pass",
"unavailable",
"unchecked"
],
"type": "string",
"description": "Result of the address line 1 check."
},
"address_postal_code_check": {
"enum": [
"fail",
"pass",
"unavailable",
"unchecked"
],
"type": "string",
"description": "Indicates whether the cardholder provided a postal code and if it matched the cardholder’s billing address."
}
},
"description": "Details of an succeeded card outcome attached to this payment evaluation.",
"x-expandableFields": []
}
insights_resources_payment_evaluation_user_intervention_raised
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationUserInterventionRaised",
"required": [
"key",
"type"
],
"properties": {
"key": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the user intervention event."
},
"type": {
"enum": [
"3ds",
"captcha",
"custom"
],
"type": "string",
"description": "Type of user intervention raised."
},
"custom": {
"$ref": "#/components/schemas/insights_resources_payment_evaluation_user_intervention_raised_custom"
}
},
"description": "User intervention raised event details attached to this payment evaluation",
"x-expandableFields": [
"custom"
]
}
insights_resources_payment_evaluation_user_intervention_raised_custom
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationUserInterventionRaisedCustom",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"maxLength": 5000,
"description": "Custom type of user intervention raised. The string must use a snake case description for the type of intervention performed."
}
},
"description": "User intervention raised custom event details attached to this payment evaluation",
"x-expandableFields": []
}
insights_resources_payment_evaluation_user_intervention_resolved
{
"type": "object",
"title": "InsightsResourcesPaymentEvaluationUserInterventionResolved",
"required": [
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 5000,
"description": "Unique ID of this intervention. Use this to provide the result."
},
"outcome": {
"enum": [
"abandoned",
"failed",
"passed"
],
"type": "string",
"nullable": true,
"description": "Result of the intervention if it has been completed."
}
},
"description": "User Intervention Resolved Event details attached to this payment evaluation",
"x-expandableFields": []
}
internal_card
{
"type": "object",
"title": "internal_card",
"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": []
}
invoice
{
"type": "object",
"title": "Invoice",
"required": [
"amount_due",
"amount_overpaid",
"amount_paid",
"amount_remaining",
"amount_shipping",
"attempt_count",
"attempted",
"auto_advance",
"automatic_tax",
"collection_method",
"created",
"currency",
"customer",
"default_tax_rates",
"discounts",
"id",
"issuer",
"lines",
"livemode",
"object",
"payment_settings",
"period_end",
"period_start",
"post_payment_credit_notes_amount",
"pre_payment_credit_notes_amount",
"starting_balance",
"status_transitions",
"subtotal",
"total"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`."
},
"lines": {
"type": "object",
"title": "InvoiceLinesList",
"required": [
"data",
"has_more",
"object",
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 5000,
"description": "The URL where this list can be accessed."
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/line_item"
},
"description": "Details about each object."
},
"object": {
"enum": [
"list"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
},
"has_more": {
"type": "boolean",
"description": "True if this list has another page of items after this one that can be fetched."
}
},
"description": "The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.",
"x-expandableFields": [
"data"
]
},
"total": {
"type": "integer",
"description": "Total after discounts and taxes."
},
"footer": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Footer displayed on the invoice."
},
"issuer": {
"$ref": "#/components/schemas/connect_account_reference"
},
"number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified."
},
"object": {
"enum": [
"invoice"
],
"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_parents_invoice_parent"
}
],
"nullable": true,
"description": "The parent that generated this invoice"
},
"status": {
"enum": [
"draft",
"open",
"paid",
"uncollectible",
"void"
],
"type": "string",
"nullable": true,
"description": "The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview)",
"x-stripeBypassValidation": true
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"currency": {
"type": "string",
"format": "currency",
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
},
"customer": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/customer"
},
{
"$ref": "#/components/schemas/deleted_customer"
}
],
"description": "The ID of the customer to bill.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
},
{
"$ref": "#/components/schemas/deleted_customer"
}
]
}
},
"due_date": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`."
},
"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
}
},
"payments": {
"type": "object",
"title": "InvoicesPaymentsListInvoicePayments",
"required": [
"data",
"has_more",
"object",
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 5000,
"description": "The URL where this list can be accessed."
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/invoice_payment"
},
"description": "Details about each object."
},
"object": {
"enum": [
"list"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
},
"has_more": {
"type": "boolean",
"description": "True if this list has another page of items after this one that can be fetched."
}
},
"description": "Payments for this invoice. Use [invoice payment](/api/invoice-payment) to get more details.",
"x-expandableFields": [
"data"
]
},
"subtotal": {
"type": "integer",
"description": "Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated"
},
"attempted": {
"type": "boolean",
"description": "Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users."
},
"discounts": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/discount"
},
{
"$ref": "#/components/schemas/deleted_discount"
}
],
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/discount"
},
{
"$ref": "#/components/schemas/deleted_discount"
}
]
}
},
"description": "The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount."
},
"rendering": {
"anyOf": [
{
"$ref": "#/components/schemas/invoices_resource_invoice_rendering"
}
],
"nullable": true,
"description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page."
},
"amount_due": {
"type": "integer",
"description": "Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`."
},
"period_end": {
"type": "integer",
"format": "unix-time",
"description": "The latest timestamp at which invoice items can be associated with this invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price."
},
"test_clock": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/test_helpers.test_clock"
}
],
"nullable": true,
"description": "ID of the test clock this invoice belongs to.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/test_helpers.test_clock"
}
]
}
},
"amount_paid": {
"type": "integer",
"description": "The amount, in cents (or local equivalent), that was paid."
},
"application": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/application"
},
{
"$ref": "#/components/schemas/deleted_application"
}
],
"nullable": true,
"description": "ID of the Connect Application that created the invoice.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/application"
},
{
"$ref": "#/components/schemas/deleted_application"
}
]
}
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard."
},
"invoice_pdf": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null."
},
"total_taxes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax"
},
"nullable": true,
"description": "The aggregate tax information of all line items."
},
"account_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The public name of the business associated with this invoice, most often the business creating the invoice."
},
"auto_advance": {
"type": "boolean",
"description": "Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action."
},
"effective_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt."
},
"from_invoice": {
"anyOf": [
{
"$ref": "#/components/schemas/invoices_resource_from_invoice"
}
],
"nullable": true,
"description": "Details of the invoice that was cloned. See the [revision documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details."
},
"on_behalf_of": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/account"
}
],
"nullable": true,
"description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/account"
}
]
}
},
"period_start": {
"type": "integer",
"format": "unix-time",
"description": "The earliest timestamp at which invoice items can be associated with this invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price."
},
"attempt_count": {
"type": "integer",
"description": "Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained."
},
"automatic_tax": {
"$ref": "#/components/schemas/automatic_tax"
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/invoice_setting_custom_field"
},
"nullable": true,
"description": "Custom fields displayed on the invoice."
},
"customer_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated."
},
"shipping_cost": {
"anyOf": [
{
"$ref": "#/components/schemas/invoices_resource_shipping_cost"
}
],
"nullable": true,
"description": "The details of the cost of shipping, including the ShippingRate applied on the invoice."
},
"billing_reason": {
"enum": [
"automatic_pending_invoice_item_invoice",
"manual",
"quote_accept",
"subscription",
"subscription_create",
"subscription_cycle",
"subscription_threshold",
"subscription_update",
"upcoming"
],
"type": "string",
"nullable": true,
"description": "Indicates the reason why the invoice was created.\n\n* `manual`: Unrelated to a subscription, for example, created via the invoice editor.\n* `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.\n* `subscription_create`: A new subscription was created.\n* `subscription_cycle`: A subscription advanced into a new period.\n* `subscription_threshold`: A subscription reached a billing threshold.\n* `subscription_update`: A subscription was updated.\n* `upcoming`: Reserved for upcoming invoices created through the Create Preview Invoice API or when an `invoice.upcoming` event is generated for an upcoming invoice on a subscription."
},
"customer_email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated."
},
"customer_phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated."
},
"default_source": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/bank_account"
},
{
"$ref": "#/components/schemas/card"
},
{
"$ref": "#/components/schemas/source"
}
],
"nullable": true,
"description": "ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/bank_account"
},
{
"$ref": "#/components/schemas/card"
},
{
"$ref": "#/components/schemas/source"
}
]
},
"x-stripeBypassValidation": true
},
"ending_balance": {
"type": "integer",
"nullable": true,
"description": "Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null."
},
"receipt_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "This is the transaction number that appears on email receipts sent for this invoice."
},
"account_country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The country of the business associated with this invoice, most often the business creating the invoice."
},
"account_tax_ids": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/tax_id"
},
{
"$ref": "#/components/schemas/deleted_tax_id"
}
],
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/tax_id"
},
{
"$ref": "#/components/schemas/deleted_tax_id"
}
]
}
},
"nullable": true,
"description": "The account tax IDs associated with the invoice. Only editable when the invoice is a draft."
},
"amount_overpaid": {
"type": "integer",
"description": "Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance."
},
"amount_shipping": {
"type": "integer",
"description": "This is the sum of all the shipping amounts."
},
"latest_revision": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/invoice"
}
],
"nullable": true,
"description": "The ID of the most recent non-draft revision of this invoice",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/invoice"
}
]
}
},
"amount_remaining": {
"type": "integer",
"description": "The difference between amount_due and amount_paid, in cents (or local equivalent)."
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of the account representing the customer to bill."
},
"customer_address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"nullable": true,
"description": "The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated."
},
"customer_tax_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/invoices_resource_invoice_tax_id"
},
"nullable": true,
"description": "The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated."
},
"payment_settings": {
"$ref": "#/components/schemas/invoices_payment_settings"
},
"shipping_details": {
"anyOf": [
{
"$ref": "#/components/schemas/shipping"
}
],
"nullable": true,
"description": "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer."
},
"starting_balance": {
"type": "integer",
"description": "Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice."
},
"threshold_reason": {
"$ref": "#/components/schemas/invoice_threshold_reason"
},
"collection_method": {
"enum": [
"charge_automatically",
"send_invoice"
],
"type": "string",
"description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions."
},
"customer_shipping": {
"anyOf": [
{
"$ref": "#/components/schemas/shipping"
}
],
"nullable": true,
"description": "The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated."
},
"default_tax_rates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tax_rate"
},
"description": "The tax rates applied to this invoice, if any."
},
"hosted_invoice_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null."
},
"status_transitions": {
"$ref": "#/components/schemas/invoices_resource_status_transitions"
},
"confirmation_secret": {
"anyOf": [
{
"$ref": "#/components/schemas/invoices_resource_confirmation_secret"
}
],
"nullable": true,
"description": "The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization."
},
"customer_tax_exempt": {
"enum": [
"exempt",
"none",
"reverse"
],
"type": "string",
"nullable": true,
"description": "The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated."
},
"total_excluding_tax": {
"type": "integer",
"nullable": true,
"description": "The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax."
},
"next_payment_attempt": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`."
},
"statement_descriptor": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Extra information about an invoice for the customer's credit card statement."
},
"webhooks_delivered_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://docs.stripe.com/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created."
},
"default_payment_method": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"nullable": true,
"description": "ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
},
"subtotal_excluding_tax": {
"type": "integer",
"nullable": true,
"description": "The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated"
},
"total_discount_amounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/discounts_resource_discount_amount"
},
"nullable": true,
"description": "The aggregate amounts calculated per discount across all line items."
},
"last_finalization_error": {
"anyOf": [
{
"$ref": "#/components/schemas/api_errors"
}
],
"nullable": true,
"description": "The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized."
},
"automatically_finalizes_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized."
},
"total_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 invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items."
},
"pre_payment_credit_notes_amount": {
"type": "integer",
"description": "Total amount of all pre-payment credit notes issued for this invoice."
},
"post_payment_credit_notes_amount": {
"type": "integer",
"description": "Total amount of all post-payment credit notes issued for this invoice."
}
},
"description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://api.stripe.com#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://docs.stripe.com/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://docs.stripe.com/billing/invoices/sending)",
"x-resourceId": "invoice",
"x-expandableFields": [
"account_tax_ids",
"application",
"automatic_tax",
"confirmation_secret",
"custom_fields",
"customer",
"customer_address",
"customer_shipping",
"customer_tax_ids",
"default_payment_method",
"default_source",
"default_tax_rates",
"discounts",
"from_invoice",
"issuer",
"last_finalization_error",
"latest_revision",
"lines",
"on_behalf_of",
"parent",
"payment_settings",
"payments",
"rendering",
"shipping_cost",
"shipping_details",
"status_transitions",
"test_clock",
"threshold_reason",
"total_discount_amounts",
"total_pretax_credit_amounts",
"total_taxes"
]
}
invoice_installments_card
{
"type": "object",
"title": "invoice_installments_card",
"properties": {
"enabled": {
"type": "boolean",
"nullable": true,
"description": "Whether Installments are enabled for this Invoice."
}
},
"description": "",
"x-expandableFields": []
}
invoice_item_threshold_reason
{
"type": "object",
"title": "InvoiceItemThresholdReason",
"required": [
"line_item_ids",
"usage_gte"
],
"properties": {
"usage_gte": {
"type": "integer",
"description": "The quantity threshold boundary that applied to the given line item."
},
"line_item_ids": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "The IDs of the line items that triggered the threshold invoice."
}
},
"description": "",
"x-expandableFields": []
}
invoice_line_item_period
{
"type": "object",
"title": "InvoiceLineItemPeriod",
"required": [
"end",
"start"
],
"properties": {
"end": {
"type": "integer",
"format": "unix-time",
"description": "The end of the period, which must be greater than or equal to the start. This value is inclusive."
},
"start": {
"type": "integer",
"format": "unix-time",
"description": "The start of the period. This value is inclusive."
}
},
"description": "",
"x-expandableFields": []
}
invoice_mandate_options_card
{
"type": "object",
"title": "invoice_mandate_options_card",
"properties": {
"amount": {
"type": "integer",
"nullable": true,
"description": "Amount to be charged for future payments, specified in the presentment currency."
},
"amount_type": {
"enum": [
"fixed",
"maximum"
],
"type": "string",
"nullable": true,
"description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 200,
"description": "A description of the mandate or subscription that is meant to be displayed to the customer."
}
},
"description": "",
"x-expandableFields": []
}
invoice_mandate_options_payto
{
"type": "object",
"title": "invoice_mandate_options_payto",
"properties": {
"amount": {
"type": "integer",
"nullable": true,
"description": "The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit."
},
"purpose": {
"enum": [
"dependant_support",
"government",
"loan",
"mortgage",
"other",
"pension",
"personal",
"retail",
"salary",
"tax",
"utility"
],
"type": "string",
"nullable": true,
"description": "The purpose for which payments are made. Has a default value based on your merchant category code."
},
"amount_type": {
"enum": [
"fixed",
"maximum"
],
"type": "string",
"nullable": true,
"description": "Only `maximum` is supported."
}
},
"description": "",
"x-expandableFields": []
}
invoice_payment
{
"type": "object",
"title": "InvoicesInvoicePayment",
"required": [
"amount_requested",
"created",
"currency",
"id",
"invoice",
"is_default",
"livemode",
"object",
"payment",
"status",
"status_transitions"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"invoice_payment"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"type": "string",
"maxLength": 5000,
"description": "The status of the payment, one of `open`, `paid`, or `canceled`."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"invoice": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/invoice"
},
{
"$ref": "#/components/schemas/deleted_invoice"
}
],
"description": "The invoice that was paid.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/invoice"
},
{
"$ref": "#/components/schemas/deleted_invoice"
}
]
}
},
"payment": {
"$ref": "#/components/schemas/invoices_payments_invoice_payment_associated_payment"
},
"currency": {
"type": "string",
"maxLength": 5000,
"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`."
},
"is_default": {
"type": "boolean",
"description": "Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s `amount_remaining`. The PaymentIntent associated with the default payment can’t be edited or canceled directly."
},
"amount_paid": {
"type": "integer",
"nullable": true,
"description": "Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent’s `amount_received` is not sufficient to pay all of the invoices that it is attached to."
},
"amount_requested": {
"type": "integer",
"description": "Amount intended to be paid toward this invoice, in cents (or local equivalent)"
},
"status_transitions": {
"$ref": "#/components/schemas/invoices_payments_invoice_payment_status_transitions"
}
},
"description": "Invoice Payments represent payments made against invoices. Invoice Payments can\nbe accessed in two ways:\n1. By expanding the `payments` field on the [Invoice](https://api.stripe.com#invoice) resource.\n2. By using the Invoice Payment retrieve and list endpoints.\n\nInvoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices.\nThis resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and\nmonitor the allocation details of the payments.",
"x-resourceId": "invoice_payment",
"x-expandableFields": [
"invoice",
"payment",
"status_transitions"
]
}
invoice_payment_method_options_acss_debit
{
"type": "object",
"title": "invoice_payment_method_options_acss_debit",
"properties": {
"mandate_options": {
"$ref": "#/components/schemas/invoice_payment_method_options_acss_debit_mandate_options"
},
"verification_method": {
"enum": [
"automatic",
"instant",
"microdeposits"
],
"type": "string",
"description": "Bank account verification method. The default value is `automatic`.",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
invoice_payment_method_options_acss_debit_mandate_options
{
"type": "object",
"title": "invoice_payment_method_options_acss_debit_mandate_options",
"properties": {
"transaction_type": {
"enum": [
"business",
"personal"
],
"type": "string",
"nullable": true,
"description": "Transaction type of the mandate."
}
},
"description": "",
"x-expandableFields": []
}