chargebee 2.33.0 → 2.34.0

package/types/resources/Gift.d.ts

@@ -123,6 +123,92 @@ declare module 'chargebee' {
       
       update_gift(gift_id:string, input:UpdateGiftInputParam):ChargebeeRequest<UpdateGiftResponse>;
     }
+    export interface CreateResponse {  
+       gift:Gift;
+       
+       subscription:Subscription;
+       
+       invoice?:Invoice;
+    }
+    export interface CreateInputParam {
+       
+      /**
+        * @description Indicates the date on which the gift notification is sent to the receiver. If not passed, the receiver is notified immediately.
+
+        */
+       
+      scheduled_at?:number;
+       
+      /**
+        * @description When &#x60;true&#x60;, the claim happens automatically. When not passed, the default value in the site settings is used.
+
+        */
+       
+      auto_claim?:boolean;
+       
+      /**
+        * @description When &#x60;true&#x60;, indicates that the gift does not expire. Do not pass or pass as &#x60;false&#x60; when &#x60;auto_claim&#x60; is set. .
+
+        */
+       
+      no_expiry?:boolean;
+       
+      /**
+        * @description The date until which the gift can be claimed. Must be set to a value after &#x60;scheduled_at&#x60;. If the gift is not claimed within &#x60;claim_expiry_date&#x60;, it will expire and the subscription will move to &#x60;cancelled&#x60; state. When not passed, the value specified in the site settings will be used. Pass as &#x60;NULL&#x60; or do not pass when &#x60;auto_claim&#x60; or &#x60;no_expiry&#x60; are set.
+
+        */
+       
+      claim_expiry_date?:number;
+       
+      /**
+        * @description List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
+
+        */
+       
+      coupon_ids?:string[];
+       
+      /**
+        * @description Parameters for gifter
+
+        */
+       
+      gifter:{customer_id:string,note?:string,payment_src_id?:string,signature:string};
+       
+      /**
+        * @description Parameters for gift_receiver
+
+        */
+       
+      gift_receiver:{customer_id:string,email:string,first_name:string,last_name:string};
+       
+      /**
+        * @description Parameters for payment_intent
+
+        */
+       
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
+       
+      /**
+        * @description Parameters for shipping_address
+
+        */
+       
+      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};
+       
+      /**
+        * @description Parameters for subscription
+
+        */
+       
+      subscription:object;
+       
+      /**
+        * @description Parameters for addons
+
+        */
+       
+      addons?:{id?:string,quantity?:number,quantity_in_decimal?:string}[];
+    }
     export interface CreateForItemsResponse {  
        gift:Gift;
        
@@ -186,7 +272,7 @@ declare module 'chargebee' {
 
         */
        
-      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
        
       /**
         * @description Parameters for shipping_address

package/types/resources/ImpactedItemPrice.d.ts

@@ -0,0 +1,22 @@
+///<reference path='./../core.d.ts'/>
+declare module 'chargebee' {
+  export interface ImpactedItemPrice {
+    
+    count?:number;
+    
+    download?:ImpactedItemPrice.Download;
+    
+    item_prices?:any[];
+  }
+  export namespace ImpactedItemPrice {
+    
+    
+    export interface Download {  
+      download_url:string;
+       
+      valid_till:number;
+       
+      mime_type?:string;
+    }
+  }
+}

package/types/resources/Installment.d.ts

@@ -0,0 +1,121 @@
+///<reference path='./../core.d.ts'/>
+declare module 'chargebee' {
+  export interface Installment {
+    
+    /**
+      * @description An auto-generated unique identifier for the Payment installment.
+
+      */
+    
+    id:string;
+    
+    /**
+      * @description The ID of the invoice to which this installment belongs.
+
+      */
+    
+    invoice_id:string;
+    
+    /**
+      * @description The date when this installment is in effect.
+
+      */
+    
+    date:number;
+    
+    /**
+      * @description The part of invoice.amount_due allocated to this installment.
+
+      */
+    
+    amount:number;
+    
+    /**
+      * @description The payment status of the installment. Possible values are paid, payment_due: The payment is due, posted. \* posted - The invoice is finalized but the payment is not due yet. \* payment_due - The payment is due. One or more payments were attempted for the installment but were unsuccessful. \* paid - The installment has been paid.
+
+      */
+    
+    status:'paid' | 'posted' | 'payment_due';
+    
+    /**
+      * @description The time when this resource was created.
+
+      */
+    
+    created_at:number;
+    
+    /**
+      * @description The time when this resource was last updated.
+
+      */
+    
+    updated_at?:number;
+  }
+  export namespace Installment {
+    export class InstallmentResource {  
+      /**
+        * @description Retrieves a specific installment resource.
+
+        */
+      
+      retrieve(installment_id:string):ChargebeeRequest<RetrieveResponse>;
+       
+      /**
+        * @description Lists the installments that match the criteria provided in the filter parameters.
+
+        */
+      
+      list(input:ListInputParam):ChargebeeRequest<ListResponse>;
+    }
+    export interface RetrieveResponse {  
+       installment:Installment;
+    }
+    
+    export interface ListResponse {  
+      /**
+        * @description Lists the installments that match the criteria provided in the filter parameters.
+
+        */
+       
+       list:{installment:Installment}[];
+       
+      /**
+        * @description Lists the installments that match the criteria provided in the filter parameters.
+
+        */
+       
+       next_offset?:string;
+    }
+    export interface ListInputParam {
+      [key : string]: any;  
+      /**
+        * @description Lists the installments that match the criteria provided in the filter parameters.
+
+        */
+        
+      limit?:number;
+       
+      /**
+        * @description Lists the installments that match the criteria provided in the filter parameters.
+
+        */
+        
+      offset?:string;
+       
+      /**
+        * @description Lists the installments that match the criteria provided in the filter parameters.
+
+        */
+        
+      sort_by?:string;
+       
+      /**
+        * @description Lists the installments that match the criteria provided in the filter parameters.
+
+        */
+        
+      invoice_id:{in?:string,is?:string};
+    }
+    
+  }
+}

