subscriptions_resource_billing_schedules_applies_to
{
"type": "object",
"title": "SubscriptionsResourceBillingSchedulesAppliesTo",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"price"
],
"type": "string",
"description": "Controls which subscription items the billing schedule applies to."
},
"price": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/price"
}
],
"nullable": true,
"description": "The billing schedule will apply to the subscription item with the given price ID.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/price"
}
]
}
}
},
"description": "Represents the entities that the billing schedule applies to.",
"x-expandableFields": [
"price"
]
}
subscriptions_resource_billing_schedules_bill_until
{
"type": "object",
"title": "SubscriptionsResourceBillingSchedulesBillUntil",
"required": [
"computed_timestamp",
"type"
],
"properties": {
"type": {
"enum": [
"duration",
"timestamp"
],
"type": "string",
"description": "Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`."
},
"duration": {
"anyOf": [
{
"$ref": "#/components/schemas/subscriptions_resource_billing_schedules_bill_until_duration"
}
],
"nullable": true,
"description": "Specifies the billing period."
},
"timestamp": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "If specified, the billing schedule will apply until the specified timestamp."
},
"computed_timestamp": {
"type": "integer",
"format": "unix-time",
"description": "The timestamp the billing schedule will apply until."
}
},
"description": "Specifies the end of billing period.",
"x-expandableFields": [
"duration"
]
}
subscriptions_resource_billing_schedules_bill_until_duration
{
"type": "object",
"title": "SubscriptionsResourceBillingSchedulesBillUntilDuration",
"required": [
"interval"
],
"properties": {
"interval": {
"enum": [
"day",
"month",
"week",
"year"
],
"type": "string",
"description": "Specifies billing duration. Either `day`, `week`, `month` or `year`."
},
"interval_count": {
"type": "integer",
"nullable": true,
"description": "The multiplier applied to the interval."
}
},
"description": "Configures the `bill_until` date based on the provided `interval` and `interval_count`.",
"x-expandableFields": []
}
subscriptions_resource_pause_collection
{
"type": "object",
"title": "SubscriptionsResourcePauseCollection",
"required": [
"behavior"
],
"properties": {
"behavior": {
"enum": [
"keep_as_draft",
"mark_uncollectible",
"void"
],
"type": "string",
"description": "The payment collection behavior for this subscription while paused.",
"x-stripeBypassValidation": true
},
"resumes_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The time after which the subscription will resume collecting payments."
}
},
"description": "The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription\nshould be paused.",
"x-expandableFields": []
}
subscriptions_resource_payment_method_options
{
"type": "object",
"title": "SubscriptionsResourcePaymentMethodOptions",
"properties": {
"pix": {
"anyOf": [
{
"$ref": "#/components/schemas/subscription_payment_method_options_pix"
}
],
"nullable": true,
"description": "This sub-hash contains details about the Pix payment method options to pass to invoices created by the subscription."
},
"upi": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_upi"
}
],
"nullable": true,
"description": "This sub-hash contains details about the UPI payment method options to pass to invoices created by the subscription."
},
"card": {
"anyOf": [
{
"$ref": "#/components/schemas/subscription_payment_method_options_card"
}
],
"nullable": true,
"description": "This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription."
},
"payto": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_payto"
}
],
"nullable": true,
"description": "This sub-hash contains details about the PayTo payment method options to pass to invoices created by the subscription."
},
"konbini": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_konbini"
}
],
"nullable": true,
"description": "This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription."
},
"acss_debit": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_acss_debit"
}
],
"nullable": true,
"description": "This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription."
},
"bancontact": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_bancontact"
}
],
"nullable": true,
"description": "This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription."
},
"sepa_debit": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_sepa_debit"
}
],
"nullable": true,
"description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription."
},
"us_bank_account": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account"
}
],
"nullable": true,
"description": "This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription."
},
"customer_balance": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_payment_method_options_customer_balance"
}
],
"nullable": true,
"description": "This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription."
}
},
"description": "",
"x-expandableFields": [
"acss_debit",
"bancontact",
"card",
"customer_balance",
"konbini",
"payto",
"pix",
"sepa_debit",
"upi",
"us_bank_account"
]
}
subscriptions_resource_payment_settings
{
"type": "object",
"title": "SubscriptionsResourcePaymentSettings",
"properties": {
"payment_method_types": {
"type": "array",
"items": {
"enum": [
"ach_credit_transfer",
"ach_debit",
"acss_debit",
"affirm",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"boleto",
"card",
"cashapp",
"crypto",
"custom",
"customer_balance",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"jp_credit_transfer",
"kakao_pay",
"klarna",
"konbini",
"kr_card",
"link",
"multibanco",
"naver_pay",
"nz_bank_account",
"p24",
"pay_by_bank",
"payco",
"paynow",
"paypal",
"payto",
"pix",
"promptpay",
"revolut_pay",
"satispay",
"sepa_credit_transfer",
"sepa_debit",
"sofort",
"swish",
"twint",
"upi",
"us_bank_account",
"wechat_pay"
],
"type": "string",
"x-stripeBypassValidation": true
},
"nullable": true,
"description": "The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice)."
},
"payment_method_options": {
"anyOf": [
{
"$ref": "#/components/schemas/subscriptions_resource_payment_method_options"
}
],
"nullable": true,
"description": "Payment-method-specific configuration to provide to invoices created by the subscription."
},
"save_default_payment_method": {
"enum": [
"off",
"on_subscription"
],
"type": "string",
"nullable": true,
"description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`."
}
},
"description": "",
"x-expandableFields": [
"payment_method_options"
]
}
subscriptions_resource_pending_update
{
"type": "object",
"title": "SubscriptionsResourcePendingUpdate",
"required": [
"expires_at"
],
"properties": {
"discount": {
"anyOf": [
{
"$ref": "#/components/schemas/discount"
}
],
"nullable": true,
"description": "The pending subscription-level discount that will be applied when the pending update is applied."
},
"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
}
},
"discounts": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/discount"
}
],
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/discount"
}
]
}
},
"nullable": true,
"description": "The discounts that will be applied to the subscription when the pending update is applied. Use `expand[]=discounts` to expand each discount."
},
"trial_end": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied."
},
"expires_at": {
"type": "integer",
"format": "unix-time",
"description": "The point after which the changes reflected by this update will be discarded and no longer applied."
},
"trial_from_plan": {
"type": "boolean",
"nullable": true,
"description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more."
},
"subscription_items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/subscription_item"
},
"nullable": true,
"description": "List of subscription items, each with an attached plan, that will be set if the update is applied."
},
"billing_cycle_anchor": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format."
}
},
"description": "Pending Updates store the changes pending from a previous update that will be applied\nto the Subscription upon successful payment.",
"x-expandableFields": [
"discount",
"discounts",
"subscription_items"
]
}
subscriptions_resource_subscription_invoice_settings
{
"type": "object",
"title": "SubscriptionsResourceSubscriptionInvoiceSettings",
"required": [
"issuer"
],
"properties": {
"footer": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Footer to be displayed on the invoice."
},
"issuer": {
"$ref": "#/components/schemas/connect_account_reference"
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/invoice_setting_custom_field"
},
"nullable": true,
"description": "A list of up to 4 custom fields to be displayed on 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 subscription. Will be set on invoices generated by the subscription."
}
},
"description": "",
"x-expandableFields": [
"account_tax_ids",
"custom_fields",
"issuer"
]
}
subscriptions_resource_subscription_presentment_details
{
"type": "object",
"title": "SubscriptionsResourceSubscriptionPresentmentDetails",
"required": [
"presentment_currency"
],
"properties": {
"presentment_currency": {
"type": "string",
"maxLength": 5000,
"description": "Currency used for customer payments."
}
},
"description": "",
"x-expandableFields": []
}
subscriptions_resource_trial_settings_end_behavior
{
"type": "object",
"title": "SubscriptionsResourceTrialSettingsEndBehavior",
"required": [
"missing_payment_method"
],
"properties": {
"missing_payment_method": {
"enum": [
"cancel",
"create_invoice",
"pause"
],
"type": "string",
"description": "Indicates how the subscription should change when the trial ends if the user did not provide a payment method."
}
},
"description": "Defines how a subscription behaves when a trial ends.",
"x-expandableFields": []
}
subscriptions_resource_trial_settings_trial_settings
{
"type": "object",
"title": "SubscriptionsResourceTrialSettingsTrialSettings",
"required": [
"end_behavior"
],
"properties": {
"end_behavior": {
"$ref": "#/components/schemas/subscriptions_resource_trial_settings_end_behavior"
}
},
"description": "Configures how this subscription behaves during the trial period.",
"x-expandableFields": [
"end_behavior"
]
}
subscriptions_trials_resource_end_behavior
{
"type": "object",
"title": "SubscriptionsTrialsResourceEndBehavior",
"required": [
"missing_payment_method"
],
"properties": {
"missing_payment_method": {
"enum": [
"cancel",
"create_invoice",
"pause"
],
"type": "string",
"description": "Indicates how the subscription should change when the trial ends if the user did not provide a payment method."
}
},
"description": "Defines how a subscription behaves when a free trial ends.",
"x-expandableFields": []
}
subscriptions_trials_resource_trial_settings
{
"type": "object",
"title": "SubscriptionsTrialsResourceTrialSettings",
"required": [
"end_behavior"
],
"properties": {
"end_behavior": {
"$ref": "#/components/schemas/subscriptions_trials_resource_end_behavior"
}
},
"description": "Configures how this subscription behaves during the trial period.",
"x-expandableFields": [
"end_behavior"
]
}
tax.association
{
"type": "object",
"title": "TaxProductResourceTaxAssociation",
"required": [
"calculation",
"id",
"object",
"payment_intent"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"tax.association"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"calculation": {
"type": "string",
"maxLength": 5000,
"description": "The [Tax Calculation](https://docs.stripe.com/api/tax/calculations/object) that was included in PaymentIntent."
},
"payment_intent": {
"type": "string",
"maxLength": 5000,
"description": "The [PaymentIntent](https://docs.stripe.com/api/payment_intents/object) that this Tax Association is tracking."
},
"tax_transaction_attempts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tax_product_resource_tax_association_transaction_attempts"
},
"nullable": true,
"description": "Information about the tax transactions linked to this payment intent"
}
},
"description": "A Tax Association exposes the Tax Transactions that Stripe attempted to create on your behalf based on the PaymentIntent input",
"x-resourceId": "tax.association",
"x-expandableFields": [
"tax_transaction_attempts"
]
}
tax.calculation
{
"type": "object",
"title": "TaxProductResourceTaxCalculation",
"required": [
"amount_total",
"currency",
"customer_details",
"livemode",
"object",
"tax_amount_exclusive",
"tax_amount_inclusive",
"tax_breakdown",
"tax_date"
],
"properties": {
"id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Unique identifier for the calculation."
},
"object": {
"enum": [
"tax.calculation"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"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": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource."
},
"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`."
},
"tax_date": {
"type": "integer",
"format": "unix-time",
"description": "The calculation uses the tax rules and rates that are in effect at this timestamp. You can use a date up to 31 days in the past or up to 31 days in the future. If you use a future date, Stripe doesn't guarantee that the expected tax rules and rate being used match the actual rules and rate that will be in effect on that date. We deploy tax changes before their effective date, but not within a fixed window."
},
"expires_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Timestamp of date at which the tax calculation will expire."
},
"line_items": {
"type": "object",
"title": "TaxProductResourceTaxCalculationLineItemList",
"nullable": true,
"required": [
"data",
"has_more",
"object",
"url"
],
"properties": {
"url": {
"type": "string",
"pattern": "^/v1/tax/calculations/[^/]+/line_items",
"maxLength": 5000,
"description": "The URL where this list can be accessed."
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tax.calculation_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 list of items the customer is purchasing.",
"x-expandableFields": [
"data"
]
},
"amount_total": {
"type": "integer",
"description": "Total amount after taxes in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units)."
},
"shipping_cost": {
"anyOf": [
{
"$ref": "#/components/schemas/tax_product_resource_tax_calculation_shipping_cost"
}
],
"nullable": true,
"description": "The shipping cost details for the calculation."
},
"tax_breakdown": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tax_product_resource_tax_breakdown"
},
"description": "Breakdown of individual tax amounts that add up to the total."
},
"customer_details": {
"$ref": "#/components/schemas/tax_product_resource_customer_details"
},
"ship_from_details": {
"anyOf": [
{
"$ref": "#/components/schemas/tax_product_resource_ship_from_details"
}
],
"nullable": true,
"description": "The details of the ship from location, such as the address."
},
"tax_amount_exclusive": {
"type": "integer",
"description": "The amount of tax to be collected on top of the line item prices."
},
"tax_amount_inclusive": {
"type": "integer",
"description": "The amount of tax already included in the line item prices."
}
},
"description": "A Tax Calculation allows you to calculate the tax to collect from your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom)",
"x-resourceId": "tax.calculation",
"x-expandableFields": [
"customer_details",
"line_items",
"ship_from_details",
"shipping_cost",
"tax_breakdown"
]
}
tax.calculation_line_item
{
"type": "object",
"title": "TaxProductResourceTaxCalculationLineItem",
"required": [
"amount",
"amount_tax",
"id",
"livemode",
"object",
"quantity",
"reference",
"tax_behavior",
"tax_code"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "The line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount."
},
"object": {
"enum": [
"tax.calculation_line_item"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"product": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of an existing [Product](https://docs.stripe.com/api/products/object)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"nullable": true,
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"quantity": {
"type": "integer",
"description": "The number of units of the item being purchased. For reversals, this is the quantity reversed."
},
"tax_code": {
"type": "string",
"maxLength": 5000,
"description": "The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource."
},
"reference": {
"type": "string",
"maxLength": 5000,
"description": "A custom identifier for this line item."
},
"amount_tax": {
"type": "integer",
"description": "The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units)."
},
"tax_behavior": {
"enum": [
"exclusive",
"inclusive"
],
"type": "string",
"description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes."
},
"tax_breakdown": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tax_product_resource_line_item_tax_breakdown"
},
"nullable": true,
"description": "Detailed account of taxes relevant to this line item."
}
},
"description": "",
"x-resourceId": "tax.calculation_line_item",
"x-expandableFields": [
"tax_breakdown"
]
}
tax.registration
{
"type": "object",
"title": "TaxProductRegistrationsResourceTaxRegistration",
"required": [
"active_from",
"country",
"country_options",
"created",
"id",
"livemode",
"object",
"status"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"tax.registration"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"active",
"expired",
"scheduled"
],
"type": "string",
"description": "The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`."
},
"country": {
"type": "string",
"maxLength": 5000,
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"expires_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch."
},
"active_from": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the registration becomes active. Measured in seconds since the Unix epoch."
},
"country_options": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options"
}
},
"description": "A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://docs.stripe.com/tax).\n\nStripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://docs.stripe.com/tax/registering).\n\nRelated guide: [Using the Registrations API](https://docs.stripe.com/tax/registrations-api)",
"x-resourceId": "tax.registration",
"x-expandableFields": [
"country_options"
]
}
tax.settings
{
"type": "object",
"title": "TaxProductResourceTaxSettings",
"required": [
"defaults",
"livemode",
"object",
"status",
"status_details"
],
"properties": {
"object": {
"enum": [
"tax.settings"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"active",
"pending"
],
"type": "string",
"description": "The status of the Tax `Settings`."
},
"defaults": {
"$ref": "#/components/schemas/tax_product_resource_tax_settings_defaults"
},
"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`."
},
"head_office": {
"anyOf": [
{
"$ref": "#/components/schemas/tax_product_resource_tax_settings_head_office"
}
],
"nullable": true,
"description": "The place where your business is located."
},
"status_details": {
"$ref": "#/components/schemas/tax_product_resource_tax_settings_status_details"
}
},
"description": "You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.\n\nRelated guide: [Using the Settings API](https://docs.stripe.com/tax/settings-api)",
"x-resourceId": "tax.settings",
"x-expandableFields": [
"defaults",
"head_office",
"status_details"
]
}
tax.transaction
{
"type": "object",
"title": "TaxProductResourceTaxTransaction",
"required": [
"created",
"currency",
"customer_details",
"id",
"livemode",
"object",
"posted_at",
"reference",
"tax_date",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the transaction."
},
"type": {
"enum": [
"reversal",
"transaction"
],
"type": "string",
"description": "If `reversal`, this transaction reverses an earlier transaction."
},
"object": {
"enum": [
"tax.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": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource."
},
"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
}
},
"reversal": {
"anyOf": [
{
"$ref": "#/components/schemas/tax_product_resource_tax_transaction_resource_reversal"
}
],
"nullable": true,
"description": "If `type=reversal`, contains information about what was reversed."
},
"tax_date": {
"type": "integer",
"format": "unix-time",
"description": "The calculation uses the tax rules and rates that are in effect at this timestamp. You can use a date up to 31 days in the past or up to 31 days in the future. If you use a future date, Stripe doesn't guarantee that the expected tax rules and rate being used match the actual rules and rate that will be in effect on that date. We deploy tax changes before their effective date, but not within a fixed window."
},
"posted_at": {
"type": "integer",
"format": "unix-time",
"description": "The Unix timestamp representing when the tax liability is assumed or reduced."
},
"reference": {
"type": "string",
"maxLength": 5000,
"description": "A custom unique identifier, such as 'myOrder_123'."
},
"line_items": {
"type": "object",
"title": "TaxProductResourceTaxTransactionLineItemList",
"nullable": true,
"required": [
"data",
"has_more",
"object",
"url"
],
"properties": {
"url": {
"type": "string",
"pattern": "^/v1/tax/transactions/[^/]+/line_items",
"maxLength": 5000,
"description": "The URL where this list can be accessed."
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tax.transaction_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 tax collected or refunded, by line item.",
"x-expandableFields": [
"data"
]
},
"shipping_cost": {
"anyOf": [
{
"$ref": "#/components/schemas/tax_product_resource_tax_transaction_shipping_cost"
}
],
"nullable": true,
"description": "The shipping cost details for the transaction."
},
"customer_details": {
"$ref": "#/components/schemas/tax_product_resource_customer_details"
},
"ship_from_details": {
"anyOf": [
{
"$ref": "#/components/schemas/tax_product_resource_ship_from_details"
}
],
"nullable": true,
"description": "The details of the ship from location, such as the address."
}
},
"description": "A Tax Transaction records the tax collected from or refunded to your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom#tax-transaction)",
"x-resourceId": "tax.transaction",
"x-expandableFields": [
"customer_details",
"line_items",
"reversal",
"ship_from_details",
"shipping_cost"
]
}
tax.transaction_line_item
{
"type": "object",
"title": "TaxProductResourceTaxTransactionLineItem",
"required": [
"amount",
"amount_tax",
"id",
"livemode",
"object",
"quantity",
"reference",
"tax_behavior",
"tax_code",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"type": {
"enum": [
"reversal",
"transaction"
],
"type": "string",
"description": "If `reversal`, this line item reverses an earlier transaction."
},
"amount": {
"type": "integer",
"description": "The line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount."
},
"object": {
"enum": [
"tax.transaction_line_item"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"product": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of an existing [Product](https://docs.stripe.com/api/products/object)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"nullable": true,
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"quantity": {
"type": "integer",
"description": "The number of units of the item being purchased. For reversals, this is the quantity reversed."
},
"reversal": {
"anyOf": [
{
"$ref": "#/components/schemas/tax_product_resource_tax_transaction_line_item_resource_reversal"
}
],
"nullable": true,
"description": "If `type=reversal`, contains information about what was reversed."
},
"tax_code": {
"type": "string",
"maxLength": 5000,
"description": "The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource."
},
"reference": {
"type": "string",
"maxLength": 5000,
"description": "A custom identifier for this line item in the transaction."
},
"amount_tax": {
"type": "integer",
"description": "The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units)."
},
"tax_behavior": {
"enum": [
"exclusive",
"inclusive"
],
"type": "string",
"description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes."
}
},
"description": "",
"x-resourceId": "tax.transaction_line_item",
"x-expandableFields": [
"reversal"
]
}
tax_code
{
"type": "object",
"title": "TaxProductResourceTaxCode",
"required": [
"description",
"id",
"name",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"name": {
"type": "string",
"maxLength": 5000,
"description": "A short name for the tax code."
},
"object": {
"enum": [
"tax_code"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"description": {
"type": "string",
"maxLength": 5000,
"description": "A detailed description of which types of products the tax code represents."
}
},
"description": "[Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.",
"x-resourceId": "tax_code",
"x-expandableFields": []
}
tax_deducted_at_source
{
"type": "object",
"title": "TaxDeductedAtSource",
"required": [
"id",
"object",
"period_end",
"period_start",
"tax_deduction_account_number"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"tax_deducted_at_source"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"period_end": {
"type": "integer",
"format": "unix-time",
"description": "The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period."
},
"period_start": {
"type": "integer",
"format": "unix-time",
"description": "The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period."
},
"tax_deduction_account_number": {
"type": "string",
"maxLength": 5000,
"description": "The TAN that was supplied to Stripe when TDS was assessed"
}
},
"description": "",
"x-expandableFields": []
}
tax_i_ds_owner
{
"type": "object",
"title": "TaxIDsOwner",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"account",
"application",
"customer",
"self"
],
"type": "string",
"description": "Type of owner referenced."
},
"account": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/account"
}
],
"description": "The account being referenced when `type` is `account`.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/account"
}
]
}
},
"customer": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/customer"
}
],
"description": "The customer being referenced when `type` is `customer`.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
}
]
}
},
"application": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/application"
}
],
"description": "The Connect Application being referenced when `type` is `application`.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/application"
}
]
}
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Account representing the customer being referenced when `type` is `customer`."
}
},
"description": "",
"x-expandableFields": [
"account",
"application",
"customer"
]
}
tax_id
{
"type": "object",
"title": "tax_id",
"required": [
"created",
"id",
"livemode",
"object",
"type",
"value"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"type": {
"enum": [
"ad_nrt",
"ae_trn",
"al_tin",
"am_tin",
"ao_tin",
"ar_cuit",
"au_abn",
"au_arn",
"aw_tin",
"az_tin",
"ba_tin",
"bb_tin",
"bd_bin",
"bf_ifu",
"bg_uic",
"bh_vat",
"bj_ifu",
"bo_tin",
"br_cnpj",
"br_cpf",
"bs_tin",
"by_tin",
"ca_bn",
"ca_gst_hst",
"ca_pst_bc",
"ca_pst_mb",
"ca_pst_sk",
"ca_qst",
"cd_nif",
"ch_uid",
"ch_vat",
"cl_tin",
"cm_niu",
"cn_tin",
"co_nit",
"cr_tin",
"cv_nif",
"de_stn",
"do_rcn",
"ec_ruc",
"eg_tin",
"es_cif",
"et_tin",
"eu_oss_vat",
"eu_vat",
"fo_vat",
"gb_vat",
"ge_vat",
"gi_tin",
"gn_nif",
"hk_br",
"hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
"in_gst",
"is_vat",
"it_cf",
"jp_cn",
"jp_rn",
"jp_trn",
"ke_pin",
"kg_tin",
"kh_tin",
"kr_brn",
"kz_bin",
"la_tin",
"li_uid",
"li_vat",
"lk_vat",
"ma_vat",
"md_vat",
"me_pib",
"mk_vat",
"mr_nif",
"mx_rfc",
"my_frp",
"my_itn",
"my_sst",
"ng_tin",
"no_vat",
"no_voec",
"np_pan",
"nz_gst",
"om_vat",
"pe_ruc",
"ph_tin",
"pl_nip",
"py_ruc",
"ro_tin",
"rs_pib",
"ru_inn",
"ru_kpp",
"sa_vat",
"sg_gst",
"sg_uen",
"si_tin",
"sn_ninea",
"sr_fin",
"sv_nit",
"th_vat",
"tj_tin",
"tr_tin",
"tw_vat",
"tz_vat",
"ua_vat",
"ug_tin",
"unknown",
"us_ein",
"uy_ruc",
"uz_tin",
"uz_vat",
"ve_rif",
"vn_tin",
"za_vat",
"zm_tin",
"zw_tin"
],
"type": "string",
"description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `fo_vat`, `gb_vat`, `ge_vat`, `gi_tin`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `it_cf`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `py_ruc`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown`"
},
"owner": {
"anyOf": [
{
"$ref": "#/components/schemas/tax_i_ds_owner"
}
],
"nullable": true,
"description": "The account or customer the tax ID belongs to."
},
"value": {
"type": "string",
"maxLength": 5000,
"description": "Value of the tax ID."
},
"object": {
"enum": [
"tax_id"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter ISO code representing the country of the tax ID."
},
"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"
}
],
"nullable": true,
"description": "ID of the customer.",
"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`."
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/tax_id_verification"
}
],
"nullable": true,
"description": "Tax ID verification information."
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the Account representing the customer."
}
},
"description": "You can add one or multiple tax IDs to a [customer](https://docs.stripe.com/api/customers) or account.\nCustomer and account tax IDs get displayed on related invoices and credit notes.\n\nRelated guides: [Customer tax identification numbers](https://docs.stripe.com/billing/taxes/tax-ids), [Account tax IDs](https://docs.stripe.com/invoicing/connect#account-tax-ids)",
"x-resourceId": "tax_id",
"x-expandableFields": [
"customer",
"owner",
"verification"
]
}
tax_id_verification
{
"type": "object",
"title": "tax_id_verification",
"required": [
"status"
],
"properties": {
"status": {
"enum": [
"pending",
"unavailable",
"unverified",
"verified"
],
"type": "string",
"description": "Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`."
},
"verified_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Verified name."
},
"verified_address": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Verified address."
}
},
"description": "",
"x-expandableFields": []
}
tax_product_registrations_resource_country_options
{
"type": "object",
"title": "TaxProductRegistrationsResourceCountryOptions",
"properties": {
"ae": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
},
"al": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"am": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"ao": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"at": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"au": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
},
"aw": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"az": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"ba": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"bb": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"bd": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"be": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"bf": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"bg": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"bh": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"bj": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"bs": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"by": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"ca": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_canada"
},
"cd": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"ch": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
},
"cl": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"cm": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"co": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"cr": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"cv": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"cy": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"cz": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"de": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"dk": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"ec": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"ee": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"eg": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"es": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"et": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"fi": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"fr": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"gb": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
},
"ge": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"gn": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"gr": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"hr": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"hu": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"id": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"ie": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"in": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"is": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"it": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"jp": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
},
"ke": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"kg": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"kh": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"kr": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"kz": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"la": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"lk": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"lt": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"lu": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"lv": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"ma": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"md": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"me": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"mk": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"mr": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"mt": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"mx": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"my": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"ng": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"nl": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"no": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
},
"np": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"nz": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
},
"om": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"pe": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"ph": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"pl": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"pt": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"ro": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"rs": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"ru": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"sa": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"se": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"sg": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
},
"si": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"sk": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
},
"sn": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"sr": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"th": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_thailand"
},
"tj": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"tr": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"tw": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"tz": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"ua": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"ug": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"us": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_united_states"
},
"uy": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"uz": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"vn": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"za": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
},
"zm": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
},
"zw": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
}
},
"description": "",
"x-expandableFields": [
"ae",
"al",
"am",
"ao",
"at",
"au",
"aw",
"az",
"ba",
"bb",
"bd",
"be",
"bf",
"bg",
"bh",
"bj",
"bs",
"by",
"ca",
"cd",
"ch",
"cl",
"cm",
"co",
"cr",
"cv",
"cy",
"cz",
"de",
"dk",
"ec",
"ee",
"eg",
"es",
"et",
"fi",
"fr",
"gb",
"ge",
"gn",
"gr",
"hr",
"hu",
"id",
"ie",
"in",
"is",
"it",
"jp",
"ke",
"kg",
"kh",
"kr",
"kz",
"la",
"lk",
"lt",
"lu",
"lv",
"ma",
"md",
"me",
"mk",
"mr",
"mt",
"mx",
"my",
"ng",
"nl",
"no",
"np",
"nz",
"om",
"pe",
"ph",
"pl",
"pt",
"ro",
"rs",
"ru",
"sa",
"se",
"sg",
"si",
"sk",
"sn",
"sr",
"th",
"tj",
"tr",
"tw",
"tz",
"ua",
"ug",
"us",
"uy",
"uz",
"vn",
"za",
"zm",
"zw"
]
}
tax_product_registrations_resource_country_options_ca_province_standard
{
"type": "object",
"title": "TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard",
"required": [
"province"
],
"properties": {
"province": {
"type": "string",
"maxLength": 5000,
"description": "Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."
}
},
"description": "",
"x-expandableFields": []
}
tax_product_registrations_resource_country_options_canada
{
"type": "object",
"title": "TaxProductRegistrationsResourceCountryOptionsCanada",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"province_standard",
"simplified",
"standard"
],
"type": "string",
"description": "Type of registration in Canada."
},
"province_standard": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_ca_province_standard"
}
},
"description": "",
"x-expandableFields": [
"province_standard"
]
}
tax_product_registrations_resource_country_options_default
{
"type": "object",
"title": "TaxProductRegistrationsResourceCountryOptionsDefault",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"standard"
],
"type": "string",
"description": "Type of registration in `country`."
}
},
"description": "",
"x-expandableFields": []
}
tax_product_registrations_resource_country_options_default_inbound_goods
{
"type": "object",
"title": "TaxProductRegistrationsResourceCountryOptionsDefaultInboundGoods",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"standard"
],
"type": "string",
"description": "Type of registration in `country`."
},
"standard": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_standard"
}
},
"description": "",
"x-expandableFields": [
"standard"
]
}
tax_product_registrations_resource_country_options_default_standard
{
"type": "object",
"title": "TaxProductRegistrationsResourceCountryOptionsDefaultStandard",
"required": [
"place_of_supply_scheme"
],
"properties": {
"place_of_supply_scheme": {
"enum": [
"inbound_goods",
"standard"
],
"type": "string",
"description": "Place of supply scheme used in an Default standard registration."
}
},
"description": "",
"x-expandableFields": []
}
tax_product_registrations_resource_country_options_eu_standard
{
"type": "object",
"title": "TaxProductRegistrationsResourceCountryOptionsEuStandard",
"required": [
"place_of_supply_scheme"
],
"properties": {
"place_of_supply_scheme": {
"enum": [
"inbound_goods",
"small_seller",
"standard"
],
"type": "string",
"description": "Place of supply scheme used in an EU standard registration."
}
},
"description": "",
"x-expandableFields": []
}
tax_product_registrations_resource_country_options_europe
{
"type": "object",
"title": "TaxProductRegistrationsResourceCountryOptionsEurope",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"ioss",
"oss_non_union",
"oss_union",
"standard"
],
"type": "string",
"description": "Type of registration in an EU country.",
"x-stripeBypassValidation": true
},
"standard": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_eu_standard"
}
},
"description": "",
"x-expandableFields": [
"standard"
]
}
tax_product_registrations_resource_country_options_simplified
{
"type": "object",
"title": "TaxProductRegistrationsResourceCountryOptionsSimplified",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"simplified"
],
"type": "string",
"description": "Type of registration in `country`."
}
},
"description": "",
"x-expandableFields": []
}
tax_product_registrations_resource_country_options_thailand
{
"type": "object",
"title": "TaxProductRegistrationsResourceCountryOptionsThailand",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"simplified"
],
"type": "string",
"description": "Type of registration in `country`.",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
tax_product_registrations_resource_country_options_united_states
{
"type": "object",
"title": "TaxProductRegistrationsResourceCountryOptionsUnitedStates",
"required": [
"state",
"type"
],
"properties": {
"type": {
"enum": [
"local_amusement_tax",
"local_lease_tax",
"state_communications_tax",
"state_retail_delivery_fee",
"state_sales_tax"
],
"type": "string",
"description": "Type of registration in the US.",
"x-stripeBypassValidation": true
},
"state": {
"type": "string",
"maxLength": 5000,
"description": "Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."
},
"local_lease_tax": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_local_lease_tax"
},
"state_sales_tax": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_state_sales_tax"
},
"local_amusement_tax": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_local_amusement_tax"
}
},
"description": "",
"x-expandableFields": [
"local_amusement_tax",
"local_lease_tax",
"state_sales_tax"
]
}
tax_product_registrations_resource_country_options_us_local_amusement_tax
{
"type": "object",
"title": "TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax",
"required": [
"jurisdiction"
],
"properties": {
"jurisdiction": {
"type": "string",
"maxLength": 5000,
"description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction."
}
},
"description": "",
"x-expandableFields": []
}
tax_product_registrations_resource_country_options_us_local_lease_tax
{
"type": "object",
"title": "TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax",
"required": [
"jurisdiction"
],
"properties": {
"jurisdiction": {
"type": "string",
"maxLength": 5000,
"description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction."
}
},
"description": "",
"x-expandableFields": []
}
tax_product_registrations_resource_country_options_us_state_sales_tax
{
"type": "object",
"title": "TaxProductRegistrationsResourceCountryOptionsUsStateSalesTax",
"properties": {
"elections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_state_sales_tax_election"
},
"description": "Elections for the state sales tax registration."
}
},
"description": "",
"x-expandableFields": [
"elections"
]
}
tax_product_registrations_resource_country_options_us_state_sales_tax_election
{
"type": "object",
"title": "TaxProductRegistrationsResourceCountryOptionsUsStateSalesTaxElection",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"local_use_tax",
"simplified_sellers_use_tax",
"single_local_use_tax"
],
"type": "string",
"description": "The type of the election for the state sales tax registration."
},
"jurisdiction": {
"type": "string",
"maxLength": 5000,
"description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction."
}
},
"description": "",
"x-expandableFields": []
}
tax_product_resource_customer_details
{
"type": "object",
"title": "TaxProductResourceCustomerDetails",
"required": [
"tax_ids",
"taxability_override"
],
"properties": {
"address": {
"anyOf": [
{
"$ref": "#/components/schemas/tax_product_resource_postal_address"
}
],
"nullable": true,
"description": "The customer's postal address (for example, home or business location)."
},
"tax_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tax_product_resource_customer_details_resource_tax_id"
},
"description": "The customer's tax IDs (for example, EU VAT numbers)."
},
"ip_address": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The customer's IP address (IPv4 or IPv6)."
},
"address_source": {
"enum": [
"billing",
"shipping"
],
"type": "string",
"nullable": true,
"description": "The type of customer address provided."
},
"taxability_override": {
"enum": [
"customer_exempt",
"none",
"reverse_charge"
],
"type": "string",
"description": "The taxability override used for taxation."
}
},
"description": "",
"x-expandableFields": [
"address",
"tax_ids"
]
}
tax_product_resource_customer_details_resource_tax_id
{
"type": "object",
"title": "TaxProductResourceCustomerDetailsResourceTaxId",
"required": [
"type",
"value"
],
"properties": {
"type": {
"enum": [
"ad_nrt",
"ae_trn",
"al_tin",
"am_tin",
"ao_tin",
"ar_cuit",
"au_abn",
"au_arn",
"aw_tin",
"az_tin",
"ba_tin",
"bb_tin",
"bd_bin",
"bf_ifu",
"bg_uic",
"bh_vat",
"bj_ifu",
"bo_tin",
"br_cnpj",
"br_cpf",
"bs_tin",
"by_tin",
"ca_bn",
"ca_gst_hst",
"ca_pst_bc",
"ca_pst_mb",
"ca_pst_sk",
"ca_qst",
"cd_nif",
"ch_uid",
"ch_vat",
"cl_tin",
"cm_niu",
"cn_tin",
"co_nit",
"cr_tin",
"cv_nif",
"de_stn",
"do_rcn",
"ec_ruc",
"eg_tin",
"es_cif",
"et_tin",
"eu_oss_vat",
"eu_vat",
"fo_vat",
"gb_vat",
"ge_vat",
"gi_tin",
"gn_nif",
"hk_br",
"hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
"in_gst",
"is_vat",
"it_cf",
"jp_cn",
"jp_rn",
"jp_trn",
"ke_pin",
"kg_tin",
"kh_tin",
"kr_brn",
"kz_bin",
"la_tin",
"li_uid",
"li_vat",
"lk_vat",
"ma_vat",
"md_vat",
"me_pib",
"mk_vat",
"mr_nif",
"mx_rfc",
"my_frp",
"my_itn",
"my_sst",
"ng_tin",
"no_vat",
"no_voec",
"np_pan",
"nz_gst",
"om_vat",
"pe_ruc",
"ph_tin",
"pl_nip",
"py_ruc",
"ro_tin",
"rs_pib",
"ru_inn",
"ru_kpp",
"sa_vat",
"sg_gst",
"sg_uen",
"si_tin",
"sn_ninea",
"sr_fin",
"sv_nit",
"th_vat",
"tj_tin",
"tr_tin",
"tw_vat",
"tz_vat",
"ua_vat",
"ug_tin",
"unknown",
"us_ein",
"uy_ruc",
"uz_tin",
"uz_vat",
"ve_rif",
"vn_tin",
"za_vat",
"zm_tin",
"zw_tin"
],
"type": "string",
"description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`"
},
"value": {
"type": "string",
"maxLength": 5000,
"description": "The value of the tax ID."
}
},
"description": "",
"x-expandableFields": []
}
tax_product_resource_jurisdiction
{
"type": "object",
"title": "TaxProductResourceJurisdiction",
"required": [
"country",
"display_name",
"level"
],
"properties": {
"level": {
"enum": [
"city",
"country",
"county",
"district",
"state"
],
"type": "string",
"description": "Indicates the level of the jurisdiction imposing the tax."
},
"state": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States."
},
"country": {
"type": "string",
"maxLength": 5000,
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
},
"display_name": {
"type": "string",
"maxLength": 5000,
"description": "A human-readable name for the jurisdiction imposing the tax."
}
},
"description": "",
"x-expandableFields": []
}
tax_product_resource_line_item_tax_breakdown
{
"type": "object",
"title": "TaxProductResourceLineItemTaxBreakdown",
"required": [
"amount",
"jurisdiction",
"sourcing",
"taxability_reason",
"taxable_amount"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units)."
},
"sourcing": {
"enum": [
"destination",
"origin"
],
"type": "string",
"description": "Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address).",
"x-stripeBypassValidation": true
},
"jurisdiction": {
"$ref": "#/components/schemas/tax_product_resource_jurisdiction"
},
"taxable_amount": {
"type": "integer",
"description": "The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units)."
},
"tax_rate_details": {
"anyOf": [
{
"$ref": "#/components/schemas/tax_product_resource_line_item_tax_rate_details"
}
],
"nullable": true,
"description": "Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax."
},
"taxability_reason": {
"enum": [
"customer_exempt",
"not_collecting",
"not_subject_to_tax",
"not_supported",
"portion_product_exempt",
"portion_reduced_rated",
"portion_standard_rated",
"product_exempt",
"product_exempt_holiday",
"proportionally_rated",
"reduced_rated",
"reverse_charge",
"standard_rated",
"taxable_basis_reduced",
"zero_rated"
],
"type": "string",
"description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported."
}
},
"description": "",
"x-expandableFields": [
"jurisdiction",
"tax_rate_details"
]
}
tax_product_resource_line_item_tax_rate_details
{
"type": "object",
"title": "TaxProductResourceLineItemTaxRateDetails",
"required": [
"display_name",
"percentage_decimal",
"tax_type"
],
"properties": {
"tax_type": {
"enum": [
"amusement_tax",
"communications_tax",
"gst",
"hst",
"igst",
"jct",
"lease_tax",
"pst",
"qst",
"retail_delivery_fee",
"rst",
"sales_tax",
"service_tax",
"vat"
],
"type": "string",
"description": "The tax type, such as `vat` or `sales_tax`.",
"x-stripeBypassValidation": true
},
"display_name": {
"type": "string",
"maxLength": 5000,
"description": "A localized display name for tax type, intended to be human-readable. For example, \"Local Sales and Use Tax\", \"Value-added tax (VAT)\", or \"Umsatzsteuer (USt.)\"."
},
"percentage_decimal": {
"type": "string",
"maxLength": 5000,
"description": "The tax rate percentage as a string. For example, 8.5% is represented as \"8.5\"."
}
},
"description": "",
"x-expandableFields": []
}
tax_product_resource_postal_address
{
"type": "object",
"title": "TaxProductResourcePostalAddress",
"required": [
"country"
],
"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/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as \"NY\" or \"TX\"."
},
"country": {
"type": "string",
"maxLength": 5000,
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
},
"postal_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ZIP or postal code."
}
},
"description": "",
"x-expandableFields": []
}
tax_product_resource_ship_from_details
{
"type": "object",
"title": "TaxProductResourceShipFromDetails",
"required": [
"address"
],
"properties": {
"address": {
"$ref": "#/components/schemas/tax_product_resource_postal_address"
}
},
"description": "",
"x-expandableFields": [
"address"
]
}
tax_product_resource_tax_association_transaction_attempts
{
"type": "object",
"title": "TaxProductResourceTaxAssociationTransactionAttempts",
"required": [
"source",
"status"
],
"properties": {
"source": {
"type": "string",
"maxLength": 5000,
"description": "The source of the tax transaction attempt. This is either a refund or a payment intent."
},
"status": {
"type": "string",
"maxLength": 5000,
"description": "The status of the transaction attempt. This can be `errored` or `committed`."
},
"errored": {
"$ref": "#/components/schemas/tax_product_resource_tax_association_transaction_attempts_resource_errored"
},
"committed": {
"$ref": "#/components/schemas/tax_product_resource_tax_association_transaction_attempts_resource_committed"
}
},
"description": "",
"x-expandableFields": [
"committed",
"errored"
]
}
tax_product_resource_tax_association_transaction_attempts_resource_committed
{
"type": "object",
"title": "TaxProductResourceTaxAssociationTransactionAttemptsResourceCommitted",
"required": [
"transaction"
],
"properties": {
"transaction": {
"type": "string",
"maxLength": 5000,
"description": "The [Tax Transaction](https://docs.stripe.com/api/tax/transaction/object)"
}
},
"description": "",
"x-expandableFields": []
}
tax_product_resource_tax_association_transaction_attempts_resource_errored
{
"type": "object",
"title": "TaxProductResourceTaxAssociationTransactionAttemptsResourceErrored",
"required": [
"reason"
],
"properties": {
"reason": {
"enum": [
"another_payment_associated_with_calculation",
"calculation_expired",
"currency_mismatch",
"original_transaction_voided",
"unique_reference_violation"
],
"type": "string",
"description": "Details on why we couldn't commit the tax transaction."
}
},
"description": "",
"x-expandableFields": []
}