chargebee 2.52.0 → 2.53.1

package/types/resources/HostedPage.d.ts

@@ -82,9 +82,9 @@ declare module 'chargebee' {
     }
     export interface CheckoutNewInputParam {
        
-      subscription:object;
+      subscription:{affiliate_token?:string,auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,id?:string,invoice_notes?:string,offline_payment_method?:OfflinePaymentMethod,plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,setup_fee?:number,start_date?:number,trial_end?:number};
        
-      customer?:object;
+      customer?:{company?:string,consolidated_invoicing?:boolean,email?:string,first_name?:string,id?:string,last_name?:string,locale?:string,phone?:string,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
        
       card?:{gateway?:Gateway,gateway_account_id?:string};
        
@@ -125,7 +125,7 @@ declare module 'chargebee' {
     }
     export interface CheckoutOneTimeInputParam {
        
-      customer?:object;
+      customer?:{company?:string,consolidated_invoicing?:boolean,email?:string,first_name?:string,id?:string,last_name?:string,locale?:string,phone?:string,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
        
       invoice?:{po_number?:string};
        
@@ -162,7 +162,7 @@ declare module 'chargebee' {
     }
     export interface CheckoutOneTimeForItemsInputParam {
        
-      customer?:object;
+      customer?:{company?:string,consolidated_invoicing?:boolean,einvoicing_method?:EinvoicingMethod,email?:string,entity_identifier_scheme?:string,entity_identifier_standard?:string,first_name?:string,id?:string,is_einvoice_enabled?:boolean,last_name?:string,locale?:string,phone?:string,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
        
       invoice?:{po_number?:string};
        
@@ -178,7 +178,7 @@ declare module 'chargebee' {
        
       charges?:{amount?:number,amount_in_decimal?:string,avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_tax_code?:string,avalara_transaction_type?:number,date_from?:number,date_to?:number,description?:string,hsn_code?:string,tax_profile_id?:string,taxable?:boolean,taxjar_product_code?:string}[];
        
-      discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
+      discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number,quantity?:number}[];
        
       entity_identifiers?:{id?:string,operation?:Operation,scheme?:string,standard?:string,value?:string}[];
        
@@ -205,9 +205,9 @@ declare module 'chargebee' {
     }
     export interface CheckoutNewForItemsInputParam {
        
-      subscription?:object;
+      subscription?:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,id?:string,invoice_notes?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
        
-      customer?:object;
+      customer?:{company?:string,einvoicing_method?:EinvoicingMethod,email?:string,entity_identifier_scheme?:string,entity_identifier_standard?:string,first_name?:string,id?:string,is_einvoice_enabled?:boolean,last_name?:string,locale?:string,phone?:string,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
        
       card?:{gateway?:Gateway,gateway_account_id?:string};
        
@@ -219,7 +219,7 @@ declare module 'chargebee' {
        
       subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
        
-      discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
+      discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number}[];
        
       item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
        
@@ -252,9 +252,9 @@ declare module 'chargebee' {
     }
     export interface CheckoutExistingInputParam {
        
-      subscription:object;
+      subscription:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,id:string,invoice_notes?:string,offline_payment_method?:OfflinePaymentMethod,plan_id?:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,setup_fee?:number,start_date?:number,trial_end?:number};
        
-      customer?:object;
+      customer?:{vat_number?:string,vat_number_prefix?:string};
        
       card?:{gateway?:Gateway,gateway_account_id?:string};
        
@@ -303,9 +303,9 @@ declare module 'chargebee' {
     }
     export interface CheckoutExistingForItemsInputParam {
        
-      subscription:object;
+      subscription:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,id:string,invoice_notes?:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number};
        
-      customer?:object;
+      customer?:{entity_identifier_scheme?:string,entity_identifier_standard?:string,is_einvoice_enabled?:boolean,vat_number?:string,vat_number_prefix?:string};
        
       card?:{gateway?:Gateway,gateway_account_id?:string};
        
@@ -313,7 +313,7 @@ declare module 'chargebee' {
        
       subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
        
-      discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
+      discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number}[];
        
       item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
        
@@ -446,7 +446,7 @@ declare module 'chargebee' {
        
       gifter?:{customer_id?:string};
        
-      subscription:object;
+      subscription:{coupon?:string,plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string};
        
       addons?:{id?:string,quantity?:number,quantity_in_decimal?:string}[];
        
@@ -510,7 +510,7 @@ declare module 'chargebee' {
       limit?:number;
        
       /**
-        * @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\` obtained 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' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         

package/types/resources/ImpactedCustomer.d.ts

@@ -0,0 +1,23 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+declare module 'chargebee' {
+  export interface ImpactedCustomer {
+    
+
+    action_type?:string;
+
+    download?:ImpactedCustomer.Download;
+
+  }
+  export namespace ImpactedCustomer {
+    
+    
+    export interface Download {  
+      download_url:string;
+       
+      valid_till:number;
+       
+      mime_type?:string;
+    }
+  }
+}

package/types/resources/Invoice.d.ts

@@ -6,44 +6,58 @@ declare module 'chargebee' {
 
     id:string;
 
-    po_number?:string;
-
     customer_id:string;
 
+    payment_owner?:string;
+
     subscription_id?:string;
 
     recurring:boolean;
 
     status:'paid' | 'posted' | 'payment_due' | 'not_paid' | 'voided' | 'pending';
 
-    vat_number?:string;
-
-    price_type:PriceType;
-
     date?:number;
 
     due_date?:number;
 
     net_term_days?:number;
 
+    po_number?:string;
+
+    vat_number?:string;
+
+    price_type:PriceType;
+
     exchange_rate?:number;
 
+    local_currency_exchange_rate?:number;
+
     currency_code:string;
 
-    total?:number;
+    local_currency_code?:string;
 
-    amount_paid?:number;
+    tax:number;
 
-    amount_adjusted?:number;
+    sub_total:number;
 
-    write_off_amount?:number;
+    sub_total_in_local_currency?:number;
 
-    credits_applied?:number;
+    total?:number;
+
+    total_in_local_currency?:number;
 
     amount_due?:number;
 
+    amount_adjusted?:number;
+
+    amount_paid?:number;
+
     paid_at?:number;
 
+    write_off_amount?:number;
+
+    credits_applied?:number;
+
     dunning_status?:'in_progress' | 'exhausted' | 'stopped' | 'success';
 
     next_retry_at?:number;
@@ -54,18 +68,6 @@ declare module 'chargebee' {
 
     updated_at?:number;
 
-    sub_total:number;
-
-    sub_total_in_local_currency?:number;
-
-    total_in_local_currency?:number;
-
-    local_currency_code?:string;
-
-    tax:number;
-
-    local_currency_exchange_rate?:number;
-
     first_invoice?:boolean;
 
     new_sales_amount?:number;
@@ -86,17 +88,21 @@ declare module 'chargebee' {
 
     line_items?:Invoice.LineItem[];
 
-    discounts?:Invoice.Discount[];
+    line_item_tiers?:Invoice.LineItemTier[];
 
     line_item_discounts?:Invoice.LineItemDiscount[];
 
-    taxes?:Invoice.Tax[];
-
     line_item_taxes?:Invoice.LineItemTax[];
 
     line_item_credits?:Invoice.LineItemCredit[];
 
-    line_item_tiers?:Invoice.LineItemTier[];
+    line_item_addresses?:Invoice.LineItemAddress[];
+
+    discounts?:Invoice.Discount[];
+
+    taxes?:Invoice.Tax[];
+
+    tax_origin?:Invoice.TaxOrigin;
 
     linked_payments?:Invoice.LinkedPayment[];
 
@@ -114,13 +120,11 @@ declare module 'chargebee' {
 
     shipping_address?:Invoice.ShippingAddress;
 
-    statement_descriptor?:Invoice.StatementDescriptor;
-
     billing_address?:Invoice.BillingAddress;
 
-    einvoice?:Invoice.Einvoice;
+    statement_descriptor?:Invoice.StatementDescriptor;
 
-    payment_owner?:string;
+    einvoice?:Invoice.Einvoice;
 
     void_reason_code?:string;
 
@@ -136,10 +140,6 @@ declare module 'chargebee' {
 
     site_details_at_creation?:Invoice.SiteDetailsAtCreation;
 
-    tax_origin?:Invoice.TaxOrigin;
-
-    line_item_addresses?:Invoice.LineItemAddress[];
-
   }
   export namespace Invoice {
     export class InvoiceResource {  
@@ -307,7 +307,7 @@ declare module 'chargebee' {
        
       tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
        
-      discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
+      discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number,quantity?:number}[];
        
       customer_id?:string;
        
@@ -476,7 +476,7 @@ declare module 'chargebee' {
        
       shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
        
-      line_items:{amount?:number,amount_in_decimal?:string,created_at?:number,date_from?:number,date_to?:number,description:string,entity_id?:string,entity_type?:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price',id?:string,item_level_discount1_amount?:number,item_level_discount1_entity_id?:string,item_level_discount2_amount?:number,item_level_discount2_entity_id?:string,quantity?:number,quantity_in_decimal?:string,subscription_id?:string,tax10_amount?:number,tax10_name?:string,tax1_amount?:number,tax1_name?:string,tax2_amount?:number,tax2_name?:string,tax3_amount?:number,tax3_name?:string,tax4_amount?:number,tax4_name?:string,tax5_amount?:number,tax5_name?:string,tax6_amount?:number,tax6_name?:string,tax7_amount?:number,tax7_name?:string,tax8_amount?:number,tax8_name?:string,tax9_amount?:number,tax9_name?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
+      line_items:{amount?:number,amount_in_decimal?:string,created_at?:number,date_from?:number,date_to?:number,description:string,entity_id?:string,entity_type?:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan_setup' | 'plan' | 'addon',id?:string,item_level_discount1_amount?:number,item_level_discount1_entity_id?:string,item_level_discount2_amount?:number,item_level_discount2_entity_id?:string,quantity?:number,quantity_in_decimal?:string,subscription_id?:string,tax10_amount?:number,tax10_name?:string,tax1_amount?:number,tax1_name?:string,tax2_amount?:number,tax2_name?:string,tax3_amount?:number,tax3_name?:string,tax4_amount?:number,tax4_name?:string,tax5_amount?:number,tax5_name?:string,tax6_amount?:number,tax6_name?:string,tax7_amount?:number,tax7_name?:string,tax8_amount?:number,tax8_name?:string,tax9_amount?:number,tax9_name?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
        
       payment_reference_numbers:{id?:string,number:string,type:'kid' | 'ocr' | 'frn' | 'fik' | 'swiss_reference'}[];
        
@@ -486,9 +486,9 @@ declare module 'chargebee' {
        
       taxes:{amount?:number,description?:string,juris_code?:string,juris_name?:string,juris_type?:'country' | 'federal' | 'state' | 'county' | 'city' | 'special' | 'unincorporated' | 'other',name:string,rate:number}[];
        
-      payments:{amount:number,date?:number,payment_method:PaymentMethod,reference_number?:string}[];
+      payments:{amount:number,date?:number,id?:string,payment_method:PaymentMethod,reference_number?:string}[];
        
-      notes?:{entity_id?:string,entity_type?:'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price',note?:string}[];
+      notes?:{entity_id?:string,entity_type?:'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan' | 'addon',note?:string}[];
        
       line_item_addresses?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,line_item_id?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string}[];
        
@@ -580,7 +580,7 @@ declare module 'chargebee' {
       limit?:number;
        
       /**
-        * @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\` obtained 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' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         
@@ -753,7 +753,7 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
       limit?:number;
        
       /**
-        * @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\` obtained 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' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         
@@ -774,7 +774,7 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
       limit?:number;
        
       /**
-        * @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\` obtained 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' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         
@@ -813,7 +813,7 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
       limit?:number;
        
       /**
-        * @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\` obtained 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' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         
@@ -1122,18 +1122,28 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
        
       customer_id?:string;
     }
-    export interface Discount {  
-      amount:number;
+    export interface LineItemTier {  
+      line_item_id?:string;
        
-      description?:string;
+      starting_unit:number;
        
-      entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
+      ending_unit?:number;
        
-      discount_type?:'fixed_amount' | 'percentage';
+      quantity_used:number;
        
-      entity_id?:string;
+      unit_amount:number;
        
-      coupon_set_code?:string;
+      starting_unit_in_decimal?:string;
+       
+      ending_unit_in_decimal?:string;
+       
+      quantity_used_in_decimal?:string;
+       
+      unit_amount_in_decimal?:string;
+       
+      pricing_type?:'per_unit' | 'flat_fee' | 'package';
+       
+      package_size?:number;
     }
     export interface LineItemDiscount {  
       line_item_id:string;
@@ -1146,13 +1156,6 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
        
       discount_amount:number;
     }
-    export interface Tax {  
-      name:string;
-       
-      amount:number;
-       
-      description?:string;
-    }
     export interface LineItemTax {  
       line_item_id?:string;
        
@@ -1191,28 +1194,61 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
        
       line_item_id?:string;
     }
-    export interface LineItemTier {  
+    export interface LineItemAddress {  
       line_item_id?:string;
        
-      starting_unit:number;
+      first_name?:string;
        
-      ending_unit?:number;
+      last_name?:string;
        
-      quantity_used:number;
+      email?:string;
        
-      unit_amount:number;
+      company?:string;
        
-      starting_unit_in_decimal?:string;
+      phone?:string;
        
-      ending_unit_in_decimal?:string;
+      line1?:string;
        
-      quantity_used_in_decimal?:string;
+      line2?:string;
        
-      unit_amount_in_decimal?:string;
+      line3?:string;
        
-      pricing_type?:'per_unit' | 'flat_fee' | 'package';
+      city?:string;
        
-      package_size?:number;
+      state_code?:string;
+       
+      state?:string;
+       
+      country?:string;
+       
+      zip?:string;
+       
+      validation_status?:'not_validated' | 'valid' | 'partially_valid' | 'invalid';
+    }
+    export interface Discount {  
+      amount:number;
+       
+      description?:string;
+       
+      entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
+       
+      discount_type?:'fixed_amount' | 'percentage';
+       
+      entity_id?:string;
+       
+      coupon_set_code?:string;
+    }
+    export interface Tax {  
+      name:string;
+       
+      amount:number;
+       
+      description?:string;
+    }
+    export interface TaxOrigin {  
+      country?:string;
+       
+      registration_number?:string;
     }
     export interface LinkedPayment {  
       txn_id:string;
@@ -1338,11 +1374,6 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
        
       index:number;
     }
-    export interface StatementDescriptor {  
-      id:string;
-       
-      descriptor?:string;
-    }
     export interface BillingAddress {  
       first_name?:string;
        
@@ -1372,6 +1403,11 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
        
       validation_status?:ValidationStatus;
     }
+    export interface StatementDescriptor {  
+      id:string;
+       
+      descriptor?:string;
+    }
     export interface Einvoice {  
       id:string;
        
@@ -1386,41 +1422,5 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
        
       organization_address?:object;
     }
-    export interface TaxOrigin {  
-      country?:string;
-       
-      registration_number?:string;
-    }
-    export interface LineItemAddress {  
-      line_item_id?:string;
-       
-      first_name?:string;
-       
-      last_name?:string;
-       
-      email?:string;
-       
-      company?:string;
-       
-      phone?:string;
-       
-      line1?:string;
-       
-      line2?:string;
-       
-      line3?:string;
-       
-      city?:string;
-       
-      state_code?:string;
-       
-      state?:string;
-       
-      country?:string;
-       
-      zip?:string;
-       
-      validation_status?:'not_validated' | 'valid' | 'partially_valid' | 'invalid';
-    }
   }
 }

package/types/resources/Item.d.ts

@@ -192,7 +192,7 @@ declare module 'chargebee' {
       limit?:number;
        
       /**
-        * @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\` obtained 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' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         

package/types/resources/ItemEntitlement.d.ts

@@ -44,7 +44,7 @@ declare module 'chargebee' {
       limit?:number;
        
       /**
-        * @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\` obtained 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' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         
@@ -69,7 +69,7 @@ declare module 'chargebee' {
       limit?:number;
        
       /**
-        * @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\` obtained 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' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         

package/types/resources/ItemFamily.d.ts

@@ -67,7 +67,7 @@ declare module 'chargebee' {
       limit?:number;
        
       /**
-        * @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\` obtained 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' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         

package/types/resources/ItemPrice.d.ts

@@ -260,7 +260,7 @@ declare module 'chargebee' {
       limit?:number;
        
       /**
-        * @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\` obtained 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' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         
@@ -405,7 +405,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
       limit?:number;
        
       /**
-        * @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\` obtained 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' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         
@@ -428,7 +428,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
       limit?:number;
        
       /**
-        * @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\` obtained 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' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */