From c431547f8efe3b085b0e91143fac6c43108a52da Mon Sep 17 00:00:00 2001 From: "stripe-openapi[bot]" <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Thu, 1 Feb 2024 21:50:21 +0000 Subject: [PATCH] OpenAPI Update (#646) Update OpenAPI for 572c0a72b48d71d6873161dbb411b5eda16fc4cf Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> --- embedded/openapi/spec3.beta.sdk.json | 856 +++++++++++++++++++++++++++ embedded/openapi/spec3.json | 791 +++++++++++++++++++++++++ 2 files changed, 1647 insertions(+) diff --git a/embedded/openapi/spec3.beta.sdk.json b/embedded/openapi/spec3.beta.sdk.json index 5179256a..debe4f3c 100644 --- a/embedded/openapi/spec3.beta.sdk.json +++ b/embedded/openapi/spec3.beta.sdk.json @@ -1287,6 +1287,42 @@ "errors" ] }, + "account_invoices_settings": { + "description": "", + "properties": { + "default_account_tax_ids": { + "description": "The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.", + "items": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/tax_id" + } + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/tax_id" + } + ] + } + }, + "nullable": true, + "type": "array" + } + }, + "required": [ + "default_account_tax_ids" + ], + "title": "AccountInvoicesSettings", + "type": "object", + "x-expandableFields": [ + "default_account_tax_ids" + ] + }, "account_link": { "description": "Account Links are the means by which a Connect platform grants a connected account permission to access\nStripe-hosted applications, such as Connect Onboarding.\n\nRelated guide: [Connect Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding)", "properties": { @@ -1912,6 +1948,9 @@ "dashboard": { "$ref": "#/components/schemas/account_dashboard_settings" }, + "invoices": { + "$ref": "#/components/schemas/account_invoices_settings" + }, "payments": { "$ref": "#/components/schemas/account_payments_settings" }, @@ -1942,6 +1981,7 @@ "card_issuing", "card_payments", "dashboard", + "invoices", "payments", "payouts", "sepa_debit_payments", @@ -21194,6 +21234,35 @@ "invoice_setting_subscription_schedule_phase_setting": { "description": "", "properties": { + "account_tax_ids": { + "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.", + "items": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$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, + "type": "array" + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "nullable": true, @@ -21216,12 +21285,42 @@ "title": "InvoiceSettingSubscriptionSchedulePhaseSetting", "type": "object", "x-expandableFields": [ + "account_tax_ids", "issuer" ] }, "invoice_setting_subscription_schedule_setting": { "description": "", "properties": { + "account_tax_ids": { + "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.", + "items": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$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, + "type": "array" + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "nullable": true, @@ -21238,6 +21337,7 @@ "title": "InvoiceSettingSubscriptionScheduleSetting", "type": "object", "x-expandableFields": [ + "account_tax_ids", "issuer" ] }, @@ -59843,6 +59943,88 @@ ] } }, + "tax_i_ds_owner": { + "description": "", + "properties": { + "account": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/account" + } + ], + "description": "The account being referenced when `type` is `account`.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/account" + } + ] + } + }, + "application": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/application" + } + ], + "description": "The Connect Application being referenced when `type` is `application`.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/application" + } + ] + } + }, + "customer": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/customer" + } + ], + "description": "The customer being referenced when `type` is `customer`.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/customer" + } + ] + } + }, + "type": { + "description": "Type of owner referenced.", + "enum": [ + "account", + "application", + "customer", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "TaxIDsOwner", + "type": "object", + "x-expandableFields": [ + "account", + "application", + "customer" + ] + }, "tax_id": { "description": "You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/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://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)", "properties": { @@ -59893,6 +60075,15 @@ ], "type": "string" }, + "owner": { + "anyOf": [ + { + "$ref": "#/components/schemas/tax_i_ds_owner" + } + ], + "description": "The account or customer the tax ID belongs to.", + "nullable": true + }, "type": { "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`", "enum": [ @@ -59996,6 +60187,7 @@ "type": "object", "x-expandableFields": [ "customer", + "owner", "verification" ], "x-resourceId": "tax_id", @@ -60007,6 +60199,13 @@ "operation": "delete", "path": "/v1/customers/{customer}/tax_ids/{id}" }, + { + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/tax_ids/{id}" + }, { "method_name": "list", "method_on": "collection", @@ -60035,6 +60234,20 @@ "operation": "get", "path": "/v1/customers/{customer}/tax_ids/{id}" }, + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/tax_ids" + }, + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/tax_ids/{id}" + }, { "method_name": "create", "method_on": "collection", @@ -60048,6 +60261,13 @@ "method_type": "create", "operation": "post", "path": "/v1/customers/{customer}/tax_ids" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/tax_ids" } ], "x-stripeResource": { @@ -72892,6 +73112,31 @@ "title": "card_payments_settings_specs", "type": "object" }, + "invoices": { + "description": "Settings specific to the account's use of Invoices.", + "properties": { + "default_account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized." + } + }, + "title": "invoices_settings_specs", + "type": "object" + }, "payments": { "description": "Settings that apply across payment methods for charging on the account.", "properties": { @@ -103061,6 +103306,24 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule." + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "type": "integer" @@ -106330,6 +106593,24 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule." + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "type": "integer" @@ -109587,6 +109868,24 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule." + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "type": "integer" @@ -169484,6 +169783,24 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule." + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.", "type": "integer" @@ -169974,6 +170291,24 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule." + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "type": "integer" @@ -170652,6 +170987,24 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule." + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.", "type": "integer" @@ -171148,6 +171501,24 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule." + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "type": "integer" @@ -173528,6 +173899,24 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription." + }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { @@ -175217,6 +175606,24 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription." + }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", "properties": { @@ -179839,6 +180246,455 @@ } } }, + "/v1/tax_ids": { + "get": { + "description": "

Returns a list of tax IDs.

", + "operationId": "GetTaxIds", + "parameters": [ + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.", + "explode": true, + "in": "query", + "name": "owner", + "required": false, + "schema": { + "properties": { + "account": { + "description": "Account the tax ID belongs to. Required when `type=account`", + "type": "string" + }, + "customer": { + "description": "Customer the tax ID belongs to. Required when `type=customer`", + "maxLength": 5000, + "type": "string" + }, + "type": { + "description": "Type of owner referenced.", + "enum": [ + "account", + "application", + "customer", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "owner_params", + "type": "object" + }, + "style": "deepObject" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "description": "Details about each object.", + "items": { + "$ref": "#/components/schemas/tax_id" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "TaxIDsList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "

Creates a new account or customer tax_id object.

", + "operationId": "PostTaxIds", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "owner": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "owner": { + "description": "The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.", + "properties": { + "account": { + "description": "Account the tax ID belongs to. Required when `type=account`", + "type": "string" + }, + "customer": { + "description": "Customer the tax ID belongs to. Required when `type=customer`", + "maxLength": 5000, + "type": "string" + }, + "type": { + "description": "Type of owner referenced.", + "enum": [ + "account", + "application", + "customer", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "owner_params", + "type": "object" + }, + "type": { + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", + "enum": [ + "ad_nrt", + "ae_trn", + "ar_cuit", + "au_abn", + "au_arn", + "bg_uic", + "bo_tin", + "br_cnpj", + "br_cpf", + "ca_bn", + "ca_gst_hst", + "ca_pst_bc", + "ca_pst_mb", + "ca_pst_sk", + "ca_qst", + "ch_vat", + "cl_tin", + "cn_tin", + "co_nit", + "cr_tin", + "do_rcn", + "ec_ruc", + "eg_tin", + "es_cif", + "eu_oss_vat", + "eu_vat", + "gb_vat", + "ge_vat", + "hk_br", + "hu_tin", + "id_npwp", + "il_vat", + "in_gst", + "is_vat", + "jp_cn", + "jp_rn", + "jp_trn", + "ke_pin", + "kr_brn", + "li_uid", + "mx_rfc", + "my_frp", + "my_itn", + "my_sst", + "no_vat", + "nz_gst", + "pe_ruc", + "ph_tin", + "ro_tin", + "rs_pib", + "ru_inn", + "ru_kpp", + "sa_vat", + "sg_gst", + "sg_uen", + "si_tin", + "sv_nit", + "th_vat", + "tr_tin", + "tw_vat", + "ua_vat", + "us_ein", + "uy_ruc", + "ve_rif", + "vn_tin", + "za_vat" + ], + "maxLength": 5000, + "type": "string", + "x-stripeBypassValidation": true + }, + "value": { + "description": "Value of the tax ID.", + "type": "string" + } + }, + "required": [ + "type", + "value" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_id" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/tax_ids/{id}": { + "delete": { + "description": "

Deletes an existing account or customer tax_id object.

", + "operationId": "DeleteTaxIdsId", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleted_tax_id" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "get": { + "description": "

Retrieves an account or customer tax_id object.

", + "operationId": "GetTaxIdsId", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_id" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/tax_rates": { "get": { "description": "

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

", diff --git a/embedded/openapi/spec3.json b/embedded/openapi/spec3.json index c3c6e28e..2e6a1fe5 100644 --- a/embedded/openapi/spec3.json +++ b/embedded/openapi/spec3.json @@ -1036,6 +1036,39 @@ "errors" ] }, + "account_invoices_settings": { + "description": "", + "properties": { + "default_account_tax_ids": { + "description": "The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.", + "items": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/tax_id" + } + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/tax_id" + } + ] + } + }, + "nullable": true, + "type": "array" + } + }, + "title": "AccountInvoicesSettings", + "type": "object", + "x-expandableFields": [ + "default_account_tax_ids" + ] + }, "account_link": { "description": "Account Links are the means by which a Connect platform grants a connected account permission to access\nStripe-hosted applications, such as Connect Onboarding.\n\nRelated guide: [Connect Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding)", "properties": { @@ -1456,6 +1489,9 @@ "dashboard": { "$ref": "#/components/schemas/account_dashboard_settings" }, + "invoices": { + "$ref": "#/components/schemas/account_invoices_settings" + }, "payments": { "$ref": "#/components/schemas/account_payments_settings" }, @@ -1483,6 +1519,7 @@ "card_issuing", "card_payments", "dashboard", + "invoices", "payments", "payouts", "sepa_debit_payments", @@ -13675,6 +13712,35 @@ "invoice_setting_subscription_schedule_phase_setting": { "description": "", "properties": { + "account_tax_ids": { + "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.", + "items": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$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, + "type": "array" + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "nullable": true, @@ -13693,12 +13759,42 @@ "title": "InvoiceSettingSubscriptionSchedulePhaseSetting", "type": "object", "x-expandableFields": [ + "account_tax_ids", "issuer" ] }, "invoice_setting_subscription_schedule_setting": { "description": "", "properties": { + "account_tax_ids": { + "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.", + "items": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$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, + "type": "array" + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "nullable": true, @@ -13714,6 +13810,7 @@ "title": "InvoiceSettingSubscriptionScheduleSetting", "type": "object", "x-expandableFields": [ + "account_tax_ids", "issuer" ] }, @@ -40578,6 +40675,88 @@ "type": "object", "x-expandableFields": [] }, + "tax_i_ds_owner": { + "description": "", + "properties": { + "account": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/account" + } + ], + "description": "The account being referenced when `type` is `account`.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/account" + } + ] + } + }, + "application": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/application" + } + ], + "description": "The Connect Application being referenced when `type` is `application`.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/application" + } + ] + } + }, + "customer": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/customer" + } + ], + "description": "The customer being referenced when `type` is `customer`.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/customer" + } + ] + } + }, + "type": { + "description": "Type of owner referenced.", + "enum": [ + "account", + "application", + "customer", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "TaxIDsOwner", + "type": "object", + "x-expandableFields": [ + "account", + "application", + "customer" + ] + }, "tax_id": { "description": "You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/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://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)", "properties": { @@ -40628,6 +40807,15 @@ ], "type": "string" }, + "owner": { + "anyOf": [ + { + "$ref": "#/components/schemas/tax_i_ds_owner" + } + ], + "description": "The account or customer the tax ID belongs to.", + "nullable": true + }, "type": { "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`", "enum": [ @@ -40728,6 +40916,7 @@ "type": "object", "x-expandableFields": [ "customer", + "owner", "verification" ], "x-resourceId": "tax_id" @@ -49940,6 +50129,29 @@ "title": "card_payments_settings_specs", "type": "object" }, + "invoices": { + "properties": { + "default_account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "invoices_settings_specs", + "type": "object" + }, "payments": { "properties": { "statement_descriptor": { @@ -71756,6 +71968,23 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "issuer": { "properties": { "account": { @@ -72887,6 +73116,23 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "issuer": { "properties": { "account": { @@ -124468,6 +124714,23 @@ }, "invoice_settings": { "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "days_until_due": { "type": "integer" }, @@ -124763,6 +125026,23 @@ }, "invoice_settings": { "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "days_until_due": { "type": "integer" }, @@ -125201,6 +125481,23 @@ }, "invoice_settings": { "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "days_until_due": { "type": "integer" }, @@ -125499,6 +125796,23 @@ }, "invoice_settings": { "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "days_until_due": { "type": "integer" }, @@ -126524,6 +126838,23 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "issuer": { "properties": { "account": { @@ -127836,6 +128167,23 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "issuer": { "properties": { "account": { @@ -131677,6 +132025,449 @@ } } }, + "/v1/tax_ids": { + "get": { + "description": "

Returns a list of tax IDs.

", + "operationId": "GetTaxIds", + "parameters": [ + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.", + "explode": true, + "in": "query", + "name": "owner", + "required": false, + "schema": { + "properties": { + "account": { + "type": "string" + }, + "customer": { + "maxLength": 5000, + "type": "string" + }, + "type": { + "enum": [ + "account", + "application", + "customer", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "owner_params", + "type": "object" + }, + "style": "deepObject" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "description": "Details about each object.", + "items": { + "$ref": "#/components/schemas/tax_id" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "TaxIDsList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "

Creates a new account or customer tax_id object.

", + "operationId": "PostTaxIds", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "owner": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "owner": { + "description": "The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.", + "properties": { + "account": { + "type": "string" + }, + "customer": { + "maxLength": 5000, + "type": "string" + }, + "type": { + "enum": [ + "account", + "application", + "customer", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "owner_params", + "type": "object" + }, + "type": { + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", + "enum": [ + "ad_nrt", + "ae_trn", + "ar_cuit", + "au_abn", + "au_arn", + "bg_uic", + "bo_tin", + "br_cnpj", + "br_cpf", + "ca_bn", + "ca_gst_hst", + "ca_pst_bc", + "ca_pst_mb", + "ca_pst_sk", + "ca_qst", + "ch_vat", + "cl_tin", + "cn_tin", + "co_nit", + "cr_tin", + "do_rcn", + "ec_ruc", + "eg_tin", + "es_cif", + "eu_oss_vat", + "eu_vat", + "gb_vat", + "ge_vat", + "hk_br", + "hu_tin", + "id_npwp", + "il_vat", + "in_gst", + "is_vat", + "jp_cn", + "jp_rn", + "jp_trn", + "ke_pin", + "kr_brn", + "li_uid", + "mx_rfc", + "my_frp", + "my_itn", + "my_sst", + "no_vat", + "nz_gst", + "pe_ruc", + "ph_tin", + "ro_tin", + "rs_pib", + "ru_inn", + "ru_kpp", + "sa_vat", + "sg_gst", + "sg_uen", + "si_tin", + "sv_nit", + "th_vat", + "tr_tin", + "tw_vat", + "ua_vat", + "us_ein", + "uy_ruc", + "ve_rif", + "vn_tin", + "za_vat" + ], + "maxLength": 5000, + "type": "string", + "x-stripeBypassValidation": true + }, + "value": { + "description": "Value of the tax ID.", + "type": "string" + } + }, + "required": [ + "type", + "value" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_id" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/tax_ids/{id}": { + "delete": { + "description": "

Deletes an existing account or customer tax_id object.

", + "operationId": "DeleteTaxIdsId", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleted_tax_id" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "get": { + "description": "

Retrieves an account or customer tax_id object.

", + "operationId": "GetTaxIdsId", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_id" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/tax_rates": { "get": { "description": "

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

",