From 77df133b26a0064beffe03077b87104429129901 Mon Sep 17 00:00:00 2001 From: cb-alish Date: Mon, 12 Jan 2026 14:35:54 +0530 Subject: [PATCH] Updating Open API Specs Jan 12th, 2026 --- spec/chargebee_api_v1_spec.json | 800 +- spec/chargebee_api_v1_spec.yaml | 2149 +- spec/chargebee_api_v2_pc_v1_spec.json | 4343 ++-- spec/chargebee_api_v2_pc_v1_spec.yaml | 18434 +++++++------- spec/chargebee_api_v2_pc_v2_spec.json | 7343 +++--- spec/chargebee_api_v2_pc_v2_spec.yaml | 31413 +++++++++++++----------- spec/chargebee_sdk_spec.json | 1666 +- spec/chargebee_sdk_spec.yaml | 666 +- 8 files changed, 35117 insertions(+), 31697 deletions(-) diff --git a/spec/chargebee_api_v1_spec.json b/spec/chargebee_api_v1_spec.json index 844841e..a7f5adc 100644 --- a/spec/chargebee_api_v1_spec.json +++ b/spec/chargebee_api_v1_spec.json @@ -7,10 +7,10 @@ "url" : "https://www.chargebee.com", "email" : "support@chargebee.com" }, - "version" : "2025-12-30.c529d21ca07ce56ab113880a50c1d456bd2a637b", - "x-cb-api-version" : 1, + "version" : "2026-01-12.2384b8e365b6622288c6a7edc05d1334abc24829", "x-cb-product-catalog-version" : 1, - "x-generated-on" : 1767083358409 + "x-cb-api-version" : 1, + "x-generated-on" : 1768208062256 }, "servers" : [ { "url" : "{protocol}://{site}.{environment}:{port}/api/v1", @@ -184,15 +184,15 @@ "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", - "description" : "

Resource object representing subscription

" + "description" : "

Resource object representing subscription

" }, "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "customer", "subscription" ], @@ -461,15 +461,15 @@ "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", - "description" : "

Resource object representing subscription

" + "description" : "

Resource object representing subscription

" }, "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "customer", "subscription" ], @@ -680,7 +680,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -706,7 +706,7 @@ "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", - "description" : "

Resource object representing subscription

" + "description" : "

Resource object representing subscription

" } }, "required" : [ "subscription" ], @@ -1003,7 +1003,7 @@ "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

\n", + "description" : "

The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

\n", "example" : null }, "coupon" : { @@ -1106,14 +1106,14 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, "state" : { "type" : "string", "deprecated" : false, - "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", + "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", "maxLength" : 50, "example" : null }, @@ -1127,7 +1127,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null } @@ -1188,7 +1188,7 @@ }, "quantity" : { "type" : "array", - "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", + "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", "items" : { "type" : "integer", "format" : "int32", @@ -1233,19 +1233,19 @@ "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", - "description" : "

Resource object representing subscription

" + "description" : "

Resource object representing subscription

" }, "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" } }, "required" : [ "customer", "subscription" ], @@ -1493,15 +1493,15 @@ "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", - "description" : "

Resource object representing subscription

" + "description" : "

Resource object representing subscription

" }, "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "customer", "subscription" ], @@ -1770,15 +1770,15 @@ "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", - "description" : "

Resource object representing subscription

" + "description" : "

Resource object representing subscription

" }, "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "customer", "subscription" ], @@ -1981,15 +1981,15 @@ "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", - "description" : "

Resource object representing subscription

" + "description" : "

Resource object representing subscription

" }, "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "customer", "subscription" ], @@ -2237,7 +2237,7 @@ "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

Providing this parameter indicates that the subscription reactivates with an in_trial\nstatus\nand the trial period ends at the date provided. The value must not be earlier than reactivate_from.\nNote: This parameter can be backdated (set to a value in the past) only when reactivate_from\nhas been backdated. Do this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end\nis backdated, the subscription immediately goes into active\nor non_renewing\nstatus.

", + "description" : "

Providing this parameter indicates that the subscription reactivates with an in_trial\nstatus\nand the trial period ends at the date provided. The value must not be earlier than reactivate_from.\nNote: This parameter can be backdated (set to a value in the past) only when reactivate_from\nhas been backdated. Do this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end\nis backdated, the subscription immediately goes into active\nor non_renewing\nstatus.

", "example" : null }, "billing_cycles" : { @@ -2306,19 +2306,19 @@ "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", - "description" : "

Resource object representing subscription

" + "description" : "

Resource object representing subscription

" }, "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" } }, "required" : [ "customer", "subscription" ], @@ -2521,15 +2521,15 @@ "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", - "description" : "

Resource object representing subscription

" + "description" : "

Resource object representing subscription

" }, "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "customer", "subscription" ], @@ -2799,14 +2799,14 @@ "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

The new start date of a future\nsubscription. Applicable only for future\nsubscriptions.

", + "description" : "

The new start date of a future\nsubscription. Applicable only for future\nsubscriptions.

", "example" : null }, "trial_end" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription status\nis future\n, in_trial\n, or cancelled.\nAlso, the value must not be earlier than changes_scheduled_at\nor start_date.\nNote:\nThis parameter can be backdated (set to a value in the past) only when the subscription is in cancelled\nor in_trial\nstatus.\nDo this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end\nis backdated, the subscription immediately goes into active\nor non_renewing\nstatus.

", + "description" : "

The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription status\nis future\n, in_trial\n, or cancelled.\nAlso, the value must not be earlier than changes_scheduled_at\nor start_date.\nNote:\nThis parameter can be backdated (set to a value in the past) only when the subscription is in cancelled\nor in_trial\nstatus.\nDo this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end\nis backdated, the subscription immediately goes into active\nor non_renewing\nstatus.

", "example" : null }, "billing_cycles" : { @@ -2820,7 +2820,7 @@ "coupon" : { "type" : "string", "deprecated" : false, - "description" : "

Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.

\n

Note:

When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.

\n

.

", + "description" : "

Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.

\n

Note:

When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.

\n

.

", "maxLength" : 100, "example" : null }, @@ -2834,7 +2834,7 @@ "prorate" : { "type" : "boolean", "deprecated" : false, - "description" : "\n

Caveat

For further changes within the same billing term, when prorate is set to true, credits are not created when all the conditions below hold true:

An immediate previous change was made

", + "description" : "\n

Caveat

For further changes within the same billing term, when prorate is set to true, credits are not created when all the conditions below hold true:

An immediate previous change was made

", "example" : null }, "end_of_term" : { @@ -2945,14 +2945,14 @@ "billing_state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, "billing_state" : { "type" : "string", "deprecated" : false, - "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", + "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", "maxLength" : 50, "example" : null }, @@ -2966,7 +2966,7 @@ "billing_country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null }, @@ -3117,14 +3117,14 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, "state" : { "type" : "string", "deprecated" : false, - "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", + "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", "maxLength" : 50, "example" : null }, @@ -3138,7 +3138,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null } @@ -3217,14 +3217,14 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, "state" : { "type" : "string", "deprecated" : false, - "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", + "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", "maxLength" : 50, "example" : null }, @@ -3238,7 +3238,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null } @@ -3253,7 +3253,7 @@ "vat_number" : { "type" : "string", "deprecated" : false, - "description" : "

The VAT/tax registration number for the customer. For customers with billing_address

\n

country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.

", + "description" : "

The VAT/tax registration number for the customer. For customers with billing_address

\n

country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.

", "maxLength" : 20, "example" : null } @@ -3278,7 +3278,7 @@ }, "quantity" : { "type" : "array", - "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", + "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", "items" : { "type" : "integer", "format" : "int32", @@ -3349,19 +3349,19 @@ "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", - "description" : "

Resource object representing subscription

" + "description" : "

Resource object representing subscription

" }, "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" } }, "required" : [ "customer", "subscription" ], @@ -3638,7 +3638,7 @@ "properties" : { "estimate" : { "$ref" : "#/components/schemas/Estimate", - "description" : "

Resource object representing estimate

" + "description" : "

Resource object representing estimate

" } }, "required" : [ "estimate" ], @@ -3837,7 +3837,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -4156,7 +4156,7 @@ "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

\n", + "description" : "

The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

\n", "example" : null }, "coupon" : { @@ -4210,7 +4210,7 @@ "id" : { "type" : "string", "deprecated" : false, - "description" : "

The unique ID of the customer for which this hosted_page\nshould be created. When not provided, a new customer is created with the ID set to the value provided for subscription[id].\nIf subscription[id]\nis unavailable, then the customer ID is autogenerated.

", + "description" : "

The unique ID of the customer for which this hosted_page\nshould be created. When not provided, a new customer is created with the ID set to the value provided for subscription[id].\nIf subscription[id]\nis unavailable, then the customer ID is autogenerated.

", "maxLength" : 50, "example" : null }, @@ -4254,7 +4254,7 @@ "type" : "string", "default" : "taxable", "deprecated" : false, - "description" : "

Specifies if the customer is liable for tax

\n* exempt - \n* taxable -

Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.

", + "description" : "

Specifies if the customer is liable for tax

\n* exempt - \n* taxable -

Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.

", "enum" : [ "taxable", "exempt" ], "example" : null }, @@ -4276,7 +4276,7 @@ "vat_number" : { "type" : "string", "deprecated" : false, - "description" : "

The VAT/tax registration number for the customer. For customers with billing_address

\n

country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.

", + "description" : "

The VAT/tax registration number for the customer. For customers with billing_address

\n

country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.

", "maxLength" : 20, "example" : null } @@ -4370,14 +4370,14 @@ "billing_state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, "billing_state" : { "type" : "string", "deprecated" : false, - "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", + "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", "maxLength" : 50, "example" : null }, @@ -4391,7 +4391,7 @@ "billing_country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null }, @@ -4542,14 +4542,14 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, "state" : { "type" : "string", "deprecated" : false, - "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", + "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", "maxLength" : 50, "example" : null }, @@ -4563,7 +4563,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null } @@ -4642,14 +4642,14 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, "state" : { "type" : "string", "deprecated" : false, - "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", + "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", "maxLength" : 50, "example" : null }, @@ -4663,7 +4663,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null } @@ -4688,7 +4688,7 @@ }, "quantity" : { "type" : "array", - "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", + "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", "items" : { "type" : "integer", "format" : "int32", @@ -4749,19 +4749,19 @@ "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", - "description" : "

Resource object representing subscription

" + "description" : "

Resource object representing subscription

" }, "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" } }, "required" : [ "customer", "subscription" ], @@ -5009,7 +5009,7 @@ "type" : "boolean", "default" : false, "deprecated" : false, - "description" : "

Set this to true\nif you want to cancel the subscription at the end of the current subscription billing cycle. The subscription status\nchanges to non_renewing\n.

", + "description" : "

Set this to true\nif you want to cancel the subscription at the end of the current subscription billing cycle. The subscription status\nchanges to non_renewing\n.

", "example" : null } }, @@ -5029,19 +5029,19 @@ "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", - "description" : "

Resource object representing subscription

" + "description" : "

Resource object representing subscription

" }, "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" } }, "required" : [ "customer", "subscription" ], @@ -5318,7 +5318,7 @@ "properties" : { "estimate" : { "$ref" : "#/components/schemas/Estimate", - "description" : "

Resource object representing estimate

" + "description" : "

Resource object representing estimate

" } }, "required" : [ "estimate" ], @@ -6054,11 +6054,11 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "customer" ], @@ -6335,7 +6335,7 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" } }, "required" : [ "customer" ], @@ -6612,7 +6612,7 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" } }, "required" : [ "customer" ], @@ -6894,11 +6894,11 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "customer" ], @@ -7017,7 +7017,7 @@ "/customers/{customer-id}/update_payment_method" : { "post" : { "summary" : "Update payment method for a customer", - "description" : "

Updates payment method details for a customer.

Note:\nIf you wish to pass the card number, CVV, or the single-use card tokens provided by gateways like Stripe, then use the Update card for a customer\nAPI under Cards resource. This API is not supported for Chargebee Test Gateway, which is provided to help you understand the billing workflow in Chargebee.

PayPal Express Checkout\nYou can use this API if you are directly integrating PayPal Express Checkout in your website instead of using Chargebee's hosted pages. When your customer updates his payment method using PayPal Express Checkout, you will be provided with the Billing Agreement ID by PayPal. You can update the payment method for that customer in Chargebee by passing type as paypal_express_checkout and reference_id with the Billing Agreement ID.

Login and Pay with Amazon\nYou can use this API if you are directly integrating Login and Pay with Amazon in your website instead of using Chargebee's hosted pages. When your customer updates Amazon as a payment method, you will be provided with the Billing Agreement ID by Amazon. You can update the payment method for that customer in Chargebee by passing type as amazon_payments and reference_id with the Billing Agreement ID.

Card Payments\nWhen the card details of your customer are stored in the vault of gateways such as Stripe or Braintree, you can use this API to update the reference id provided by them in Chargebee. To use this API, pass

