chargebee 2.28.0 → 2.30.0

package/types/resources/PromotionalCredit.d.ts

@@ -89,18 +89,13 @@ declare module 'chargebee' {
   export namespace PromotionalCredit {
     export class PromotionalCreditResource {  
       /**
-        * @description This endpoint retrieves the promotional credit based on the promotional credit id
+        * @description This API call can be used to add promotional credits to a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
 
-        */
-      
-      retrieve(account_credit_id:string):ChargebeeRequest<RetrieveResponse>;
-       
-      /**
-        * @description This endpoint lists the promotional credits set for a customer
+For example, if a customer has credits of $10, if you pass the **amount** as $10, then the customer&#x27;s credit balance would become $20.
 
         */
       
-      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+      add(input:AddInputParam):ChargebeeRequest<AddResponse>;
        
       /**
         * @description This API call can be used to deduct promotional credits for a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
@@ -123,76 +118,74 @@ For example, if a customer has a credit balance of $10 and if you would like to
       set(input:SetInputParam):ChargebeeRequest<SetResponse>;
        
       /**
-        * @description This API call can be used to add promotional credits to a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
+        * @description This endpoint lists the promotional credits set for a customer
 
-For example, if a customer has credits of $10, if you pass the **amount** as $10, then the customer&#x27;s credit balance would become $20.
+        */
+      
+      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+       
+      /**
+        * @description This endpoint retrieves the promotional credit based on the promotional credit id
 
         */
       
-      add(input:AddInputParam):ChargebeeRequest<AddResponse>;
+      retrieve(account_credit_id:string):ChargebeeRequest<RetrieveResponse>;
     }
-    export interface RetrieveResponse {  
+    export interface AddResponse {  
+       customer:Customer;
+       
        promotional_credit:PromotionalCredit;
     }
-    
-    export interface ListResponse {  
+    export interface AddInputParam {
+       
       /**
-        * @description This endpoint lists the promotional credits set for a customer
+        * @description Identifier of the customer.
 
         */
        
-       list:{promotional_credit:PromotionalCredit}[];
+      customer_id:string;
        
       /**
-        * @description This endpoint lists the promotional credits set for a customer
+        * @description Promotional credits amount.
 
         */
        
-       next_offset?:string;
-    }
-    export interface ListInputParam {
-      [key : string]: any;  
-      /**
-        * @description The number of resources to be returned.
-
-        */
-        
-      limit?:number;
+      amount?:number;
        
       /**
-        * @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.
+        * @description Amount in decimal.
 
         */
-        
-      offset?:string;
+       
+      amount_in_decimal?:string;
        
       /**
-        * @description Unique reference ID provided for promotional credits
+        * @description The currency code (ISO 4217 format) for promotional credit.
 
         */
-        
-      id?:{is?:string,is_not?:string,starts_with?:string};
+       
+      currency_code?:string;
        
       /**
-        * @description Timestamp indicating when this promotional credit resource is created.
+        * @description Detailed description of this promotional credits.
 
         */
-        
-      created_at?:{after?:string,before?:string,between?:string,on?:string};
+       
+      description:string;
        
       /**
-        * @description Type of promotional credits
+        * @description Type of promotional credits provided to customer. \* general - General \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits
 
         */
-        
-      type?:{in?:string,is?:'decrement' | 'increment',is_not?:'decrement' | 'increment',not_in?:string};
+       
+      credit_type?:CreditType;
        
       /**
-        * @description Identifier of the customer.
+        * @description Describes why promotional credits were provided.
 
         */
-        
-      customer_id?:{is?:string,is_not?:string,starts_with?:string};
+       
+      reference?:string;
     }
     export interface DeductResponse {  
        customer:Customer;
@@ -306,62 +299,69 @@ For example, if a customer has credits of $10, if you pass the **amount** as $10
        
       reference?:string;
     }
-    export interface AddResponse {  
-       customer:Customer;
-       
-       promotional_credit:PromotionalCredit;
-    }
-    export interface AddInputParam {
-       
+    export interface ListResponse {  
       /**
-        * @description Identifier of the customer.
+        * @description This endpoint lists the promotional credits set for a customer
 
         */
        
-      customer_id:string;
+       list:{promotional_credit:PromotionalCredit}[];
        
       /**
-        * @description Promotional credits amount.
+        * @description This endpoint lists the promotional credits set for a customer
 
         */
        
-      amount?:number;
-       
+       next_offset?:string;
+    }
+    export interface ListInputParam {
+      [key : string]: any;  
       /**
-        * @description Amount in decimal.
+        * @description This endpoint lists the promotional credits set for a customer
 
         */
-       
-      amount_in_decimal?:string;
+        
+      limit?:number;
        
       /**
-        * @description The currency code (ISO 4217 format) for promotional credit.
+        * @description This endpoint lists the promotional credits set for a customer
 
         */
-       
-      currency_code?:string;
+        
+      offset?:string;
        
       /**
-        * @description Detailed description of this promotional credits.
+        * @description This endpoint lists the promotional credits set for a customer
 
         */
-       
-      description:string;
+        
+      id?:{is?:string,is_not?:string,starts_with?:string};
        
       /**
-        * @description Type of promotional credits provided to customer. \* general - General \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits
+        * @description This endpoint lists the promotional credits set for a customer
 
         */
-       
-      credit_type?:CreditType;
+        
+      created_at?:{after?:string,before?:string,between?:string,on?:string};
        
       /**
-        * @description Describes why promotional credits were provided.
+        * @description This endpoint lists the promotional credits set for a customer
 
         */
+        
+      type?:{in?:string,is?:'decrement' | 'increment',is_not?:'decrement' | 'increment',not_in?:string};
        
-      reference?:string;
+      /**
+        * @description This endpoint lists the promotional credits set for a customer
+
+        */
+        
+      customer_id?:{is?:string,is_not?:string,starts_with?:string};
     }
+    export interface RetrieveResponse {  
+       promotional_credit:PromotionalCredit;
+    }
+    
     
   }
 }

package/types/resources/Purchase.d.ts

@@ -73,7 +73,7 @@ The following subsections describe the types of groups in detail.
 
 You can specify up to 10 groups,
 
-* with a recommended subscription group of 5. To increase this limit to a maximum of 8, contact [Chargebee Support](https://support.chargebee.com).
+* with a recommended subscription group of 5. To increase this limit to a maximum of 8, contact [Chargebee Support](https://support.chargebee.com/support/home).
 * with a maximum of 10 one-time charge groups by default.
 
 The total limit for group items for a single purchase is 60.
@@ -83,7 +83,7 @@ The total limit for group items for a single purchase is 60.
 To create a subscription, specify a *subscription group* . A subscription [group](#groups) is a group of item prices that contains exactly one item price of `type` `plan`. To create multiple subscriptions, provide multiple subscription groups.  
 **Note**
 
-A subscription group can have up to 20 non-plan item prices. To increase this limit to a maximum of 60, contact [Chargebee Support](https://support.chargebee.com).  
+A subscription group can have up to 20 non-plan item prices. To increase this limit to a maximum of 60, contact [Chargebee Support](https://support.chargebee.com/support/home).  
 
 #### Custom Fields {#custom-fields}
 
@@ -94,7 +94,7 @@ Purchase API supports custom fields of Subscriptions, use the following format t
 A one-time charge [group](#groups) is a group of charge item prices (i.e. item prices belonging to items of `type` `charge`). Charge item prices can be added to subscription groups as well. The charges within and across each one-time group must be unique.  
 **Note**
 
-* A one-time charge group can have up to 20 item prices. To increase this limit to a maximum of 60, contact [Chargebee Support](https://support.chargebee.com).
+* A one-time charge group can have up to 20 item prices. To increase this limit to a maximum of 60, contact [Chargebee Support](https://support.chargebee.com/support/home).
 * A charge item price can only be added to a single one-time charge group. However, it can be part of multiple [subscription groups](#subscription).
 
 ### Applying discounts {#discounts}