chargebee 2.51.0 → 2.52.0

package/types/resources/TimeMachine.d.ts

@@ -1,80 +1,30 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface TimeMachine {
     
-    /**
-      * @description The name of the time machine. Currently only **delorean** is allowed
 
-      */
-    
     name:string;
-    
-    /**
-      * @description The current status of time travel \* succeeded - Time travel has succeeded. \* not_enabled - Time travel has not been enabled for the site \* failed - Time travel has failed. Check the failure code and failure reason attributes for further details.  
-**Note:** The time machine needs to be reset by starting afresh again. \* in_progress - Time travel is in progress
 
-      */
-    
-    time_travel_status:'in_progress' | 'not_enabled' | 'failed' | 'succeeded';
-    
-    /**
-      * @description The start time of the time machine. Specified when &#x27;starting afresh&#x27;
+    time_travel_status:'not_enabled' | 'in_progress' | 'succeeded' | 'failed';
 
-      */
-    
     genesis_time:number;
-    
-    /**
-      * @description The destination time to which the time machine is travelling (or has traveled)
 
-      */
-    
     destination_time:number;
-    
-    /**
-      * @description The failure code. This will follow the api error code convention
 
-      */
-    
     failure_code?:string;
-    
-    /**
-      * @description The more descriptive failure reason.
 
-      */
-    
     failure_reason?:string;
-    
-    /**
-      * @description The failure details as error json.
 
-      */
-    
     error_json?:string;
+
   }
   export namespace TimeMachine {
     export class TimeMachineResource {  
-      /**
-        * @description Retrieves the time machine. Currently only one time machine is available per site and is named &#x27;delorean&#x27;.
-
-        */
-      
       retrieve(time_machine_name:string):ChargebeeRequest<RetrieveResponse>;
        
-      /**
-        * @description Restart the time machine. This will clear the &quot;customer&quot; data like customer details, subscriptions, invoices, transactions. Also a time travel is initiated to travel back to specified genesis time.
-
-**Note:** This API call is asynchronous. You need to check if the &quot;start afresh&quot; operation has completed by checking if the time travel status is **successful** by retrieving the time machine in a loop with a minimum delay of 3 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for time travel completion** function provided as a instance method in the library. Use method **waitForTimeTravelCompletion()** on the returned **time_machine** resource which will block until the time travel completes. Use method **waitForTimeTravelCompletion()** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes. Use method **WaitForTimeTravelCompletion** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes. Use method **waitForTimeTravelCompletion** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes.
-
-        */
-      
       start_afresh(time_machine_name:string, input?:StartAfreshInputParam):ChargebeeRequest<StartAfreshResponse>;
        
-      /**
-        * @description Travel forward in time. This operation is **asynchronous** . You need to check if the &quot;start afresh&quot; operation has completed by checking if the time travel status is **successful** by retrieving the time machine in a loop with a minimum delay of 3 secs between two retrieve requests. Use method **waitForTimeTravelCompletion()** on the returned time_machine resource which will block until the time travel completes.
-
-        */
-      
       travel_forward(time_machine_name:string, input?:TravelForwardInputParam):ChargebeeRequest<TravelForwardResponse>;
     }
     export interface RetrieveResponse {  
@@ -86,12 +36,6 @@ declare module 'chargebee' {
     }
     export interface StartAfreshInputParam {
        
-      /**
-        * @description The genesis time to travel back as part of the reset operation. If not provided, then the travel is set to 6 months in the past.   
-**Note:** Can only be in the past.
-
-        */
-       
       genesis_time?:number;
     }
     export interface TravelForwardResponse {  
@@ -99,11 +43,6 @@ declare module 'chargebee' {
     }
     export interface TravelForwardInputParam {
        
-      /**
-        * @description The **time** to travel to. Should be between the &#x27;current&#x27; destination time of the time machine and present time.
-
-        */
-       
       destination_time?:number;
     }
     

package/types/resources/Token.d.ts

@@ -1,89 +1,32 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface Token {
     
-    /**
-      * @description Identifier of the Chargebee Token
 
-      */
-    
     id:string;
-    
-    /**
-      * @description Name of the gateway this token is stored in. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* eway - eWAY Account is a payment gateway. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* global_payments - Global Payments is a payment service provider. \* amazon_payments - Amazon Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* worldpay - WorldPay is a payment gateway \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* sage_pay - Sage Pay is a payment gateway. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* stripe - Stripe is a payment gateway. \* vantiv - Vantiv is a payment gateway. \* moneris - Moneris is a payment gateway. \* chargebee - Chargebee test gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* cybersource - CyberSource is a payment gateway.
 
-      */
-    
     gateway:Gateway;
-    
-    /**
-      * @description The gateway account in which this token is stored.
 
-      */
-    
     gateway_account_id:string;
-    
-    /**
-      * @description Type of payment method of the token. \* google_pay - Payments made via Google Pay. \* apple_pay - Payments made via Apple Pay. \* unionpay - Payments made via UnionPay. \* ideal - Payments made via iDEAL. \* bancontact - Payments made via Bancontact Card. \* netbanking_emandates - Netbanking (eMandates) Payments. \* alipay - Payments made via Alipay. \* dotpay - Payments made via Dotpay. \* giropay - Payments made via giropay. \* sofort - Payments made via Sofort. \* direct_debit - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* paypal_express_checkout - Payments made via PayPal Express Checkout. \* amazon_payments - Payments made via Amazon Payments. \* card - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* upi - UPI Payments. \* generic - Payments made via Generic Payment Method. \* wechat_pay - Payments made via WeChat Pay.
 
-      */
-    
     payment_method_type:PaymentMethodType;
-    
-    /**
-      * @description Status of the token \* new - new \* consumed - The token is already used \* expired - expired
 
-      */
-    
-    status:'consumed' | 'new' | 'expired';
-    
-    /**
-      * @description The id with which this token is referred in gateway
+    status:'new' | 'expired' | 'consumed';
 
-      */
-    
     id_at_vault:string;
-    
-    /**
-      * @description Name of the gateway/vault provider where the payment method is tokenized \* gateway - gateway \* spreedly - spreedly
 
-      */
-    
     vault:'spreedly' | 'gateway';
-    
-    /**
-      * @description The IP address from where the token is created. Used primarily for EU VAT validation.
 
-      */
-    
     ip_address?:string;
-    
-    /**
-      * @description Version number of this resource. The &#x60;resource_version&#x60; is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
 
-      */
-    
     resource_version?:number;
-    
-    /**
-      * @description Timestamp indicating when this token resource was last updated.
 
-      */
-    
     updated_at?:number;
-    
-    /**
-      * @description Timestamp indicating when this token resource is created.
 
-      */
-    
     created_at:number;
-    
-    /**
-      * @description Timestamp indicating when this token is expired
 
-      */
-    
     expired_at?:number;
+
   }
 }

package/types/resources/Transaction.d.ts

@@ -236,14 +236,14 @@ declare module 'chargebee' {
 
         */
         
-      payment_method?:{in?:string,is?:'card' | 'cash' | 'check' | 'chargeback' | 'bank_transfer' | 'amazon_payments' | 'paypal_express_checkout' | 'direct_debit' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ach_credit' | 'sepa_credit' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'other' | 'upi' | 'netbanking_emandates' | 'custom' | 'boleto' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland',is_not?:'card' | 'cash' | 'check' | 'chargeback' | 'bank_transfer' | 'amazon_payments' | 'paypal_express_checkout' | 'direct_debit' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ach_credit' | 'sepa_credit' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'other' | 'upi' | 'netbanking_emandates' | 'custom' | 'boleto' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland',not_in?:string};
+      payment_method?:{in?:string,is?:'card' | 'cash' | 'check' | 'chargeback' | 'bank_transfer' | 'amazon_payments' | 'paypal_express_checkout' | 'direct_debit' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ach_credit' | 'sepa_credit' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'other' | 'upi' | 'netbanking_emandates' | 'custom' | 'boleto' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',is_not?:'card' | 'cash' | 'check' | 'chargeback' | 'bank_transfer' | 'amazon_payments' | 'paypal_express_checkout' | 'direct_debit' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ach_credit' | 'sepa_credit' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'other' | 'upi' | 'netbanking_emandates' | 'custom' | 'boleto' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',not_in?:string};
        
       /**
         * @description Gateway through which this transaction was done. Applicable only for 'Card' Payment Method
 
         */
         
-      gateway?:{in?:string,is?:'chargebee' | 'chargebee_payments' | 'adyen' | 'stripe' | 'wepay' | 'braintree' | 'authorize_net' | 'paypal_pro' | 'pin' | 'eway' | 'eway_rapid' | 'worldpay' | 'balanced_payments' | 'beanstream' | 'bluepay' | 'elavon' | 'first_data_global' | 'hdfc' | 'migs' | 'nmi' | 'ogone' | 'paymill' | 'paypal_payflow_pro' | 'sage_pay' | 'tco' | 'wirecard' | 'amazon_payments' | 'paypal_express_checkout' | 'gocardless' | 'orbital' | 'moneris_us' | 'moneris' | 'bluesnap' | 'cybersource' | 'vantiv' | 'checkout_com' | 'paypal' | 'ingenico_direct' | 'exact' | 'mollie' | 'quickbooks' | 'razorpay' | 'global_payments' | 'bank_of_america' | 'ecentric' | 'metrics_global' | 'windcave' | 'pay_com' | 'ebanx' | 'dlocal' | 'nuvei' | 'paystack' | 'jp_morgan' | 'not_applicable',is_not?:'chargebee' | 'chargebee_payments' | 'adyen' | 'stripe' | 'wepay' | 'braintree' | 'authorize_net' | 'paypal_pro' | 'pin' | 'eway' | 'eway_rapid' | 'worldpay' | 'balanced_payments' | 'beanstream' | 'bluepay' | 'elavon' | 'first_data_global' | 'hdfc' | 'migs' | 'nmi' | 'ogone' | 'paymill' | 'paypal_payflow_pro' | 'sage_pay' | 'tco' | 'wirecard' | 'amazon_payments' | 'paypal_express_checkout' | 'gocardless' | 'orbital' | 'moneris_us' | 'moneris' | 'bluesnap' | 'cybersource' | 'vantiv' | 'checkout_com' | 'paypal' | 'ingenico_direct' | 'exact' | 'mollie' | 'quickbooks' | 'razorpay' | 'global_payments' | 'bank_of_america' | 'ecentric' | 'metrics_global' | 'windcave' | 'pay_com' | 'ebanx' | 'dlocal' | 'nuvei' | 'paystack' | 'jp_morgan' | 'not_applicable',not_in?:string};
+      gateway?:{in?:string,is?:'chargebee' | 'chargebee_payments' | 'adyen' | 'stripe' | 'wepay' | 'braintree' | 'authorize_net' | 'paypal_pro' | 'pin' | 'eway' | 'eway_rapid' | 'worldpay' | 'balanced_payments' | 'beanstream' | 'bluepay' | 'elavon' | 'first_data_global' | 'hdfc' | 'migs' | 'nmi' | 'ogone' | 'paymill' | 'paypal_payflow_pro' | 'sage_pay' | 'tco' | 'wirecard' | 'amazon_payments' | 'paypal_express_checkout' | 'gocardless' | 'orbital' | 'moneris_us' | 'moneris' | 'bluesnap' | 'cybersource' | 'vantiv' | 'checkout_com' | 'paypal' | 'ingenico_direct' | 'exact' | 'mollie' | 'quickbooks' | 'razorpay' | 'global_payments' | 'bank_of_america' | 'ecentric' | 'metrics_global' | 'windcave' | 'pay_com' | 'ebanx' | 'dlocal' | 'nuvei' | 'solidgate' | 'paystack' | 'jp_morgan' | 'not_applicable',is_not?:'chargebee' | 'chargebee_payments' | 'adyen' | 'stripe' | 'wepay' | 'braintree' | 'authorize_net' | 'paypal_pro' | 'pin' | 'eway' | 'eway_rapid' | 'worldpay' | 'balanced_payments' | 'beanstream' | 'bluepay' | 'elavon' | 'first_data_global' | 'hdfc' | 'migs' | 'nmi' | 'ogone' | 'paymill' | 'paypal_payflow_pro' | 'sage_pay' | 'tco' | 'wirecard' | 'amazon_payments' | 'paypal_express_checkout' | 'gocardless' | 'orbital' | 'moneris_us' | 'moneris' | 'bluesnap' | 'cybersource' | 'vantiv' | 'checkout_com' | 'paypal' | 'ingenico_direct' | 'exact' | 'mollie' | 'quickbooks' | 'razorpay' | 'global_payments' | 'bank_of_america' | 'ecentric' | 'metrics_global' | 'windcave' | 'pay_com' | 'ebanx' | 'dlocal' | 'nuvei' | 'solidgate' | 'paystack' | 'jp_morgan' | 'not_applicable',not_in?:string};
        
       /**
         * @description The gateway account used for this transaction

package/types/resources/Usage.d.ts

@@ -3,128 +3,42 @@
 declare module 'chargebee' {
   export interface Usage {
     
-    /**
-      * @description A unique and immutable id for the usage. If not provided, it is autogenerated.
 
-      */
-    
     id?:string;
-    
-    /**
-      * @description The time at which this usage occurred. Chargebee bills only those usages whose `usage_date` falls within a time when the subscription `status` was `active` or `non_renewing`. However, the remaining usage records are still stored and are [retrievable](/docs/api/usages?prod_cat_ver=2#retrieve_a_usage).   
-**Note:** If `usage_date` corresponds to a time already invoiced, then it is stored but never invoiced unless the [invoice is regenerated](/docs/api/subscriptions?prod_cat_ver=2#regenerate_an_invoice).
 
-      */
-    
     usage_date:number;
-    
-    /**
-      * @description The id of the [subscription](/docs/api/subscriptions?prod_cat_ver=2) to which this usage record belongs.
 
-      */
-    
     subscription_id:string;
-    
-    /**
-      * @description The id of the [item price](/docs/api/item_prices?prod_cat_ver=2) to which this usage belongs. The item price must be a part of the subscription or should have been part of it historically.
 
-      */
-    
     item_price_id:string;
-    
-    /**
-      * @description When the usage has been invoiced, this is the `id` of the [invoice](/docs/api/invoices?prod_cat_ver=2). This is cleared when the invoice is `voided` or deleted.
 
-      */
-    
     invoice_id?:string;
-    
-    /**
-      * @description When the usage has been invoiced, this is the `id` of the [invoice.line_item](/docs/api/invoices?prod_cat_ver=2#invoice_line_items) that the usage is for. This is cleared when the invoice is [voided](/docs/api/invoices?prod_cat_ver=2#void_an_invoice) or [deleted](/docs/api/invoices?prod_cat_ver=2#delete_an_invoice).
 
-      */
-    
     line_item_id?:string;
-    
-    /**
-      * @description The quantity specified for this usage record.
 
-      */
-    
     quantity:string;
-    
-    /**
-      * @description The source from which the usage record was created. \* admin_console - Operation made through the Chargebee admin UI \* api - Operation made through the API \* bulk_operation - Operation that are triggerd through bulk operation.
 
-      */
-    
     source?:Source;
-    
-    /**
-      * @description A note for this usage record. This appears against the usage on the Chargebee UI. This note is not displayed on any customer-facing document or interface such as [invoice PDFs](/docs/api/invoices?prod_cat_ver=2#retrieve_invoice_as_pdf) or [Hosted Pages](/docs/api/hosted_pages?prod_cat_ver=2).
 
-      */
-    
     note?:string;
-    
-    /**
-      * @description Version number of this resource. The `resource_version` is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
 
-      */
-    
     resource_version?:number;
-    
-    /**
-      * @description Timestamp indicating when this usage resource was last updated.
 
-      */
-    
     updated_at?:number;
-    
-    /**
-      * @description Timestamp indicating when the item was created.
 
-      */
-    
     created_at:number;
+
   }
   export namespace Usage {
     export class UsageResource {  
-      /**
-        * @description Creates a usage record for an item price in a subscription. The item price must belong to a [metered](/docs/api/items?prod_cat_ver=2#item_metered) item.  
-**Max Usages**   
-The maximum number of usages that can be recorded for the entire lifetime of a subscription is 5000. [Contact Support](https://chargebee.freshdesk.com/support/home) if you want this limit to be increased for your site.
-
-        */
-      
       create(subscription_id:string, input:CreateInputParam):ChargebeeRequest<CreateResponse>;
        
-      /**
-        * @description Retrieves a usage record of a specific subscription.
-
-        */
-      
       retrieve(subscription_id:string, input:RetrieveInputParam):ChargebeeRequest<RetrieveResponse>;
        
-      /**
-        * @description Deletes a usage record. This operation cannot be invoked for a usage record that has been [invoiced](usages?prod_cat_ver&#x3D;2#invoicing_usages).
-
-        */
-      
       delete(subscription_id:string, input:DeleteInputParam):ChargebeeRequest<DeleteResponse>;
        
-      /**
-        * @description Retrieves the list of usages.
-
-        */
-      
-      list(input:ListInputParam):ChargebeeRequest<ListResponse>;
+      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
        
-      /**
-        * @description Retrieves usages record for an invoice in PDF file format.
-
-        */
-      
       pdf(input:PdfInputParam):ChargebeeRequest<PdfResponse>;
     }
     export interface CreateResponse {  
@@ -132,39 +46,15 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
     }
     export interface CreateInputParam {
        
-      /**
-        * @description A unique and immutable id for the usage. If not provided, it is autogenerated.
-
-        */
-       
       id?:string;
        
-      /**
-        * @description The id of the [item price](/docs/api/item_prices?prod_cat_ver&#x3D;2) to which this usage belongs. The item price must be a part of the subscription or should have been part of it historically.
-
-        */
-       
       item_price_id:string;
        
-      /**
-        * @description The quantity specified for this usage record.
-
-        */
-       
       quantity:string;
        
-      /**
-        * @description The time at which this usage occurred. Chargebee bills only those usages whose &#x60;usage_date&#x60; falls within a time when the subscription &#x60;status&#x60; was &#x60;active&#x60; or &#x60;non_renewing&#x60;. However, the remaining usage records are still stored and are [retrievable](/docs/api/usages?prod_cat_ver&#x3D;2#retrieve_a_usage).   
-**Note:** If &#x60;usage_date&#x60; corresponds to a time already invoiced, then it is stored but never invoiced unless the [invoice is regenerated](/docs/api/subscriptions?prod_cat_ver&#x3D;2#regenerate_an_invoice).
-
-        */
-       
       usage_date:number;
        
-      /**
-        * @description A note for this usage record. This appears against the usage on the Chargebee UI. This note is not displayed on any customer-facing document or interface such as [invoice PDFs](/docs/api/invoices?prod_cat_ver&#x3D;2#retrieve_invoice_as_pdf) or [Hosted Pages](/docs/api/hosted_pages?prod_cat_ver&#x3D;2).
-
-        */
+      dedupe_option?:DedupeOption;
        
       note?:string;
     }
@@ -173,11 +63,6 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
     }
     export interface RetrieveInputParam {
        
-      /**
-        * @description Retrieves a usage record of a specific subscription.
-
-        */
-        
       id:string;
     }
     export interface DeleteResponse {  
@@ -185,118 +70,89 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
     }
     export interface DeleteInputParam {
        
-      /**
-        * @description A unique and immutable id for the usage. If not provided, it is autogenerated.
-
-        */
-       
       id:string;
     }
     export interface ListResponse {  
-      /**
-        * @description Retrieves the list of usages.
-
-        */
-       
        list:{usage:Usage}[];
        
-      /**
-        * @description Retrieves the list of usages.
-
-        */
-       
        next_offset?:string;
     }
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description Retrieves the list of usages.
+        * @description The number of resources to be returned.
 
         */
         
       limit?:number;
        
       /**
-        * @description Retrieves the list of usages.
+        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
 
         */
         
       offset?:string;
        
       /**
-        * @description Retrieves the list of usages.
+        * @description A unique and immutable id for the usage. If not provided, it is autogenerated.
 
         */
         
       id?:{is?:string,is_not?:string,starts_with?:string};
        
       /**
-        * @description Retrieves the list of usages.
+        * @description The id of the [subscription](/docs/api/subscriptions?prod_cat_ver&#x3D;2) to which this usage record belongs.
 
         */
         
-      subscription_id:{is?:string,is_not?:string,starts_with?:string};
+      subscription_id?:{is?:string,is_not?:string,starts_with?:string};
        
       /**
-        * @description Retrieves the list of usages.
+        * @description The time at which this usage occurred. Chargebee bills only those usages whose &#x60;usage_date&#x60; falls within a time when the subscription &#x60;status&#x60; was &#x60;active&#x60; or &#x60;non_renewing&#x60;. However, the remaining usage records are still stored and are [retrievable](/docs/api/usages?prod_cat_ver&#x3D;2#retrieve_a_usage).   
+**Note:** If &#x60;usage_date&#x60; corresponds to a time already invoiced, then it is stored but never invoiced unless the [invoice is regenerated](/docs/api/subscriptions?prod_cat_ver&#x3D;2#regenerate_an_invoice).
 
         */
         
       usage_date?:{after?:string,before?:string,between?:string,on?:string};
        
       /**
-        * @description Retrieves the list of usages.
+        * @description Indicates the date at which this credit note is last updated.
 
         */
         
-      item_price_id?:{is?:string,is_not?:string,starts_with?:string};
+      updated_at?:{after?:string,before?:string,between?:string,on?:string};
        
       /**
-        * @description Retrieves the list of usages.
+        * @description The id of the [item price](/docs/api/item_prices?prod_cat_ver&#x3D;2) to which this usage belongs. The item price must be a part of the subscription or should have been part of it historically.
 
         */
         
-      invoice_id?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string};
+      item_price_id?:{is?:string,is_not?:string,starts_with?:string};
        
       /**
-        * @description Retrieves the list of usages.
+        * @description When the usage has been invoiced, this is the &#x60;id&#x60; of the [invoice](/docs/api/invoices?prod_cat_ver&#x3D;2). This is cleared when the invoice is &#x60;voided&#x60; or deleted.
 
         */
         
-      source?:{in?:string,is?:'admin_console' | 'bulk_operation' | 'api',is_not?:'admin_console' | 'bulk_operation' | 'api',not_in?:string};
+      invoice_id?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string};
        
       /**
-        * @description Retrieves the list of usages.
-
-        */
-        
-      sort_by?:{asc?:'usage_date',desc?:'usage_date'};
-      
-       /**
-        * @description Indicates the date at which this credit note is last updated.
+        * @description The source from which the usage record was created.
 
         */
         
-       updated_at?:{after?:string,before?:string,between?:string,on?:string};
+      source?:{in?:string,is?:'admin_console' | 'api' | 'bulk_operation',is_not?:'admin_console' | 'api' | 'bulk_operation',not_in?:string};
+       
+      sort_by?:{asc?:'usage_date' | 'updated_at',desc?:'usage_date' | 'updated_at'};
     }
     export interface PdfResponse {  
        download:Download;
     }
     export interface PdfInputParam {
        
-      /**
-        * @description Determines the pdf should be rendered as inline or attachment in the browser. \* attachment - PDF is rendered as attachment in the browser \* inline - PDF is rendered as inline in the browser
-
-        */
+      invoice:{id:string};
        
       disposition_type?:DispositionType;
-       
-      /**
-        * @description Parameters for invoice
-
-        */
-       
-      invoice:{id:string};
     }
     
   }