Reference id format for Card Payments\nThe format of reference_id will differ based on where the card is stored.\nStripe: In case of Stripe, the reference_id consists of combination of Stripe Customer ID and Stripe Card ID separated by forward slash (e.g. cus_63MnDn0t6kfDW7/card_6WjCF20vT9WN1G). If you are passing Stripe Customer ID alone, then Chargebee will store the card marked as active for that customer in Stripe.\nBraintree: In case of Braintree, the reference_id consists of combination of Braintree Customer ID and Braintree Payment Method Token separated by forward slash (e.g. cus_63MnDn0t6kfDW7/card_6WjCF20vT9WN1G). If you are passing Braintree Customer ID alone, then Chargebee will store the card marked as default for that customer in Braintree.\nSpreedly Card vault: If the card details are stored in Spreedly vault, then you need to provide the Spreedly token as reference_id.

Direct Debit Payments\nWhen the bank account details of your customer is stored in the vault of Authorize.Net, you can use this API to update the reference id provided by them in Chargebee. To use this API, pass

Reference id format for Direct Debit Payments\nThe reference_id consists of combination of Authorize.Net's Customer Profile ID and Payment Profile ID separated by forward slash (e.g. 2384383/34834382). If you are passing Authorize.Net's Customer Profile ID alone, then Chargebee will store the first bank account details present in payment profile list of that customer in Authorize.Net.

Note: While using this API to update payment method details, Card Verification will not happen even if it is enabled for that particular gateway.

Storing card after successful 3DS flow not supported in this API. Use create using Payment Intent API\nunder Payment source to store the card after successful 3DS flow completion.

", + "description" : "

Updates payment method details for a customer.

Note:\nIf you wish to pass the card number, CVV, or the single-use card tokens provided by gateways like Stripe, then use the Update card for a customer\nAPI under Cards resource. This API is not supported for Chargebee Test Gateway, which is provided to help you understand the billing workflow in Chargebee.

PayPal Express Checkout\nYou can use this API if you are directly integrating PayPal Express Checkout in your website instead of using Chargebee's hosted pages. When your customer updates his payment method using PayPal Express Checkout, you will be provided with the Billing Agreement ID by PayPal. You can update the payment method for that customer in Chargebee by passing type as paypal_express_checkout and reference_id with the Billing Agreement ID.

Login and Pay with Amazon\nYou can use this API if you are directly integrating Login and Pay with Amazon in your website instead of using Chargebee's hosted pages. When your customer updates Amazon as a payment method, you will be provided with the Billing Agreement ID by Amazon. You can update the payment method for that customer in Chargebee by passing type as amazon_payments and reference_id with the Billing Agreement ID.

Card Payments\nWhen the card details of your customer are stored in the vault of gateways such as Stripe or Braintree, you can use this API to update the reference id provided by them in Chargebee. To use this API, pass

Reference id format for Card Payments\nThe format of reference_id will differ based on where the card is stored.\nStripe: In case of Stripe, the reference_id consists of combination of Stripe Customer ID and Stripe Card ID separated by forward slash (e.g. cus_63MnDn0t6kfDW7/card_6WjCF20vT9WN1G). If you are passing Stripe Customer ID alone, then Chargebee will store the card marked as active for that customer in Stripe.\nBraintree: In case of Braintree, the reference_id consists of combination of Braintree Customer ID and Braintree Payment Method Token separated by forward slash (e.g. cus_63MnDn0t6kfDW7/card_6WjCF20vT9WN1G). If you are passing Braintree Customer ID alone, then Chargebee will store the card marked as default for that customer in Braintree.\nSpreedly Card vault: If the card details are stored in Spreedly vault, then you need to provide the Spreedly token as reference_id.

Direct Debit Payments\nWhen the bank account details of your customer is stored in the vault of Authorize.Net, you can use this API to update the reference id provided by them in Chargebee. To use this API, pass

Reference id format for Direct Debit Payments\nThe reference_id consists of combination of Authorize.Net's Customer Profile ID and Payment Profile ID separated by forward slash (e.g. 2384383/34834382). If you are passing Authorize.Net's Customer Profile ID alone, then Chargebee will store the first bank account details present in payment profile list of that customer in Authorize.Net.

Note: While using this API to update payment method details, Card Verification will not happen even if it is enabled for that particular gateway.

Storing card after successful 3DS flow not supported in this API. Use create using Payment Intent API\nunder Payment source to store the card after successful 3DS flow completion.

", "operationId" : "update_payment_method_for_a_customer", "parameters" : [ { "name" : "chargebee-request-origin-device", @@ -7194,11 +7194,11 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "customer" ], @@ -7401,11 +7401,11 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "customer" ], @@ -7703,7 +7703,7 @@ "type" : "string", "default" : "taxable", "deprecated" : false, - "description" : "

Specifies if the customer is liable for tax.

\n* exempt - \n* taxable -

Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.

", + "description" : "

Specifies if the customer is liable for tax.

\n* exempt - \n* taxable -

Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.

", "enum" : [ "taxable", "exempt" ], "example" : null }, @@ -7738,11 +7738,11 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "customer" ], @@ -8081,11 +8081,11 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "customer" ], @@ -8362,7 +8362,7 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" } }, "required" : [ "customer" ], @@ -8609,7 +8609,7 @@ "vat_number" : { "type" : "string", "deprecated" : false, - "description" : "

The VAT/tax registration number for the customer. For customers with billing_address

\n

country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.

", + "description" : "

The VAT/tax registration number for the customer. For customers with billing_address

\n

country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.

", "maxLength" : 20, "example" : null }, @@ -8685,14 +8685,14 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, "state" : { "type" : "string", "deprecated" : false, - "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", + "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", "maxLength" : 50, "example" : null }, @@ -8706,7 +8706,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

\n

E-Invoicing

If country is provided as different from the existing value and if entity_identifier_scheme, entity_identifier_standard, and entity_identifier already exist and are not provided for this operation, they're cleared.

\n", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

\n

E-Invoicing

If country is provided as different from the existing value and if entity_identifier_scheme, entity_identifier_standard, and entity_identifier already exist and are not provided for this operation, they're cleared.

\n", "maxLength" : 50, "example" : null } @@ -8735,11 +8735,11 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "customer" ], @@ -8938,7 +8938,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -9272,7 +9272,7 @@ "vat_number" : { "type" : "string", "deprecated" : false, - "description" : "

The VAT/tax registration number for the customer. For customers with billing_address

\n

country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.

", + "description" : "

The VAT/tax registration number for the customer. For customers with billing_address

\n

country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.

", "maxLength" : 20, "example" : null }, @@ -9280,7 +9280,7 @@ "type" : "string", "default" : "taxable", "deprecated" : false, - "description" : "

Specifies if the customer is liable for tax.

\n* taxable -

Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.

\n* exempt - ", + "description" : "

Specifies if the customer is liable for tax.

\n* taxable -

Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.

\n* exempt - ", "enum" : [ "taxable", "exempt" ], "example" : null }, @@ -9392,14 +9392,14 @@ "billing_state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, "billing_state" : { "type" : "string", "deprecated" : false, - "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", + "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", "maxLength" : 50, "example" : null }, @@ -9413,7 +9413,7 @@ "billing_country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null }, @@ -9564,14 +9564,14 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, "state" : { "type" : "string", "deprecated" : false, - "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", + "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", "maxLength" : 50, "example" : null }, @@ -9585,7 +9585,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null } @@ -9626,11 +9626,11 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "customer" ], @@ -9969,11 +9969,11 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "customer" ], @@ -10176,7 +10176,7 @@ "properties" : { "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "card" ], @@ -10465,11 +10465,11 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "card", "customer" ], @@ -10738,11 +10738,11 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "card", "customer" ], @@ -10990,7 +10990,7 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" } }, "required" : [ "customer" ], @@ -11316,14 +11316,14 @@ "billing_state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, "billing_state" : { "type" : "string", "deprecated" : false, - "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", + "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", "maxLength" : 50, "example" : null }, @@ -11337,7 +11337,7 @@ "billing_country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

\n

.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

\n

.

", "maxLength" : 50, "example" : null }, @@ -11366,11 +11366,11 @@ "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", - "description" : "

Resource object representing customer

" + "description" : "

Resource object representing customer

" }, "card" : { "$ref" : "#/components/schemas/Card", - "description" : "

Resource object representing card

" + "description" : "

Resource object representing card

" } }, "required" : [ "card", "customer" ], @@ -11663,7 +11663,7 @@ "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" } }, "required" : [ "invoice" ], @@ -11911,7 +11911,7 @@ "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" } }, "required" : [ "invoice" ], @@ -12188,7 +12188,7 @@ "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" } }, "required" : [ "invoice" ], @@ -12399,7 +12399,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -12705,7 +12705,7 @@ "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" } }, "required" : [ "invoice" ], @@ -12982,7 +12982,7 @@ "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" } }, "required" : [ "invoice" ], @@ -13250,7 +13250,7 @@ "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" } }, "required" : [ "invoice" ], @@ -13519,11 +13519,11 @@ "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", - "description" : "

Resource object representing transaction

" + "description" : "

Resource object representing transaction

" } }, "required" : [ "invoice", "transaction" ], @@ -13771,7 +13771,7 @@ "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" } }, "required" : [ "invoice" ], @@ -14019,7 +14019,7 @@ "type" : "integer", "format" : "int64", "deprecated" : false, - "description" : "

The amount to be refunded. If not specified, the entire refundable amount for this invoice is refunded. The refundable amount is the total amount paid via online transaction\ns, and not already refunded.

\n

Note:\nAny linked_taxes_withheld\nassociated with the invoice cannot be refunded via this operation.

", + "description" : "

The amount to be refunded. If not specified, the entire refundable amount for this invoice is refunded. The refundable amount is the total amount paid via online transaction\ns, and not already refunded.

\n

Note:\nAny linked_taxes_withheld\nassociated with the invoice cannot be refunded via this operation.

", "minimum" : 1, "example" : null }, @@ -14047,11 +14047,11 @@ "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", - "description" : "

Resource object representing transaction

" + "description" : "

Resource object representing transaction

" } }, "required" : [ "invoice", "transaction" ], @@ -14250,7 +14250,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -14639,14 +14639,14 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, "state" : { "type" : "string", "deprecated" : false, - "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", + "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", "maxLength" : 50, "example" : null }, @@ -14660,7 +14660,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null } @@ -14721,7 +14721,7 @@ }, "quantity" : { "type" : "array", - "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", + "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", "items" : { "type" : "integer", "format" : "int32", @@ -14800,7 +14800,7 @@ "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" } }, "required" : [ "invoice" ], @@ -15060,21 +15060,21 @@ "type" : "integer", "format" : "int64", "deprecated" : false, - "description" : "

The amount to be refunded (for online payments) or recorded as refunded (for offline payments). If not specified, the entire refundable amount for this invoice is refunded. The refundable amount is the total amount paid (and not already refunded) for the invoice.

\n

Note:\nAny linked_taxes_withheld\nassociated with the invoice can also be recorded as refunded via this operation.

", + "description" : "

The amount to be refunded (for online payments) or recorded as refunded (for offline payments). If not specified, the entire refundable amount for this invoice is refunded. The refundable amount is the total amount paid (and not already refunded) for the invoice.

\n

Note:\nAny linked_taxes_withheld\nassociated with the invoice can also be recorded as refunded via this operation.

", "minimum" : 0, "example" : null }, "payment_method" : { "type" : "string", "deprecated" : false, - "description" : "

The payment method of this transaction

\n* cash -

Cash

\n* paypal_express_checkout -

Paypal Express Checkout

\n* card -

Card

\n* other -

Payment Methods other than the above types

\n* check -

Check

\n* direct_debit -

Direct Debit

\n* bank_transfer -

Bank Transfer

\n* chargeback -

Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.

\n* amazon_payments -

Amazon Payments

", + "description" : "

The payment method of this transaction

\n* cash -

Cash

\n* paypal_express_checkout -

Paypal Express Checkout

\n* card -

Card

\n* other -

Payment Methods other than the above types

\n* check -

Check

\n* direct_debit -

Direct Debit

\n* bank_transfer -

Bank Transfer

\n* chargeback -

Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.

\n* amazon_payments -

Amazon Payments

", "enum" : [ "cash", "check", "chargeback", "bank_transfer", "other" ], "example" : null }, "reference_number" : { "type" : "string", "deprecated" : false, - "description" : "

The reference number for this transaction. For example, the check number when payment_method\n= check\n.

", + "description" : "

The reference number for this transaction. For example, the check number when payment_method\n= check\n.

", "maxLength" : 100, "example" : null }, @@ -15112,11 +15112,11 @@ "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", - "description" : "

Resource object representing transaction

" + "description" : "

Resource object representing transaction

" } }, "required" : [ "invoice" ], @@ -15364,7 +15364,7 @@ "properties" : { "download" : { "$ref" : "#/components/schemas/Download", - "description" : "

Resource object representing download

" + "description" : "

Resource object representing download

" } }, "required" : [ "download" ], @@ -15567,7 +15567,7 @@ "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" } }, "required" : [ "invoice" ], @@ -15778,7 +15778,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -16109,7 +16109,7 @@ "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" } }, "required" : [ "invoice" ], @@ -16308,7 +16308,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -16650,7 +16650,7 @@ "properties" : { "order" : { "$ref" : "#/components/schemas/Order", - "description" : "

Resource object representing order

" + "description" : "

Resource object representing order

" } }, "required" : [ "order" ], @@ -16861,7 +16861,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -17102,7 +17102,7 @@ "properties" : { "order" : { "$ref" : "#/components/schemas/Order", - "description" : "

Resource object representing order

" + "description" : "

Resource object representing order