package/types/resources/InstallmentConfig.d.ts

@@ -0,0 +1,162 @@
+///<reference path='./../core.d.ts'/>
+declare module 'chargebee' {
+  export interface InstallmentConfig {
+    
+    /**
+      * @description An auto-generated unique identifier for the Payment installment Configuration.
+
+      */
+    
+    id:string;
+    
+    /**
+      * @description A brief description for this installment configuration.
+
+      */
+    
+    description?:string;
+    
+    /**
+      * @description Specifies the total number of installments for the invoice.
+
+      */
+    
+    number_of_installments:number;
+    
+    /**
+      * @description Defines the time unit for intervals between installments.Possible values are: day, week, month \* month - month \* week - week \* day - day
+
+      */
+    
+    period_unit:'week' | 'month' | 'day';
+    
+    /**
+      * @description The time period between the effective dates of two consecutive installments, expressed in period_units.
+
+      */
+    
+    period?:number;
+    
+    /**
+      * @description The day of the week (or month) when the installment is in effect. For week: A value between 1 (Sunday) and 7 (Saturday) indicating the preferred day of the week for the installment dates. For example, 2 represents Monday. For month: A value from 1 to 31, indicating the preferred day of the month for installment dates. For example, 15 represents the 15th day of the month. If the month has fewer days than the specified preferred_day, the installment date is the last day of the month.
+
+      */
+    
+    preferred_day?:number;
+    
+    /**
+      * @description The timestamp at which the installment_config was created.
+
+      */
+    
+    created_at:number;
+    
+    /**
+      * @description The timestamp at which the installment_config was last updated at.
+
+      */
+    
+    updated_at?:number;
+    
+    /**
+      * @description Defines the details for each installment individually.
+
+      */
+    
+    installments?:InstallmentConfig.Installment[];
+  }
+  export namespace InstallmentConfig {
+    export class InstallmentConfigResource {  
+      /**
+        * @description Creates an installment configuration. After creating an installment_config, you can use it to generate installments for multiple invoices.
+
+        */
+      
+      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+       
+      /**
+        * @description This endpoint retrieves an installment_config resource.
+
+        */
+      
+      retrieve(installment_config_id:string):ChargebeeRequest<RetrieveResponse>;
+       
+      /**
+        * @description This endpoint deletes an installment_config resource.
+
+        */
+      
+      delete(installment_config_id:string):ChargebeeRequest<DeleteResponse>;
+    }
+    export interface CreateResponse {  
+       installment_config:InstallmentConfig;
+    }
+    export interface CreateInputParam {
+       
+      /**
+        * @description Specifies the total number of installments for the invoice.
+
+        */
+       
+      number_of_installments:number;
+       
+      /**
+        * @description Defines the time unit for intervals between installments.Possible values are: day, week, month \* month - month \* week - week \* day - day
+
+        */
+       
+      period_unit:'week' | 'month' | 'day';
+       
+      /**
+        * @description The time period between the effective dates of two consecutive installments, expressed in period_units.
+
+        */
+       
+      period?:number;
+       
+      /**
+        * @description The day of the week (or month) when the installment is in effect. For week: A value between 1 (Sunday) and 7 (Saturday) indicating the preferred day of the week for the installment dates. For example, 2 represents Monday. For month: A value from 1 to 31, indicating the preferred day of the month for installment dates. For example, 15 represents the 15th day of the month. If the month has fewer days than the specified preferred_day, the installment date is the last day of the month.
+
+        */
+       
+      preferred_day?:number;
+       
+      /**
+        * @description A brief description for this installment configuration.
+
+        */
+       
+      description?:string;
+       
+      /**
+        * @description Parameters for installments
+
+        */
+       
+      installments?:{amount_percentage?:number,period?:number}[];
+    }
+    export interface RetrieveResponse {  
+       installment_config:InstallmentConfig;
+    }
+    
+    export interface DeleteResponse {  
+       installment_config:InstallmentConfig;
+    }
+    
+    export interface Installments {  
+         /**
+          * @description The period of time (expressed in period_units) after the invoice.date, marking the date when installment is in effect. For example, when installments.period is 3 and period_unit is month, this installment is effective 3 months after the invoice.date
+
+          */
+       
+      period?:number;
+       
+         /**
+          * @description The percentage of invoice.amount_due allocated to this installment. If unspecified, the invoice.amount_due is distributed equally among the installments.
+
+          */
+       
+      amount_percentage?:number;
+    }
+  }
+}

