Retrieve an active entitlement
", + "operationId": "GetEntitlementsActiveEntitlementsId", + "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" + }, + { + "description": "The ID of the entitlement.", + "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/entitlements.active_entitlement" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/entitlements/features": { "get": { "description": "Retrieve a list of features
", @@ -96870,6 +97813,73 @@ } }, "/v1/entitlements/features/{id}": { + "get": { + "description": "Retrieves a feature
", + "operationId": "GetEntitlementsFeaturesId", + "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" + }, + { + "description": "The ID of the feature.", + "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/entitlements.feature" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, "post": { "description": "Update a feature’s metadata or permanently deactivate it.
", "operationId": "PostEntitlementsFeaturesId", @@ -101623,6 +102633,10 @@ "options": { "explode": true, "style": "deepObject" + }, + "provided_details": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -101691,11 +102705,68 @@ } ], "description": "Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document)." + }, + "email": { + "anyOf": [ + { + "properties": { + "require_verification": { + "description": "Request one time password verification of `provided_details.email`.", + "type": "boolean" + } + }, + "title": "email_options", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Options that apply to the email check." + }, + "phone": { + "anyOf": [ + { + "properties": { + "require_verification": { + "description": "Request one time password verification of `provided_details.phone`.", + "type": "boolean" + } + }, + "title": "phone_options", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Options that apply to the phone check." } }, "title": "session_options_param", "type": "object" }, + "provided_details": { + "description": "Details provided about the user being verified. These details may be shown to the user.", + "properties": { + "email": { + "description": "Email of user being verified", + "type": "string" + }, + "phone": { + "description": "Phone number of user being verified", + "type": "string" + } + }, + "title": "provided_details_param", + "type": "object" + }, "return_url": { "description": "The URL that the user will be redirected to upon completing the verification flow.", "type": "string" @@ -101708,16 +102779,18 @@ ], "type": "string", "x-stripeBypassValidation": true + }, + "verification_flow": { + "description": "The ID of a Verification Flow from the Dashboard.", + "maxLength": 5000, + "type": "string" } }, - "required": [ - "type" - ], "type": "object" } } }, - "required": true + "required": false }, "responses": { "200": { @@ -101840,6 +102913,10 @@ "options": { "explode": true, "style": "deepObject" + }, + "provided_details": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -101903,11 +102980,68 @@ } ], "description": "Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document)." + }, + "email": { + "anyOf": [ + { + "properties": { + "require_verification": { + "description": "Request one time password verification of `provided_details.email`.", + "type": "boolean" + } + }, + "title": "email_options", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Options that apply to the email check." + }, + "phone": { + "anyOf": [ + { + "properties": { + "require_verification": { + "description": "Request one time password verification of `provided_details.phone`.", + "type": "boolean" + } + }, + "title": "phone_options", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Options that apply to the phone check." } }, "title": "session_options_param", "type": "object" }, + "provided_details": { + "description": "Details provided about the user being verified. These details may be shown to the user.", + "properties": { + "email": { + "description": "Email of user being verified", + "type": "string" + }, + "phone": { + "description": "Phone number of user being verified", + "type": "string" + } + }, + "title": "provided_details_param", + "type": "object" + }, "type": { "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.", "enum": [ @@ -103381,10 +104515,6 @@ "explode": true, "style": "deepObject" }, - "rendering_options": { - "explode": true, - "style": "deepObject" - }, "shipping_cost": { "explode": true, "style": "deepObject" @@ -104172,32 +105302,6 @@ "title": "rendering_param", "type": "object" }, - "rendering_options": { - "anyOf": [ - { - "properties": { - "amount_tax_display": { - "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.", - "enum": [ - "", - "exclude_tax", - "include_inclusive_tax" - ], - "type": "string" - } - }, - "title": "rendering_options_param", - "type": "object" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "This is a legacy field that will be removed soon. For details about `rendering_options`, refer to `rendering` instead. Options for invoice PDF rendering." - }, "shipping_cost": { "description": "Settings for the cost of shipping for this invoice.", "properties": { @@ -104568,7 +105672,7 @@ "type": "object" }, "coupon": { - "description": "The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -104735,7 +105839,7 @@ "items": { "properties": { "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`, `no_voec`, `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`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `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`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `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", @@ -104743,6 +105847,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -104776,14 +105881,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -104908,7 +106016,7 @@ "type": "string" } ], - "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts." + "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts." }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -106162,7 +107270,7 @@ "type": "string" }, "coupon": { - "description": "The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -107422,7 +108530,7 @@ "style": "deepObject" }, { - "description": "The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "in": "query", "name": "coupon", "required": false, @@ -107612,7 +108720,7 @@ "items": { "properties": { "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`, `no_voec`, `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`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `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`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `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", @@ -107620,6 +108728,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -107653,14 +108762,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -107707,7 +108819,7 @@ "style": "deepObject" }, { - "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.", + "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.", "explode": true, "in": "query", "name": "discounts", @@ -109093,7 +110205,7 @@ "type": "string" }, "coupon": { - "description": "The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -110677,7 +111789,7 @@ "style": "deepObject" }, { - "description": "The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "in": "query", "name": "coupon", "required": false, @@ -110867,7 +111979,7 @@ "items": { "properties": { "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`, `no_voec`, `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`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `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`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `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", @@ -110875,6 +111987,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -110908,14 +112021,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -110962,7 +112078,7 @@ "style": "deepObject" }, { - "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.", + "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.", "explode": true, "in": "query", "name": "discounts", @@ -112369,7 +113485,7 @@ "type": "string" }, "coupon": { - "description": "The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -114152,10 +115268,6 @@ "explode": true, "style": "deepObject" }, - "rendering_options": { - "explode": true, - "style": "deepObject" - }, "shipping_cost": { "explode": true, "style": "deepObject" @@ -114961,32 +116073,6 @@ "title": "rendering_param", "type": "object" }, - "rendering_options": { - "anyOf": [ - { - "properties": { - "amount_tax_display": { - "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.", - "enum": [ - "", - "exclude_tax", - "include_inclusive_tax" - ], - "type": "string" - } - }, - "title": "rendering_options_param", - "type": "object" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "This is a legacy field that will be removed soon. For details about `rendering_options`, refer to `rendering` instead. Options for invoice PDF rendering." - }, "shipping_cost": { "anyOf": [ { @@ -130230,7 +131316,7 @@ "items": { "properties": { "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`, `no_voec`, `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`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `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`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `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", @@ -130238,6 +131324,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -130271,14 +131358,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -132047,7 +133137,7 @@ "items": { "properties": { "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`, `no_voec`, `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`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `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`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `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", @@ -132055,6 +133145,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -132088,14 +133179,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -133804,6 +134898,12 @@ "title": "param", "type": "object" }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { @@ -134346,6 +135446,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -134623,6 +135724,40 @@ ], "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options." }, + "amazon_pay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "enum": [ + "", + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "enum": [ + "", + "none", + "off_session" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options." + }, "au_becs_debit": { "anyOf": [ { @@ -136067,6 +137202,14 @@ "anyOf": [ { "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "enum": [ + "", + "manual" + ], + "type": "string" + }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", "enum": [ @@ -137868,6 +139011,12 @@ "title": "param", "type": "object" }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { @@ -138410,6 +139559,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -138687,6 +139837,40 @@ ], "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options." }, + "amazon_pay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "enum": [ + "", + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "enum": [ + "", + "none", + "off_session" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options." + }, "au_becs_debit": { "anyOf": [ { @@ -140131,6 +141315,14 @@ "anyOf": [ { "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "enum": [ + "", + "manual" + ], + "type": "string" + }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", "enum": [ @@ -142868,6 +144060,12 @@ "title": "param", "type": "object" }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { @@ -143410,6 +144608,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -143687,6 +144886,40 @@ ], "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options." }, + "amazon_pay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "enum": [ + "", + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "enum": [ + "", + "none", + "off_session" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options." + }, "au_becs_debit": { "anyOf": [ { @@ -145131,6 +146364,14 @@ "anyOf": [ { "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "enum": [ + "", + "manual" + ], + "type": "string" + }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", "enum": [ @@ -145627,7 +146868,7 @@ }, "/v1/payment_intents/{intent}/decrement_authorization": { "post": { - "description": "Perform an decremental authorization on an eligible\nPaymentIntent. To be eligible, the\nPaymentIntent’s status must be requires_capture and\ndecremental_authorization.status\nmust be available.
Decremental authorizations decrease the authorized amount on your customer’s card\nto the new, lower amount provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.
After decrement, the PaymentIntent object\nreturns with the updated\namount.\nThe PaymentIntent will now be capturable up to the new authorized amount.
\n\nEach PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines.\nAfter it’s captured, a PaymentIntent can no longer be decremented.
", + "description": "Perform a decremental authorization on an eligible\nPaymentIntent. To be eligible, the\nPaymentIntent’s status must be requires_capture and\ndecremental_authorization.status\nmust be available.
Decremental authorizations decrease the authorized amount on your customer’s card\nto the new, lower amount provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.
After decrement, the PaymentIntent object\nreturns with the updated\namount.\nThe PaymentIntent will now be capturable up to the new authorized amount.
\n\nEach PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines.\nAfter it’s fully captured, a PaymentIntent can no longer be decremented.
", "operationId": "PostPaymentIntentsIntentDecrementAuthorization", "parameters": [ { @@ -145662,7 +146903,7 @@ "additionalProperties": false, "properties": { "amount": { - "description": "The updated total amount that you intend to collect from the cardholder. This amount must be smaller than the currently authorized amount.", + "description": "The updated total amount that you intend to collect from the cardholder. This amount must be smaller than the currently authorized amount and greater than the already captured amount.", "type": "integer" }, "application_fee_amount": { @@ -148858,6 +150099,10 @@ "explode": true, "style": "deepObject" }, + "amazon_pay": { + "explode": true, + "style": "deepObject" + }, "apple_pay": { "explode": true, "style": "deepObject" @@ -148989,6 +150234,10 @@ "wechat_pay": { "explode": true, "style": "deepObject" + }, + "zip": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -149086,6 +150335,29 @@ "title": "payment_method_param", "type": "object" }, + "amazon_pay": { + "description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, "apple_pay": { "description": "Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.", "properties": { @@ -149839,6 +151111,29 @@ }, "title": "payment_method_param", "type": "object" + }, + "zip": { + "description": "Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" } }, "type": "object" @@ -149973,6 +151268,10 @@ "explode": true, "style": "deepObject" }, + "amazon_pay": { + "explode": true, + "style": "deepObject" + }, "apple_pay": { "explode": true, "style": "deepObject" @@ -150104,6 +151403,10 @@ "wechat_pay": { "explode": true, "style": "deepObject" + }, + "zip": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -150205,6 +151508,29 @@ "title": "payment_method_param", "type": "object" }, + "amazon_pay": { + "description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, "apple_pay": { "description": "Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.", "properties": { @@ -150953,6 +152279,29 @@ }, "title": "payment_method_param", "type": "object" + }, + "zip": { + "description": "Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" } }, "type": "object" @@ -151473,6 +152822,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -151608,6 +152958,10 @@ "explode": true, "style": "deepObject" }, + "amazon_pay": { + "explode": true, + "style": "deepObject" + }, "au_becs_debit": { "explode": true, "style": "deepObject" @@ -151809,6 +153163,12 @@ "title": "param", "type": "object" }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { @@ -152440,6 +153800,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -155806,11 +157167,11 @@ "explode": true, "style": "deepObject" }, - "features": { + "images": { "explode": true, "style": "deepObject" }, - "images": { + "marketing_features": { "explode": true, "style": "deepObject" }, @@ -156003,14 +157364,22 @@ }, "type": "array" }, - "features": { + "id": { + "description": "An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.", + "maxLength": 5000, + "type": "string" + }, + "images": { + "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", + "items": { + "type": "string" + }, + "type": "array" + }, + "marketing_features": { "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", "items": { "properties": { - "feature": { - "maxLength": 5000, - "type": "string" - }, "name": { "description": "The marketing feature name. Up to 80 characters long.", "maxLength": 5000, @@ -156025,18 +157394,6 @@ }, "type": "array" }, - "id": { - "description": "An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.", - "maxLength": 5000, - "type": "string" - }, - "images": { - "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", - "items": { - "type": "string" - }, - "type": "array" - }, "metadata": { "additionalProperties": { "type": "string" @@ -156471,11 +157828,11 @@ "explode": true, "style": "deepObject" }, - "features": { + "images": { "explode": true, "style": "deepObject" }, - "images": { + "marketing_features": { "explode": true, "style": "deepObject" }, @@ -156535,26 +157892,11 @@ }, "type": "array" }, - "features": { + "images": { "anyOf": [ { "items": { - "properties": { - "feature": { - "maxLength": 5000, - "type": "string" - }, - "name": { - "description": "The marketing feature name. Up to 80 characters long.", - "maxLength": 5000, - "type": "string" - } - }, - "required": [ - "name" - ], - "title": "features", - "type": "object" + "type": "string" }, "type": "array" }, @@ -156565,13 +157907,24 @@ "type": "string" } ], - "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table)." + "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer." }, - "images": { + "marketing_features": { "anyOf": [ { "items": { - "type": "string" + "properties": { + "name": { + "description": "The marketing feature name. Up to 80 characters long.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "features", + "type": "object" }, "type": "array" }, @@ -156582,7 +157935,7 @@ "type": "string" } ], - "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer." + "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table)." }, "metadata": { "anyOf": [ @@ -156997,6 +158350,84 @@ "description": "Error response." } } + }, + "get": { + "description": "Retrieves a product_feature, which represents a feature attachment to a product
", + "operationId": "GetProductsProductFeaturesId", + "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" + }, + { + "description": "The ID of the product_feature.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + }, + { + "description": "The ID of the product.", + "in": "path", + "name": "product", + "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/product_feature" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } } }, "/v1/promotion_codes": { @@ -158298,6 +159729,11 @@ ], "title": "discount_end", "type": "object" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -158475,6 +159911,11 @@ ], "title": "discount_end", "type": "object" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -158627,6 +160068,11 @@ "index": { "description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.", "type": "integer" + }, + "promotion_code": { + "description": "The promotion code to redeem.", + "maxLength": 5000, + "type": "string" } }, "title": "add_discount_specs", @@ -159488,6 +160934,11 @@ ], "title": "discount_end", "type": "object" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -160469,6 +161920,11 @@ ], "title": "discount_end", "type": "object" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -160627,6 +162083,11 @@ ], "title": "discount_end", "type": "object" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -160784,6 +162245,11 @@ "index": { "description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.", "type": "integer" + }, + "promotion_code": { + "description": "The promotion code to redeem.", + "maxLength": 5000, + "type": "string" } }, "title": "add_discount_specs", @@ -161655,6 +163121,11 @@ ], "title": "discount_end", "type": "object" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -167333,6 +168804,12 @@ "title": "param", "type": "object" }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { @@ -167875,6 +169352,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -168050,6 +169528,12 @@ "title": "setup_intent_payment_method_options_param", "type": "object" }, + "amazon_pay": { + "description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.", + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "card": { "description": "Configuration for any card setup attempted on this SetupIntent.", "properties": { @@ -168261,6 +169745,12 @@ "title": "setup_intent_param", "type": "object" }, + "card_present": { + "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.", + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "link": { "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.", "properties": { @@ -168800,6 +170290,12 @@ "title": "param", "type": "object" }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { @@ -169342,6 +170838,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -169517,6 +171014,12 @@ "title": "setup_intent_payment_method_options_param", "type": "object" }, + "amazon_pay": { + "description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.", + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "card": { "description": "Configuration for any card setup attempted on this SetupIntent.", "properties": { @@ -169728,6 +171231,12 @@ "title": "setup_intent_param", "type": "object" }, + "card_present": { + "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.", + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "link": { "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.", "properties": { @@ -170299,6 +171808,12 @@ "title": "param", "type": "object" }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { @@ -170841,6 +172356,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -171016,6 +172532,12 @@ "title": "setup_intent_payment_method_options_param", "type": "object" }, + "amazon_pay": { + "description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.", + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "card": { "description": "Configuration for any card setup attempted on this SetupIntent.", "properties": { @@ -171227,6 +172749,12 @@ "title": "setup_intent_param", "type": "object" }, + "card_present": { + "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.", + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "link": { "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.", "properties": { @@ -175533,7 +177061,7 @@ "type": "string" }, "coupon": { - "description": "The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -176732,7 +178260,7 @@ "type": "string" }, "coupon": { - "description": "The identifier of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -180031,7 +181559,7 @@ "type": "object" }, "promotion_code": { - "description": "The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "description": "The ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -182219,7 +183747,7 @@ "items": { "properties": { "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`, `no_voec`, `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`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `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`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `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", @@ -182227,6 +183755,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -182260,14 +183789,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -182333,7 +183865,7 @@ "items": { "properties": { "amount": { - "description": "A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing the line item's total price. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.", + "description": "A positive integer representing the line item's total price in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).\nThe minimum amount is $0.0 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts).\nThe amount value supports up to twelve digits (e.g., a value of 999999999999 for a USD charge of $9,999,999,999.99).\nIf `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.", "type": "integer" }, "product": { @@ -185906,7 +187438,7 @@ "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`, `no_voec`, `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`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `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`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `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", @@ -185914,6 +187446,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -185947,14 +187480,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -188580,6 +190116,7 @@ "bbpos_chipper2x", "bbpos_wisepad3", "bbpos_wisepos_e", + "mobile_phone_reader", "simulated_wisepos_e", "stripe_m2", "verifone_P400" @@ -189261,14 +190798,45 @@ "title": "selection_params", "type": "object" }, + "toggles": { + "description": "List of toggles to be displayed and customization for the toggles", + "items": { + "properties": { + "default_value": { + "description": "The default value of the toggle", + "enum": [ + "disabled", + "enabled" + ], + "type": "string" + }, + "description": { + "description": "The description which will be displayed for the toggle", + "maxLength": 50, + "type": "string" + }, + "title": { + "description": "The title which will be displayed for the toggle", + "maxLength": 50, + "type": "string" + } + }, + "title": "toggle_params", + "type": "object" + }, + "type": "array" + }, "type": { "description": "The type of input to collect", "enum": [ + "email", + "numeric", + "phone", "selection", - "signature" + "signature", + "text" ], - "type": "string", - "x-stripeBypassValidation": true + "type": "string" } }, "required": [ @@ -190034,6 +191602,12 @@ "title": "param", "type": "object" }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { @@ -190576,6 +192150,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -195400,11 +196975,11 @@ "type": "object" }, "directors_provided": { - "description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.", + "description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.", "type": "boolean" }, "executives_provided": { - "description": "Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` requirement.", + "description": "Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.executive` requirement.", "type": "boolean" }, "export_license_id": { @@ -195433,7 +197008,7 @@ "type": "string" }, "owners_provided": { - "description": "Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.owner` requirement.", + "description": "Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.owner` requirement.", "type": "boolean" }, "ownership_declaration": { @@ -195472,7 +197047,7 @@ "type": "string" }, "structure": { - "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.", + "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.", "enum": [ "", "free_zone_establishment", @@ -195745,12 +197320,12 @@ "type": "string" }, "id_number": { - "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { - "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, @@ -195929,7 +197504,7 @@ "type": "object" }, "tos_shown_and_accepted": { - "description": "Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](https://stripe.com/docs/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.", + "description": "Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](https://docs.stripe.com/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.", "type": "boolean" } }, @@ -196445,12 +198020,12 @@ "type": "string" }, "id_number": { - "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { - "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, @@ -202697,7 +204272,8 @@ "2022-08-01", "2022-11-15", "2023-08-16", - "2023-10-16" + "2023-10-16", + "2024-04-10" ], "maxLength": 5000, "type": "string", diff --git a/embedded/openapi/spec3.json b/embedded/openapi/spec3.json index a5cdef20..4126fa2e 100644 --- a/embedded/openapi/spec3.json +++ b/embedded/openapi/spec3.json @@ -161,10 +161,10 @@ "enum": [ "custom", "express", + "none", "standard" ], - "type": "string", - "x-stripeBypassValidation": true + "type": "string" } }, "required": [ @@ -191,7 +191,7 @@ "description": "", "properties": { "amount": { - "description": "A non-negative integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", + "description": "A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).", "nullable": true, "type": "integer" }, @@ -797,7 +797,7 @@ "type": "array" }, "pending_verification": { - "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`.", + "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" @@ -874,7 +874,7 @@ "type": "array" }, "pending_verification": { - "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`.", + "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" @@ -1039,7 +1039,7 @@ "type": "array" }, "pending_verification": { - "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`.", + "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" @@ -1129,7 +1129,7 @@ "description": "", "properties": { "amount": { - "description": "A non-negative integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", + "description": "A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).", "type": "integer" }, "currency": { @@ -1269,7 +1269,7 @@ "type": "array" }, "pending_verification": { - "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`.", + "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" @@ -1617,10 +1617,27 @@ "account_unification_account_controller": { "description": "", "properties": { + "fees": { + "$ref": "#/components/schemas/account_unification_account_controller_fees" + }, "is_controller": { "description": "`true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null.", "type": "boolean" }, + "losses": { + "$ref": "#/components/schemas/account_unification_account_controller_losses" + }, + "requirement_collection": { + "description": "A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.", + "enum": [ + "application", + "stripe" + ], + "type": "string" + }, + "stripe_dashboard": { + "$ref": "#/components/schemas/account_unification_account_controller_stripe_dashboard" + }, "type": { "description": "The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself.", "enum": [ @@ -1635,6 +1652,71 @@ ], "title": "AccountUnificationAccountController", "type": "object", + "x-expandableFields": [ + "fees", + "losses", + "stripe_dashboard" + ] + }, + "account_unification_account_controller_fees": { + "description": "", + "properties": { + "payer": { + "description": "A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account.", + "enum": [ + "account", + "application", + "application_custom", + "application_express" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "payer" + ], + "title": "AccountUnificationAccountControllerFees", + "type": "object", + "x-expandableFields": [] + }, + "account_unification_account_controller_losses": { + "description": "", + "properties": { + "payments": { + "description": "A value indicating who is liable when this account can't pay back negative balances from payments.", + "enum": [ + "application", + "stripe" + ], + "type": "string" + } + }, + "required": [ + "payments" + ], + "title": "AccountUnificationAccountControllerLosses", + "type": "object", + "x-expandableFields": [] + }, + "account_unification_account_controller_stripe_dashboard": { + "description": "", + "properties": { + "type": { + "description": "A value indicating the Stripe dashboard this account has access to independent of the Connect application.", + "enum": [ + "express", + "full", + "none" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "AccountUnificationAccountControllerStripeDashboard", + "type": "object", "x-expandableFields": [] }, "address": { @@ -2922,6 +3004,12 @@ "format": "unix-time", "type": "integer" }, + "next_refresh_available_at": { + "description": "Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "nullable": true, + "type": "integer" + }, "status": { "description": "The status of the last refresh attempt.", "enum": [ @@ -2999,7 +3087,7 @@ "x-expandableFields": [] }, "billing.meter": { - "description": "A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then use the billing meter to charge the user for the number of API calls they make.", + "description": "A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -3149,8 +3237,22 @@ "x-resourceId": "billing.meter_event" }, "billing.meter_event_adjustment": { - "description": "A billing meter event adjustment represents the status of a meter event adjustment.", + "description": "A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.", "properties": { + "cancel": { + "anyOf": [ + { + "$ref": "#/components/schemas/billing_meter_resource_billing_meter_event_adjustment_cancel" + } + ], + "description": "Specifies which event to cancel.", + "nullable": true + }, + "event_name": { + "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", + "maxLength": 100, + "type": "string" + }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" @@ -3169,16 +3271,27 @@ "pending" ], "type": "string" + }, + "type": { + "description": "Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.", + "enum": [ + "cancel" + ], + "type": "string" } }, "required": [ + "event_name", "livemode", "object", - "status" + "status", + "type" ], "title": "BillingMeterEventAdjustment", "type": "object", - "x-expandableFields": [], + "x-expandableFields": [ + "cancel" + ], "x-resourceId": "billing.meter_event_adjustment" }, "billing.meter_event_summary": { @@ -3290,6 +3403,20 @@ "type": "object", "x-expandableFields": [] }, + "billing_meter_resource_billing_meter_event_adjustment_cancel": { + "description": "", + "properties": { + "identifier": { + "description": "Unique identifier for the event.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "title": "BillingMeterResourceBillingMeterEventAdjustmentCancel", + "type": "object", + "x-expandableFields": [] + }, "billing_meter_resource_billing_meter_status_transitions": { "description": "", "properties": { @@ -3566,7 +3693,7 @@ "type": "string" }, "on_behalf_of": { - "description": "The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.", + "description": "The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.", "maxLength": 5000, "nullable": true, "type": "string" @@ -4085,7 +4212,7 @@ "$ref": "#/components/schemas/application_fee" } ], - "description": "The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details.", + "description": "The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ @@ -4096,7 +4223,7 @@ } }, "application_fee_amount": { - "description": "The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details.", + "description": "The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.", "nullable": true, "type": "integer" }, @@ -5388,6 +5515,13 @@ "type": "object", "x-expandableFields": [] }, + "checkout_amazon_pay_payment_method_options": { + "description": "", + "properties": {}, + "title": "CheckoutAmazonPayPaymentMethodOptions", + "type": "object", + "x-expandableFields": [] + }, "checkout_au_becs_debit_payment_method_options": { "description": "", "properties": { @@ -5869,6 +6003,9 @@ "alipay": { "$ref": "#/components/schemas/checkout_alipay_payment_method_options" }, + "amazon_pay": { + "$ref": "#/components/schemas/checkout_amazon_pay_payment_method_options" + }, "au_becs_debit": { "$ref": "#/components/schemas/checkout_au_becs_debit_payment_method_options" }, @@ -5952,6 +6089,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -6650,6 +6788,9 @@ "alipay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay" }, + "amazon_pay": { + "$ref": "#/components/schemas/payment_method_amazon_pay" + }, "au_becs_debit": { "$ref": "#/components/schemas/payment_method_au_becs_debit" }, @@ -6747,6 +6888,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -6804,6 +6946,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -6991,7 +7134,15 @@ }, "connect_embedded_account_features": { "description": "", - "properties": {}, + "properties": { + "external_account_collection": { + "description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements.", + "type": "boolean" + } + }, + "required": [ + "external_account_collection" + ], "title": "ConnectEmbeddedAccountFeatures", "type": "object", "x-expandableFields": [] @@ -6999,12 +7150,18 @@ "connect_embedded_account_session_create_components": { "description": "", "properties": { + "account_management": { + "$ref": "#/components/schemas/connect_embedded_account_config" + }, "account_onboarding": { "$ref": "#/components/schemas/connect_embedded_account_config" }, "documents": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, + "notification_banner": { + "$ref": "#/components/schemas/connect_embedded_account_config" + }, "payment_details": { "$ref": "#/components/schemas/connect_embedded_payments_config" }, @@ -7016,8 +7173,10 @@ } }, "required": [ + "account_management", "account_onboarding", "documents", + "notification_banner", "payment_details", "payments", "payouts" @@ -7025,8 +7184,10 @@ "title": "ConnectEmbeddedAccountSessionCreateComponents", "type": "object", "x-expandableFields": [ + "account_management", "account_onboarding", "documents", + "notification_banner", "payment_details", "payments", "payouts" @@ -9551,6 +9712,12 @@ "maxLength": 5000, "nullable": true, "type": "string" + }, + "subscription_item": { + "description": "The subscription item that this coupon is applied to, if it is applied to a particular subscription item.", + "maxLength": 5000, + "nullable": true, + "type": "string" } }, "required": [ @@ -9792,6 +9959,39 @@ "x-expandableFields": [], "x-resourceId": "deleted_product" }, + "deleted_product_feature": { + "description": "", + "properties": { + "deleted": { + "description": "Always true for a deleted object", + "enum": [ + true + ], + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "product_feature" + ], + "type": "string" + } + }, + "required": [ + "deleted", + "id", + "object" + ], + "title": "DeletedProductFeature", + "type": "object", + "x-expandableFields": [], + "x-resourceId": "deleted_product_feature" + }, "deleted_radar.value_list": { "description": "", "properties": { @@ -10194,6 +10394,12 @@ "maxLength": 5000, "nullable": true, "type": "string" + }, + "subscription_item": { + "description": "The subscription item that this coupon is applied to, if it is applied to a particular subscription item.", + "maxLength": 5000, + "nullable": true, + "type": "string" } }, "required": [ @@ -10254,6 +10460,78 @@ "discount" ] }, + "discounts_resource_stackable_discount": { + "description": "", + "properties": { + "coupon": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/coupon" + } + ], + "description": "ID of the coupon to create a new discount for.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/coupon" + } + ] + } + }, + "discount": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/discount" + } + ], + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/discount" + } + ] + } + }, + "promotion_code": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/promotion_code" + } + ], + "description": "ID of the promotion code to create a new discount for.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/promotion_code" + } + ] + } + } + }, + "title": "DiscountsResourceStackableDiscount", + "type": "object", + "x-expandableFields": [ + "coupon", + "discount", + "promotion_code" + ] + }, "dispute": { "description": "A dispute occurs when a customer questions your charge with their card issuer.\nWhen this happens, you have the opportunity to respond to the dispute with\nevidence that shows that the charge is legitimate.\n\nRelated guide: [Disputes and fraud](https://stripe.com/docs/disputes)", "properties": { @@ -10810,6 +11088,104 @@ "type": "object", "x-expandableFields": [] }, + "entitlements.active_entitlement": { + "description": "An active entitlement describes access to a feature for a customer.", + "properties": { + "feature": { + "description": "The feature that the customer is entitled to.", + "maxLength": 5000, + "type": "string" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "lookup_key": { + "description": "A unique key you provide as your own system identifier. This may be up to 80 characters.", + "maxLength": 5000, + "type": "string" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "entitlements.active_entitlement" + ], + "type": "string" + } + }, + "required": [ + "feature", + "id", + "livemode", + "lookup_key", + "object" + ], + "title": "ActiveEntitlement", + "type": "object", + "x-expandableFields": [], + "x-resourceId": "entitlements.active_entitlement" + }, + "entitlements.feature": { + "description": "A feature represents a monetizable ability or functionality in your system.\nFeatures can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.", + "properties": { + "active": { + "description": "Inactive features cannot be attached to new products and will not be returned from the features list endpoint.", + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "lookup_key": { + "description": "A unique key you provide as your own system identifier. This may be up to 80 characters.", + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "additionalProperties": { + "maxLength": 500, + "type": "string" + }, + "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", + "type": "object" + }, + "name": { + "description": "The feature's name, for your own purpose, not meant to be displayable to the customer.", + "maxLength": 80, + "type": "string" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "entitlements.feature" + ], + "type": "string" + } + }, + "required": [ + "active", + "id", + "livemode", + "lookup_key", + "metadata", + "name", + "object" + ], + "title": "Feature", + "type": "object", + "x-expandableFields": [], + "x-resourceId": "entitlements.feature" + }, "ephemeral_key": { "description": "", "properties": { @@ -11019,7 +11395,7 @@ "type": "array" }, "pending_verification": { - "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`.", + "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" @@ -12780,6 +13156,66 @@ "type": "object", "x-expandableFields": [] }, + "gelato_email_report": { + "description": "Result from a email check", + "properties": { + "email": { + "description": "Email to be verified.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "error": { + "anyOf": [ + { + "$ref": "#/components/schemas/gelato_email_report_error" + } + ], + "description": "Details on the verification error. Present when status is `unverified`.", + "nullable": true + }, + "status": { + "description": "Status of this `email` check.", + "enum": [ + "unverified", + "verified" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "status" + ], + "title": "GelatoEmailReport", + "type": "object", + "x-expandableFields": [ + "error" + ] + }, + "gelato_email_report_error": { + "description": "", + "properties": { + "code": { + "description": "A short machine-readable string giving the reason for the verification failure.", + "enum": [ + "email_unverified_other", + "email_verification_declined" + ], + "nullable": true, + "type": "string" + }, + "reason": { + "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "title": "GelatoEmailReportError", + "type": "object", + "x-expandableFields": [] + }, "gelato_id_number_report": { "description": "Result from an id_number check", "properties": { @@ -12873,6 +13309,84 @@ "type": "object", "x-expandableFields": [] }, + "gelato_phone_report": { + "description": "Result from a phone check", + "properties": { + "error": { + "anyOf": [ + { + "$ref": "#/components/schemas/gelato_phone_report_error" + } + ], + "description": "Details on the verification error. Present when status is `unverified`.", + "nullable": true + }, + "phone": { + "description": "Phone to be verified.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "status": { + "description": "Status of this `phone` check.", + "enum": [ + "unverified", + "verified" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "status" + ], + "title": "GelatoPhoneReport", + "type": "object", + "x-expandableFields": [ + "error" + ] + }, + "gelato_phone_report_error": { + "description": "", + "properties": { + "code": { + "description": "A short machine-readable string giving the reason for the verification failure.", + "enum": [ + "phone_unverified_other", + "phone_verification_declined" + ], + "nullable": true, + "type": "string" + }, + "reason": { + "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "title": "GelatoPhoneReportError", + "type": "object", + "x-expandableFields": [] + }, + "gelato_provided_details": { + "description": "", + "properties": { + "email": { + "description": "Email of user being verified", + "maxLength": 5000, + "type": "string" + }, + "phone": { + "description": "Phone number of user being verified", + "maxLength": 5000, + "type": "string" + } + }, + "title": "GelatoProvidedDetails", + "type": "object", + "x-expandableFields": [] + }, "gelato_report_document_options": { "description": "", "properties": { @@ -13012,6 +13526,18 @@ "type": "object", "x-expandableFields": [] }, + "gelato_session_email_options": { + "description": "", + "properties": { + "require_verification": { + "description": "Request one time password verification of `provided_details.email`.", + "type": "boolean" + } + }, + "title": "GelatoSessionEmailOptions", + "type": "object", + "x-expandableFields": [] + }, "gelato_session_id_number_options": { "description": "", "properties": {}, @@ -13032,9 +13558,13 @@ "document_expired", "document_type_not_supported", "document_unverified_other", + "email_unverified_other", + "email_verification_declined", "id_number_insufficient_document_data", "id_number_mismatch", "id_number_unverified_other", + "phone_unverified_other", + "phone_verification_declined", "selfie_document_missing_photo", "selfie_face_mismatch", "selfie_manipulated", @@ -13056,6 +13586,18 @@ "type": "object", "x-expandableFields": [] }, + "gelato_session_phone_options": { + "description": "", + "properties": { + "require_verification": { + "description": "Request one time password verification of `provided_details.phone`.", + "type": "boolean" + } + }, + "title": "GelatoSessionPhoneOptions", + "type": "object", + "x-expandableFields": [] + }, "gelato_verification_report_options": { "description": "", "properties": { @@ -13079,15 +13621,23 @@ "document": { "$ref": "#/components/schemas/gelato_session_document_options" }, + "email": { + "$ref": "#/components/schemas/gelato_session_email_options" + }, "id_number": { "$ref": "#/components/schemas/gelato_session_id_number_options" + }, + "phone": { + "$ref": "#/components/schemas/gelato_session_phone_options" } }, "title": "GelatoVerificationSessionOptions", "type": "object", "x-expandableFields": [ "document", - "id_number" + "email", + "id_number", + "phone" ] }, "gelato_verified_outputs": { @@ -13111,6 +13661,12 @@ "description": "The user’s verified date of birth.", "nullable": true }, + "email": { + "description": "The user's verified email address", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "first_name": { "description": "The user's verified first name.", "maxLength": 5000, @@ -13138,6 +13694,12 @@ "maxLength": 5000, "nullable": true, "type": "string" + }, + "phone": { + "description": "The user's verified phone number", + "maxLength": 5000, + "nullable": true, + "type": "string" } }, "title": "GelatoVerifiedOutputs", @@ -13164,6 +13726,9 @@ "document": { "$ref": "#/components/schemas/gelato_document_report" }, + "email": { + "$ref": "#/components/schemas/gelato_email_report" + }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, @@ -13186,6 +13751,9 @@ "options": { "$ref": "#/components/schemas/gelato_verification_report_options" }, + "phone": { + "$ref": "#/components/schemas/gelato_phone_report" + }, "selfie": { "$ref": "#/components/schemas/gelato_selfie_report" }, @@ -13193,11 +13761,17 @@ "description": "Type of report.", "enum": [ "document", - "id_number" + "id_number", + "verification_flow" ], "type": "string", "x-stripeBypassValidation": true }, + "verification_flow": { + "description": "The configuration token of a Verification Flow from the dashboard.", + "maxLength": 5000, + "type": "string" + }, "verification_session": { "description": "ID of the VerificationSession that created this report.", "maxLength": 5000, @@ -13216,8 +13790,10 @@ "type": "object", "x-expandableFields": [ "document", + "email", "id_number", "options", + "phone", "selfie" ], "x-resourceId": "identity.verification_report" @@ -13304,6 +13880,15 @@ "description": "A set of options for the session’s verification checks.", "nullable": true }, + "provided_details": { + "anyOf": [ + { + "$ref": "#/components/schemas/gelato_provided_details" + } + ], + "description": "Details provided about the user being verified. These details may be shown to the user.", + "nullable": true + }, "redaction": { "anyOf": [ { @@ -13327,7 +13912,8 @@ "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.", "enum": [ "document", - "id_number" + "id_number", + "verification_flow" ], "type": "string", "x-stripeBypassValidation": true @@ -13338,6 +13924,11 @@ "nullable": true, "type": "string" }, + "verification_flow": { + "description": "The configuration token of a Verification Flow from the dashboard.", + "maxLength": 5000, + "type": "string" + }, "verified_outputs": { "anyOf": [ { @@ -13363,6 +13954,7 @@ "last_error", "last_verification_report", "options", + "provided_details", "redaction", "verified_outputs" ], @@ -13862,7 +14454,6 @@ ] } }, - "nullable": true, "type": "array" }, "due_date": { @@ -14287,6 +14878,7 @@ "created", "currency", "default_tax_rates", + "discounts", "issuer", "lines", "livemode", @@ -14622,11 +15214,11 @@ "items": { "enum": [ "balances", + "ownership", "payment_method", "transactions" ], - "type": "string", - "x-stripeBypassValidation": true + "type": "string" }, "type": "array" }, @@ -14635,6 +15227,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -15453,7 +16046,7 @@ "description": "", "properties": { "type": { - "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`, `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`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `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`, or `unknown`", + "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`, `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`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `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`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", @@ -15461,6 +16054,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -15494,14 +16088,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -21661,7 +22258,6 @@ ] } }, - "nullable": true, "type": "array" }, "id": { @@ -21815,6 +22411,7 @@ "amount", "currency", "discountable", + "discounts", "id", "livemode", "metadata", @@ -21930,6 +22527,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -24169,6 +24767,16 @@ } ] }, + "amazon_pay": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_method_options_amazon_pay" + }, + { + "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" + } + ] + }, "au_becs_debit": { "anyOf": [ { @@ -24497,6 +25105,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -26357,6 +26966,9 @@ "alipay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay" }, + "amazon_pay": { + "$ref": "#/components/schemas/payment_method_amazon_pay" + }, "au_becs_debit": { "$ref": "#/components/schemas/payment_method_au_becs_debit" }, @@ -26507,6 +27119,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -26568,6 +27181,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -26658,6 +27272,13 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_amazon_pay": { + "description": "", + "properties": {}, + "title": "payment_method_amazon_pay", + "type": "object", + "x-expandableFields": [] + }, "payment_method_au_becs_debit": { "description": "", "properties": { @@ -27315,6 +27936,9 @@ "alipay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, + "amazon_pay": { + "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" + }, "apple_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, @@ -27441,6 +28065,9 @@ }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" + }, + "zip": { + "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" } }, "required": [ @@ -27458,6 +28085,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "apple_pay", "au_becs_debit", "bacs_debit", @@ -27487,7 +28115,8 @@ "sepa_debit", "sofort", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "x-resourceId": "payment_method_configuration" }, @@ -27519,6 +28148,9 @@ "alipay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay_details" }, + "amazon_pay": { + "$ref": "#/components/schemas/payment_method_details_amazon_pay" + }, "au_becs_debit": { "$ref": "#/components/schemas/payment_method_details_au_becs_debit" }, @@ -27642,6 +28274,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -27828,6 +28461,13 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_details_amazon_pay": { + "description": "", + "properties": {}, + "title": "payment_method_details_amazon_pay", + "type": "object", + "x-expandableFields": [] + }, "payment_method_details_au_becs_debit": { "description": "", "properties": { @@ -30093,6 +30733,21 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_options_amazon_pay": { + "description": "", + "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.", + "enum": [ + "manual" + ], + "type": "string" + } + }, + "title": "payment_method_options_amazon_pay", + "type": "object", + "x-expandableFields": [] + }, "payment_method_options_bacs_debit": { "description": "", "properties": { @@ -30674,7 +31329,15 @@ }, "payment_method_options_revolut_pay": { "description": "", - "properties": {}, + "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.", + "enum": [ + "manual" + ], + "type": "string" + } + }, "title": "payment_method_options_revolut_pay", "type": "object", "x-expandableFields": [] @@ -32052,7 +32715,7 @@ "description": "", "properties": { "type": { - "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`, `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`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `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`, or `unknown`", + "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`, `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`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `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`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", @@ -32060,6 +32723,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -32093,14 +32757,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -32822,7 +33489,7 @@ "type": "array" }, "pending_verification": { - "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`.", + "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" @@ -32931,7 +33598,7 @@ "type": "array" }, "pending_verification": { - "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`.", + "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" @@ -34060,13 +34727,6 @@ "nullable": true, "type": "string" }, - "features": { - "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", - "items": { - "$ref": "#/components/schemas/product_marketing_feature" - }, - "type": "array" - }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, @@ -34084,6 +34744,13 @@ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, + "marketing_features": { + "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", + "items": { + "$ref": "#/components/schemas/product_marketing_feature" + }, + "type": "array" + }, "metadata": { "additionalProperties": { "maxLength": 500, @@ -34165,10 +34832,10 @@ "required": [ "active", "created", - "features", "id", "images", "livemode", + "marketing_features", "metadata", "name", "object", @@ -34178,12 +34845,48 @@ "type": "object", "x-expandableFields": [ "default_price", - "features", + "marketing_features", "package_dimensions", "tax_code" ], "x-resourceId": "product" }, + "product_feature": { + "description": "A product_feature represents an attachment between a feature and a product.\nWhen a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.", + "properties": { + "entitlement_feature": { + "$ref": "#/components/schemas/entitlements.feature" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "product_feature" + ], + "type": "string" + } + }, + "required": [ + "entitlement_feature", + "id", + "livemode", + "object" + ], + "title": "ProductFeature", + "type": "object", + "x-expandableFields": [ + "entitlement_feature" + ], + "x-resourceId": "product_feature" + }, "product_marketing_feature": { "description": "", "properties": { @@ -35807,6 +36510,9 @@ "alipay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, + "amazon_pay": { + "$ref": "#/components/schemas/destination_details_unimplemented" + }, "au_bank_transfer": { "$ref": "#/components/schemas/destination_details_unimplemented" }, @@ -35897,6 +36603,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_bank_transfer", "blik", "br_bank_transfer", @@ -37084,12 +37791,22 @@ } ] } + }, + "offline": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_method_details_card_present_offline" + } + ], + "description": "Details about payments collected offline.", + "nullable": true } }, "title": "setup_attempt_payment_method_details_card_present", "type": "object", "x-expandableFields": [ - "generated_card" + "generated_card", + "offline" ] }, "setup_attempt_payment_method_details_card_wallet": { @@ -37777,9 +38494,29 @@ } ] }, + "amazon_pay": { + "anyOf": [ + { + "$ref": "#/components/schemas/setup_intent_payment_method_options_amazon_pay" + }, + { + "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client" + } + ] + }, "card": { "$ref": "#/components/schemas/setup_intent_payment_method_options_card" }, + "card_present": { + "anyOf": [ + { + "$ref": "#/components/schemas/setup_intent_payment_method_options_card_present" + }, + { + "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client" + } + ] + }, "link": { "anyOf": [ { @@ -37825,7 +38562,9 @@ "type": "object", "x-expandableFields": [ "acss_debit", + "amazon_pay", "card", + "card_present", "link", "paypal", "sepa_debit", @@ -37864,6 +38603,13 @@ "mandate_options" ] }, + "setup_intent_payment_method_options_amazon_pay": { + "description": "", + "properties": {}, + "title": "setup_intent_payment_method_options_amazon_pay", + "type": "object", + "x-expandableFields": [] + }, "setup_intent_payment_method_options_card": { "description": "", "properties": { @@ -37993,6 +38739,13 @@ "type": "object", "x-expandableFields": [] }, + "setup_intent_payment_method_options_card_present": { + "description": "", + "properties": {}, + "title": "setup_intent_payment_method_options_card_present", + "type": "object", + "x-expandableFields": [] + }, "setup_intent_payment_method_options_link": { "description": "", "properties": {}, @@ -40093,9 +40846,31 @@ "$ref": "#/components/schemas/discount" } ], - "description": "Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.", + "description": "Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "nullable": true }, + "discounts": { + "description": "The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.", + "items": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/discount" + } + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/discount" + } + ] + } + }, + "type": "array" + }, "ended_at": { "description": "If the subscription has ended, the date the subscription ended.", "format": "unix-time", @@ -40367,6 +41142,7 @@ "current_period_end", "current_period_start", "customer", + "discounts", "id", "items", "livemode", @@ -40388,6 +41164,7 @@ "default_source", "default_tax_rates", "discount", + "discounts", "items", "latest_invoice", "on_behalf_of", @@ -40480,6 +41257,28 @@ "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "type": "integer" }, + "discounts": { + "description": "The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.", + "items": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/discount" + } + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/discount" + } + ] + } + }, + "type": "array" + }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, @@ -40523,6 +41322,7 @@ }, "required": [ "created", + "discounts", "id", "metadata", "object", @@ -40533,6 +41333,7 @@ "type": "object", "x-expandableFields": [ "billing_thresholds", + "discounts", "price", "tax_rates" ], @@ -40834,6 +41635,13 @@ "subscription_schedule_add_invoice_item": { "description": "An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase.", "properties": { + "discounts": { + "description": "The stackable discounts that will be applied to the item.", + "items": { + "$ref": "#/components/schemas/discounts_resource_stackable_discount" + }, + "type": "array" + }, "price": { "anyOf": [ { @@ -40874,11 +41682,13 @@ } }, "required": [ + "discounts", "price" ], "title": "SubscriptionScheduleAddInvoiceItem", "type": "object", "x-expandableFields": [ + "discounts", "price", "tax_rates" ] @@ -40895,6 +41705,13 @@ "description": "Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period", "nullable": true }, + "discounts": { + "description": "The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.", + "items": { + "$ref": "#/components/schemas/discounts_resource_stackable_discount" + }, + "type": "array" + }, "metadata": { "additionalProperties": { "maxLength": 500, @@ -40943,12 +41760,14 @@ } }, "required": [ + "discounts", "price" ], "title": "SubscriptionScheduleConfigurationItem", "type": "object", "x-expandableFields": [ "billing_thresholds", + "discounts", "price", "tax_rates" ] @@ -41084,6 +41903,13 @@ "nullable": true, "type": "string" }, + "discounts": { + "description": "The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.", + "items": { + "$ref": "#/components/schemas/discounts_resource_stackable_discount" + }, + "type": "array" + }, "end_date": { "description": "The end of this phase of the subscription schedule.", "format": "unix-time", @@ -41167,6 +41993,7 @@ "required": [ "add_invoice_items", "currency", + "discounts", "end_date", "items", "proration_behavior", @@ -41181,6 +42008,7 @@ "coupon", "default_payment_method", "default_tax_rates", + "discounts", "invoice_settings", "items", "on_behalf_of", @@ -42454,7 +43282,7 @@ "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`, `no_voec`, `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`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `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`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `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": [ "ad_nrt", "ae_trn", @@ -42462,6 +43290,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -42495,14 +43324,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -43047,7 +43879,7 @@ "description": "", "properties": { "type": { - "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`, `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`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `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`, or `unknown`", + "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`, `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`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `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`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", @@ -43055,6 +43887,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -43088,14 +43921,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -43921,11 +44757,12 @@ "type": "string" }, "device_type": { - "description": "Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, or `simulated_wisepos_e`.", + "description": "Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`.", "enum": [ "bbpos_chipper2x", "bbpos_wisepad3", "bbpos_wisepos_e", + "mobile_phone_reader", "simulated_wisepos_e", "stripe_m2", "verifone_P400" @@ -45236,7 +46073,7 @@ ] }, "transfer_reversal": { - "description": "[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reversing transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reversing-transfers)", + "description": "[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reverse transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers)", "properties": { "amount": { "description": "Amount, in cents (or local equivalent).", @@ -48048,7 +48885,7 @@ "x-expandableFields": [] }, "usage_record": { - "description": "Usage records allow you to report customer usage and metrics to Stripe for\nmetered billing of subscription prices.\n\nRelated guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)", + "description": "Usage records allow you to report customer usage and metrics to Stripe for\nmetered billing of subscription prices.\n\nRelated guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)\n\nThis is our legacy usage-based billing API. See the [updated usage-based billing docs](https://docs.stripe.com/billing/subscriptions/usage-based).", "properties": { "id": { "description": "Unique identifier for the object.", @@ -48279,7 +49116,7 @@ "description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.", "termsOfService": "https://stripe.com/us/terms/", "title": "Stripe API", - "version": "2023-10-16", + "version": "2024-04-10", "x-stripeSpecFilename": "spec3" }, "openapi": "3.0.0", @@ -48486,13 +49323,38 @@ "components": { "description": "Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).", "properties": { + "account_management": { + "properties": { + "enabled": { + "type": "boolean" + }, + "features": { + "properties": { + "external_account_collection": { + "type": "boolean" + } + }, + "title": "account_features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "account_config_param", + "type": "object" + }, "account_onboarding": { "properties": { "enabled": { "type": "boolean" }, "features": { - "properties": {}, + "properties": { + "external_account_collection": { + "type": "boolean" + } + }, "title": "account_features_param", "type": "object" } @@ -48520,6 +49382,27 @@ "title": "base_config_param", "type": "object" }, + "notification_banner": { + "properties": { + "enabled": { + "type": "boolean" + }, + "features": { + "properties": { + "external_account_collection": { + "type": "boolean" + } + }, + "title": "account_features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "account_config_param", + "type": "object" + }, "payment_details": { "properties": { "enabled": { @@ -48833,6 +49716,10 @@ "explode": true, "style": "deepObject" }, + "controller": { + "explode": true, + "style": "deepObject" + }, "documents": { "explode": true, "style": "deepObject" @@ -49061,7 +49948,7 @@ "type": "object" }, "business_type": { - "description": "The business type. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts.", + "description": "The business type. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts.", "enum": [ "company", "government_entity", @@ -49439,7 +50326,7 @@ "type": "object" }, "company": { - "description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions), this property can only be updated for Custom accounts.", + "description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for Custom accounts.", "properties": { "address": { "properties": { @@ -49659,13 +50546,67 @@ "title": "company_specs", "type": "object" }, + "controller": { + "description": "A hash of configuration describing the account controller's attributes.", + "properties": { + "fees": { + "properties": { + "payer": { + "enum": [ + "account", + "application" + ], + "type": "string" + } + }, + "title": "controller_fees_specs", + "type": "object" + }, + "losses": { + "properties": { + "payments": { + "enum": [ + "application", + "stripe" + ], + "type": "string" + } + }, + "title": "controller_losses_specs", + "type": "object" + }, + "requirement_collection": { + "enum": [ + "application", + "stripe" + ], + "type": "string" + }, + "stripe_dashboard": { + "properties": { + "type": { + "enum": [ + "express", + "full", + "none" + ], + "type": "string" + } + }, + "title": "controller_dashboard_specs", + "type": "object" + } + }, + "title": "controller_specs", + "type": "object" + }, "country": { "description": "The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported.", "maxLength": 5000, "type": "string" }, "default_currency": { - "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).", + "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).", "type": "string" }, "documents": { @@ -49779,13 +50720,13 @@ "type": "array" }, "external_account": { - "description": "A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.Creates a short-lived API key for a given resource.
", - "operationId": "PostEphemeralKeys", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": { - "expand": { - "explode": true, - "style": "deepObject" - } - }, - "schema": { - "additionalProperties": false, - "properties": { - "customer": { - "description": "The ID of the Customer you'd like to modify using the resulting ephemeral key.", - "maxLength": 5000, - "type": "string" - }, - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "issuing_card": { - "description": "The ID of the Issuing Card you'd like to access using the resulting ephemeral key.", - "maxLength": 5000, - "type": "string" - }, - "nonce": { - "description": "A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information.", - "maxLength": 5000, - "type": "string" - }, - "verification_session": { - "description": "The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key", - "maxLength": 5000, - "type": "string" - } - }, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ephemeral_key" - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/ephemeral_keys/{key}": { - "delete": { - "description": "Invalidates a short-lived API key for a given resource.
", - "operationId": "DeleteEphemeralKeysKey", + "/v1/entitlements/active_entitlements": { + "get": { + "description": "Retrieve a list of active entitlements for a customer
", + "operationId": "GetEntitlementsActiveEntitlements", "parameters": [ { - "in": "path", - "name": "key", + "description": "The ID of the customer.", + "in": "query", + "name": "customer", "required": true, "schema": { "maxLength": 5000, "type": "string" }, - "style": "simple" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": { - "expand": { - "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" - } - }, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ephemeral_key" - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/events": { - "get": { - "description": "List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).
Retrieve an active entitlement
", + "operationId": "GetEntitlementsActiveEntitlementsId", + "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" + }, + { + "description": "The ID of the entitlement.", + "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/entitlements.active_entitlement" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/entitlements/features": { + "get": { + "description": "Retrieve a list of features
", + "operationId": "GetEntitlementsFeatures", + "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": "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": { + "items": { + "$ref": "#/components/schemas/entitlements.feature" + }, + "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, + "pattern": "^/v1/entitlements/features", + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "EntitlementsResourceFeatureList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "Creates a feature
", + "operationId": "PostEntitlementsFeatures", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "metadata": { + "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" + }, + "lookup_key": { + "description": "A unique key you provide as your own system identifier. This may be up to 80 characters.", + "maxLength": 80, + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", + "type": "object" + }, + "name": { + "description": "The feature's name, for your own purpose, not meant to be displayable to the customer.", + "maxLength": 80, + "type": "string" + } + }, + "required": [ + "lookup_key", + "name" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/entitlements.feature" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/entitlements/features/{id}": { + "get": { + "description": "Retrieves a feature
", + "operationId": "GetEntitlementsFeaturesId", + "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" + }, + { + "description": "The ID of the feature.", + "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/entitlements.feature" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "Update a feature’s metadata or permanently deactivate it.
", + "operationId": "PostEntitlementsFeaturesId", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "metadata": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "active": { + "description": "Inactive features cannot be attached to new products and will not be returned from the features list endpoint.", + "type": "boolean" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", + "type": "object" + }, + "name": { + "description": "The feature's name, for your own purpose, not meant to be displayable to the customer.", + "maxLength": 80, + "type": "string" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/entitlements.feature" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/ephemeral_keys": { + "post": { + "description": "Creates a short-lived API key for a given resource.
", + "operationId": "PostEphemeralKeys", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "customer": { + "description": "The ID of the Customer you'd like to modify using the resulting ephemeral key.", + "maxLength": 5000, + "type": "string" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "issuing_card": { + "description": "The ID of the Issuing Card you'd like to access using the resulting ephemeral key.", + "maxLength": 5000, + "type": "string" + }, + "nonce": { + "description": "A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information.", + "maxLength": 5000, + "type": "string" + }, + "verification_session": { + "description": "The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key", + "maxLength": 5000, + "type": "string" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ephemeral_key" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/ephemeral_keys/{key}": { + "delete": { + "description": "Invalidates a short-lived API key for a given resource.
", + "operationId": "DeleteEphemeralKeysKey", + "parameters": [ + { + "in": "path", + "name": "key", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "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" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ephemeral_key" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/events": { + "get": { + "description": "List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).
Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
", + "operationId": "PostProductsId", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "description": { + "explode": true, + "style": "deepObject" + }, + "expand": { + "explode": true, + "style": "deepObject" + }, + "images": { + "explode": true, + "style": "deepObject" + }, + "marketing_features": { + "explode": true, + "style": "deepObject" + }, + "metadata": { + "explode": true, + "style": "deepObject" + }, + "package_dimensions": { + "explode": true, + "style": "deepObject" + }, + "tax_code": { + "explode": true, + "style": "deepObject" + }, + "unit_label": { + "explode": true, + "style": "deepObject" + }, + "url": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "active": { + "description": "Whether the product is available for purchase.", + "type": "boolean" + }, + "default_price": { + "description": "The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.", + "maxLength": 5000, + "type": "string" + }, + "description": { + "anyOf": [ + { + "maxLength": 40000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes." + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "images": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer." + }, + "marketing_features": { + "anyOf": [ + { + "items": { + "properties": { + "name": { + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "features", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table)." + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "name": { + "description": "The product's name, meant to be displayable to the customer.", + "maxLength": 5000, + "type": "string" + }, + "package_dimensions": { + "anyOf": [ + { + "properties": { + "height": { + "type": "number" + }, + "length": { + "type": "number" + }, + "weight": { + "type": "number" + }, + "width": { + "type": "number" + } + }, + "required": [ + "height", + "length", + "weight", + "width" + ], + "title": "package_dimensions_specs", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The dimensions of this product for shipping purposes." + }, + "shippable": { + "description": "Whether this product is shipped (i.e., physical goods).", + "type": "boolean" + }, + "statement_descriptor": { + "description": "An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.\n\nThis may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `\"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.\n It must contain at least one letter. May only be set if `type=service`.", + "maxLength": 22, + "type": "string" + }, + "tax_code": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." + }, + "unit_label": { + "anyOf": [ + { + "maxLength": 12, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`." + }, + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A URL of a publicly-accessible webpage for this product." + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/products/{product}/features": { + "get": { + "description": "Retrieve a list of features for a product
", + "operationId": "GetProductsProductFeatures", + "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" + }, + { + "in": "path", + "name": "product", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + }, + { + "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": { + "items": { + "$ref": "#/components/schemas/product_feature" + }, + "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": "EntitlementsResourceProductFeatureList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "Creates a product_feature, which represents a feature attachment to a product
", + "operationId": "PostProductsProductFeatures", + "parameters": [ + { + "in": "path", + "name": "product", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "entitlement_feature": { + "description": "The ID of the [Feature](docs/api/entitlements/feature) object attached to this product.", + "maxLength": 5000, + "type": "string" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "entitlement_feature" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_feature" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/products/{product}/features/{id}": { + "delete": { + "description": "Deletes the feature attachment to a product
", + "operationId": "DeleteProductsProductFeaturesId", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + }, + { + "in": "path", + "name": "product", + "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_product_feature" } } }, @@ -115628,11 +118313,27 @@ } } }, - "post": { - "description": "Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
", - "operationId": "PostProductsId", + "get": { + "description": "Retrieves a product_feature, which represents a feature attachment to a product
", + "operationId": "GetProductsProductFeaturesId", "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" + }, + { + "description": "The ID of the product_feature.", "in": "path", "name": "id", "required": true, @@ -115641,238 +118342,26 @@ "type": "string" }, "style": "simple" + }, + { + "description": "The ID of the product.", + "in": "path", + "name": "product", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { - "encoding": { - "description": { - "explode": true, - "style": "deepObject" - }, - "expand": { - "explode": true, - "style": "deepObject" - }, - "features": { - "explode": true, - "style": "deepObject" - }, - "images": { - "explode": true, - "style": "deepObject" - }, - "metadata": { - "explode": true, - "style": "deepObject" - }, - "package_dimensions": { - "explode": true, - "style": "deepObject" - }, - "tax_code": { - "explode": true, - "style": "deepObject" - }, - "unit_label": { - "explode": true, - "style": "deepObject" - }, - "url": { - "explode": true, - "style": "deepObject" - } - }, + "encoding": {}, "schema": { "additionalProperties": false, - "properties": { - "active": { - "description": "Whether the product is available for purchase.", - "type": "boolean" - }, - "default_price": { - "description": "The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.", - "maxLength": 5000, - "type": "string" - }, - "description": { - "anyOf": [ - { - "maxLength": 40000, - "type": "string" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes." - }, - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "features": { - "anyOf": [ - { - "items": { - "properties": { - "name": { - "maxLength": 5000, - "type": "string" - } - }, - "required": [ - "name" - ], - "title": "features", - "type": "object" - }, - "type": "array" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table)." - }, - "images": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer." - }, - "metadata": { - "anyOf": [ - { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." - }, - "name": { - "description": "The product's name, meant to be displayable to the customer.", - "maxLength": 5000, - "type": "string" - }, - "package_dimensions": { - "anyOf": [ - { - "properties": { - "height": { - "type": "number" - }, - "length": { - "type": "number" - }, - "weight": { - "type": "number" - }, - "width": { - "type": "number" - } - }, - "required": [ - "height", - "length", - "weight", - "width" - ], - "title": "package_dimensions_specs", - "type": "object" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "The dimensions of this product for shipping purposes." - }, - "shippable": { - "description": "Whether this product is shipped (i.e., physical goods).", - "type": "boolean" - }, - "statement_descriptor": { - "description": "An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.\n\nThis may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `\"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.\n It must contain at least one letter. May only be set if `type=service`.", - "maxLength": 22, - "type": "string" - }, - "tax_code": { - "anyOf": [ - { - "type": "string" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." - }, - "unit_label": { - "anyOf": [ - { - "maxLength": 12, - "type": "string" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`." - }, - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "A URL of a publicly-accessible webpage for this product." - } - }, + "properties": {}, "type": "object" } } @@ -115884,7 +118373,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/product" + "$ref": "#/components/schemas/product_feature" } } }, @@ -116770,6 +119259,10 @@ "discount": { "maxLength": 5000, "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -116879,6 +119372,37 @@ "description": "A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.", "items": { "properties": { + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "price": { "maxLength": 5000, "type": "string" @@ -117367,6 +119891,10 @@ "discount": { "maxLength": 5000, "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -117459,6 +119987,37 @@ "description": "A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.", "items": { "properties": { + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "id": { "maxLength": 5000, "type": "string" @@ -121874,6 +124433,11 @@ "title": "param", "type": "object" }, + "amazon_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "properties": { "account_number": { @@ -122316,6 +124880,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -122471,6 +125036,11 @@ "title": "setup_intent_payment_method_options_param", "type": "object" }, + "amazon_pay": { + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "card": { "properties": { "mandate_options": { @@ -122652,6 +125222,11 @@ "title": "setup_intent_param", "type": "object" }, + "card_present": { + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "link": { "properties": {}, "title": "setup_intent_payment_method_options_param", @@ -122700,6 +125275,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -123060,6 +125636,11 @@ "title": "param", "type": "object" }, + "amazon_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "properties": { "account_number": { @@ -123502,6 +126083,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -123657,6 +126239,11 @@ "title": "setup_intent_payment_method_options_param", "type": "object" }, + "amazon_pay": { + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "card": { "properties": { "mandate_options": { @@ -123838,6 +126425,11 @@ "title": "setup_intent_param", "type": "object" }, + "card_present": { + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "link": { "properties": {}, "title": "setup_intent_payment_method_options_param", @@ -123886,6 +126478,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -124270,6 +126863,11 @@ "title": "param", "type": "object" }, + "amazon_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "properties": { "account_number": { @@ -124712,6 +127310,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -124867,6 +127466,11 @@ "title": "setup_intent_payment_method_options_param", "type": "object" }, + "amazon_pay": { + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "card": { "properties": { "mandate_options": { @@ -125048,6 +127652,11 @@ "title": "setup_intent_param", "type": "object" }, + "card_present": { + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "link": { "properties": {}, "title": "setup_intent_payment_method_options_param", @@ -125096,6 +127705,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -127432,6 +130042,409 @@ "explode": true, "style": "deepObject" }, + "discounts": { + "explode": true, + "style": "deepObject" + }, + "expand": { + "explode": true, + "style": "deepObject" + }, + "metadata": { + "explode": true, + "style": "deepObject" + }, + "price_data": { + "explode": true, + "style": "deepObject" + }, + "tax_rates": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "usage_gte": { + "type": "integer" + } + }, + "required": [ + "usage_gte" + ], + "title": "item_billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription item." + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", + "type": "object" + }, + "payment_behavior": { + "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", + "enum": [ + "allow_incomplete", + "default_incomplete", + "error_if_incomplete", + "pending_if_incomplete" + ], + "type": "string" + }, + "price": { + "description": "The ID of the price object.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "properties": { + "currency": { + "type": "string" + }, + "product": { + "maxLength": 5000, + "type": "string" + }, + "recurring": { + "properties": { + "interval": { + "enum": [ + "day", + "month", + "week", + "year" + ], + "type": "string" + }, + "interval_count": { + "type": "integer" + } + }, + "required": [ + "interval" + ], + "title": "recurring_adhoc", + "type": "object" + }, + "tax_behavior": { + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "type": "integer" + }, + "unit_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product", + "recurring" + ], + "title": "recurring_price_data", + "type": "object" + }, + "proration_behavior": { + "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], + "type": "string" + }, + "proration_date": { + "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", + "format": "unix-time", + "type": "integer" + }, + "quantity": { + "description": "The quantity you'd like to apply to the subscription item you're creating.", + "type": "integer" + }, + "subscription": { + "description": "The identifier of the subscription to modify.", + "maxLength": 5000, + "type": "string" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." + } + }, + "required": [ + "subscription" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/subscription_item" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/subscription_items/{item}": { + "delete": { + "description": "Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
", + "operationId": "DeleteSubscriptionItemsItem", + "parameters": [ + { + "in": "path", + "name": "item", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": { + "clear_usage": { + "description": "Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`.", + "type": "boolean" + }, + "proration_behavior": { + "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], + "type": "string" + }, + "proration_date": { + "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", + "format": "unix-time", + "type": "integer" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleted_subscription_item" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "get": { + "description": "Retrieves the subscription item with the given ID.
", + "operationId": "GetSubscriptionItemsItem", + "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": "item", + "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/subscription_item" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "Updates the plan or quantity of an item on a current subscription.
", + "operationId": "PostSubscriptionItemsItem", + "parameters": [ + { + "in": "path", + "name": "item", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "billing_thresholds": { + "explode": true, + "style": "deepObject" + }, + "discounts": { + "explode": true, + "style": "deepObject" + }, "expand": { "explode": true, "style": "deepObject" @@ -127475,120 +130488,26 @@ ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", - "type": "object" - }, - "payment_behavior": { - "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", - "enum": [ - "allow_incomplete", - "default_incomplete", - "error_if_incomplete", - "pending_if_incomplete" - ], - "type": "string" - }, - "price": { - "description": "The ID of the price object.", - "maxLength": 5000, - "type": "string" - }, - "price_data": { - "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", - "properties": { - "currency": { - "type": "string" - }, - "product": { - "maxLength": 5000, - "type": "string" - }, - "recurring": { - "properties": { - "interval": { - "enum": [ - "day", - "month", - "week", - "year" - ], - "type": "string" - }, - "interval_count": { - "type": "integer" - } - }, - "required": [ - "interval" - ], - "title": "recurring_adhoc", - "type": "object" - }, - "tax_behavior": { - "enum": [ - "exclusive", - "inclusive", - "unspecified" - ], - "type": "string" - }, - "unit_amount": { - "type": "integer" - }, - "unit_amount_decimal": { - "format": "decimal", - "type": "string" - } - }, - "required": [ - "currency", - "product", - "recurring" - ], - "title": "recurring_price_data", - "type": "object" - }, - "proration_behavior": { - "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", - "enum": [ - "always_invoice", - "create_prorations", - "none" - ], - "type": "string" - }, - "proration_date": { - "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", - "format": "unix-time", - "type": "integer" - }, - "quantity": { - "description": "The quantity you'd like to apply to the subscription item you're creating.", - "type": "integer" - }, - "subscription": { - "description": "The identifier of the subscription to modify.", - "maxLength": 5000, - "type": "string" - }, - "tax_rates": { + "discounts": { "anyOf": [ { "items": { - "maxLength": 5000, - "type": "string" + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" }, "type": "array" }, @@ -127599,244 +130518,7 @@ "type": "string" } ], - "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." - } - }, - "required": [ - "subscription" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/subscription_item" - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/subscription_items/{item}": { - "delete": { - "description": "Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
", - "operationId": "DeleteSubscriptionItemsItem", - "parameters": [ - { - "in": "path", - "name": "item", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": {}, - "schema": { - "additionalProperties": false, - "properties": { - "clear_usage": { - "description": "Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`.", - "type": "boolean" - }, - "proration_behavior": { - "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", - "enum": [ - "always_invoice", - "create_prorations", - "none" - ], - "type": "string" - }, - "proration_date": { - "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.", - "format": "unix-time", - "type": "integer" - } - }, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/deleted_subscription_item" - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - }, - "get": { - "description": "Retrieves the subscription item with the given ID.
", - "operationId": "GetSubscriptionItemsItem", - "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": "item", - "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/subscription_item" - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - }, - "post": { - "description": "Updates the plan or quantity of an item on a current subscription.
", - "operationId": "PostSubscriptionItemsItem", - "parameters": [ - { - "in": "path", - "name": "item", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": { - "billing_thresholds": { - "explode": true, - "style": "deepObject" - }, - "expand": { - "explode": true, - "style": "deepObject" - }, - "metadata": { - "explode": true, - "style": "deepObject" - }, - "price_data": { - "explode": true, - "style": "deepObject" - }, - "tax_rates": { - "explode": true, - "style": "deepObject" - } - }, - "schema": { - "additionalProperties": false, - "properties": { - "billing_thresholds": { - "anyOf": [ - { - "properties": { - "usage_gte": { - "type": "integer" - } - }, - "required": [ - "usage_gte" - ], - "title": "item_billing_thresholds_param", - "type": "object" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." + "description": "The coupons to redeem into discounts for the subscription item." }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -128778,6 +131460,27 @@ "add_invoice_items": { "items": { "properties": { + "discounts": { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, "price": { "maxLength": 5000, "type": "string" @@ -128952,6 +131655,37 @@ } ] }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "end_date": { "format": "unix-time", "type": "integer" @@ -129026,6 +131760,37 @@ } ] }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "metadata": { "additionalProperties": { "type": "string" @@ -129540,6 +132305,27 @@ "add_invoice_items": { "items": { "properties": { + "discounts": { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, "price": { "maxLength": 5000, "type": "string" @@ -129711,6 +132497,37 @@ } ] }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "end_date": { "anyOf": [ { @@ -129796,6 +132613,37 @@ } ] }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "metadata": { "additionalProperties": { "type": "string" @@ -130491,6 +133339,10 @@ "explode": true, "style": "deepObject" }, + "discounts": { + "explode": true, + "style": "deepObject" + }, "expand": { "explode": true, "style": "deepObject" @@ -130539,6 +133391,27 @@ "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.", "items": { "properties": { + "discounts": { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, "price": { "maxLength": 5000, "type": "string" @@ -130724,7 +133597,7 @@ "type": "string" }, "coupon": { - "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", + "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -130774,6 +133647,38 @@ "maxLength": 500, "type": "string" }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer." + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -130851,6 +133756,37 @@ } ] }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "metadata": { "additionalProperties": { "type": "string" @@ -131211,6 +134147,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -131335,7 +134272,7 @@ "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval." }, "promotion_code": { - "description": "The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.", + "description": "The ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -131815,6 +134752,10 @@ "explode": true, "style": "deepObject" }, + "discounts": { + "explode": true, + "style": "deepObject" + }, "expand": { "explode": true, "style": "deepObject" @@ -131867,6 +134808,27 @@ "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.", "items": { "properties": { + "discounts": { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, "price": { "maxLength": 5000, "type": "string" @@ -132071,7 +135033,7 @@ "type": "string" }, "coupon": { - "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", + "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -132132,6 +135094,38 @@ ], "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs." }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer." + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -132215,6 +135209,37 @@ "deleted": { "type": "boolean" }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "id": { "maxLength": 5000, "type": "string" @@ -132621,6 +135646,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -133154,6 +136180,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -133187,14 +136214,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -136230,7 +139260,7 @@ "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`, `no_voec`, `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`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `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`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `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", @@ -136238,6 +139268,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -136271,14 +139302,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -138770,6 +141804,7 @@ "bbpos_chipper2x", "bbpos_wisepad3", "bbpos_wisepos_e", + "mobile_phone_reader", "simulated_wisepos_e", "stripe_m2", "verifone_P400" @@ -139846,6 +142881,11 @@ "title": "param", "type": "object" }, + "amazon_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "properties": { "account_number": { @@ -140288,6 +143328,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -151823,7 +154864,8 @@ "2022-08-01", "2022-11-15", "2023-08-16", - "2023-10-16" + "2023-10-16", + "2024-04-10" ], "maxLength": 5000, "type": "string",