" } }, "required" : [ "order" ], @@ -17459,14 +17459,14 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, "state" : { "type" : "string", "deprecated" : false, - "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", + "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", "maxLength" : 50, "example" : null }, @@ -17480,7 +17480,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null } @@ -17509,7 +17509,7 @@ "properties" : { "order" : { "$ref" : "#/components/schemas/Order", - "description" : "

Resource object representing order

" + "description" : "

Resource object representing order

" } }, "required" : [ "order" ], @@ -17720,7 +17720,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -17746,7 +17746,7 @@ "properties" : { "transaction" : { "$ref" : "#/components/schemas/Transaction", - "description" : "

Resource object representing transaction

" + "description" : "

Resource object representing transaction

" } }, "required" : [ "transaction" ], @@ -17969,7 +17969,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -17995,7 +17995,7 @@ "properties" : { "transaction" : { "$ref" : "#/components/schemas/Transaction", - "description" : "

Resource object representing transaction

" + "description" : "

Resource object representing transaction

" } }, "required" : [ "transaction" ], @@ -18206,7 +18206,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -18232,7 +18232,7 @@ "properties" : { "transaction" : { "$ref" : "#/components/schemas/Transaction", - "description" : "

Resource object representing transaction

" + "description" : "

Resource object representing transaction

" } }, "required" : [ "transaction" ], @@ -18499,7 +18499,7 @@ "payment_method" : { "type" : "string", "deprecated" : false, - "description" : "

The payment method of this transaction.

\n* card -

Card

\n* cash -

Cash

\n* bank_transfer -

Bank Transfer

\n* paypal_express_checkout -

Paypal Express Checkout

\n* amazon_payments -

Amazon Payments

\n* check -

Check

\n* direct_debit -

Direct Debit

\n* chargeback -

Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.

\n* other -

Payment Methods other than the above types

", + "description" : "

The payment method of this transaction.

\n* card -

Card

\n* cash -

Cash

\n* bank_transfer -

Bank Transfer

\n* paypal_express_checkout -

Paypal Express Checkout

\n* amazon_payments -

Amazon Payments

\n* check -

Check

\n* direct_debit -

Direct Debit

\n* chargeback -

Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.

\n* other -

Payment Methods other than the above types

", "enum" : [ "cash", "check", "bank_transfer", "direct_debit", "other" ], "example" : null }, @@ -18513,7 +18513,7 @@ "reference_number" : { "type" : "string", "deprecated" : false, - "description" : "

The reference number for this transaction. For example, the check number when payment_method\n= check\n.

", + "description" : "

The reference number for this transaction. For example, the check number when payment_method\n= check\n.

", "maxLength" : 100, "example" : null }, @@ -18542,11 +18542,11 @@ "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", - "description" : "

Resource object representing invoice

" + "description" : "

Resource object representing invoice

" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", - "description" : "

Resource object representing transaction

" + "description" : "

Resource object representing transaction

" } }, "required" : [ "invoice", "transaction" ], @@ -18749,7 +18749,7 @@ "properties" : { "transaction" : { "$ref" : "#/components/schemas/Transaction", - "description" : "

Resource object representing transaction

" + "description" : "

Resource object representing transaction

" } }, "required" : [ "transaction" ], @@ -18960,7 +18960,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -18986,7 +18986,7 @@ "properties" : { "transaction" : { "$ref" : "#/components/schemas/Transaction", - "description" : "

Resource object representing transaction

" + "description" : "

Resource object representing transaction

" } }, "required" : [ "transaction" ], @@ -19233,7 +19233,7 @@ "redirect_url" : { "type" : "string", "deprecated" : false, - "description" : "

The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.\nAlthough the customer will be redirected to the redirect_url\nafter successful checkout,\nwe do not recommend relying on it for completing critical post-checkout actions.\nThis is because redirection may not happen due to unforeseen reasons.\nChargebee recommends listening to appropriate webhooks such as subscription_created

\n

or invoice_generated\nto verify a successful checkout.

\n

Note\n: - Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.\nEg : http://yoursite.com?id=&state=succeeded

\n", + "description" : "

The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.\nAlthough the customer will be redirected to the redirect_url\nafter successful checkout,\nwe do not recommend relying on it for completing critical post-checkout actions.\nThis is because redirection may not happen due to unforeseen reasons.\nChargebee recommends listening to appropriate webhooks such as subscription_created

\n

or invoice_generated\nto verify a successful checkout.

\n

Note\n: - Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.\nEg : http://yoursite.com?id=&state=succeeded

\n", "maxLength" : 250, "example" : null }, @@ -19322,7 +19322,7 @@ "properties" : { "hosted_page" : { "$ref" : "#/components/schemas/HostedPage", - "description" : "

Resource object representing hosted_page

" + "description" : "

Resource object representing hosted_page

" } }, "required" : [ "hosted_page" ], @@ -19565,7 +19565,7 @@ "redirect_url" : { "type" : "string", "deprecated" : false, - "description" : "

The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.\nAlthough the customer will be redirected to the redirect_url\nafter successful checkout,\nwe do not recommend relying on it for completing critical post-checkout actions.\nThis is because redirection may not happen due to unforeseen reasons.\nChargebee recommends listening to appropriate webhooks such as subscription_created

\n

or invoice_generated\nto verify a successful checkout.

\n

Note\n: - Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.\nEg : http://yoursite.com?id=&state=succeeded

\n", + "description" : "

The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.\nAlthough the customer will be redirected to the redirect_url\nafter successful checkout,\nwe do not recommend relying on it for completing critical post-checkout actions.\nThis is because redirection may not happen due to unforeseen reasons.\nChargebee recommends listening to appropriate webhooks such as subscription_created

\n

or invoice_generated\nto verify a successful checkout.

\n

Note\n: - Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.\nEg : http://yoursite.com?id=&state=succeeded

\n", "maxLength" : 250, "example" : null }, @@ -19637,7 +19637,7 @@ "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

\n", + "description" : "

The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

\n", "example" : null }, "coupon" : { @@ -19660,7 +19660,7 @@ "id" : { "type" : "string", "deprecated" : false, - "description" : "

The unique ID of the customer for which this hosted_page\nshould be created. When not provided, a new customer is created with the ID set to the value provided for subscription[id].\nIf subscription[id]\nis unavailable, then the customer ID is autogenerated.

", + "description" : "

The unique ID of the customer for which this hosted_page\nshould be created. When not provided, a new customer is created with the ID set to the value provided for subscription[id].\nIf subscription[id]\nis unavailable, then the customer ID is autogenerated.

", "maxLength" : 50, "example" : null }, @@ -19704,7 +19704,7 @@ "type" : "string", "default" : "taxable", "deprecated" : false, - "description" : "

Specifies if the customer is liable for tax

\n* exempt - \n* taxable -

Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.

", + "description" : "

Specifies if the customer is liable for tax

\n* exempt - \n* taxable -

Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.

", "enum" : [ "taxable", "exempt" ], "example" : null } @@ -19744,7 +19744,7 @@ }, "quantity" : { "type" : "array", - "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", + "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", "items" : { "type" : "integer", "format" : "int32", @@ -19792,7 +19792,7 @@ "properties" : { "hosted_page" : { "$ref" : "#/components/schemas/HostedPage", - "description" : "

Resource object representing hosted_page

" + "description" : "

Resource object representing hosted_page

" } }, "required" : [ "hosted_page" ], @@ -20087,7 +20087,7 @@ }, "quantity" : { "type" : "array", - "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", + "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", "items" : { "type" : "integer", "format" : "int32", @@ -20132,7 +20132,7 @@ "properties" : { "hosted_page" : { "$ref" : "#/components/schemas/HostedPage", - "description" : "

Resource object representing hosted_page

" + "description" : "

Resource object representing hosted_page

" } }, "required" : [ "hosted_page" ], @@ -20444,7 +20444,7 @@ "properties" : { "hosted_page" : { "$ref" : "#/components/schemas/HostedPage", - "description" : "

Resource object representing hosted_page

" + "description" : "

Resource object representing hosted_page

" } }, "required" : [ "hosted_page" ], @@ -20647,7 +20647,7 @@ "properties" : { "hosted_page" : { "$ref" : "#/components/schemas/HostedPage", - "description" : "

Resource object representing hosted_page

" + "description" : "

Resource object representing hosted_page

" } }, "required" : [ "hosted_page" ], @@ -20897,7 +20897,7 @@ "redirect_url" : { "type" : "string", "deprecated" : false, - "description" : "

The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.\nAlthough the customer will be redirected to the redirect_url\nafter successful checkout,\nwe do not recommend relying on it for completing critical post-checkout actions.\nThis is because redirection may not happen due to unforeseen reasons.\nChargebee recommends listening to appropriate webhooks such as subscription_created

\n

or invoice_generated\nto verify a successful checkout.

\n

Note\n: - Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.\nEg : http://yoursite.com?id=&state=succeeded

\n", + "description" : "

The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.\nAlthough the customer will be redirected to the redirect_url\nafter successful checkout,\nwe do not recommend relying on it for completing critical post-checkout actions.\nThis is because redirection may not happen due to unforeseen reasons.\nChargebee recommends listening to appropriate webhooks such as subscription_created

\n

or invoice_generated\nto verify a successful checkout.

\n

Note\n: - Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.\nEg : http://yoursite.com?id=&state=succeeded

\n", "maxLength" : 250, "example" : null }, @@ -20962,20 +20962,20 @@ "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

The new start date of a future\nsubscription. Applicable only for future\nsubscriptions.

", + "description" : "

The new start date of a future\nsubscription. Applicable only for future\nsubscriptions.

", "example" : null }, "trial_end" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription status\nis future\n, in_trial\n, or cancelled.\nAlso, the value must not be earlier than changes_scheduled_at\nor start_date.\nNote:\nThis parameter can be backdated (set to a value in the past) only when the subscription is in cancelled\nor in_trial\nstatus.\nDo this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end\nis backdated, the subscription immediately goes into active\nor non_renewing\nstatus.

", + "description" : "

The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription status\nis future\n, in_trial\n, or cancelled.\nAlso, the value must not be earlier than changes_scheduled_at\nor start_date.\nNote:\nThis parameter can be backdated (set to a value in the past) only when the subscription is in cancelled\nor in_trial\nstatus.\nDo this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end\nis backdated, the subscription immediately goes into active\nor non_renewing\nstatus.

", "example" : null }, "coupon" : { "type" : "string", "deprecated" : false, - "description" : "

Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.

\n

Note:

When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.

", + "description" : "

Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.

\n

Note:

When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.

", "maxLength" : 100, "example" : null } @@ -21016,7 +21016,7 @@ }, "quantity" : { "type" : "array", - "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", + "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", "items" : { "type" : "integer", "format" : "int32", @@ -21060,7 +21060,7 @@ "properties" : { "hosted_page" : { "$ref" : "#/components/schemas/HostedPage", - "description" : "

Resource object representing hosted_page

" + "description" : "

Resource object representing hosted_page

" } }, "required" : [ "hosted_page" ], @@ -21291,7 +21291,7 @@ "properties" : { "estimate" : { "$ref" : "#/components/schemas/Estimate", - "description" : "

Resource object representing estimate

" + "description" : "

Resource object representing estimate

" } }, "required" : [ "estimate" ], @@ -21487,7 +21487,7 @@ "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

\n", + "description" : "

The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

\n", "example" : null }, "coupon" : { @@ -21516,7 +21516,7 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, @@ -21530,7 +21530,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null } @@ -21562,7 +21562,7 @@ }, "quantity" : { "type" : "array", - "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", + "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", "items" : { "type" : "integer", "format" : "int32", @@ -21658,7 +21658,7 @@ "properties" : { "estimate" : { "$ref" : "#/components/schemas/Estimate", - "description" : "

Resource object representing estimate

" + "description" : "

Resource object representing estimate

" } }, "required" : [ "estimate" ], @@ -21908,7 +21908,7 @@ "prorate" : { "type" : "boolean", "deprecated" : false, - "description" : "\n

Caveat

For further changes within the same billing term, when prorate is set to true, credits are not created when all the conditions below hold true:

An immediate previous change was made

", + "description" : "\n

Caveat

For further changes within the same billing term, when prorate is set to true, credits are not created when all the conditions below hold true:

An immediate previous change was made

", "example" : null }, "end_of_term" : { @@ -21964,20 +21964,20 @@ "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

The new start date of a future\nsubscription. Applicable only for future\nsubscriptions.

", + "description" : "

The new start date of a future\nsubscription. Applicable only for future\nsubscriptions.

", "example" : null }, "trial_end" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription status\nis future\n, in_trial\n, or cancelled.\nAlso, the value must not be earlier than changes_scheduled_at\nor start_date.\nNote:\nThis parameter can be backdated (set to a value in the past) only when the subscription is in cancelled\nor in_trial\nstatus.\nDo this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end\nis backdated, the subscription immediately goes into active\nor non_renewing\nstatus.

", + "description" : "

The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription status\nis future\n, in_trial\n, or cancelled.\nAlso, the value must not be earlier than changes_scheduled_at\nor start_date.\nNote:\nThis parameter can be backdated (set to a value in the past) only when the subscription is in cancelled\nor in_trial\nstatus.\nDo this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end\nis backdated, the subscription immediately goes into active\nor non_renewing\nstatus.

", "example" : null }, "coupon" : { "type" : "string", "deprecated" : false, - "description" : "

Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.

\n

Note:

When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.

", + "description" : "

Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.

\n

Note:

When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.

", "maxLength" : 100, "example" : null } @@ -21993,7 +21993,7 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, @@ -22007,7 +22007,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null } @@ -22022,7 +22022,7 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, @@ -22036,7 +22036,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null } @@ -22076,7 +22076,7 @@ }, "quantity" : { "type" : "array", - "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", + "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", "items" : { "type" : "integer", "format" : "int32", @@ -22139,7 +22139,7 @@ "properties" : { "estimate" : { "$ref" : "#/components/schemas/Estimate", - "description" : "

Resource object representing estimate

" + "description" : "

Resource object representing estimate

" } }, "required" : [ "estimate" ], @@ -22418,7 +22418,7 @@ "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

\n", + "description" : "

The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

\n", "example" : null }, "coupon" : { @@ -22440,7 +22440,7 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, @@ -22454,7 +22454,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null } @@ -22469,7 +22469,7 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, @@ -22483,7 +22483,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null } @@ -22506,7 +22506,7 @@ "type" : "string", "default" : "taxable", "deprecated" : false, - "description" : "

Specifies if the customer is liable for tax

\n* exempt - \n* taxable -

Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.

", + "description" : "

Specifies if the customer is liable for tax

\n* exempt - \n* taxable -

Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.

", "enum" : [ "taxable", "exempt" ], "example" : null } @@ -22531,7 +22531,7 @@ }, "quantity" : { "type" : "array", - "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", + "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", "items" : { "type" : "integer", "format" : "int32", @@ -22583,7 +22583,7 @@ "properties" : { "estimate" : { "$ref" : "#/components/schemas/Estimate", - "description" : "

Resource object representing estimate

" + "description" : "

Resource object representing estimate

" } }, "required" : [ "estimate" ], @@ -22867,7 +22867,7 @@ "type" : "string", "default" : "taxable", "deprecated" : false, - "description" : "

Specifies if the customer is liable for tax

\n* exempt - \n* taxable -

Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.

", + "description" : "

Specifies if the customer is liable for tax

\n* exempt - \n* taxable -

Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.

", "enum" : [ "taxable", "exempt" ], "example" : null } @@ -22882,7 +22882,7 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, @@ -22896,7 +22896,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null } @@ -22975,14 +22975,14 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, "state" : { "type" : "string", "deprecated" : false, - "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", + "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", "maxLength" : 50, "example" : null }, @@ -22996,7 +22996,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null } @@ -23021,7 +23021,7 @@ }, "quantity" : { "type" : "array", - "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", + "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", "items" : { "type" : "integer", "format" : "int32", @@ -23108,7 +23108,7 @@ "properties" : { "estimate" : { "$ref" : "#/components/schemas/Estimate", - "description" : "

Resource object representing estimate

" + "description" : "

Resource object representing estimate

" } }, "required" : [ "estimate" ], @@ -23356,7 +23356,7 @@ "properties" : { "plan" : { "$ref" : "#/components/schemas/Plan", - "description" : "

Resource object representing plan

" + "description" : "

Resource object representing plan

" } }, "required" : [ "plan" ], @@ -23555,7 +23555,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -23984,7 +23984,7 @@ "properties" : { "plan" : { "$ref" : "#/components/schemas/Plan", - "description" : "

Resource object representing plan

" + "description" : "

Resource object representing plan

" } }, "required" : [ "plan" ], @@ -24187,7 +24187,7 @@ "properties" : { "plan" : { "$ref" : "#/components/schemas/Plan", - "description" : "

Resource object representing plan

" + "description" : "

Resource object representing plan

" } }, "required" : [ "plan" ], @@ -24582,7 +24582,7 @@ "properties" : { "plan" : { "$ref" : "#/components/schemas/Plan", - "description" : "

Resource object representing plan

" + "description" : "

Resource object representing plan

" } }, "required" : [ "plan" ], @@ -24785,7 +24785,7 @@ "properties" : { "addon" : { "$ref" : "#/components/schemas/Addon", - "description" : "

Resource object representing addon

" + "description" : "

Resource object representing addon

" } }, "required" : [ "addon" ], @@ -25147,7 +25147,7 @@ "properties" : { "addon" : { "$ref" : "#/components/schemas/Addon", - "description" : "

Resource object representing addon

" + "description" : "

Resource object representing addon

" } }, "required" : [ "addon" ], @@ -25346,7 +25346,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -25742,7 +25742,7 @@ "properties" : { "addon" : { "$ref" : "#/components/schemas/Addon", - "description" : "

Resource object representing addon

" + "description" : "

Resource object representing addon

" } }, "required" : [ "addon" ], @@ -25990,7 +25990,7 @@ "properties" : { "addon" : { "$ref" : "#/components/schemas/Addon", - "description" : "

Resource object representing addon

" + "description" : "

Resource object representing addon

" } }, "required" : [ "addon" ], @@ -26189,7 +26189,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -26460,14 +26460,14 @@ "id" : { "type" : "string", "deprecated" : false, - "description" : "

Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.

\n

Note:

When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.

\n

.

", + "description" : "

Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.

\n

Note:

When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.

\n

.

", "maxLength" : 100, "example" : null }, "name" : { "type" : "string", "deprecated" : false, - "description" : "

The display name used in web interface for identifying the coupon.

\n

Note:

When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.

\n

.

", + "description" : "

The display name used in web interface for identifying the coupon.

\n

Note:

When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.

\n

.

", "maxLength" : 50, "example" : null }, @@ -26513,7 +26513,7 @@ "apply_on" : { "type" : "string", "deprecated" : false, - "description" : "

The amount on the invoice to which the coupon is applied.

\n* invoice_amount -

The coupon is applied to the invoice sub_total\n.

\n* each_unit_of_specified_items -

Discount will be applied to each unit of plan and addon items specified.

\n* each_specified_item -

The coupon is applied to the invoice.line_item.amount\nthat corresponds to the plan or addon specified by plan_ids\nand addon_ids\n.

\n* specified_items_total -

Discount will be applied to the total of plan and addon items specified.

", + "description" : "

The amount on the invoice to which the coupon is applied.

\n* invoice_amount -

The coupon is applied to the invoice sub_total\n.

\n* each_unit_of_specified_items -

Discount will be applied to each unit of plan and addon items specified.

\n* each_specified_item -

The coupon is applied to the invoice.line_item.amount\nthat corresponds to the plan or addon specified by plan_ids\nand addon_ids\n.

\n* specified_items_total -

Discount will be applied to the total of plan and addon items specified.

", "enum" : [ "invoice_amount", "each_specified_item" ], "example" : null }, @@ -26521,7 +26521,7 @@ "type" : "string", "default" : "forever", "deprecated" : false, - "description" : "

Specifies the time duration for which this coupon is attached to the subscription.

\n* forever -

The coupon is attached to the subscription and applied on the invoices until explicitly removed.

\n* limited_period -

The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.

\n* one_time -

The coupon stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.

", + "description" : "

Specifies the time duration for which this coupon is attached to the subscription.

\n* forever -

The coupon is attached to the subscription and applied on the invoices until explicitly removed.

\n* limited_period -

The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.

\n* one_time -

The coupon stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.

", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, @@ -26529,7 +26529,7 @@ "type" : "integer", "format" : "int32", "deprecated" : false, - "description" : "

(Deprecated)\nThe duration of time in months for which the coupon is attached to the subscription. Applicable only when duration_type\nis limited_period.

\n

Note:\nThis parameter has been deprecated. Use period\nand period_unit\ninstead.

", + "description" : "

(Deprecated)\nThe duration of time in months for which the coupon is attached to the subscription. Applicable only when duration_type\nis limited_period.

\n

Note:\nThis parameter has been deprecated. Use period\nand period_unit\ninstead.

", "maximum" : 240, "minimum" : 1, "example" : null @@ -26619,7 +26619,7 @@ "properties" : { "coupon" : { "$ref" : "#/components/schemas/Coupon", - "description" : "

Resource object representing coupon

" + "description" : "

Resource object representing coupon

" } }, "required" : [ "coupon" ], @@ -26822,7 +26822,7 @@ "properties" : { "coupon" : { "$ref" : "#/components/schemas/Coupon", - "description" : "

Resource object representing coupon

" + "description" : "

Resource object representing coupon

" } }, "required" : [ "coupon" ], @@ -27093,7 +27093,7 @@ "properties" : { "coupon_code" : { "$ref" : "#/components/schemas/CouponCode", - "description" : "

Resource object representing coupon_code

" + "description" : "

Resource object representing coupon_code

" } }, "required" : [ "coupon_code" ], @@ -27296,7 +27296,7 @@ "properties" : { "coupon_code" : { "$ref" : "#/components/schemas/CouponCode", - "description" : "

Resource object representing coupon_code

" + "description" : "

Resource object representing coupon_code

" } }, "required" : [ "coupon_code" ], @@ -27515,7 +27515,7 @@ "properties" : { "address" : { "$ref" : "#/components/schemas/Address", - "description" : "

Resource object representing address

" + "description" : "

Resource object representing address

" } }, "required" : [ "address" ], @@ -27826,14 +27826,14 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, "state" : { "type" : "string", "deprecated" : false, - "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", + "description" : "

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.

", "maxLength" : 50, "example" : null }, @@ -27847,7 +27847,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

\n

.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

\n

.

", "maxLength" : 50, "example" : null } @@ -27869,7 +27869,7 @@ "properties" : { "address" : { "$ref" : "#/components/schemas/Address", - "description" : "

Resource object representing address

" + "description" : "

Resource object representing address

" } }, "required" : [ "address" ], @@ -28068,7 +28068,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -28365,7 +28365,7 @@ "properties" : { "event" : { "$ref" : "#/components/schemas/Event", - "description" : "

Resource object representing event

" + "description" : "

Resource object representing event

" } }, "required" : [ "event" ], @@ -28613,7 +28613,7 @@ "properties" : { "comment" : { "$ref" : "#/components/schemas/Comment", - "description" : "

Resource object representing comment

" + "description" : "

Resource object representing comment

" } }, "required" : [ "comment" ], @@ -28816,7 +28816,7 @@ "properties" : { "comment" : { "$ref" : "#/components/schemas/Comment", - "description" : "

Resource object representing comment

" + "description" : "

Resource object representing comment

" } }, "required" : [ "comment" ], @@ -29015,7 +29015,7 @@ }, { "name" : "offset", "in" : "query", - "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", + "description" : "

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.

", "required" : false, "style" : "form", "explode" : true, @@ -29357,7 +29357,7 @@ "properties" : { "comment" : { "$ref" : "#/components/schemas/Comment", - "description" : "

Resource object representing comment

" + "description" : "

Resource object representing comment

" } }, "required" : [ "comment" ], @@ -29634,7 +29634,7 @@ "properties" : { "portal_session" : { "$ref" : "#/components/schemas/PortalSession", - "description" : "

Resource object representing portal_session

" + "description" : "

Resource object representing portal_session

" } }, "required" : [ "portal_session" ], @@ -29903,7 +29903,7 @@ "properties" : { "portal_session" : { "$ref" : "#/components/schemas/PortalSession", - "description" : "

Resource object representing portal_session

" + "description" : "

Resource object representing portal_session

" } }, "required" : [ "portal_session" ], @@ -30151,7 +30151,7 @@ "properties" : { "portal_session" : { "$ref" : "#/components/schemas/PortalSession", - "description" : "

Resource object representing portal_session

" + "description" : "

Resource object representing portal_session

" } }, "required" : [ "portal_session" ], @@ -30270,7 +30270,7 @@ "/portal_sessions/{portal-session-id}" : { "get" : { "summary" : "Retrieve a portal session", - "description" : "

This API retrieves a portal session using portal_session_id\nas a path parameter.

", + "description" : "

This API retrieves a portal session using portal_session_id\nas a path parameter.

", "operationId" : "retrieve_a_portal_session", "parameters" : [ { "name" : "chargebee-request-origin-device", @@ -30354,7 +30354,7 @@ "properties" : { "portal_session" : { "$ref" : "#/components/schemas/PortalSession", - "description" : "

Resource object representing portal_session

" + "description" : "

Resource object representing portal_session

" } }, "required" : [ "portal_session" ], @@ -30557,7 +30557,7 @@ "properties" : { "payment_intent" : { "$ref" : "#/components/schemas/PaymentIntent", - "description" : "

Resource object representing payment_intent

" + "description" : "

Resource object representing payment_intent

" } }, "required" : [ "payment_intent" ], @@ -30824,14 +30824,14 @@ "success_url" : { "type" : "string", "deprecated" : false, - "description" : "

The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.

", + "description" : "

The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.

", "maxLength" : 250, "example" : null }, "failure_url" : { "type" : "string", "deprecated" : false, - "description" : "

The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.

", + "description" : "

The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.

", "maxLength" : 250, "example" : null } @@ -30852,7 +30852,7 @@ "properties" : { "payment_intent" : { "$ref" : "#/components/schemas/PaymentIntent", - "description" : "

Resource object representing payment_intent

" + "description" : "

Resource object representing payment_intent

" } }, "required" : [ "payment_intent" ], @@ -31087,7 +31087,7 @@ "customer_id" : { "type" : "string", "deprecated" : false, - "description" : "

The unique identifier of the customer for whom the payment_intent will be created. If specified, the payment_intent will be used exclusively for that customer. If not specified, the payment_intent won't be associated with any customer and will be available for any customer.