package/types/resources/Invoice.d.ts

@@ -743,6 +743,13 @@ All associated [usages](/docs/api/usages?prod_cat_ver=2) are permanently de
       
       update_details(invoice_id:string, input?:UpdateDetailsInputParam):ChargebeeRequest<UpdateDetailsResponse>;
        
+      /**
+        * @description Creates installments for an invoice, enabling the invoice to be paid in multiple, scheduled payments. **Note: The invoice must be in payment_due.**
+
+        */
+      
+      installments(invoice_id:string, input:InstallmentsInputParam):ChargebeeRequest<InstallmentsResponse>;
+       
       /**
         * @description Resend failed einvoice of an invoice to the customer using this API.
 
@@ -772,6 +779,179 @@ This endpoint schedules e-invoices manually. This operation is not allowed when
       
       send_einvoice(invoice_id:string):ChargebeeRequest<SendEinvoiceResponse>;
     }
+    export interface CreateResponse {  
+       invoice:Invoice;
+    }
+    export interface CreateInputParam {
+       
+      /**
+        * @description Identifier of the customer for which this invoice needs to be created. Should be specified if &#x27;subscription_id&#x27; is not specified.
+
+        */
+       
+      customer_id?:string;
+       
+      /**
+        * @description Identifier of the subscription for which this invoice needs to be created. Should be specified if &#x27;customer_id&#x27; is not specified.(not applicable for consolidated invoice).
+
+        */
+       
+      subscription_id?:string;
+       
+      /**
+        * @description The currency code (ISO 4217 format) of the invoice amount.
+
+        */
+       
+      currency_code?:string;
+       
+      /**
+        * @description The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date. &#x60;taxes&#x60; and &#x60;line_item_taxes&#x60; are computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.
+
+        */
+       
+      invoice_date?:number;
+       
+      /**
+        * @description A note for this particular invoice. This, and [all other notes](/docs/api/invoices#invoice_notes) for the invoice are displayed on the PDF invoice sent to the customer.
+
+        */
+       
+      invoice_note?:string;
+       
+      /**
+        * @description Set as &#x60;true&#x60; to remove the **[general note](https://www.chargebee.com/docs/invoice_notes.html#adding-general-notes)** from this invoice.
+
+        */
+       
+      remove_general_note?:boolean;
+       
+      /**
+        * @description Purchase Order Number for this invoice.
+
+        */
+       
+      po_number?:string;
+       
+      /**
+        * @description List of Coupons to be added.
+
+        */
+       
+      coupon_ids?:string[];
+       
+      /**
+        * @description Authorization transaction to be captured.
+
+        */
+       
+      authorization_transaction_id?:string;
+       
+      /**
+        * @description Payment source to be used for this payment.
+
+        */
+       
+      payment_source_id?:string;
+       
+      /**
+        * @description If specified, the customer level auto collection will be overridden. \* on - Whenever an invoice is created, an automatic attempt will be made to charge. \* off - Whenever an invoice is created as payment due.
+
+        */
+       
+      auto_collection?:AutoCollection;
+       
+      /**
+        * @description Token generated by Chargebee JS representing payment method details.
+
+        */
+       
+      token_id?:string;
+       
+      /**
+        * @description Indicates whether the primary payment source should be replaced with this payment source. In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
+
+        */
+       
+      replace_primary_payment_source?:boolean;
+       
+      /**
+        * @description Indicates whether the payment source should be retained for the customer.
+
+        */
+       
+      retain_payment_source?:boolean;
+       
+      /**
+        * @description The type of initiator to be used for the payment request triggered by this operation. \* customer - Pass this value to indicate that the request is initiated by the customer \* merchant - Pass this value to indicate that the request is initiated by the merchant
+
+        */
+       
+      payment_initiator?:PaymentInitiator;
+       
+      /**
+        * @description Parameters for shipping_address
+
+        */
+       
+      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};
+       
+      /**
+        * @description Parameters for statement_descriptor
+
+        */
+       
+      statement_descriptor?:{additional_info?:string,descriptor?:string};
+       
+      /**
+        * @description Parameters for card
+
+        */
+       
+      card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway_account_id?:string,last_name?:string,number?:string};
+       
+      /**
+        * @description Parameters for bank_account
+
+        */
+       
+      bank_account?:{account_holder_type?:AccountHolderType,account_number?:string,account_type?:AccountType,bank_code?:string,bank_name?:string,billing_address?:object,company?:string,echeck_type?:EcheckType,email?:string,first_name?:string,gateway_account_id?:string,iban?:string,issuing_country?:string,last_name?:string,phone?:string,routing_number?:string,swedish_identity_number?:string};
+       
+      /**
+        * @description Parameters for payment_method
+
+        */
+       
+      payment_method?:{additional_information?:object,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
+       
+      /**
+        * @description Parameters for payment_intent
+
+        */
+       
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
+       
+      /**
+        * @description Parameters for addons
+
+        */
+       
+      addons?:{date_from?:number,date_to?:number,id?:string,quantity?:number,quantity_in_decimal?:string,unit_price?:number,unit_price_in_decimal?:string}[];
+       
+      /**
+        * @description Parameters for charges
+
+        */
+       
+      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}[];
+       
+      /**
+        * @description Parameters for notes_to_remove
+
+        */
+       
+      notes_to_remove?:{entity_id?:string,entity_type?:EntityType}[];
+    }
     export interface CreateForChargeItemsAndChargesResponse {  
        invoice:Invoice;
     }
@@ -930,7 +1110,7 @@ The invoice is [linked](/docs/api?prod_cat_ver&#x3D;2#mbe-linked-be) to the same
 
         */
        
-      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
        
       /**
         * @description Parameters for item_prices
@@ -1984,6 +2164,25 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
        
       statement_descriptor?:{additional_info?:string,descriptor?:string};
     }
+    export interface InstallmentsResponse {  
+       invoice:Invoice;
+    }
+    export interface InstallmentsInputParam {
+       
+      /**
+        * @description The identifier of the installment_config used to create the installments.
+
+        */
+       
+      config_id:string;
+       
+      /**
+        * @description The part of the invoice.amount_due to be distributed across the installments. If unspecified, the full invoice.amount_due is considered by default.
+
+        */
+       
+      amount?:number;
+    }
     export interface ResendEinvoiceResponse {  
        invoice:Invoice;
     }

package/types/resources/ItemPrice.d.ts

@@ -23,13 +23,6 @@ declare module 'chargebee' {
     
     item_family_id?:string;
     
-    /**
-      * @description Identifier of the product
-
-      */
-    
-    product_id?:string;
-    
     /**
       * @description The id of the item that the item price belongs to.
 

package/types/resources/NonSubscription.d.ts

@@ -0,0 +1,30 @@
+///<reference path='./../core.d.ts'/>
+declare module 'chargebee' {
+  export interface NonSubscription {
+    
+    app_id:string;
+    
+    invoice_id:string;
+    
+    customer_id?:string;
+    
+    charge_id:string;
+  }
+  export namespace NonSubscription {
+    export class NonSubscriptionResource {  
+      process_receipt(non_subscription_app_id:string, input:ProcessReceiptInputParam):ChargebeeRequest<ProcessReceiptResponse>;
+    }
+    export interface ProcessReceiptResponse {  
+       non_subscription:NonSubscription;
+    }
+    export interface ProcessReceiptInputParam {
+       
+      receipt:string;
+       
+      product:{currency_code:string,id:string,name?:string,price:number,price_in_decimal?:string,type:'non_consumable' | 'consumable' | 'non_renewing_subscription'};
+       
+      customer?:{email?:string,first_name?:string,id?:string,last_name?:string};
+    }
+    
+  }
+}