chargebee 3.32.0 → 3.34.0

package/types/resources/HostedPage.d.ts

@@ -25,7 +25,7 @@ declare module 'chargebee' {
       | 'acknowledged';
     failure_reason?: 'card_error' | 'server_error';
     pass_thru_content?: string;
-    embed: boolean;
+    embed?: boolean;
     created_at?: number;
     expires_at?: number;
     layout?: LayoutEnum;
@@ -34,6 +34,7 @@ declare module 'chargebee' {
     resource_version?: number;
     checkout_info?: any;
     business_entity_id?: string;
+    brand_id?: string;
   }
 
   export namespace HostedPage {
@@ -293,6 +294,7 @@ declare module 'chargebee' {
     }
     export interface CheckoutOneTimeForItemsInputParam {
       business_entity_id?: string;
+      brand_id?: string;
       layout?: LayoutEnum;
       invoice_note?: string /**
        * @deprecated Please refer API docs to use other attributes
@@ -318,6 +320,7 @@ declare module 'chargebee' {
     export interface CheckoutNewForItemsInputParam {
       layout?: LayoutEnum;
       business_entity_id?: string;
+      brand_id?: string;
       billing_cycles?: number;
       mandatory_items_to_remove?: string[];
       terms_to_charge?: number;
@@ -365,6 +368,7 @@ declare module 'chargebee' {
     }
     export interface CheckoutExistingForItemsInputParam {
       layout?: LayoutEnum;
+      brand_id?: string;
       mandatory_items_to_remove?: string[];
       replace_items_list?: boolean;
       invoice_date?: number;
@@ -412,11 +416,13 @@ declare module 'chargebee' {
     }
     export interface ManagePaymentSourcesInputParam {
       business_entity_id?: string;
+      brand_id?: string;
       redirect_url?: string;
       customer?: CustomerManagePaymentSourcesInputParam;
       card?: CardManagePaymentSourcesInputParam;
     }
     export interface CollectNowInputParam {
+      brand_id?: string;
       redirect_url?: string;
       currency_code?: string;
       payment_method_save_policy?: PaymentMethodSavePolicyEnum;
@@ -424,11 +430,13 @@ declare module 'chargebee' {
       card?: CardCollectNowInputParam;
     }
     export interface AcceptQuoteInputParam {
+      brand_id?: string;
       redirect_url?: string;
       layout?: LayoutEnum;
       quote?: QuoteAcceptQuoteInputParam;
     }
     export interface ExtendSubscriptionInputParam {
+      brand_id?: string;
       expiry?: number;
       billing_cycle?: number;
       subscription?: SubscriptionExtendSubscriptionInputParam;
@@ -443,6 +451,7 @@ declare module 'chargebee' {
     export interface CheckoutGiftForItemsInputParam {
       layout?: LayoutEnum;
       business_entity_id?: string;
+      brand_id?: string;
       redirect_url?: string;
       coupon_ids?: string[];
       gifter?: GifterCheckoutGiftForItemsInputParam;
@@ -450,6 +459,7 @@ declare module 'chargebee' {
       item_tiers?: ItemTiersCheckoutGiftForItemsInputParam[];
     }
     export interface ClaimGiftInputParam {
+      brand_id?: string;
       redirect_url?: string;
       gift?: GiftClaimGiftInputParam;
       customer?: CustomerClaimGiftInputParam;
@@ -466,6 +476,7 @@ declare module 'chargebee' {
       updated_at?: filter.Timestamp;
     }
     export interface PreCancelInputParam {
+      brand_id?: string;
       pass_thru_content?: string;
       cancel_url?: string;
       redirect_url?: string;
@@ -532,7 +543,7 @@ declare module 'chargebee' {
     }
     export interface SubscriptionCheckoutNewInputParam {
       id?: string;
-      plan_id: string;
+      plan_id?: string;
       plan_quantity?: number;
       plan_quantity_in_decimal?: string;
       plan_unit_price?: number;
@@ -1097,7 +1108,7 @@ declare module 'chargebee' {
       customer_id?: string;
     }
     export interface SubscriptionCheckoutGiftInputParam {
-      plan_id: string;
+      plan_id?: string;
       plan_quantity?: number;
       plan_quantity_in_decimal?: string;
       /**

package/types/resources/Invoice.d.ts

@@ -80,6 +80,7 @@ declare module 'chargebee' {
     vat_number_prefix?: string;
     channel?: ChannelEnum;
     business_entity_id?: string;
+    brand_id?: string;
     site_details_at_creation?: Invoice.SiteDetailsAtCreation;
   }
 
@@ -297,6 +298,11 @@ declare module 'chargebee' {
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<VoidBeforeCaptureResponse>>;
 
+      sendEmail(
+        invoice_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<SendEmailResponse>>;
+
       delete(
         invoice_id: string,
         input?: DeleteInputParam,
@@ -487,6 +493,10 @@ declare module 'chargebee' {
       credit_note?: CreditNote;
     }
 
+    export interface SendEmailResponse {
+      email_logs: EmailLog[];
+    }
+
     export interface DeleteResponse {
       invoice: Invoice;
     }
@@ -1333,7 +1343,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1357,7 +1380,7 @@ declare module 'chargebee' {
       expiry_month?: number;
       expiry_year?: number;
       cvv?: string;
-      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa' | 'dankort';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;
@@ -1511,7 +1534,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1535,7 +1571,7 @@ declare module 'chargebee' {
       expiry_month?: number;
       expiry_year?: number;
       cvv?: string;
-      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa' | 'dankort';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;
@@ -1790,6 +1826,8 @@ declare module 'chargebee' {
       tax9_amount?: number;
       tax10_name?: string;
       tax10_amount?: number;
+      is_partial_tax_applied?: boolean;
+      taxable_amount?: number;
       proration_mode?:
         | 'reset'
         | 'delta'

package/types/resources/LedgerEntry.d.ts

@@ -4,10 +4,10 @@
 declare module 'chargebee' {
   export interface LedgerEntry {
     id: string;
-    subscription_id?: string;
-    account_type?: 'provisioned' | 'overdraft';
-    unit_id?: string;
-    unit_type?: 'credit_unit';
+    subscription_id: string;
+    unit_id: string;
+    unit_type: 'credit_unit';
+    account_type: 'provisioned' | 'overdraft';
     amount: string;
     grant_block_start_balance: string;
     grant_block_end_balance: string;

package/types/resources/LedgerOperation.d.ts

@@ -4,9 +4,9 @@
 declare module 'chargebee' {
   export interface LedgerOperation {
     id: string;
-    subscription_id?: string;
-    unit_id?: string;
-    unit_type?: 'credit_unit';
+    subscription_id: string;
+    unit_id: string;
+    unit_type: 'credit_unit';
     type:
       | 'allocation'
       | 'capture'
@@ -16,7 +16,8 @@ declare module 'chargebee' {
       | 'expiry'
       | 'void'
       | 'rollover'
-      | 'adjustment';
+      | 'adjustment'
+      | 'overdraft_settlement';
     amount: string;
     provisioned_start_balance: string;
     provisioned_end_balance: string;
@@ -78,28 +79,32 @@ declare module 'chargebee' {
     }
 
     export interface CaptureResponse {
-      ledger_operation: LedgerOperation;
+      ledger_operation?: LedgerOperation;
+      ledger_operations: LedgerOperation[];
       ledger_account_balance: LedgerAccountBalance;
       grant_blocks: GrantBlock[];
       ledger_entries: LedgerEntry[];
     }
 
     export interface AuthorizeResponse {
-      ledger_operation: LedgerOperation;
+      ledger_operation?: LedgerOperation;
+      ledger_operations: LedgerOperation[];
       ledger_account_balance: LedgerAccountBalance;
       grant_blocks: GrantBlock[];
       ledger_entries: LedgerEntry[];
     }
 
     export interface CaptureAuthorizationResponse {
-      ledger_operation: LedgerOperation;
+      ledger_operation?: LedgerOperation;
+      ledger_operations: LedgerOperation[];
       ledger_account_balance: LedgerAccountBalance;
       grant_blocks: GrantBlock[];
       ledger_entries: LedgerEntry[];
     }
 
     export interface ReleaseAuthorizationResponse {
-      ledger_operation: LedgerOperation;
+      ledger_operation?: LedgerOperation;
+      ledger_operations: LedgerOperation[];
       ledger_account_balance: LedgerAccountBalance;
       grant_blocks: GrantBlock[];
       ledger_entries: LedgerEntry[];
@@ -158,7 +163,9 @@ declare module 'chargebee' {
     export interface AllocateInputParam {
       subscription_id: string;
       unit_id: string;
+      id?: string;
       amount: string;
+      effective_from?: number;
       expires_at: number;
       metadata?: any;
     }

package/types/resources/OmnichannelSubscriptionItem.d.ts

@@ -17,7 +17,11 @@ declare module 'chargebee' {
     current_term_start?: number;
     current_term_end?: number;
     expired_at?: number;
-    expiration_reason?: 'billing_error' | 'product_not_available' | 'other';
+    expiration_reason?:
+      | 'billing_error'
+      | 'product_not_available'
+      | 'other'
+      | 'subscription_not_found_in_source';
     cancelled_at?: number;
     cancellation_reason?:
       | 'customer_cancelled'

package/types/resources/PaymentIntent.d.ts

@@ -62,7 +62,20 @@ declare module 'chargebee' {
       | 'dana'
       | 'touch_n_go'
       | 'tamara'
-      | 'qpay';
+      | 'qpay'
+      | 'ovo'
+      | 'momo'
+      | 'mercado_pago'
+      | 'nequi'
+      | 'nupay'
+      | 'picpay'
+      | 'thai_qr'
+      | 'blik'
+      | 'fpx'
+      | 'wero'
+      | 'p24'
+      | 'affirm_pay'
+      | 'rakuten_pay';
     success_url?: string;
     failure_url?: string;
     created_at: number;
@@ -76,6 +89,7 @@ declare module 'chargebee' {
     payment_attempts?: PaymentIntent.PaymentAttempt[];
     payment_intent_metadata?: PaymentIntent.PaymentIntentMetadata;
     business_entity_id?: string;
+    brand_id?: string;
   }
 
   export namespace PaymentIntent {
@@ -171,7 +185,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       id_at_gateway?: string;
       error_code?: string;
       error_text?: string;
@@ -244,7 +271,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       id_at_gateway?: string;
       error_code?: string;
       error_text?: string;
@@ -272,6 +312,7 @@ declare module 'chargebee' {
 
     export interface CreateInputParam {
       business_entity_id?: string;
+      brand_id?: string;
       customer_id?: string;
       amount: number;
       currency_code: string;
@@ -330,7 +371,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       success_url?: string;
       failure_url?: string;
       payment_method_options?: any;
@@ -391,7 +445,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       success_url?: string;
       failure_url?: string;
       payment_method_options?: any;

package/types/resources/PaymentSchedule.d.ts

@@ -1,6 +1,6 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
-
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface PaymentSchedule {
     id: string;
@@ -13,16 +13,53 @@ declare module 'chargebee' {
     updated_at?: number;
     currency_code?: string;
     schedule_entries?: PaymentSchedule.ScheduleEntry[];
+    reference_transactions?: PaymentSchedule.ReferenceTransaction[];
   }
 
   export namespace PaymentSchedule {
+    export class PaymentScheduleResource {
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface ListResponse {
+      list: { payment_schedule: PaymentSchedule }[];
+      next_offset?: string;
+    }
+
     export interface ScheduleEntry {
       id: string;
       date: number;
       amount: number;
+      scheduled_amount: number;
       status: 'posted' | 'payment_due' | 'paid';
     }
+    export interface ReferenceTransaction {
+      schedule_entry_id: string;
+      applied_amount?: number;
+      txn_id: string;
+      txn_status?:
+        | 'in_progress'
+        | 'success'
+        | 'voided'
+        | 'failure'
+        | 'timeout'
+        | 'needs_attention'
+        | 'late_failure';
+      txn_date?: number;
+      txn_amount?: number;
+    }
     // REQUEST PARAMS
     //---------------
+
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      invoice_id?: filter.String;
+      id?: filter.String;
+      updated_at?: filter.Timestamp;
+    }
   }
 }

package/types/resources/PaymentScheduleEstimate.d.ts

@@ -17,6 +17,7 @@ declare module 'chargebee' {
       id: string;
       date: number;
       amount: number;
+      scheduled_amount: number;
       status: 'posted' | 'payment_due' | 'paid';
     }
     // REQUEST PARAMS

package/types/resources/PaymentScheduleScheme.d.ts

@@ -1,6 +1,6 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
-
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface PaymentScheduleScheme {
     id: string;
@@ -27,6 +27,11 @@ declare module 'chargebee' {
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<RetrieveResponse>>;
 
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
       delete(
         payment_schedule_scheme_id: string,
         headers?: ChargebeeRequestHeader,
@@ -41,6 +46,11 @@ declare module 'chargebee' {
       payment_schedule_scheme: PaymentScheduleScheme;
     }
 
+    export interface ListResponse {
+      list: { payment_schedule_scheme: PaymentScheduleScheme }[];
+      next_offset?: string;
+    }
+
     export interface DeleteResponse {
       payment_schedule_scheme: PaymentScheduleScheme;
     }
@@ -59,6 +69,12 @@ declare module 'chargebee' {
       name: string;
       flexible_schedules?: FlexibleSchedulesCreateInputParam[];
     }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      updated_at?: filter.Timestamp;
+    }
     export interface FlexibleSchedulesCreateInputParam {
       period?: number;
       amount_percentage?: number;

package/types/resources/PaymentSource.d.ts

@@ -31,8 +31,10 @@ declare module 'chargebee' {
     klarna_pay_now?: PaymentSource.KlarnaPayNow;
     mandates?: PaymentSource.Mandate[];
     vault_token?: any;
+    network_transaction_reference?: PaymentSource.NetworkTransactionReference;
     deleted: boolean;
     business_entity_id?: string;
+    brand_id?: string;
   }
 
   export namespace PaymentSource {
@@ -314,6 +316,9 @@ declare module 'chargebee' {
       subscription_id: string;
       created_at: number;
     }
+    export interface NetworkTransactionReference {
+      original_network_transaction_id?: string;
+    }
     // REQUEST PARAMS
     //---------------
 
@@ -323,11 +328,13 @@ declare module 'chargebee' {
       type: TypeEnum;
       tmp_token: string;
       issuing_country?: string;
+      brand_id?: string;
       replace_primary_payment_source?: boolean;
       additional_information?: any;
     }
     export interface CreateUsingPermanentTokenInputParam {
       customer_id: string;
+      brand_id?: string;
       type: TypeEnum;
       gateway_account_id?: string;
       reference_id?: string;
@@ -344,25 +351,30 @@ declare module 'chargebee' {
     }
     export interface CreateUsingTokenInputParam {
       customer_id: string;
+      brand_id?: string;
       replace_primary_payment_source?: boolean;
       token_id: string;
     }
     export interface CreateUsingPaymentIntentInputParam {
       customer_id: string;
+      brand_id?: string;
       replace_primary_payment_source?: boolean;
       payment_intent?: PaymentIntentCreateUsingPaymentIntentInputParam;
     }
     export interface CreateVoucherPaymentSourceInputParam {
       customer_id: string;
+      brand_id?: string;
       voucher_payment_source?: VoucherPaymentSourceCreateVoucherPaymentSourceInputParam;
     }
     export interface CreateCardInputParam {
       customer_id: string;
+      brand_id?: string;
       replace_primary_payment_source?: boolean;
       card?: CardCreateCardInputParam;
     }
     export interface CreateBankAccountInputParam {
       customer_id: string;
+      brand_id?: string;
       issuing_country?: string;
       replace_primary_payment_source?: boolean;
       bank_account?: BankAccountCreateBankAccountInputParam;
@@ -371,6 +383,7 @@ declare module 'chargebee' {
       gateway_meta_data?: any;
       reference_transaction?: string;
       card?: CardUpdateCardInputParam;
+      network_transaction_reference?: NetworkTransactionReferenceUpdateCardInputParam;
     }
     export interface UpdateBankAccountInputParam {
       bank_account?: BankAccountUpdateBankAccountInputParam;
@@ -503,7 +516,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -528,7 +554,7 @@ declare module 'chargebee' {
       expiry_month: number;
       expiry_year: number;
       cvv?: string;
-      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa' | 'dankort';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;
@@ -558,6 +584,9 @@ declare module 'chargebee' {
       billing_address?: any;
     }
 
+    export interface NetworkTransactionReferenceUpdateCardInputParam {
+      original_network_transaction_id?: string;
+    }
     export interface CardUpdateCardInputParam {
       first_name?: string;
       last_name?: string;

package/types/resources/PricingPageSession.d.ts

@@ -36,6 +36,7 @@ declare module 'chargebee' {
     export interface CreateForNewSubscriptionInputParam {
       redirect_url?: string;
       business_entity_id?: string;
+      brand_id?: string;
       auto_select_local_currency?: boolean;
       custom?: any;
       pricing_page?: PricingPageCreateForNewSubscriptionInputParam;

package/types/resources/PromotionalGrant.d.ts

@@ -29,7 +29,9 @@ declare module 'chargebee' {
     export interface PromotionalGrantsInputParam {
       subscription_id: string;
       unit_id: string;
+      id?: string;
       amount: string;
+      effective_from?: number;
       expires_at: number;
       metadata?: any;
     }