\n

See also

Customer resource lookup and creation\n.

", + "description" : "

The unique identifier of the customer for whom the payment_intent will be created. If specified, the payment_intent will be used exclusively for that customer. If not specified, the payment_intent won't be associated with any customer and will be available for any customer.

\n

See also

Customer resource lookup and creation\n.

", "maxLength" : 50, "example" : null }, @@ -31123,14 +31123,14 @@ "success_url" : { "type" : "string", "deprecated" : false, - "description" : "

The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.

", + "description" : "

The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.

", "maxLength" : 250, "example" : null }, "failure_url" : { "type" : "string", "deprecated" : false, - "description" : "

The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.

", + "description" : "

The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.

", "maxLength" : 250, "example" : null } @@ -31152,7 +31152,7 @@ "properties" : { "payment_intent" : { "$ref" : "#/components/schemas/PaymentIntent", - "description" : "

Resource object representing payment_intent

" + "description" : "

Resource object representing payment_intent

" } }, "required" : [ "payment_intent" ], @@ -32197,7 +32197,7 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, @@ -32211,7 +32211,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null }, @@ -32349,7 +32349,7 @@ "billing_state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, @@ -32363,7 +32363,7 @@ "billing_country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null }, @@ -32817,14 +32817,14 @@ "id" : { "type" : "string", "deprecated" : false, - "description" : "

Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.

\n

Note:

When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.

", + "description" : "

Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.

\n

Note:

When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.

", "maxLength" : 100, "example" : null }, "name" : { "type" : "string", "deprecated" : false, - "description" : "

The display name used in web interface for identifying the coupon.

\n

Note:

When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.

", + "description" : "

The display name used in web interface for identifying the coupon.

\n

Note:

When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.

", "maxLength" : 50, "example" : null }, @@ -32871,7 +32871,7 @@ "type" : "string", "default" : "forever", "deprecated" : false, - "description" : "

Specifies the time duration for which this coupon is attached to the subscription.

\n* forever -

The coupon is attached to the subscription and applied on the invoices until explicitly removed.

\n* limited_period -

The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.

\n* one_time -

The coupon stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.

", + "description" : "

Specifies the time duration for which this coupon is attached to the subscription.

\n* forever -

The coupon is attached to the subscription and applied on the invoices until explicitly removed.

\n* limited_period -

The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.

\n* one_time -

The coupon stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.

", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, @@ -32879,7 +32879,7 @@ "type" : "integer", "format" : "int32", "deprecated" : false, - "description" : "

(Deprecated)\nThe duration of time in months for which the coupon is attached to the subscription. Applicable only when duration_type\nis limited_period.

\n

Note:\nThis parameter has been deprecated. Use period\nand period_unit\ninstead.

", + "description" : "

(Deprecated)\nThe duration of time in months for which the coupon is attached to the subscription. Applicable only when duration_type\nis limited_period.

\n

Note:\nThis parameter has been deprecated. Use period\nand period_unit\ninstead.

", "maximum" : 240, "minimum" : 1, "example" : null @@ -32903,14 +32903,14 @@ "type" : "string", "default" : "active", "deprecated" : false, - "description" : "

Status of the coupon.

\n* active -

Can be applied to a subscription.

\n* expired -

Cannot be applied to a subscription. A coupon may expire due to exceeding max_redemptions\nor valid_till\ndate is past. Existing associations remain unaffected.

\n* archived -

Cannot be applied to a subscription. Existing associations remain unaffected.

", + "description" : "

Status of the coupon.

\n* active -

Can be applied to a subscription.

\n* expired -

Cannot be applied to a subscription. A coupon may expire due to exceeding max_redemptions\nor valid_till\ndate is past. Existing associations remain unaffected.

\n* archived -

Cannot be applied to a subscription. Existing associations remain unaffected.

", "enum" : [ "active", "expired", "archived" ], "example" : null }, "apply_on" : { "type" : "string", "deprecated" : false, - "description" : "

The amount on the invoice to which the coupon is applied.

\n* invoice_amount -

The coupon is applied to the invoice sub_total\n.

\n* each_specified_item -

The coupon is applied to the invoice.line_item.amount\nthat corresponds to the plan or addon specified by plan_ids\nand addon_ids\n.

", + "description" : "

The amount on the invoice to which the coupon is applied.

\n* invoice_amount -

The coupon is applied to the invoice sub_total\n.

\n* each_specified_item -

The coupon is applied to the invoice.line_item.amount\nthat corresponds to the plan or addon specified by plan_ids\nand addon_ids\n.

", "enum" : [ "invoice_amount", "each_specified_item" ], "example" : null }, @@ -33286,7 +33286,7 @@ "vat_number" : { "type" : "string", "deprecated" : false, - "description" : "

The VAT/tax registration number for the customer. For customers with billing_address

\n

country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.

", + "description" : "

The VAT/tax registration number for the customer. For customers with billing_address

\n

country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.

", "maxLength" : 20, "example" : null }, @@ -33323,7 +33323,7 @@ "type" : "string", "default" : "taxable", "deprecated" : false, - "description" : "

Specifies if the customer is liable for tax

\n* taxable -

Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.

\n* exempt - ", + "description" : "

Specifies if the customer is liable for tax

\n* taxable -

Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.

\n* exempt - ", "enum" : [ "taxable", "exempt" ], "example" : null }, @@ -33399,7 +33399,7 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, @@ -33413,7 +33413,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null }, @@ -33746,7 +33746,11 @@ "$ref" : "#/components/schemas/Card" }, "subscriptions" : { - "$ref" : "#/components/schemas/Subscription" + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Subscription" + }, + "example" : null } }, "required" : [ "card", "customer", "subscriptions" ], @@ -33758,7 +33762,7 @@ }, "Download" : { "type" : "object", - "description" : "

Requesting to download a file through this API will return the download_url attribute as the response. This attribute will contain a URL that will allow the requested content to be downloaded.

", + "description" : "

Requesting to download a file through this API will return the download_url attribute as the response. This attribute will contain a URL that will allow the requested content to be downloaded.

", "properties" : { "download_url" : { "type" : "string", @@ -33771,7 +33775,7 @@ "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

The time until which the download_url\nis valid.

", + "description" : "

The time until which the download_url\nis valid.

", "example" : null } }, @@ -34015,7 +34019,7 @@ "entity_id" : { "type" : "string", "deprecated" : false, - "description" : "

When the deduction is due to a coupon\n, then this is the id\nof the coupon.

", + "description" : "

When the deduction is due to a coupon\n, then this is the id\nof the coupon.

", "maxLength" : 100, "example" : null } @@ -34093,7 +34097,7 @@ "webhooks" : { "type" : "array", "deprecated" : false, - "description" : "

Array of webhook call statuses: one for each of the webhooks configured for the site. This object is only available after the first webhook call for the event has completed or timed out. Also, creation/updation of the webhook\nobject data is a queued operation and hence there can be an additional delay of up to 5 seconds.

", + "description" : "

Array of webhook call statuses: one for each of the webhooks configured for the site. This object is only available after the first webhook call for the event has completed or timed out. Also, creation/updation of the webhook\nobject data is a queued operation and hence there can be an additional delay of up to 5 seconds.

", "items" : { "type" : "object", "deprecated" : false, @@ -34108,7 +34112,7 @@ "webhook_status" : { "type" : "string", "deprecated" : false, - "description" : "\n* scheduled -

Webhook call has been scheduled.

\n* not_applicable -

Webhook call is not applicable for this event.

\n* skipped -

Skipped as specified in request

\n* failed -

Webhook call has been suspended after the all retries have resulted in failure.

\n* re_scheduled -

Webhook call has been rescheduled due failure(s) in previous call(s)

\n* not_configured -

Webhook was not configured when this event occurred

\n* succeeded -

Webhook call was successful.

", + "description" : "\n* scheduled -

Webhook call has been scheduled.

\n* not_applicable -

Webhook call is not applicable for this event.

\n* skipped -

Skipped as specified in request

\n* failed -

Webhook call has been suspended after the all retries have resulted in failure.

\n* re_scheduled -

Webhook call has been rescheduled due failure(s) in previous call(s)

\n* not_configured -

Webhook was not configured when this event occurred

\n* succeeded -

Webhook call was successful.

