connect_embedded_issuing_card_config_claim
{
"type": "object",
"title": "ConnectEmbeddedIssuingCardConfigClaim",
"required": [
"enabled",
"features"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the embedded component is enabled."
},
"features": {
"$ref": "#/components/schemas/connect_embedded_issuing_card_features"
}
},
"description": "",
"x-expandableFields": [
"features"
]
}
connect_embedded_issuing_card_features
{
"type": "object",
"title": "ConnectEmbeddedIssuingCardFeatures",
"required": [
"card_management",
"card_spend_dispute_management",
"cardholder_management",
"spend_control_management"
],
"properties": {
"card_management": {
"type": "boolean",
"description": "Whether to allow card management features."
},
"cardholder_management": {
"type": "boolean",
"description": "Whether to allow cardholder management features."
},
"spend_control_management": {
"type": "boolean",
"description": "Whether to allow spend control management features."
},
"card_spend_dispute_management": {
"type": "boolean",
"description": "Whether to allow card spend dispute management features."
}
},
"description": "",
"x-expandableFields": []
}
connect_embedded_issuing_cards_list_config_claim
{
"type": "object",
"title": "ConnectEmbeddedIssuingCardsListConfigClaim",
"required": [
"enabled",
"features"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the embedded component is enabled."
},
"features": {
"$ref": "#/components/schemas/connect_embedded_issuing_cards_list_features"
}
},
"description": "",
"x-expandableFields": [
"features"
]
}
connect_embedded_issuing_cards_list_features
{
"type": "object",
"title": "ConnectEmbeddedIssuingCardsListFeatures",
"required": [
"card_management",
"card_spend_dispute_management",
"cardholder_management",
"disable_stripe_user_authentication",
"spend_control_management"
],
"properties": {
"card_management": {
"type": "boolean",
"description": "Whether to allow card management features."
},
"cardholder_management": {
"type": "boolean",
"description": "Whether to allow cardholder management features."
},
"spend_control_management": {
"type": "boolean",
"description": "Whether to allow spend control management features."
},
"card_spend_dispute_management": {
"type": "boolean",
"description": "Whether to allow card spend dispute management features."
},
"disable_stripe_user_authentication": {
"type": "boolean",
"description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."
}
},
"description": "",
"x-expandableFields": []
}
connect_embedded_payment_disputes_config
{
"type": "object",
"title": "ConnectEmbeddedPaymentDisputesConfig",
"required": [
"enabled",
"features"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the embedded component is enabled."
},
"features": {
"$ref": "#/components/schemas/connect_embedded_payment_disputes_features"
}
},
"description": "",
"x-expandableFields": [
"features"
]
}
connect_embedded_payment_disputes_features
{
"type": "object",
"title": "ConnectEmbeddedPaymentDisputesFeatures",
"required": [
"destination_on_behalf_of_charge_management",
"dispute_management",
"refund_management"
],
"properties": {
"refund_management": {
"type": "boolean",
"description": "Whether sending refunds is enabled. This is `true` by default."
},
"dispute_management": {
"type": "boolean",
"description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default."
},
"destination_on_behalf_of_charge_management": {
"type": "boolean",
"description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default."
}
},
"description": "",
"x-expandableFields": []
}
connect_embedded_payments_config_claim
{
"type": "object",
"title": "ConnectEmbeddedPaymentsConfigClaim",
"required": [
"enabled",
"features"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the embedded component is enabled."
},
"features": {
"$ref": "#/components/schemas/connect_embedded_payments_features"
}
},
"description": "",
"x-expandableFields": [
"features"
]
}
connect_embedded_payments_features
{
"type": "object",
"title": "ConnectEmbeddedPaymentsFeatures",
"required": [
"capture_payments",
"destination_on_behalf_of_charge_management",
"dispute_management",
"refund_management"
],
"properties": {
"capture_payments": {
"type": "boolean",
"description": "Whether to allow capturing and cancelling payment intents. This is `true` by default."
},
"refund_management": {
"type": "boolean",
"description": "Whether sending refunds is enabled. This is `true` by default."
},
"dispute_management": {
"type": "boolean",
"description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default."
},
"destination_on_behalf_of_charge_management": {
"type": "boolean",
"description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default."
}
},
"description": "",
"x-expandableFields": []
}
connect_embedded_payouts_config
{
"type": "object",
"title": "ConnectEmbeddedPayoutsConfig",
"required": [
"enabled",
"features"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the embedded component is enabled."
},
"features": {
"$ref": "#/components/schemas/connect_embedded_payouts_features"
}
},
"description": "",
"x-expandableFields": [
"features"
]
}
connect_embedded_payouts_features
{
"type": "object",
"title": "ConnectEmbeddedPayoutsFeatures",
"required": [
"disable_stripe_user_authentication",
"edit_payout_schedule",
"external_account_collection",
"instant_payouts",
"standard_payouts"
],
"properties": {
"instant_payouts": {
"type": "boolean",
"description": "Whether to allow creation of instant payouts. The default value is `enabled` when Stripe is responsible for negative account balances, and `use_dashboard_rules` otherwise."
},
"standard_payouts": {
"type": "boolean",
"description": "Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`."
},
"edit_payout_schedule": {
"type": "boolean",
"description": "Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`."
},
"external_account_collection": {
"type": "boolean",
"description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`."
},
"disable_stripe_user_authentication": {
"type": "boolean",
"description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."
}
},
"description": "",
"x-expandableFields": []
}
country_spec
{
"type": "object",
"title": "CountrySpec",
"required": [
"default_currency",
"id",
"object",
"supported_bank_account_currencies",
"supported_payment_currencies",
"supported_payment_methods",
"supported_transfer_countries",
"verification_fields"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object. Represented as the ISO country code for this country."
},
"object": {
"enum": [
"country_spec"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"default_currency": {
"type": "string",
"maxLength": 5000,
"description": "The default currency for this country. This applies to both payment methods and bank accounts."
},
"verification_fields": {
"$ref": "#/components/schemas/country_spec_verification_fields"
},
"supported_payment_methods": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges)."
},
"supported_payment_currencies": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "Currencies that can be accepted in the specified country (for payments)."
},
"supported_transfer_countries": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "Countries that can accept transfers from the specified country."
},
"supported_bank_account_currencies": {
"type": "object",
"description": "Currencies that can be accepted in the specific country (for transfers).",
"additionalProperties": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
}
}
}
},
"description": "Stripe needs to collect certain pieces of information about each account\ncreated. These requirements can differ depending on the account's country. The\nCountry Specs API makes these rules available to your integration.\n\nYou can also view the information from this API call as [an online\nguide](/docs/connect/required-verification-information).",
"x-resourceId": "country_spec",
"x-expandableFields": [
"verification_fields"
]
}
country_spec_verification_field_details
{
"type": "object",
"title": "CountrySpecVerificationFieldDetails",
"required": [
"additional",
"minimum"
],
"properties": {
"minimum": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "Fields which every account must eventually provide."
},
"additional": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "Additional fields which are only required for some users."
}
},
"description": "",
"x-expandableFields": []
}
country_spec_verification_fields
{
"type": "object",
"title": "CountrySpecVerificationFields",
"required": [
"company",
"individual"
],
"properties": {
"company": {
"$ref": "#/components/schemas/country_spec_verification_field_details"
},
"individual": {
"$ref": "#/components/schemas/country_spec_verification_field_details"
}
},
"description": "",
"x-expandableFields": [
"company",
"individual"
]
}
coupon
{
"type": "object",
"title": "Coupon",
"required": [
"created",
"duration",
"id",
"livemode",
"object",
"times_redeemed",
"valid"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Name of the coupon displayed to customers on for instance invoices or receipts."
},
"valid": {
"type": "boolean",
"description": "Taking account of the above properties, whether this coupon can still be applied to a customer."
},
"object": {
"enum": [
"coupon"
],
"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."
},
"currency": {
"type": "string",
"format": "currency",
"nullable": true,
"description": "If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off."
},
"duration": {
"enum": [
"forever",
"once",
"repeating"
],
"type": "string",
"description": "One of `forever`, `once`, or `repeating`. Describes how long a customer who applies this coupon will get the discount.",
"x-stripeBypassValidation": true
},
"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
}
},
"redeem_by": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Date after which the coupon can no longer be redeemed."
},
"amount_off": {
"type": "integer",
"nullable": true,
"description": "Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer."
},
"applies_to": {
"$ref": "#/components/schemas/coupon_applies_to"
},
"percent_off": {
"type": "number",
"nullable": true,
"description": "Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead."
},
"times_redeemed": {
"type": "integer",
"description": "Number of times this coupon has been applied to a customer."
},
"max_redemptions": {
"type": "integer",
"nullable": true,
"description": "Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid."
},
"currency_options": {
"type": "object",
"description": "Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
"additionalProperties": {
"$ref": "#/components/schemas/coupon_currency_option"
}
},
"duration_in_months": {
"type": "integer",
"nullable": true,
"description": "If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`."
}
},
"description": "A coupon contains information about a percent-off or amount-off discount you\nmight want to apply to a customer. Coupons may be applied to [subscriptions](https://api.stripe.com#subscriptions), [invoices](https://api.stripe.com#invoices),\n[checkout sessions](https://docs.stripe.com/api/checkout/sessions), [quotes](https://api.stripe.com#quotes), and more. Coupons do not work with conventional one-off [charges](/api/charges/create) or [payment intents](https://docs.stripe.com/api/payment_intents).",
"x-resourceId": "coupon",
"x-expandableFields": [
"applies_to",
"currency_options"
]
}
coupon_applies_to
{
"type": "object",
"title": "CouponAppliesTo",
"required": [
"products"
],
"properties": {
"products": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "A list of product IDs this coupon applies to"
}
},
"description": "",
"x-expandableFields": []
}
coupon_currency_option
{
"type": "object",
"title": "CouponCurrencyOption",
"required": [
"amount_off"
],
"properties": {
"amount_off": {
"type": "integer",
"description": "Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer."
}
},
"description": "",
"x-expandableFields": []
}
credit_balance
{
"type": "object",
"title": "CreditBalance",
"required": [
"available_balance",
"ledger_balance"
],
"properties": {
"ledger_balance": {
"$ref": "#/components/schemas/billing_credit_grants_resource_amount"
},
"available_balance": {
"$ref": "#/components/schemas/billing_credit_grants_resource_amount"
}
},
"description": "",
"x-expandableFields": [
"available_balance",
"ledger_balance"
]
}
credit_note
{
"type": "object",
"title": "CreditNote",
"required": [
"amount",
"amount_shipping",
"created",
"currency",
"customer",
"discount_amount",
"discount_amounts",
"id",
"invoice",
"lines",
"livemode",
"number",
"object",
"pdf",
"post_payment_amount",
"pre_payment_amount",
"pretax_credit_amounts",
"refunds",
"status",
"subtotal",
"total",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"pdf": {
"type": "string",
"maxLength": 5000,
"description": "The link to download the PDF of the credit note."
},
"memo": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Customer-facing text that appears on the credit note PDF."
},
"type": {
"enum": [
"mixed",
"post_payment",
"pre_payment"
],
"type": "string",
"description": "Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid."
},
"lines": {
"type": "object",
"title": "CreditNoteLinesList",
"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/credit_note_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": "Line items that make up the credit note",
"x-expandableFields": [
"data"
]
},
"total": {
"type": "integer",
"description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount."
},
"amount": {
"type": "integer",
"description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax."
},
"number": {
"type": "string",
"maxLength": 5000,
"description": "A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice."
},
"object": {
"enum": [
"credit_note"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"reason": {
"enum": [
"duplicate",
"fraudulent",
"order_change",
"product_unsatisfactory"
],
"type": "string",
"nullable": true,
"description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`",
"x-stripeBypassValidation": true
},
"status": {
"enum": [
"issued",
"void"
],
"type": "string",
"description": "Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://docs.stripe.com/billing/invoices/credit-notes#voiding).",
"x-stripeBypassValidation": true
},
"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"
}
],
"description": "ID of the invoice.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/invoice"
}
]
}
},
"refunds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/credit_note_refund"
},
"description": "Refunds related to this credit note."
},
"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": "ID of the customer.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
},
{
"$ref": "#/components/schemas/deleted_customer"
}
]
}
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"nullable": true,
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"subtotal": {
"type": "integer",
"description": "The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts."
},
"voided_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The time that the credit note was voided."
},
"total_taxes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax"
},
"nullable": true,
"description": "The aggregate tax information for all line items."
},
"effective_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF."
},
"shipping_cost": {
"anyOf": [
{
"$ref": "#/components/schemas/invoices_resource_shipping_cost"
}
],
"nullable": true,
"description": "The details of the cost of shipping, including the ShippingRate applied to the invoice."
},
"amount_shipping": {
"type": "integer",
"description": "This is the sum of all the shipping amounts."
},
"discount_amount": {
"type": "integer",
"description": "The integer amount in cents (or local equivalent) representing the total amount of discount that was credited."
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the account representing the customer."
},
"discount_amounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/discounts_resource_discount_amount"
},
"description": "The aggregate amounts calculated per discount for all line items."
},
"out_of_band_amount": {
"type": "integer",
"nullable": true,
"description": "Amount that was credited outside of Stripe."
},
"pre_payment_amount": {
"type": "integer",
"description": "The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced."
},
"post_payment_amount": {
"type": "integer",
"description": "The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof."
},
"total_excluding_tax": {
"type": "integer",
"nullable": true,
"description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts."
},
"pretax_credit_amounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/credit_notes_pretax_credit_amount"
},
"description": "The pretax credit amounts (ex: discount, credit grants, etc) for all line items."
},
"subtotal_excluding_tax": {
"type": "integer",
"nullable": true,
"description": "The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts."
},
"customer_balance_transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/customer_balance_transaction"
}
],
"nullable": true,
"description": "Customer balance transaction related to this credit note.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer_balance_transaction"
}
]
}
}
},
"description": "Issue a credit note to adjust an invoice's amount after the invoice is finalized.\n\nRelated guide: [Credit notes](https://docs.stripe.com/billing/invoices/credit-notes)",
"x-resourceId": "credit_note",
"x-expandableFields": [
"customer",
"customer_balance_transaction",
"discount_amounts",
"invoice",
"lines",
"pretax_credit_amounts",
"refunds",
"shipping_cost",
"total_taxes"
]
}
credit_note_line_item
{
"type": "object",
"title": "CreditNoteLineItem",
"required": [
"amount",
"discount_amount",
"discount_amounts",
"id",
"livemode",
"object",
"pretax_credit_amounts",
"tax_rates",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"type": {
"enum": [
"custom_line_item",
"invoice_line_item"
],
"type": "string",
"description": "The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice."
},
"taxes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax"
},
"nullable": true,
"description": "The tax information of the line item."
},
"amount": {
"type": "integer",
"description": "The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts."
},
"object": {
"enum": [
"credit_note_line_item"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"nullable": true,
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"quantity": {
"type": "integer",
"nullable": true,
"description": "The number of units of product being credited."
},
"tax_rates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tax_rate"
},
"description": "The tax rates which apply to the line item."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Description of the item being credited."
},
"unit_amount": {
"type": "integer",
"nullable": true,
"description": "The cost of each unit of product being credited."
},
"discount_amount": {
"type": "integer",
"description": "The integer amount in cents (or local equivalent) representing the discount being credited for this line item."
},
"discount_amounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/discounts_resource_discount_amount"
},
"description": "The amount of discount calculated per discount for this line item"
},
"invoice_line_item": {
"type": "string",
"maxLength": 5000,
"description": "ID of the invoice line item being credited"
},
"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."
},
"pretax_credit_amounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/credit_notes_pretax_credit_amount"
},
"description": "The pretax credit amounts (ex: discount, credit grants, etc) for this line item."
}
},
"description": "The credit note line item object",
"x-resourceId": "credit_note_line_item",
"x-expandableFields": [
"discount_amounts",
"pretax_credit_amounts",
"tax_rates",
"taxes"
]
}
credit_note_refund
{
"type": "object",
"title": "CreditNoteRefund",
"required": [
"amount_refunded",
"refund"
],
"properties": {
"type": {
"enum": [
"payment_record_refund",
"refund"
],
"type": "string",
"nullable": true,
"description": "Type of the refund, one of `refund` or `payment_record_refund`."
},
"refund": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/refund"
}
],
"description": "ID of the refund.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/refund"
}
]
}
},
"amount_refunded": {
"type": "integer",
"description": "Amount of the refund that applies to this credit note, in cents (or local equivalent)."
},
"payment_record_refund": {
"anyOf": [
{
"$ref": "#/components/schemas/credit_notes_payment_record_refund"
}
],
"nullable": true,
"description": "The PaymentRecord refund details associated with this credit note refund."
}
},
"description": "",
"x-expandableFields": [
"payment_record_refund",
"refund"
]
}
credit_notes_payment_record_refund
{
"type": "object",
"title": "CreditNotesPaymentRecordRefund",
"required": [
"payment_record",
"refund_group"
],
"properties": {
"refund_group": {
"type": "string",
"maxLength": 5000,
"description": "ID of the refund group."
},
"payment_record": {
"type": "string",
"maxLength": 5000,
"description": "ID of the payment record."
}
},
"description": "",
"x-expandableFields": []
}
credit_notes_pretax_credit_amount
{
"type": "object",
"title": "CreditNotesPretaxCreditAmount",
"required": [
"amount",
"type"
],
"properties": {
"type": {
"enum": [
"credit_balance_transaction",
"discount"
],
"type": "string",
"description": "Type of the pretax credit amount referenced."
},
"amount": {
"type": "integer",
"description": "The amount, in cents (or local equivalent), of the pretax credit amount."
},
"discount": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/discount"
},
{
"$ref": "#/components/schemas/deleted_discount"
}
],
"description": "The discount that was applied to get this pretax credit amount.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/discount"
},
{
"$ref": "#/components/schemas/deleted_discount"
}
]
}
},
"credit_balance_transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/billing.credit_balance_transaction"
}
],
"description": "The credit balance transaction that was applied to get this pretax credit amount.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/billing.credit_balance_transaction"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"credit_balance_transaction",
"discount"
]
}
currency_option
{
"type": "object",
"title": "CurrencyOption",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/price_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`."
},
"unit_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`."
},
"tax_behavior": {
"enum": [
"exclusive",
"inclusive",
"unspecified"
],
"type": "string",
"nullable": true,
"description": "Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed."
},
"custom_unit_amount": {
"anyOf": [
{
"$ref": "#/components/schemas/custom_unit_amount"
}
],
"nullable": true,
"description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links."
},
"unit_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`."
}
},
"description": "",
"x-expandableFields": [
"custom_unit_amount",
"tiers"
]
}
custom_logo
{
"type": "object",
"title": "custom_logo",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 5000,
"description": "URL of the Dashboard-only CustomPaymentMethodType logo."
},
"content_type": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Content type of the Dashboard-only CustomPaymentMethodType logo."
}
},
"description": "",
"x-expandableFields": []
}
custom_unit_amount
{
"type": "object",
"title": "CustomUnitAmount",
"properties": {
"preset": {
"type": "integer",
"nullable": true,
"description": "The starting unit amount which can be updated by the customer."
},
"maximum": {
"type": "integer",
"nullable": true,
"description": "The maximum unit amount the customer can specify for this item."
},
"minimum": {
"type": "integer",
"nullable": true,
"description": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount."
}
},
"description": "",
"x-expandableFields": []
}
customer
{
"type": "object",
"title": "Customer",
"required": [
"created",
"id",
"livemode",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"tax": {
"$ref": "#/components/schemas/customer_tax"
},
"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."
},
"object": {
"enum": [
"customer"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"nullable": true,
"description": "The customer's address."
},
"balance": {
"type": "integer",
"description": "The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance)."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"sources": {
"type": "object",
"title": "ApmsSourcesSourceList",
"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": {
"anyOf": [
{
"$ref": "#/components/schemas/bank_account"
},
{
"$ref": "#/components/schemas/card"
},
{
"$ref": "#/components/schemas/source"
}
],
"title": "Polymorphic",
"x-stripeBypassValidation": true
},
"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 customer's payment sources, if any.",
"x-expandableFields": [
"data"
]
},
"tax_ids": {
"type": "object",
"title": "TaxIDsList",
"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/tax_id"
},
"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 customer's tax IDs.",
"x-expandableFields": [
"data"
]
},
"currency": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes."
},
"discount": {
"anyOf": [
{
"$ref": "#/components/schemas/discount"
}
],
"nullable": true,
"description": "Describes the current discount active on the customer, if there is one."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"shipping": {
"anyOf": [
{
"$ref": "#/components/schemas/shipping"
}
],
"nullable": true,
"description": "Mailing and shipping address for the customer. Appears on invoices emailed to this customer."
},
"delinquent": {
"type": "boolean",
"nullable": true,
"description": "Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.\n\nIf an invoice becomes uncollectible by [dunning](https://docs.stripe.com/billing/automatic-collection), `delinquent` doesn't reset to `false`.\n\nIf you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`."
},
"tax_exempt": {
"enum": [
"exempt",
"none",
"reverse"
],
"type": "string",
"nullable": true,
"description": "Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **\"Reverse charge\"**."
},
"test_clock": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/test_helpers.test_clock"
}
],
"nullable": true,
"description": "ID of the test clock that this customer belongs to.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/test_helpers.test_clock"
}
]
}
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"cash_balance": {
"anyOf": [
{
"$ref": "#/components/schemas/cash_balance"
}
],
"nullable": true,
"description": "The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is \"cash_balance\". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically."
},
"business_name": {
"type": "string",
"maxLength": 150,
"description": "The customer's business name."
},
"subscriptions": {
"type": "object",
"title": "SubscriptionList",
"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/subscription"
},
"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 customer's current subscriptions, if any.",
"x-expandableFields": [
"data"
]
},
"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 customer.\n\nIf you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/bank_account"
},
{
"$ref": "#/components/schemas/card"
},
{
"$ref": "#/components/schemas/source"
}
]
},
"x-stripeBypassValidation": true
},
"invoice_prefix": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The prefix for the customer used to generate unique invoice numbers."
},
"individual_name": {
"type": "string",
"maxLength": 150,
"description": "The customer's individual name."
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter."
},
"invoice_settings": {
"$ref": "#/components/schemas/invoice_setting_customer_setting"
},
"preferred_locales": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"nullable": true,
"description": "The customer's preferred locales (languages), ordered by preference."
},
"next_invoice_sequence": {
"type": "integer",
"description": "The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses."
},
"invoice_credit_balance": {
"type": "object",
"description": "The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.",
"additionalProperties": {
"type": "integer"
}
}
},
"description": "This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information,\nand track payments that belong to the same customer.",
"x-resourceId": "customer",
"x-expandableFields": [
"address",
"cash_balance",
"default_source",
"discount",
"invoice_settings",
"shipping",
"sources",
"subscriptions",
"tax",
"tax_ids",
"test_clock"
]
}
customer_acceptance
{
"type": "object",
"title": "customer_acceptance",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"offline",
"online"
],
"type": "string",
"description": "The mandate includes the type of customer acceptance information, such as: `online` or `offline`."
},
"online": {
"$ref": "#/components/schemas/online_acceptance"
},
"offline": {
"$ref": "#/components/schemas/offline_acceptance"
},
"accepted_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The time that the customer accepts the mandate."
}
},
"description": "",
"x-expandableFields": [
"offline",
"online"
]
}
customer_balance_customer_balance_settings
{
"type": "object",
"title": "CustomerBalanceCustomerBalanceSettings",
"required": [
"reconciliation_mode",
"using_merchant_default"
],
"properties": {
"reconciliation_mode": {
"enum": [
"automatic",
"manual"
],
"type": "string",
"description": "The configuration for how funds that land in the customer cash balance are reconciled."
},
"using_merchant_default": {
"type": "boolean",
"description": "A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance"
}
},
"description": "",
"x-expandableFields": []
}
customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft
{
"type": "object",
"title": "CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft",
"required": [
"balance_transaction",
"linked_transaction"
],
"properties": {
"linked_transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/customer_cash_balance_transaction"
}
],
"description": "The [Cash Balance Transaction](https://docs.stripe.com/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer_cash_balance_transaction"
}
]
}
},
"balance_transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/balance_transaction"
}
],
"description": "The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/balance_transaction"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"balance_transaction",
"linked_transaction"
]
}
customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction
{
"type": "object",
"title": "CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction",
"required": [
"payment_intent"
],
"properties": {
"payment_intent": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_intent"
}
],
"description": "The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were applied to.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_intent"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"payment_intent"
]
}
customer_balance_resource_cash_balance_transaction_resource_funded_transaction
{
"type": "object",
"title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction",
"required": [
"bank_transfer"
],
"properties": {
"bank_transfer": {
"$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer"
}
},
"description": "",
"x-expandableFields": [
"bank_transfer"
]
}
customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer
{
"type": "object",
"title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransfer",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"eu_bank_transfer",
"gb_bank_transfer",
"jp_bank_transfer",
"mx_bank_transfer",
"us_bank_transfer"
],
"type": "string",
"description": "The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
"x-stripeBypassValidation": true
},
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user-supplied reference field on the bank transfer."
},
"eu_bank_transfer": {
"$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer"
},
"gb_bank_transfer": {
"$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer"
},
"jp_bank_transfer": {
"$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer"
},
"us_bank_transfer": {
"$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer"
}
},
"description": "",
"x-expandableFields": [
"eu_bank_transfer",
"gb_bank_transfer",
"jp_bank_transfer",
"us_bank_transfer"
]
}
customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer
{
"type": "object",
"title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer",
"properties": {
"bic": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The BIC of the bank of the sender of the funding."
},
"iban_last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The last 4 digits of the IBAN of the sender of the funding."
},
"sender_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The full name of the sender, as supplied by the sending bank."
}
},
"description": "",
"x-expandableFields": []
}
customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer
{
"type": "object",
"title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer",
"properties": {
"sort_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The sort code of the bank of the sender of the funding"
},
"sender_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The full name of the sender, as supplied by the sending bank."
},
"account_number_last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The last 4 digits of the account number of the sender of the funding."
}
},
"description": "",
"x-expandableFields": []
}
customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer
{
"type": "object",
"title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer",
"properties": {
"sender_bank": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The name of the bank of the sender of the funding."
},
"sender_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The full name of the sender, as supplied by the sending bank."
},
"sender_branch": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The name of the bank branch of the sender of the funding."
}
},
"description": "",
"x-expandableFields": []
}
customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer
{
"type": "object",
"title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer",
"properties": {
"network": {
"enum": [
"ach",
"domestic_wire_us",
"swift"
],
"type": "string",
"description": "The banking network used for this funding."
},
"sender_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The full name of the sender, as supplied by the sending bank."
}
},
"description": "",
"x-expandableFields": []
}
customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction
{
"type": "object",
"title": "CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction",
"required": [
"refund"
],
"properties": {
"refund": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/refund"
}
],
"description": "The [Refund](https://docs.stripe.com/api/refunds/object) that moved these funds into the customer's cash balance.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/refund"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"refund"
]
}
customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance
{
"type": "object",
"title": "CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance",
"required": [
"balance_transaction"
],
"properties": {
"balance_transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/balance_transaction"
}
],
"description": "The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/balance_transaction"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"balance_transaction"
]
}
customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction
{
"type": "object",
"title": "CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction",
"required": [
"payment_intent"
],
"properties": {
"payment_intent": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_intent"
}
],
"description": "The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were unapplied from.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_intent"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"payment_intent"
]
}
customer_balance_transaction
{
"type": "object",
"title": "CustomerBalanceTransaction",
"required": [
"amount",
"created",
"currency",
"customer",
"ending_balance",
"id",
"livemode",
"object",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"type": {
"enum": [
"adjustment",
"applied_to_invoice",
"checkout_session_subscription_payment",
"checkout_session_subscription_payment_canceled",
"credit_note",
"initial",
"invoice_overpaid",
"invoice_too_large",
"invoice_too_small",
"migration",
"unapplied_from_invoice",
"unspent_receiver_credit"
],
"type": "string",
"description": "Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, `unapplied_from_invoice`, `checkout_session_subscription_payment`, or `checkout_session_subscription_payment_canceled`. See the [Customer Balance page](https://docs.stripe.com/billing/customer/balance#types) to learn more about transaction types.",
"x-stripeBypassValidation": true
},
"amount": {
"type": "integer",
"description": "The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`."
},
"object": {
"enum": [
"customer_balance_transaction"
],
"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."
},
"invoice": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/invoice"
}
],
"nullable": true,
"description": "The ID of the invoice (if any) related to the transaction.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/invoice"
}
]
}
},
"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"
}
],
"description": "The ID of the customer the transaction belongs to.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
}
]
}
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"nullable": true,
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"credit_note": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/credit_note"
}
],
"nullable": true,
"description": "The ID of the credit note (if any) related to the transaction.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/credit_note"
}
]
}
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"ending_balance": {
"type": "integer",
"description": "The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice."
},
"checkout_session": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/checkout.session"
}
],
"nullable": true,
"description": "The ID of the checkout session (if any) that created the transaction.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/checkout.session"
}
]
}
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of an Account representing a customer that the transaction belongs to."
}
},
"description": "Each customer has a [Balance](https://docs.stripe.com/api/customers/object#customer_object-balance) value,\nwhich denotes a debit or credit that's automatically applied to their next invoice upon finalization.\nYou may modify the value directly by using the [update customer API](https://docs.stripe.com/api/customers/update),\nor by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.\n\nRelated guide: [Customer balance](https://docs.stripe.com/billing/customer/balance)",
"x-resourceId": "customer_balance_transaction",
"x-expandableFields": [
"checkout_session",
"credit_note",
"customer",
"invoice"
]
}
customer_cash_balance_transaction
{
"type": "object",
"title": "CustomerCashBalanceTransaction",
"required": [
"created",
"currency",
"customer",
"ending_balance",
"id",
"livemode",
"net_amount",
"object",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"type": {
"enum": [
"adjusted_for_overdraft",
"applied_to_payment",
"funded",
"funding_reversed",
"refunded_from_payment",
"return_canceled",
"return_initiated",
"transferred_to_balance",
"unapplied_from_payment"
],
"type": "string",
"description": "The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://docs.stripe.com/payments/customer-balance#types) to learn more about these types."
},
"funded": {
"$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction"
},
"object": {
"enum": [
"customer_cash_balance_transaction"
],
"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."
},
"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)."
},
"customer": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/customer"
}
],
"description": "The customer whose available cash balance changed as a result of this transaction.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
}
]
}
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"net_amount": {
"type": "integer",
"description": "The amount by which the cash balance changed, represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance."
},
"ending_balance": {
"type": "integer",
"description": "The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of an Account representing a customer whose available cash balance changed as a result of this transaction."
},
"applied_to_payment": {
"$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction"
},
"refunded_from_payment": {
"$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction"
},
"adjusted_for_overdraft": {
"$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft"
},
"transferred_to_balance": {
"$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance"
},
"unapplied_from_payment": {
"$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction"
}
},
"description": "Customers with certain payments enabled have a cash balance, representing funds that were paid\nby the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions\nrepresent when funds are moved into or out of this balance. This includes funding by the customer, allocation\nto payments, and refunds to the customer.",
"x-resourceId": "customer_cash_balance_transaction",
"x-expandableFields": [
"adjusted_for_overdraft",
"applied_to_payment",
"customer",
"funded",
"refunded_from_payment",
"transferred_to_balance",
"unapplied_from_payment"
]
}
customer_session
{
"type": "object",
"title": "CustomerSessionResourceCustomerSession",
"required": [
"client_secret",
"created",
"customer",
"expires_at",
"livemode",
"object"
],
"properties": {
"object": {
"enum": [
"customer_session"
],
"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."
},
"customer": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/customer"
}
],
"description": "The Customer the Customer Session was created for.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
}
]
}
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"components": {
"$ref": "#/components/schemas/customer_session_resource_components"
},
"expires_at": {
"type": "integer",
"format": "unix-time",
"description": "The timestamp at which this Customer Session will expire."
},
"client_secret": {
"type": "string",
"maxLength": 5000,
"description": "The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret."
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Account that the Customer Session was created for."
}
},
"description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.\n\nRelated guides: [Customer Session with the Payment Element](/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),\n[Customer Session with the Pricing Table](/payments/checkout/pricing-table#customer-session),\n[Customer Session with the Buy Button](/payment-links/buy-button#pass-an-existing-customer).",
"x-resourceId": "customer_session",
"x-expandableFields": [
"components",
"customer"
]
}
customer_session_resource_components
{
"type": "object",
"title": "CustomerSessionResourceComponents",
"required": [
"buy_button",
"customer_sheet",
"mobile_payment_element",
"payment_element",
"pricing_table"
],
"properties": {
"buy_button": {
"$ref": "#/components/schemas/customer_session_resource_components_resource_buy_button"
},
"pricing_table": {
"$ref": "#/components/schemas/customer_session_resource_components_resource_pricing_table"
},
"customer_sheet": {
"$ref": "#/components/schemas/customer_session_resource_components_resource_customer_sheet"
},
"payment_element": {
"$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element"
},
"mobile_payment_element": {
"$ref": "#/components/schemas/customer_session_resource_components_resource_mobile_payment_element"
}
},
"description": "Configuration for the components supported by this Customer Session.",
"x-expandableFields": [
"buy_button",
"customer_sheet",
"mobile_payment_element",
"payment_element",
"pricing_table"
]
}
customer_session_resource_components_resource_buy_button
{
"type": "object",
"title": "CustomerSessionResourceComponentsResourceBuyButton",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the buy button is enabled."
}
},
"description": "This hash contains whether the buy button is enabled.",
"x-expandableFields": []
}
customer_session_resource_components_resource_customer_sheet
{
"type": "object",
"title": "CustomerSessionResourceComponentsResourceCustomerSheet",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the customer sheet is enabled."
},
"features": {
"anyOf": [
{
"$ref": "#/components/schemas/customer_session_resource_components_resource_customer_sheet_resource_features"
}
],
"nullable": true,
"description": "This hash defines whether the customer sheet supports certain features."
}
},
"description": "This hash contains whether the customer sheet is enabled and the features it supports.",
"x-expandableFields": [
"features"
]
}
customer_session_resource_components_resource_customer_sheet_resource_features
{
"type": "object",
"title": "CustomerSessionResourceComponentsResourceCustomerSheetResourceFeatures",
"properties": {
"payment_method_remove": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"nullable": true,
"description": "Controls whether the customer sheet displays the option to remove a saved payment method.\"\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).",
"x-stripeBypassValidation": true
},
"payment_method_allow_redisplay_filters": {
"type": "array",
"items": {
"enum": [
"always",
"limited",
"unspecified"
],
"type": "string"
},
"nullable": true,
"description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the customer sheet displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"]."
}
},
"description": "This hash contains the features the customer sheet supports.",
"x-expandableFields": []
}
customer_session_resource_components_resource_mobile_payment_element
{
"type": "object",
"title": "CustomerSessionResourceComponentsResourceMobilePaymentElement",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the mobile payment element is enabled."
},
"features": {
"anyOf": [
{
"$ref": "#/components/schemas/customer_session_resource_components_resource_mobile_payment_element_resource_features"
}
],
"nullable": true,
"description": "This hash defines whether the mobile payment element supports certain features."
}
},
"description": "This hash contains whether the mobile payment element is enabled and the features it supports.",
"x-expandableFields": [
"features"
]
}
customer_session_resource_components_resource_mobile_payment_element_resource_features
{
"type": "object",
"title": "CustomerSessionResourceComponentsResourceMobilePaymentElementResourceFeatures",
"properties": {
"payment_method_save": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"nullable": true,
"description": "Controls whether the mobile payment element displays a checkbox offering to save a new payment method.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.",
"x-stripeBypassValidation": true
},
"payment_method_remove": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"nullable": true,
"description": "Controls whether the mobile payment element displays the option to remove a saved payment method.\"\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).",
"x-stripeBypassValidation": true
},
"payment_method_redisplay": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"nullable": true,
"description": "Controls whether or not the mobile payment element shows saved payment methods.",
"x-stripeBypassValidation": true
},
"payment_method_allow_redisplay_filters": {
"type": "array",
"items": {
"enum": [
"always",
"limited",
"unspecified"
],
"type": "string"
},
"nullable": true,
"description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the mobile payment element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"]."
},
"payment_method_save_allow_redisplay_override": {
"enum": [
"always",
"limited",
"unspecified"
],
"type": "string",
"nullable": true,
"description": "Allows overriding the value of allow_override when saving a new payment method when payment_method_save is set to disabled. Use values: \"always\", \"limited\", or \"unspecified\".\n\nIf not specified, defaults to `nil` (no override value)."
}
},
"description": "This hash contains the features the mobile payment element supports.",
"x-expandableFields": []
}
customer_session_resource_components_resource_payment_element
{
"type": "object",
"title": "CustomerSessionResourceComponentsResourcePaymentElement",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the Payment Element is enabled."
},
"features": {
"anyOf": [
{
"$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element_resource_features"
}
],
"nullable": true,
"description": "This hash defines whether the Payment Element supports certain features."
}
},
"description": "This hash contains whether the Payment Element is enabled and the features it supports.",
"x-expandableFields": [
"features"
]
}
customer_session_resource_components_resource_payment_element_resource_features
{
"type": "object",
"title": "CustomerSessionResourceComponentsResourcePaymentElementResourceFeatures",
"required": [
"payment_method_allow_redisplay_filters",
"payment_method_redisplay",
"payment_method_remove",
"payment_method_save"
],
"properties": {
"payment_method_save": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"description": "Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.",
"x-stripeBypassValidation": true
},
"payment_method_remove": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"description": "Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).",
"x-stripeBypassValidation": true
},
"payment_method_redisplay": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"description": "Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.",
"x-stripeBypassValidation": true
},
"payment_method_save_usage": {
"enum": [
"off_session",
"on_session"
],
"type": "string",
"nullable": true,
"description": "When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.\n\nWhen using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation."
},
"payment_method_redisplay_limit": {
"type": "integer",
"nullable": true,
"description": "Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`."
},
"payment_method_allow_redisplay_filters": {
"type": "array",
"items": {
"enum": [
"always",
"limited",
"unspecified"
],
"type": "string"
},
"description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"]."
}
},
"description": "This hash contains the features the Payment Element supports.",
"x-expandableFields": []
}