chargebee 2.28.0 → 2.29.0

package/types/resources/QuoteLineGroup.d.ts

@@ -104,108 +104,353 @@ declare module 'chargebee' {
     
     
     export interface LineItem {  
+         /**
+          * @description Uniquely identifies a line_item
+
+          */
+       
       id?:string;
        
+         /**
+          * @description A unique identifier for the subscription this line item belongs to.
+
+          */
+       
       subscription_id?:string;
        
+         /**
+          * @description Start date of this line item.
+
+          */
+       
       date_from?:number;
        
+         /**
+          * @description End date of this line item.
+
+          */
+       
       date_to?:number;
        
+         /**
+          * @description Unit amount of the line item.
+
+          */
+       
       unit_amount?:number;
        
+         /**
+          * @description [Quantity of the recurring item](/docs/api/invoices?prod_cat_ver=2#invoice_line_items_quantity) which is represented by this line item. For `metered` line items, this value is updated from [usages](/docs/api/usages) once when the invoice is generated as `pending` and finally when the invoice is [closed](/docs/api/invoices#close_a_pending_invoice).
+
+          */
+       
       quantity?:number;
        
+         /**
+          * @description Total amount of this line item. Typically equals to unit amount x quantity
+
+          */
+       
       amount?:number;
        
+         /**
+          * @description The [pricing scheme](https://www.chargebee.com/docs/2.0/plans.html#pricing-models) for this item price. \* per_unit - A fixed price per unit quantity. \* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in. \* flat_fee - A fixed price that is not quantity-based. \* tiered - The per unit price is based on the tier that the total quantity falls in. \* volume - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
+
+          */
+       
       pricing_model?:'volume' | 'per_unit' | 'tiered' | 'flat_fee' | 'stairstep';
        
+         /**
+          * @description Specifies whether this line item is taxed or not
+
+          */
+       
       is_taxed?:boolean;
        
+         /**
+          * @description The tax amount charged for this item
+
+          */
+       
       tax_amount?:number;
        
+         /**
+          * @description Rate of tax used to calculate tax for this lineitem
+
+          */
+       
       tax_rate?:number;
        
+         /**
+          * @description The decimal representation of the unit amount of the `line_item`. The value is in major units of the currency. Returned when the `line_item` is quantity-based and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
+
+          */
+       
       unit_amount_in_decimal?:string;
        
+         /**
+          * @description The decimal representation of the quantity of this line_item. Returned when the `line_item` is quantity-based and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
+
+          */
+       
       quantity_in_decimal?:string;
        
+         /**
+          * @description The decimal representation of the amount for the `line_item`, in major units of the currency. Typically equals to `unit_amount_in_decimal` x `quantity_in_decimal`. Returned when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
+
+          */
+       
       amount_in_decimal?:string;
        
+         /**
+          * @description Total discounts for this line
+
+          */
+       
       discount_amount?:number;
        
+         /**
+          * @description Line Item-level discounts for this line.
+
+          */
+       
       item_level_discount_amount?:number;
        
+         /**
+          * @description Invoice Reference Line Item ID
+
+          */
+       
       reference_line_item_id?:string;
        
+         /**
+          * @description Detailed description about this line item.
+
+          */
+       
       description?:string;
        
+         /**
+          * @description Detailed description about this item.
+
+          */
+       
       entity_description?:string;
        
+         /**
+          * @description Specifies the modelled entity this line item is based on. \* addon - Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/addons#addon_attributes) id \* plan_item_price - Indicates that this line item is based on plan Item Price \* addon_item_price - Indicates that this line item is based on addon Item Price \* charge_item_price - Indicates that this line item is based on charge Item Price \* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case \* plan_setup - Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/plans#plan_attributes) id \* plan - Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/plans#plan_attributes) id
+
+          */
+       
       entity_type?:'addon_item_price' | 'plan_item_price' | 'charge_item_price' | 'adhoc';
        
+         /**
+          * @description The reason due to which the line item price/amount is exempted from tax. \* reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only \* tax_not_configured - If tax is not enabled for the site \* high_value_physical_goods - If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied \* product_exempt - If the Plan or Addon is marked as Tax exempt \* zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item \* customer_exempt - If the Customer is marked as Tax exempt \* region_non_taxable - If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction \* export - You are not registered for tax in the customer's region. This is also the reason code when both `billing_address` and `shipping_address` have not been provided for the customer and subscription respectively
+
+          */
+       
       tax_exempt_reason?:'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt';
        
+         /**
+          * @description The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type
+
+          */
+       
       entity_id?:string;
        
+         /**
+          * @description A unique identifier for the customer this line item belongs to
+
+          */
+       
       customer_id?:string;
     }
     export interface Discount {  
+         /**
+          * @description The amount deducted. The format of this value depends on the [kind of currency](/docs/api?prod_cat_ver=2#currencies).
+
+          */
+       
       amount?:number;
        
+         /**
+          * @description Description for this deduction.
+
+          */
+       
       description?:string;
        
+         /**
+          * @description The unique id of the line item that this deduction is for. Is required when `discounts[entity_type]` is `item_level_coupon` or `document_level_coupon`.
+
+          */
+       
       line_item_id?:string;
        
+         /**
+          * @description The type of deduction and the amount to which it is applied. \* document_level_coupon - The deduction is due to a coupon applied to the invoice `sub_total`. The coupon id is passed as `entity_id`. \* prorated_credits - The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id` is `null` in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices?prod_cat_ver=2#invoice_adjustment_credit_notes). \* item_level_coupon - The deduction is due to a coupon applied to line item. The coupon `id` is passed as `entity_id`. \* item_level_discount - The deduction is due to a [discount](/docs/api/discounts?prod_cat_ver=2) applied to a line item of the invoice. The discount `id` is available as the `entity_id`. \* promotional_credits - The deduction is due to a [promotional credit](/docs/api/promotional_credits?prod_cat_ver=2) applied to the invoice. \* document_level_discount - The deduction is due to a [discount](/docs/api/discounts?prod_cat_ver=2) applied to the invoice `sub_total`. The discount `id` is available as the `entity_id`.
+
+          */
+       
       entity_type?:'item_level_coupon' | 'promotional_credits' | 'item_level_discount' | 'prorated_credits' | 'document_level_discount' | 'document_level_coupon';
        
+         /**
+          * @description The type of discount that is applied to the line item. Relevant only when `discounts[entity_type]` is one of `item_level_discount` , `item_level_coupon`, `document_level_discount`, or `document_level_coupon` \* percentage - when percentage is applied as discount \* fixed_amount - when amount is applied as discount
+
+          */
+       
       discount_type?:'fixed_amount' | 'percentage';
        
+         /**
+          * @description When the deduction is due to a `coupon` or a [discount](discounts), then this is the `id` of the coupon or discount.
+
+          */
+       
       entity_id?:string;
        
+         /**
+          * @description The [coupon code](/docs/api/coupon_codes#coupon_code_code), if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons#coupon_id) is available in `entity_id`.
+
+          */
+       
       coupon_set_code?:string;
     }
     export interface LineItemDiscount {  
+         /**
+          * @description The unique id of the line item that this deduction is for.
+
+          */
+       
       line_item_id?:string;
        
+         /**
+          * @description The type of deduction and the amount to which it is applied. \* item_level_coupon - The deduction is due to a coupon applied to a line item of the invoice. The coupon `id` is available as `entity_id`. \* prorated_credits - The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id` is `null` in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices?prod_cat_ver=2#invoice_adjustment_credit_notes). \* document_level_coupon - The deduction is due to a coupon applied to the invoice `sub_total`. The coupon `id` is available as `entity_id`. \* document_level_discount - The deduction is due to a [discount](/docs/api/discounts?prod_cat_ver=2) applied to the invoice `sub_total`. The discount `id` is available as the `entity_id`. \* item_level_discount - The deduction is due to a [discount](/docs/api/discounts?prod_cat_ver=2) applied to a line item of the invoice. The discount `id` is available as the `entity_id`. \* promotional_credits - The deduction is due to a [promotional credit](/docs/api/promotional_credits) applied to the invoice. The `entity_id` is `null` in this case.
+
+          */
+       
       discount_type?:'item_level_coupon' | 'promotional_credits' | 'item_level_discount' | 'prorated_credits' | 'document_level_discount' | 'document_level_coupon';
        
       coupon_id?:string;
        
+         /**
+          * @description When the deduction is due to a `coupon` or a [discount](discounts), then this is the `id` of the coupon or discount.
+
+          */
+       
       entity_id?:string;
        
+         /**
+          * @description The amount deducted. The format of this value depends on the [kind of currency](/docs/api#currencies).
+
+          */
+       
       discount_amount?:number;
     }
     export interface Tax {  
+         /**
+          * @description The name of the tax applied. E.g. GST.
+
+          */
+       
       name?:string;
        
+         /**
+          * @description The tax amount.
+
+          */
+       
       amount?:number;
        
+         /**
+          * @description Description of the tax item.
+
+          */
+       
       description?:string;
     }
     export interface LineItemTax {  
+         /**
+          * @description The unique reference id of the line item for which the tax is applicable
+
+          */
+       
       line_item_id?:string;
        
+         /**
+          * @description The name of the tax applied
+
+          */
+       
       tax_name?:string;
        
+         /**
+          * @description The rate of tax used to calculate tax amount
+
+          */
+       
       tax_rate?:number;
        
+         /**
+          * @description Indicates if tax is applied only on a portion of the line item amount.
+
+          */
+       
       is_partial_tax_applied?:boolean;
        
+         /**
+          * @description Indicates the non-compliance tax that should not be reported to the jurisdiction.
+
+          */
+       
       is_non_compliance_tax?:boolean;
        
+         /**
+          * @description Indicates the actual portion of the line item amount that is taxable.
+
+          */
+       
       taxable_amount?:number;
        
+         /**
+          * @description The tax amount
+
+          */
+       
       tax_amount?:number;
        
+         /**
+          * @description The type of tax jurisdiction \* unincorporated - Combined tax of state and county. \* federal - The tax jurisdiction is a federal \* state - The tax jurisdiction is a state \* county - The tax jurisdiction is a county \* country - The tax jurisdiction is a country \* city - The tax jurisdiction is a city \* other - Jurisdictions other than the ones listed above. \* special - Special tax jurisdiction.
+
+          */
+       
       tax_juris_type?:'special' | 'country' | 'unincorporated' | 'other' | 'city' | 'federal' | 'county' | 'state';
        
+         /**
+          * @description The name of the tax jurisdiction
+
+          */
+       
       tax_juris_name?:string;
        
+         /**
+          * @description The tax jurisdiction code
+
+          */
+       
       tax_juris_code?:string;
        
+         /**
+          * @description Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
+
+          */
+       
       tax_amount_in_local_currency?:number;
        
+         /**
+          * @description The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.
+
+          */
+       
       local_currency_code?:string;
     }
   }