", "enum" : [ "not_configured", "scheduled", "succeeded", "re_scheduled", "failed", "skipped", "not_applicable", "disabled" ], "example" : null } @@ -34231,7 +34235,7 @@ "Invoice" : { "type" : "object", "additionalProperties" : true, - "description" : "Invoices are statements containing charges, adjustments and any discounts for a subscription specific to a term. For every subscription a draft invoice (upcoming invoice) is used to track all the charges, credits and adjustments for the current term.\n\nGenerally, an invoice is closed at start of the next term. However, cancellation and other such operations on subscription may trigger premature closing. While closing the invoice, in addition to recurring charges, credits and coupons are applied to calculate the final amount that is due.\n\nWhen invoice is closed, an attempt to charge the credit card is made. If the payment succeeds, it is marked as **paid** . If the payment fails, the invoice is marked as **payment_due** and retry settings are taken into account. If no retry attempts are configured, the invoice is marked as **not_paid** . If the amount due is zero or negative, the invoice is immediately marked as **paid** and the balance if any is carried forward to the next term of the invoice. \n**Note:**\nIf *consolidated invoicing*\nis enabled, the attribute *invoice.subscription_id*\nshould **not**\nbe used (as it will not be present if the invoice has lines from multiple subscriptions). Instead to know the related subscriptions, their [line_items'](/docs/api/invoices#invoice_line_items)\n*subscription_id*\nattribute should be referred.\n", + "description" : "Invoices are statements containing charges, adjustments and any discounts for a subscription specific to a term. For every subscription a draft invoice (upcoming invoice) is used to track all the charges, credits and adjustments for the current term.\n\nGenerally, an invoice is closed at start of the next term. However, cancellation and other such operations on subscription may trigger premature closing. While closing the invoice, in addition to recurring charges, credits and coupons are applied to calculate the final amount that is due.\n\nWhen invoice is closed, an attempt to charge the credit card is made. If the payment succeeds, it is marked as **paid** . If the payment fails, the invoice is marked as **payment_due** and retry settings are taken into account. If no retry attempts are configured, the invoice is marked as **not_paid** . If the amount due is zero or negative, the invoice is immediately marked as **paid** and the balance if any is carried forward to the next term of the invoice. \n**Note:**\nIf *consolidated invoicing*\nis enabled, the attribute *invoice.subscription_id*\nshould **not**\nbe used (as it will not be present if the invoice has lines from multiple subscriptions). Instead to know the related subscriptions, their [line_items](/docs/api/invoices#invoice_line_items)\n*subscription_id*\nattribute should be referred.\n", "properties" : { "id" : { "type" : "string", @@ -34250,7 +34254,7 @@ "subscription_id" : { "type" : "string", "deprecated" : false, - "description" : "

The identifier of the subscription this invoice belongs to.\nNote:\nWhen consolidated invoicing is enabled, you have to refer to line_item`s\nsubscription_id\nto identify the subscriptions associated with this invoice. However, it is important to avoid using this attribute if the invoice includes charges from multiple subscriptions, as it will be null in such cases.

", + "description" : "

The identifier of the subscription this invoice belongs to.\nNote:\nWhen consolidated invoicing is enabled, you have to refer to line_items\nsubscription_id\nto identify the subscriptions associated with this invoice. However, it is important to avoid using this attribute if the invoice includes charges from multiple subscriptions, as it will be null in such cases.

", "maxLength" : 50, "example" : null }, @@ -34264,7 +34268,7 @@ "status" : { "type" : "string", "deprecated" : false, - "description" : "

Current status of this invoice.

\n* pending -

The invoice is yet to be closed (sent for payment collection). An invoice is generated with this status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.\nThe invoice is yet to be closed (sent for payment collection). All invoices are generated with this status when Metered Billing is enabled for the site.

\n* not_paid -

Indicates the payment is not made and all attempts to collect is failed.

\n* payment_due -

Indicates the payment is not yet collected and is being retried as per retry settings.

\n* voided -

Indicates a voided invoice.

\n* paid -

Indicates a paid invoice.

", + "description" : "

Current status of this invoice.

\n* pending -

The invoice is yet to be closed (sent for payment collection). An invoice is generated with this status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.\nThe invoice is yet to be closed (sent for payment collection). All invoices are generated with this status when Metered Billing is enabled for the site.

\n* not_paid -

Indicates the payment is not made and all attempts to collect is failed.

\n* payment_due -

Indicates the payment is not yet collected and is being retried as per retry settings.

\n* voided -

Indicates a voided invoice.

\n* paid -

Indicates a paid invoice.

", "enum" : [ "paid", "payment_due", "not_paid", "voided", "pending" ], "example" : null }, @@ -34279,7 +34283,7 @@ "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

The document date displayed on the invoice PDF. By default, it has the same value as the effective date of the action that created the invoice (subscription creation, update, or invoice creation). This date can be backdated (set to a value in the past) while performing the actions. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription or non-recurring charge is effective as of a past date. However, if the invoice is created as pending\n, and if the site is configured to set invoice dates to the date of closing, then upon invoice closure, this date is changed to the invoice closing date.

", + "description" : "

The document date displayed on the invoice PDF. By default, it has the same value as the effective date of the action that created the invoice (subscription creation, update, or invoice creation). This date can be backdated (set to a value in the past) while performing the actions. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription or non-recurring charge is effective as of a past date. However, if the invoice is created as pending\n, and if the site is configured to set invoice dates to the date of closing, then upon invoice closure, this date is changed to the invoice closing date.

", "example" : null }, "po_number" : { @@ -34323,7 +34327,7 @@ "type" : "integer", "format" : "int64", "deprecated" : false, - "description" : "

The sum of all the line item amounts minus the sum of all line item discounts. In other words, this is the sum of all line_items[].amount

\n", + "description" : "

The sum of all the line item amounts minus the sum of all line item discounts. In other words, this is the sum of all line_items[].amount

\n", "minimum" : 0, "example" : null }, @@ -34339,7 +34343,7 @@ "type" : "integer", "format" : "int64", "deprecated" : false, - "description" : "

The unpaid amount that is due on the invoice. This is calculated as: total

\n", + "description" : "

The unpaid amount that is due on the invoice. This is calculated as: total

\n", "minimum" : 0, "example" : null }, @@ -34356,7 +34360,7 @@ "type" : "integer", "format" : "int64", "deprecated" : false, - "description" : "

Payments collected successfully for the invoice. This is the sum of linked_payments[].txn_amount\nfor all linked_payments[]\nthat have txn_status\nas success.

", + "description" : "

Payments collected successfully for the invoice. This is the sum of linked_payments[].txn_amount\nfor all linked_payments[]\nthat have txn_status\nas success.

", "minimum" : 0, "example" : null }, @@ -34539,7 +34543,7 @@ "entity_id" : { "type" : "string", "deprecated" : false, - "description" : "

When the deduction is due to a coupon\n, then this is the id\nof the coupon.

", + "description" : "

When the deduction is due to a coupon\n, then this is the id\nof the coupon.

", "maxLength" : 100, "example" : null } @@ -34611,7 +34615,7 @@ "txn_type" : { "type" : "string", "deprecated" : false, - "description" : "

Type of the transaction.

\n* payment_reversal -

Indicates a reversal transaction.

\n* refund -

The transaction represents a refund of amount\nto the customer's payment_source\n.

\n* authorization -

The transaction represents an authorization for capturing the amount\nfrom the customer's payment_source\n.

\n* payment -

The transaction represents capture of amount\nfrom the customer's payment_source\n.

", + "description" : "

Type of the transaction.

\n* payment_reversal -

Indicates a reversal transaction.

\n* refund -

The transaction represents a refund of amount\nto the customer's payment_source\n.

\n* authorization -

The transaction represents an authorization for capturing the amount\nfrom the customer's payment_source\n.

\n* payment -

The transaction represents capture of amount\nfrom the customer's payment_source\n.

", "enum" : [ "authorization", "payment", "refund", "payment_reversal" ], "example" : null }, @@ -34703,7 +34707,7 @@ "notes" : { "type" : "array", "deprecated" : false, - "description" : "

The list of notes\nthat appear on the invoice PDF sent to the customer. Notes that come from a specific resource related to the invoice have entity_type\nand entity_id\ndefined. There can be up to two notes in this array for which entity_type\nand entity_id\nare not defined:

\n", + "description" : "

The list of notes\nthat appear on the invoice PDF sent to the customer. Notes that come from a specific resource related to the invoice have entity_type\nand entity_id\ndefined. There can be up to two notes in this array for which entity_type\nand entity_id\nare not defined:

\n", "items" : { "type" : "object", "deprecated" : false, @@ -34807,7 +34811,7 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, @@ -34821,7 +34825,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null }, @@ -34907,7 +34911,7 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, @@ -34921,7 +34925,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null }, @@ -35431,14 +35435,14 @@ "success_url" : { "type" : "string", "deprecated" : false, - "description" : "

The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.

", + "description" : "

The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.

", "maxLength" : 250, "example" : null }, "failure_url" : { "type" : "string", "deprecated" : false, - "description" : "

The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.

", + "description" : "

The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.

", "maxLength" : 250, "example" : null }, @@ -35459,7 +35463,7 @@ "customer_id" : { "type" : "string", "deprecated" : false, - "description" : "

The unique identifier of the customer for whom the payment_intent will be created. If specified, the payment_intent will be used exclusively for that customer. If not specified, the payment_intent won't be associated with any customer and will be available for any customer.

\n

See also

Customer resource lookup and creation
", + "description" : "

The unique identifier of the customer for whom the payment_intent will be created. If specified, the payment_intent will be used exclusively for that customer. If not specified, the payment_intent won't be associated with any customer and will be available for any customer.

\n

See also

Customer resource lookup and creation
", "maxLength" : 50, "example" : null }, @@ -35836,7 +35840,7 @@ }, "PortalSession" : { "type" : "object", - "description" : "

Customer Portal lets your customers to manage their account and billing themselves. Chargebee supports Single Sign-on (SSO) to access the customer portal. If you already have your own authentication for your website, it allows your authenticated customers to access their portal without having to login again.

Note: You can instead allow your customers to access the portal via login page provided by Chargebee. Read more.

Please follow the below steps for supporting portal access via SSO:

    \n
  1. Enable the "Allow access to customer portal via API" under "Settings > Hosted Pages Settings > Customer Portal" to use the portal sessions API.
    2. \n
  2. Provide a link in your website/application which your authenticated customers can use to access the portal (For example, {your_website_url}/portal_link).
    3. \n
  3. Handle the link request in your server code and create a portal session for the customer by calling Chargebee's "Create a portal session" API
    4. \n
  4. Forward the user to the access URL present in the "Portal Session" resource returned by the above API call.
    5. \n

Notes about access URL:

    \n
  • The access URL should be accessed by the customer within one hour from the time it was created.
    • \n
  • Once accessed, the session is valid until the user logs out from the portal UI or logout API is called from your application for this session.
    • \n
  • Once accessed, the access url cannot be reused. Hence do not persist this URL. Whenever you need to provide access to the portal, you need to create a new portal session.
    • \n

Using Chargebee's authentication to allow access to your website

Note: This feature is not supported in in-app portal.\nChargebee allows you to integrate your website by building user authentication on top of Chargebee. If you would want to allow access to parts of your website only to subscribers (like a paywall), you can integrate Chargebee's authentication without having to handle it from your end.\nWorkflow:\nUsers should be redirected to the portal login URL - https://yourdomain.chargebeeportal.com/portal/login by passing the following parameters:

Upon successful authentication, a session is created for the user and Chargebee redirects the user to the return_url along with the following parameters:

", + "description" : "

Customer Portal lets your customers to manage their account and billing themselves. Chargebee supports Single Sign-on (SSO) to access the customer portal. If you already have your own authentication for your website, it allows your authenticated customers to access their portal without having to login again.

Note: You can instead allow your customers to access the portal via login page provided by Chargebee. Read more.

Please follow the below steps for supporting portal access via SSO:

    \n
  1. Enable the "Allow access to customer portal via API" under "Settings > Hosted Pages Settings > Customer Portal" to use the portal sessions API.
    2. \n
  2. Provide a link in your website/application which your authenticated customers can use to access the portal (For example, {your_website_url}/portal_link).
    3. \n
  3. Handle the link request in your server code and create a portal session for the customer by calling Chargebee's "Create a portal session" API
    4. \n
  4. Forward the user to the access URL present in the "Portal Session" resource returned by the above API call.
    5. \n

Notes about access URL:

    \n
  • The access URL should be accessed by the customer within one hour from the time it was created.
    • \n
  • Once accessed, the session is valid until the user logs out from the portal UI or logout API is called from your application for this session.
    • \n
  • Once accessed, the access url cannot be reused. Hence do not persist this URL. Whenever you need to provide access to the portal, you need to create a new portal session.
    • \n

Using Chargebee's authentication to allow access to your website

Note: This feature is not supported in in-app portal.\nChargebee allows you to integrate your website by building user authentication on top of Chargebee. If you would want to allow access to parts of your website only to subscribers (like a paywall), you can integrate Chargebee's authentication without having to handle it from your end.\nWorkflow:\nUsers should be redirected to the portal login URL - https://yourdomain.chargebeeportal.com/portal/login by passing the following parameters:

Upon successful authentication, a session is created for the user and Chargebee redirects the user to the return_url along with the following parameters:

", "properties" : { "id" : { "type" : "string", @@ -36096,7 +36100,7 @@ "Subscription" : { "type" : "object", "additionalProperties" : true, - "description" : "

Subscription represents the recurring items a customer has subscribed to. The recurring items can be - plan, addons. It may also contain the discount items like coupons.

Subscriptions are invoiced at the start of every term based on the recurring items and charged immediately against the customer's credit card if 'auto_collection' is turned 'on', otherwise the resulting invoice will be created as 'Payment Due'.

Note:\nThe maximum number of subscriptions for any given customer\n(active\nor not) is 900.

", + "description" : "

Subscription represents the recurring items a customer has subscribed to. The recurring items can be - plan, addons. It may also contain the discount items like coupons.

Subscriptions are invoiced at the start of every term based on the recurring items and charged immediately against the customer's credit card if 'auto_collection' is turned 'on', otherwise the resulting invoice will be created as 'Payment Due'.

Note:\nThe maximum number of subscriptions for any given customer\n(active\nor not) is 900.

", "properties" : { "id" : { "type" : "string", @@ -36153,7 +36157,7 @@ "status" : { "type" : "string", "deprecated" : false, - "description" : "

Current state of the subscription

\n* future -

The subscription is scheduled to start at a future date.

\n* transferred -

The transferred\nstatus will be reflected on the source business entity's subscription attribute once the customer transfer\nactivity is completed successfully. This status is only valid for product catalog 2.0\nas the Multiple Business Entity features can only be enabled for product catalog 2.0.

\n* in_trial -

The subscription is in trial.

\n* active -

The subscription is active and will be charged for automatically based on the items in it.

\n* cancelled -

The subscription has been canceled and is no longer in service.

\n* non_renewing -

The subscription will be canceled at the end of the current term.

", + "description" : "

Current state of the subscription

\n* future -

The subscription is scheduled to start at a future date.

\n* transferred -

The transferred\nstatus will be reflected on the source business entity's subscription attribute once the customer transfer\nactivity is completed successfully. This status is only valid for product catalog 2.0\nas the Multiple Business Entity features can only be enabled for product catalog 2.0.

\n* in_trial -

The subscription is in trial.

\n* active -

The subscription is active and will be charged for automatically based on the items in it.

\n* cancelled -

The subscription has been canceled and is no longer in service.

\n* non_renewing -

The subscription will be canceled at the end of the current term.

", "enum" : [ "future", "in_trial", "active", "non_renewing", "cancelled", "transferred" ], "example" : null }, @@ -36161,7 +36165,7 @@ "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

Start of the trial period for the subscription. Presence of this value for future\nsubscription implies the subscription will go into in_trial\nstate when it starts.

", + "description" : "

Start of the trial period for the subscription. Presence of this value for future\nsubscription implies the subscription will go into in_trial\nstate when it starts.

", "example" : null }, "current_term_start" : { @@ -36189,14 +36193,14 @@ "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

Time at which the subscription was started. Is null\nfor future\nsubscriptions as it is yet to be started.

", + "description" : "

Time at which the subscription was started. Is null\nfor future\nsubscriptions as it is yet to be started.

", "example" : null }, "activated_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

Time at which the subscription status\nlast changed to\nactive.\nFor example, this value is updated when an in_trial\nor\ncancelled\nsubscription activates.

", + "description" : "

Time at which the subscription status\nlast changed to\nactive.\nFor example, this value is updated when an in_trial\nor\ncancelled\nsubscription activates.

", "example" : null }, "cancelled_at" : { @@ -36231,14 +36235,14 @@ "type" : "boolean", "default" : false, "deprecated" : false, - "description" : "

If true\n, there are subscription changes scheduled on next renewal.

", + "description" : "

If true\n, there are subscription changes scheduled on next renewal.

", "example" : null }, "due_invoices_count" : { "type" : "integer", "format" : "int32", "deprecated" : false, - "description" : "

Total number of invoices that are due for payment against the subscription.\nNote:\nNot supported if consolidated invoicing\nis enabled, or when the subscription is for the customer who is in hierarchy\n, and the parent of this customer owns and pays for the invoices of the subscription. It is also worth noting that the consolidated invoice amount is not included in the calculation of due_invoices_count\n.

", + "description" : "

Total number of invoices that are due for payment against the subscription.\nNote:\nNot supported if consolidated invoicing\nis enabled, or when the subscription is for the customer who is in hierarchy\n, and the parent of this customer owns and pays for the invoices of the subscription. It is also worth noting that the consolidated invoice amount is not included in the calculation of due_invoices_count\n.

", "example" : null }, "due_since" : { @@ -36252,7 +36256,7 @@ "type" : "integer", "format" : "int64", "deprecated" : false, - "description" : "

Total invoice due amount for this subscription. The value depends on the type of currency\n.\nNote:\nNot supported if consolidated invoicing\nis enabled, or when the subscription is for the customer who is in hierarchy\n, and the parent of this customer owns and pays for the invoices of the subscription. It is also worth noting that the consolidated invoice amount is not included in the calculation of total_dues\n.

", + "description" : "

Total invoice due amount for this subscription. The value depends on the type of currency\n.\nNote:\nNot supported if consolidated invoicing\nis enabled, or when the subscription is for the customer who is in hierarchy\n, and the parent of this customer owns and pays for the invoices of the subscription. It is also worth noting that the consolidated invoice amount is not included in the calculation of total_dues\n.

", "minimum" : 0, "example" : null }, @@ -36276,7 +36280,7 @@ "format" : "int32", "default" : 1, "deprecated" : false, - "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", + "description" : "

Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.

", "minimum" : 1, "example" : null }, @@ -36312,7 +36316,7 @@ "type" : "integer", "format" : "unix-time", "deprecated" : false, - "description" : "

The date till when the coupon can be applied. Applicable for limited_period\ncoupons\nonly.

", + "description" : "

The date till when the coupon can be applied. Applicable for limited_period\ncoupons\nonly.

", "example" : null }, "applied_count" : { @@ -36408,7 +36412,7 @@ "state_code" : { "type" : "string", "deprecated" : false, - "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", + "description" : "

The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).

", "maxLength" : 50, "example" : null }, @@ -36422,7 +36426,7 @@ "country" : { "type" : "string", "deprecated" : false, - "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", + "description" : "

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.

\n

Note:\nIf you enter an invalid country code, the system will return an error.

\n

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

", "maxLength" : 50, "example" : null }, @@ -37433,14 +37437,14 @@ "type" : "string", "default" : "card", "deprecated" : false, - "description" : "

The payment method of this transaction

\n* card -

Card

\n* amazon_payments -

Amazon Payments

\n* chargeback -

Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.

\n* bank_transfer -

Bank Transfer

\n* paypal_express_checkout -

Paypal Express Checkout

\n* direct_debit -

Direct Debit

\n* other -

Payment Methods other than the above types

\n* cash -

Cash

\n* check -

Check

", + "description" : "

The payment method of this transaction

\n* card -

Card

\n* amazon_payments -

Amazon Payments

\n* chargeback -

Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.

\n* bank_transfer -

Bank Transfer

\n* paypal_express_checkout -

Paypal Express Checkout

\n* direct_debit -

Direct Debit

\n* other -

Payment Methods other than the above types

\n* cash -

Cash

\n* check -

Check

", "enum" : [ "card", "cash", "check", "chargeback", "bank_transfer", "amazon_payments", "paypal_express_checkout", "direct_debit", "other" ], "example" : null }, "reference_number" : { "type" : "string", "deprecated" : false, - "description" : "

The reference number for this transaction. For example, the check number when payment_method\n= check\n.

", + "description" : "

The reference number for this transaction. For example, the check number when payment_method\n= check\n.

", "maxLength" : 100, "example" : null }, @@ -37454,7 +37458,7 @@ "type" : { "type" : "string", "deprecated" : false, - "description" : "

Type of the transaction.

\n* payment_reversal -

Indicates a reversal transaction.

\n* payment -

The transaction represents capture of amount\nfrom the customer's payment_source\n.

\n* refund -

The transaction represents a refund of amount\nto the customer's payment_source\n.

\n* authorization -

The transaction represents an authorization for capturing the amount\nfrom the customer's payment_source\n.

", + "description" : "

Type of the transaction.

\n* payment_reversal -

Indicates a reversal transaction.

\n* payment -

The transaction represents capture of amount\nfrom the customer's payment_source\n.

\n* refund -

The transaction represents a refund of amount\nto the customer's payment_source\n.

\n* authorization -

The transaction represents an authorization for capturing the amount\nfrom the customer's payment_source\n.

", "enum" : [ "authorization", "payment", "refund", "payment_reversal" ], "example" : null }, @@ -37532,7 +37536,7 @@ "type" : "integer", "format" : "int64", "deprecated" : false, - "description" : "

This is the part of the amount\nwhich has not been invoiced yet and is therefore added to excess_payments\nfor the customer. Applicable only for a transaction of type\n= payment\n.

", + "description" : "

This is the part of the amount\nwhich has not been invoiced yet and is therefore added to excess_payments\nfor the customer. Applicable only for a transaction of type\n= payment\n.

", "minimum" : 0, "example" : null }, @@ -37546,14 +37550,14 @@ "reference_transaction_id" : { "type" : "string", "deprecated" : false, - "description" : "

This is the id\nof the offline transaction that is being refunded or reversed. Applicable only for transaction of type\n= refund\nor payment_reversal\n.

", + "description" : "

This is the id\nof the offline transaction that is being refunded or reversed. Applicable only for transaction of type\n= refund\nor payment_reversal\n.

", "maxLength" : 40, "example" : null }, "refunded_txn_id" : { "type" : "string", "deprecated" : false, - "description" : "

This is the id\nof the transaction (always of type\n= payment\n) being refunded. Applicable only for transaction of type\n= refund\n.

", + "description" : "

This is the id\nof the transaction (always of type\n= payment\n) being refunded. Applicable only for transaction of type\n= refund\n.

", "maxLength" : 40, "example" : null }, @@ -38121,10 +38125,10 @@ "jsonSchemaDialect" : "https://spec.openapis.org/oas/3.1/dialect/base", "webhooks" : { "subscription_reactivated" : { - "description" : "

Triggered when the subscription is moved from cancelled status to active or in_trial.

", + "description" : "

Triggered when the subscription is moved from cancelled status to active or in_trial.

", "post" : { "summary" : "Triggered when the subscription is moved from `cancelled` `status` to `active` or `in_trial`.", - "description" : "

Triggered when the subscription is moved from cancelled status to active or in_trial.

", + "description" : "

Triggered when the subscription is moved from cancelled status to active or in_trial.

", "operationId" : "onSubscription_reactivatedWebhook", "requestBody" : { "description" : "Payload for subscription_reactivated event", @@ -38145,10 +38149,10 @@ } }, "transaction_updated" : { - "description" : "

Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated.

", + "description" : "

Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated.

", "post" : { "summary" : "Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated.", - "description" : "

Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated.

", + "description" : "

Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated.

", "operationId" : "onTransaction_updatedWebhook", "requestBody" : { "description" : "Payload for transaction_updated event", @@ -38169,10 +38173,10 @@ } }, "subscription_created" : { - "description" : "

Triggered when a new subscription is created.

", + "description" : "

Triggered when a new subscription is created.

", "post" : { "summary" : "Triggered when a new subscription is created.", - "description" : "

Triggered when a new subscription is created.

", + "description" : "

Triggered when a new subscription is created.

", "operationId" : "onSubscription_createdWebhook", "requestBody" : { "description" : "Payload for subscription_created event", @@ -38193,10 +38197,10 @@ } }, "subscription_cancellation_scheduled" : { - "description" : "

Triggered when subscription is scheduled to cancel at end of current term.

", + "description" : "

Triggered when subscription is scheduled to cancel at end of current term.

", "post" : { "summary" : "Triggered when subscription is scheduled to cancel at end of current term.", - "description" : "

Triggered when subscription is scheduled to cancel at end of current term.

", + "description" : "

Triggered when subscription is scheduled to cancel at end of current term.

", "operationId" : "onSubscription_cancellation_scheduledWebhook", "requestBody" : { "description" : "Payload for subscription_cancellation_scheduled event", @@ -38217,10 +38221,10 @@ } }, "subscription_trial_extended" : { - "description" : "

Trial Extension

", + "description" : "

Trial Extension

", "post" : { "summary" : "Trial Extension", - "description" : "

Trial Extension

", + "description" : "

Trial Extension

", "operationId" : "onSubscription_trial_extendedWebhook", "requestBody" : { "description" : "Payload for subscription_trial_extended event", @@ -38241,10 +38245,10 @@ } }, "subscription_deleted" : { - "description" : "

Triggered when a subscription is deleted.

", + "description" : "

Triggered when a subscription is deleted.

", "post" : { "summary" : "Triggered when a subscription is deleted.", - "description" : "

Triggered when a subscription is deleted.

", + "description" : "

Triggered when a subscription is deleted.

", "operationId" : "onSubscription_deletedWebhook", "requestBody" : { "description" : "Payload for subscription_deleted event", @@ -38265,10 +38269,10 @@ } }, "invoice_generated" : { - "description" : "

Event triggered when a new invoice is created except when created with status as pending. For pending invoices, this event is triggered when the invoice is closed.

", + "description" : "

Event triggered when a new invoice is created except when created with status as pending. For pending invoices, this event is triggered when the invoice is closed.

", "post" : { "summary" : "Event triggered when a new invoice is created except when created with status as pending. For pending invoices, this event is triggered when the invoice is closed.", - "description" : "

Event triggered when a new invoice is created except when created with status as pending. For pending invoices, this event is triggered when the invoice is closed.

", + "description" : "

Event triggered when a new invoice is created except when created with status as pending. For pending invoices, this event is triggered when the invoice is closed.

", "operationId" : "onInvoice_generatedWebhook", "requestBody" : { "description" : "Payload for invoice_generated event", @@ -38289,10 +38293,10 @@ } }, "subscription_cancelling" : { - "description" : "

Triggered 6 days prior to the scheduled cancellation date.

", + "description" : "

Triggered 6 days prior to the scheduled cancellation date.

", "post" : { "summary" : "Triggered 6 days prior to the scheduled cancellation date.", - "description" : "

Triggered 6 days prior to the scheduled cancellation date.

", + "description" : "

Triggered 6 days prior to the scheduled cancellation date.

", "operationId" : "onSubscription_cancellingWebhook", "requestBody" : { "description" : "Payload for subscription_cancelling event", @@ -38313,10 +38317,10 @@ } }, "subscription_renewed" : { - "description" : "

Triggered when the subscription is renewed from the current term.

", + "description" : "

Triggered when the subscription is renewed from the current term.

", "post" : { "summary" : "Triggered when the subscription is renewed from the current term.", - "description" : "

Triggered when the subscription is renewed from the current term.

", + "description" : "

Triggered when the subscription is renewed from the current term.

", "operationId" : "onSubscription_renewedWebhook", "requestBody" : { "description" : "Payload for subscription_renewed event", @@ -38337,10 +38341,10 @@ } }, "subscription_scheduled_cancellation_removed" : { - "description" : "

Triggered when scheduled cancellation is removed for the subscription.

", + "description" : "

Triggered when scheduled cancellation is removed for the subscription.

", "post" : { "summary" : "Triggered when scheduled cancellation is removed for the subscription.", - "description" : "

Triggered when scheduled cancellation is removed for the subscription.

", + "description" : "

Triggered when scheduled cancellation is removed for the subscription.

", "operationId" : "onSubscription_scheduled_cancellation_removedWebhook", "requestBody" : { "description" : "Payload for subscription_scheduled_cancellation_removed event", @@ -38361,10 +38365,10 @@ } }, "payment_refunded" : { - "description" : "

Triggered when a payment refund is made.

", + "description" : "

Triggered when a payment refund is made.

", "post" : { "summary" : "Triggered when a payment refund is made.", - "description" : "

Triggered when a payment refund is made.

", + "description" : "

Triggered when a payment refund is made.

", "operationId" : "onPayment_refundedWebhook", "requestBody" : { "description" : "Payload for payment_refunded event", @@ -38385,10 +38389,10 @@ } }, "subscription_changed" : { - "description" : "

Triggered when the subscription's recurring items are changed.

", + "description" : "

Triggered when the subscription's recurring items are changed.

", "post" : { "summary" : "Triggered when the subscription's recurring items are changed.", - "description" : "

Triggered when the subscription's recurring items are changed.

", + "description" : "

Triggered when the subscription's recurring items are changed.

", "operationId" : "onSubscription_changedWebhook", "requestBody" : { "description" : "Payload for subscription_changed event", @@ -38409,10 +38413,10 @@ } }, "invoice_created" : { - "description" : "

Event triggered (in the case of metered billing) when a "Pending" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the "Notify for Pending Invoices" option is enabled.

", + "description" : "

Event triggered (in the case of metered billing) when a "Pending" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the "Notify for Pending Invoices" option is enabled.

", "post" : { "summary" : "Event triggered (in the case of metered billing) when a \"Pending\" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the “Notify for Pending Invoices” option is enabled.", - "description" : "

Event triggered (in the case of metered billing) when a "Pending" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the "Notify for Pending Invoices" option is enabled.

", + "description" : "

Event triggered (in the case of metered billing) when a "Pending" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the "Notify for Pending Invoices" option is enabled.

", "operationId" : "onInvoice_createdWebhook", "requestBody" : { "description" : "Payload for invoice_created event", @@ -38433,10 +38437,10 @@ } }, "transaction_created" : { - "description" : "

Triggered when a transaction is recorded.

", + "description" : "

Triggered when a transaction is recorded.

", "post" : { "summary" : "Triggered when a transaction is recorded.", - "description" : "

Triggered when a transaction is recorded.

", + "description" : "

Triggered when a transaction is recorded.

", "operationId" : "onTransaction_createdWebhook", "requestBody" : { "description" : "Payload for transaction_created event", @@ -38457,10 +38461,10 @@ } }, "subscription_cancelled" : { - "description" : "

Triggered when the subscription is cancelled. If it is cancelled due to non payment or because the card details are not present, the subscription will have the possible reason as 'cancel_reason'.

", + "description" : "

Triggered when the subscription is cancelled. If it is cancelled due to non payment or because the card details are not present, the subscription will have the possible reason as 'cancel_reason'.

", "post" : { "summary" : "Triggered when the subscription is cancelled. If it is cancelled due to non payment or because the card details are not present, the subscription will have the possible reason as 'cancel_reason'.", - "description" : "

Triggered when the subscription is cancelled. If it is cancelled due to non payment or because the card details are not present, the subscription will have the possible reason as 'cancel_reason'.

", + "description" : "

Triggered when the subscription is cancelled. If it is cancelled due to non payment or because the card details are not present, the subscription will have the possible reason as 'cancel_reason'.

", "operationId" : "onSubscription_cancelledWebhook", "requestBody" : { "description" : "Payload for subscription_cancelled event", @@ -38481,10 +38485,10 @@ } }, "invoice_deleted" : { - "description" : "

Event triggered when an invoice is deleted.

", + "description" : "

Event triggered when an invoice is deleted.

", "post" : { "summary" : "Event triggered when an invoice is deleted.", - "description" : "

Event triggered when an invoice is deleted.

", + "description" : "

Event triggered when an invoice is deleted.

", "operationId" : "onInvoice_deletedWebhook", "requestBody" : { "description" : "Payload for invoice_deleted event", @@ -38505,10 +38509,10 @@ } }, "payment_failed" : { - "description" : "

Triggered when the payment collection fails.

", + "description" : "

Triggered when the payment collection fails.

", "post" : { "summary" : "Triggered when the payment collection fails.", - "description" : "

Triggered when the payment collection fails.

", + "description" : "

Triggered when the payment collection fails.

", "operationId" : "onPayment_failedWebhook", "requestBody" : { "description" : "Payload for payment_failed event", @@ -38529,10 +38533,10 @@ } }, "card_expired" : { - "description" : "

Triggered when the card for a customer has expired.

", + "description" : "

Triggered when the card for a customer has expired.

", "post" : { "summary" : "Triggered when the card for a customer has expired.", - "description" : "

Triggered when the card for a customer has expired.

", + "description" : "

Triggered when the card for a customer has expired.

", "operationId" : "onCard_expiredWebhook", "requestBody" : { "description" : "Payload for card_expired event", @@ -38553,10 +38557,10 @@ } }, "invoice_updated" : { - "description" : "

Triggered when you make the following changes to a pending invoice - add a charge, add a non-recurring addon, or delete a line item.

", + "description" : "

Triggered when you make the following changes to a pending invoice - add a charge, add a non-recurring addon, or delete a line item.

", "post" : { "summary" : "Triggered when you make the following changes to a pending invoice - add a charge, add a non-recurring addon, or delete a line item.", - "description" : "

Triggered when you make the following changes to a pending invoice - add a charge, add a non-recurring addon, or delete a line item.

", + "description" : "

Triggered when you make the following changes to a pending invoice - add a charge, add a non-recurring addon, or delete a line item.

", "operationId" : "onInvoice_updatedWebhook", "requestBody" : { "description" : "Payload for invoice_updated event", @@ -38577,10 +38581,10 @@ } }, "payment_succeeded" : { - "description" : "

Triggered when the payment is successfully collected.

", + "description" : "

Triggered when the payment is successfully collected.

", "post" : { "summary" : "Triggered when the payment is successfully collected.", - "description" : "

Triggered when the payment is successfully collected.

", + "description" : "

Triggered when the payment is successfully collected.

", "operationId" : "onPayment_succeededWebhook", "requestBody" : { "description" : "Payload for payment_succeeded event", @@ -38601,10 +38605,10 @@ } }, "card_updated" : { - "description" : "

Triggered when the card is updated for a customer.

", + "description" : "

Triggered when the card is updated for a customer.

", "post" : { "summary" : "Triggered when the card is updated for a customer.", - "description" : "

Triggered when the card is updated for a customer.

", + "description" : "

Triggered when the card is updated for a customer.

", "operationId" : "onCard_updatedWebhook", "requestBody" : { "description" : "Payload for card_updated event", @@ -38625,10 +38629,10 @@ } }, "card_expiring" : { - "description" : "

Triggered when the customer's credit card is expiring soon. Triggered 30 days before the expiry date.

", + "description" : "

Triggered when the customer's credit card is expiring soon. Triggered 30 days before the expiry date.

", "post" : { "summary" : "Triggered when the customer's credit card is expiring soon. Triggered 30 days before the expiry date.", - "description" : "

Triggered when the customer's credit card is expiring soon. Triggered 30 days before the expiry date.

", + "description" : "

Triggered when the customer's credit card is expiring soon. Triggered 30 days before the expiry date.

", "operationId" : "onCard_expiringWebhook", "requestBody" : { "description" : "Payload for card_expiring event", @@ -38649,10 +38653,10 @@ } }, "card_deleted" : { - "description" : "

Triggered when a card is deleted for a customer.

", + "description" : "

Triggered when a card is deleted for a customer.

", "post" : { "summary" : "Triggered when a card is deleted for a customer.", - "description" : "

Triggered when a card is deleted for a customer.

", + "description" : "

Triggered when a card is deleted for a customer.

", "operationId" : "onCard_deletedWebhook", "requestBody" : { "description" : "Payload for card_deleted event", @@ -38673,10 +38677,10 @@ } }, "customer_created" : { - "description" : "

Triggered when a customer is created.

", + "description" : "

Triggered when a customer is created.

", "post" : { "summary" : "Triggered when a customer is created.", - "description" : "

Triggered when a customer is created.

", + "description" : "

Triggered when a customer is created.

", "operationId" : "onCustomer_createdWebhook", "requestBody" : { "description" : "Payload for customer_created event", @@ -38697,10 +38701,10 @@ } }, "subscription_shipping_address_updated" : { - "description" : "

Triggered when shipping address is added or updated for a subscription.

", + "description" : "

Triggered when shipping address is added or updated for a subscription.

", "post" : { "summary" : "Triggered when shipping address is added or updated for a subscription.", - "description" : "

Triggered when shipping address is added or updated for a subscription.

", + "description" : "

Triggered when shipping address is added or updated for a subscription.

", "operationId" : "onSubscription_shipping_address_updatedWebhook", "requestBody" : { "description" : "Payload for subscription_shipping_address_updated event", @@ -38721,10 +38725,10 @@ } }, "customer_changed" : { - "description" : "

Triggered when a customer is changed.

", + "description" : "

Triggered when a customer is changed.

", "post" : { "summary" : "Triggered when a customer is changed.", - "description" : "

Triggered when a customer is changed.

", + "description" : "

Triggered when a customer is changed.

", "operationId" : "onCustomer_changedWebhook", "requestBody" : { "description" : "Payload for customer_changed event", @@ -38745,10 +38749,10 @@ } }, "subscription_renewal_reminder" : { - "description" : "

Triggered 3 days before each subscription's renewal.

", + "description" : "

Triggered 3 days before each subscription's renewal.

", "post" : { "summary" : "Triggered 3 days before each subscription's renewal.", - "description" : "

Triggered 3 days before each subscription's renewal.

", + "description" : "

Triggered 3 days before each subscription's renewal.

", "operationId" : "onSubscription_renewal_reminderWebhook", "requestBody" : { "description" : "Payload for subscription_renewal_reminder event", @@ -38769,10 +38773,10 @@ } }, "subscription_started" : { - "description" : "

Triggered when a 'future' subscription gets started.

", + "description" : "

Triggered when a 'future' subscription gets started.

", "post" : { "summary" : "Triggered when a 'future' subscription gets started.", - "description" : "

Triggered when a 'future' subscription gets started.

", + "description" : "

Triggered when a 'future' subscription gets started.

", "operationId" : "onSubscription_startedWebhook", "requestBody" : { "description" : "Payload for subscription_started event", @@ -38793,10 +38797,10 @@ } }, "transaction_deleted" : { - "description" : "

Triggered when a transaction is deleted.

", + "description" : "

Triggered when a transaction is deleted.

", "post" : { "summary" : "Triggered when a transaction is deleted.", - "description" : "

Triggered when a transaction is deleted.

", + "description" : "

Triggered when a transaction is deleted.

", "operationId" : "onTransaction_deletedWebhook", "requestBody" : { "description" : "Payload for transaction_deleted event", @@ -38817,10 +38821,10 @@ } }, "subscription_trial_ending" : { - "description" : "

Triggered 6 days prior to the trial period's end date.

", + "description" : "

Triggered 6 days prior to the trial period's end date.

", "post" : { "summary" : "Triggered 6 days prior to the trial period's end date.", - "description" : "

Triggered 6 days prior to the trial period's end date.

", + "description" : "

Triggered 6 days prior to the trial period's end date.

", "operationId" : "onSubscription_trial_endingWebhook", "requestBody" : { "description" : "Payload for subscription_trial_ending event", @@ -38841,10 +38845,10 @@ } }, "payment_initiated" : { - "description" : "

Triggered when a payment is initiated via direct debit.

", + "description" : "

Triggered when a payment is initiated via direct debit.

", "post" : { "summary" : "Triggered when a payment is initiated via direct debit.", - "description" : "

Triggered when a payment is initiated via direct debit.

", + "description" : "

Triggered when a payment is initiated via direct debit.

", "operationId" : "onPayment_initiatedWebhook", "requestBody" : { "description" : "Payload for payment_initiated event", @@ -38865,10 +38869,10 @@ } }, "customer_deleted" : { - "description" : "

Triggered when a customer is deleted.

", + "description" : "

Triggered when a customer is deleted.

", "post" : { "summary" : "Triggered when a customer is deleted.", - "description" : "

Triggered when a customer is deleted.

", + "description" : "

Triggered when a customer is deleted.

", "operationId" : "onCustomer_deletedWebhook", "requestBody" : { "description" : "Payload for customer_deleted event", @@ -38889,10 +38893,10 @@ } }, "subscription_activated" : { - "description" : "

Triggered after the subscription has been moved from "Trial" to "Active" state.

", + "description" : "

Triggered after the subscription has been moved from "Trial" to "Active" state.

", "post" : { "summary" : "Triggered after the subscription has been moved from \"Trial\" to \"Active\" state.", - "description" : "

Triggered after the subscription has been moved from "Trial" to "Active" state.

", + "description" : "

Triggered after the subscription has been moved from "Trial" to "Active" state.

", "operationId" : "onSubscription_activatedWebhook", "requestBody" : { "description" : "Payload for subscription_activated event", @@ -38913,10 +38917,10 @@ } }, "card_added" : { - "description" : "

Triggered when a card is added for a customer.

", + "description" : "

Triggered when a card is added for a customer.

", "post" : { "summary" : "Triggered when a card is added for a customer.", - "description" : "

Triggered when a card is added for a customer.

", + "description" : "

Triggered when a card is added for a customer.

", "operationId" : "onCard_addedWebhook", "requestBody" : { "description" : "Payload for card_added event", @@ -38937,10 +38941,10 @@ } }, "refund_initiated" : { - "description" : "

Triggered when a refund is initiated via direct debit.

", + "description" : "

Triggered when a refund is initiated via direct debit.

", "post" : { "summary" : "Triggered when a refund is initiated via direct debit.", - "description" : "

Triggered when a refund is initiated via direct debit.

", + "description" : "

Triggered when a refund is initiated via direct debit.

", "operationId" : "onRefund_initiatedWebhook", "requestBody" : { "description" : "Payload for refund_initiated event", diff --git a/spec/chargebee_api_v1_spec.yaml b/spec/chargebee_api_v1_spec.yaml index 9146cfe..146371d 100644 --- a/spec/chargebee_api_v1_spec.yaml +++ b/spec/chargebee_api_v1_spec.yaml @@ -5,10 +5,10 @@ info: name: Chargebee Support url: https://www.chargebee.com email: support@chargebee.com - version: 2025-12-30.c529d21ca07ce56ab113880a50c1d456bd2a637b - x-cb-api-version: 1 + version: 2026-01-12.2384b8e365b6622288c6a7edc05d1334abc24829 x-cb-product-catalog-version: 1 - x-generated-on: 1767083358409 + x-cb-api-version: 1 + x-generated-on: 1768208062256 servers: - url: "{protocol}://{site}.{environment}:{port}/api/v1" variables: @@ -185,13 +185,13 @@ paths: properties: subscription: $ref: "#/components/schemas/Subscription" - description:

Resource object representing subscription

+ description:

Resource object representing subscription

customer: $ref: "#/components/schemas/Customer" - description:

Resource object representing customer

+ description:

Resource object representing customer

card: $ref: "#/components/schemas/Card" - description:

Resource object representing card

+ description:

Resource object representing card

required: - customer - subscription @@ -427,13 +427,13 @@ paths: properties: subscription: $ref: "#/components/schemas/Subscription" - description:

Resource object representing subscription

+ description:

Resource object representing subscription

customer: $ref: "#/components/schemas/Customer" - description:

Resource object representing customer

+ description:

Resource object representing customer

card: $ref: "#/components/schemas/Card" - description:

Resource object representing card

+ description:

Resource object representing card

required: - customer - subscription @@ -604,8 +604,8 @@ paths: - name: offset in: query description: |- -

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset - to the value of next_offset +

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset + to the value of next_offset obtained in the previous iteration of the API call.

required: false style: form @@ -631,7 +631,8 @@ paths: properties: subscription: $ref: "#/components/schemas/Subscription" - description:

Resource object representing subscription

+ description:

Resource object representing + subscription

required: - subscription example: null @@ -900,11 +901,11 @@ paths: format: unix-time deprecated: false description: |- -

The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

-