package/types/resources/QuotedCharge.d.ts

@@ -41,74 +41,244 @@ declare module 'chargebee' {
     
     
     export interface Charge {  
+         /**
+          * @description The amount to be charged. The unit depends on the [type of currency](/docs/api?prod_cat_ver=1#md_disabled).
+
+          */
+       
       amount?:number;
        
+         /**
+          * @description The decimal representation of the amount for the one-time charge. The value is in [major units of the currency](/docs/api#md_enabled). Applicable only when multi-decimal pricing is enabled.
+
+          */
+       
       amount_in_decimal?:string;
        
+         /**
+          * @description Description for this charge
+
+          */
+       
       description?:string;
        
+         /**
+          * @description Specifies the service period of the charge in days. When the quote is converted, the [invoice.line_item.date_from](/docs/api/invoices#invoice_line_items) is set to current date/time and `invoice.line_item.date_to` is set to `service_period_in_days` ahead of `date_from`.
+
+          */
+       
       service_period_in_days?:number;
        
+         /**
+          * @description Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. \* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer \* retail - Transaction is a sale to an end user \* consumed - Transaction is for an item that is consumed directly \* vendor_use - Transaction is for an item that is subject to vendor use tax
+
+          */
+       
       avalara_sale_type?:'consumed' | 'wholesale' | 'vendor_use' | 'retail';
        
+         /**
+          * @description Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration.
+
+          */
+       
       avalara_transaction_type?:number;
        
+         /**
+          * @description Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration.
+
+          */
+       
       avalara_service_type?:number;
     }
     export interface ItemPrice {  
+         /**
+          * @description A unique ID for your system to identify the item price.
+
+          */
+       
       item_price_id?:string;
        
+         /**
+          * @description Item price quantity
+
+          */
+       
       quantity?:number;
        
+         /**
+          * @description The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
+
+          */
+       
       quantity_in_decimal?:string;
        
+         /**
+          * @description The price or per-unit-price of the item price. By default, it is the [value set](/docs/api/item_prices#item_price_price) for the `item_price`. This is only applicable when the `pricing_model` of the `item_price` is `flat_fee` or `per_unit`. The value depends on the [type of currency](/docs/api/#handling_currency_units).
+
+          */
+       
       unit_price?:number;
        
+         /**
+          * @description The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
+
+          */
+       
       unit_price_in_decimal?:string;
        
+         /**
+          * @description Defines service period of the item in days from the day of charge.
+
+          */
+       
       service_period_days?:number;
     }
     export interface ItemTier {  
+         /**
+          * @description The id of the item price to which this tier belongs.
+
+          */
+       
       item_price_id?:string;
        
+         /**
+          * @description The lowest value in the quantity tier.
+
+          */
+       
       starting_unit?:number;
        
+         /**
+          * @description The highest value in the quantity tier.
+
+          */
+       
       ending_unit?:number;
        
+         /**
+          * @description The per-unit price for the tier when the `pricing_model` is `tiered` or `volume`. The total cost for the item price when the `pricing_model` is `stairstep`. The value is in the minor unit of the currency.
+
+          */
+       
       price?:number;
        
+         /**
+          * @description The decimal representation of the the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as `ending_unit_in_decimal` of the next lower tier. Returned only when the pricing_model is `tiered`, `volume` or `stairstep` and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
+
+          */
+       
       starting_unit_in_decimal?:string;
        
+         /**
+          * @description The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the `starting_unit_in_decimal` of the next higher tier. Returned only when the pricing_model is `tiered`, `volume` or `stairstep` and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
+
+          */
+       
       ending_unit_in_decimal?:string;
        
+         /**
+          * @description The decimal representation of the per-unit price for the tier when the `pricing_model` is `tiered` or `volume`. When the `pricing_model` is `stairstep`, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
+
+          */
+       
       price_in_decimal?:string;
        
+         /**
+          * @description The index number of the subscription to which the item price is added. Provide a unique number between `0` and `4` (inclusive) for each subscription that is to be created.
+
+          */
+       
       index?:number;
     }
     export interface Coupon {  
+         /**
+          * @description Used to uniquely identify the coupon
+
+          */
+       
       coupon_id?:string;
     }
     export interface Discount {  
+         /**
+          * @description An immutable unique id for the discount. It is always auto-generated.
+
+          */
+       
       id?:string;
        
+         /**
+          * @description The name of the discount as it should appear on customer-facing pages and documents such as [invoices](/docs/api/invoices?prod_cat_ver=2) and [hosted pages](/docs/api/hosted_pages?prod_cat_ver=2). This is auto-generated based on the `type`, `amount`, and `currency_code` of the discount. For example, it can be `10% off` or `10$ off`.
+
+          */
+       
       invoice_name?:string;
        
+         /**
+          * @description The type of discount. Possible value are: \* percentage - The specified percentage will be given as discount. \* fixed_amount - The specified amount will be given as discount.
+
+          */
+       
       type?:'fixed_amount' | 'percentage';
        
+         /**
+          * @description The percentage of the original amount that should be deducted from it. Only applicable when `discount.type` is percentage.
+
+          */
+       
       percentage?:number;
        
+         /**
+          * @description The value of the discount. [The format of this value](https://apidocs.chargebee.com/docs/api?prod_cat_ver=2#currencies) depends on the kind of currency. This is only applicable when `discount.type` is `fixed_amount`.
+
+          */
+       
       amount?:number;
        
+         /**
+          * @description The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) of the discount. This is only applicable when `discount.type` is `fixed_amount`.
+
+          */
+       
       currency_code?:string;
        
+         /**
+          * @description The amount on the invoice to which the discount is applied. \* invoice_amount - The discount is applied to the invoice `sub_total`. \* specific_item_price - The discount is applied to the `invoice.line_item.amount` that corresponds to the item price specified by `item_price_id`.
+
+          */
+       
       apply_on?:'specific_item_price' | 'invoice_amount';
        
+         /**
+          * @description The [id of the item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) in the subscription to which the discount is to be applied. Relevant only when `apply_on` = `specific_item_price`.
+
+          */
+       
       item_price_id?:string;
        
+         /**
+          * @description Timestamp indicating when this discount is created.
+
+          */
+       
       created_at?:number;
        
+         /**
+          * @description Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.  
+**Note:**
+
+
+When the coupon ID contains a special character; for example: `#`, the API returns an error.
+Make sure that you [encode](https://www.urlencoder.org/) the coupon ID in the path parameter before making an API call.
+
+          */
+       
       coupon_id?:string;
        
+         /**
+          * @description The index number of the subscription to which the item price is added. Provide a unique number between `0` and `4` (inclusive) for each subscription that is to be created.
+
+          */
+       
       index?:number;
     }
   }