chargebee 3.28.1 → 3.30.0

package/types/resources/Invoice.d.ts

@@ -43,6 +43,7 @@ declare module 'chargebee' {
     resource_version?: number;
     updated_at?: number;
     line_items_next_offset?: string;
+    exchange_rates?: Invoice.ExchangeRate[];
     first_invoice?: boolean;
     new_sales_amount?: number;
     has_advance_charges?: boolean;
@@ -499,6 +500,10 @@ declare module 'chargebee' {
       invoice: Invoice;
     }
 
+    export interface ExchangeRate {
+      currency_code: string;
+      rate: number;
+    }
     export interface LineItem {
       id?: string;
       subscription_id?: string;
@@ -547,6 +552,11 @@ declare module 'chargebee' {
         | 'tax_not_configured_external_provider';
       entity_id?: string;
       customer_id?: string;
+      proration_mode?:
+        | 'reset'
+        | 'delta'
+        | 'service_period_revision'
+        | 'adjusted_term';
     }
     export interface LineItemTier {
       line_item_id?: string;
@@ -688,7 +698,11 @@ declare module 'chargebee' {
     export interface DunningAttempt {
       attempt: number;
       transaction_id?: string;
-      dunning_type: 'auto_collect' | 'offline' | 'direct_debit';
+      dunning_type:
+        | 'auto_collect'
+        | 'offline'
+        | 'direct_debit'
+        | 'real_time_payments';
       created_at?: number;
       txn_status?:
         | 'in_progress'
@@ -911,6 +925,7 @@ declare module 'chargebee' {
       auto_collection?: AutoCollectionEnum;
       net_term_days?: number;
       invoice_date?: number;
+      create_pending_invoice?: boolean;
       token_id?: string;
       replace_primary_payment_source?: boolean;
       retain_payment_source?: boolean;
@@ -1022,6 +1037,7 @@ declare module 'chargebee' {
       net_term_days?: number;
       has_advance_charges?: boolean;
       use_for_proration?: boolean;
+      paid_at?: number;
       credit_note?: CreditNoteImportInvoiceInputParam;
       billing_address?: BillingAddressImportInvoiceInputParam;
       shipping_address?: ShippingAddressImportInvoiceInputParam;
@@ -1294,7 +1310,14 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay'
+        | 'dana'
+        | 'touch_n_go'
+        | 'tamara'
+        | 'qpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1465,7 +1488,14 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay'
+        | 'dana'
+        | 'touch_n_go'
+        | 'tamara'
+        | 'qpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1505,6 +1535,7 @@ declare module 'chargebee' {
     }
 
     export interface ChargesCreateForChargeItemsAndChargesInputParam {
+      entity_description?: string;
       amount?: number;
       amount_in_decimal?: string;
       description?: string;
@@ -1545,6 +1576,8 @@ declare module 'chargebee' {
       unit_price_in_decimal?: string;
       date_from?: number;
       date_to?: number;
+      description?: string;
+      entity_description?: string;
     }
     export interface TaxProvidersFieldsCreateForChargeItemsAndChargesInputParam {
       provider_name?: string;
@@ -1741,6 +1774,11 @@ declare module 'chargebee' {
       tax9_amount?: number;
       tax10_name?: string;
       tax10_amount?: number;
+      proration_mode?:
+        | 'reset'
+        | 'delta'
+        | 'service_period_revision'
+        | 'adjusted_term';
       created_at?: number;
     }
     export interface TransactionsApplyPaymentsInputParam {

package/types/resources/InvoiceEstimate.d.ts

@@ -72,6 +72,11 @@ declare module 'chargebee' {
         | 'tax_not_configured_external_provider';
       entity_id?: string;
       customer_id?: string;
+      proration_mode?:
+        | 'reset'
+        | 'delta'
+        | 'service_period_revision'
+        | 'adjusted_term';
     }
     export interface LineItemTier {
       line_item_id?: string;

package/types/resources/LedgerAccountBalance.d.ts

@@ -6,7 +6,9 @@ declare module 'chargebee' {
     subscription_id: string;
     unit_id: string;
     unit_type: 'credit_unit';
-    modified_at?: number;
+    created_at: number;
+    modified_at: number;
+    resource_version?: number;
     provisioned_balance?: LedgerAccountBalance.ProvisionedBalance;
     overdraft_balance?: LedgerAccountBalance.OverdraftBalance;
   }

package/types/resources/LedgerEntry.d.ts

@@ -0,0 +1,22 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface LedgerEntry {
+    id: string;
+    subscription_id?: string;
+    account_type?: 'provisioned' | 'overdraft';
+    unit_id?: string;
+    unit_type?: 'credit_unit';
+    amount: string;
+    grant_block_start_balance: string;
+    grant_block_end_balance: string;
+    account_start_balance: string;
+    account_end_balance: string;
+    type: TypeEnum;
+    ledger_operation_id: string;
+    grant_block_id: string;
+    created_at: number;
+    modified_at: number;
+  }
+}

package/types/resources/LedgerOperation.d.ts

@@ -4,6 +4,9 @@
 declare module 'chargebee' {
   export interface LedgerOperation {
     id: string;
+    subscription_id?: string;
+    unit_id?: string;
+    unit_type?: 'credit_unit';
     type:
       | 'allocation'
       | 'capture'
@@ -15,21 +18,16 @@ declare module 'chargebee' {
       | 'rollover'
       | 'adjustment';
     amount: string;
-    start_balance: string;
-    end_balance: string;
     provisioned_start_balance: string;
     provisioned_end_balance: string;
     overdraft_start_balance: string;
     overdraft_end_balance: string;
     parent_ledger_operation_id?: string;
-    ledger_operation_timestamp?: number;
+    ledger_operation_timestamp: number;
     auto_release_timestamp?: number;
-    metadata?: string;
-    created_at?: number;
-    modified_at?: number;
-    subscription_id?: string;
-    unit_id?: string;
-    unit_type?: 'credit_unit';
+    created_at: number;
+    modified_at: number;
+    metadata?: any;
   }
 
   export namespace LedgerOperation {
@@ -63,6 +61,11 @@ declare module 'chargebee' {
         input: ReleaseAuthorizationInputParam,
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<ReleaseAuthorizationResponse>>;
+
+      allocate(
+        input: AllocateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<AllocateResponse>>;
     }
 
     export interface RetrieveLedgerOperationResponse {
@@ -77,21 +80,36 @@ declare module 'chargebee' {
     export interface CaptureResponse {
       ledger_operation: LedgerOperation;
       ledger_account_balance: LedgerAccountBalance;
+      grant_blocks: GrantBlock[];
+      ledger_entries: LedgerEntry[];
     }
 
     export interface AuthorizeResponse {
       ledger_operation: LedgerOperation;
       ledger_account_balance: LedgerAccountBalance;
+      grant_blocks: GrantBlock[];
+      ledger_entries: LedgerEntry[];
     }
 
     export interface CaptureAuthorizationResponse {
       ledger_operation: LedgerOperation;
       ledger_account_balance: LedgerAccountBalance;
+      grant_blocks: GrantBlock[];
+      ledger_entries: LedgerEntry[];
     }
 
     export interface ReleaseAuthorizationResponse {
       ledger_operation: LedgerOperation;
       ledger_account_balance: LedgerAccountBalance;
+      grant_blocks: GrantBlock[];
+      ledger_entries: LedgerEntry[];
+    }
+
+    export interface AllocateResponse {
+      ledger_account_balance: LedgerAccountBalance;
+      ledger_operations: LedgerOperation[];
+      grant_blocks: GrantBlock[];
+      ledger_entries: LedgerEntry[];
     }
 
     // REQUEST PARAMS
@@ -137,5 +155,12 @@ declare module 'chargebee' {
       ledger_operation_timestamp: number;
       metadata?: any;
     }
+    export interface AllocateInputParam {
+      subscription_id: string;
+      unit_id: string;
+      amount: string;
+      expires_at: number;
+      metadata?: any;
+    }
   }
 }

package/types/resources/Meter.d.ts

@@ -0,0 +1,42 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface Meter {
+    id: string;
+    name: string;
+    description?: string;
+    type: 'simple' | 'compound';
+    status?: 'active' | 'archived' | 'deleted';
+    query: string;
+    created_at: number;
+    updated_at?: number;
+    column_definitions?: ColumnDefinition[];
+    features?: Feature[];
+  }
+
+  export namespace Meter {
+    export class MeterResource {
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface ListResponse {
+      list: { meter: Meter }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      name?: filter.String;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+  }
+}

package/types/resources/MeteredFeature.d.ts

@@ -0,0 +1,70 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface MeteredFeature {
+    id: string;
+    name?: string;
+    description?: string;
+    type?: TypeEnum;
+    status?: StatusEnum;
+    query?: string;
+    column_definitions?: ColumnDefinition[];
+    features?: Feature[];
+  }
+
+  export namespace MeteredFeature {
+    export class MeteredFeatureResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      archive(
+        metered_feature_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ArchiveResponse>>;
+
+      reactivate(
+        metered_feature_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ReactivateResponse>>;
+
+      delete(
+        metered_feature_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+    }
+
+    export interface CreateResponse {
+      meter: Meter;
+    }
+
+    export interface ArchiveResponse {
+      meter: Meter;
+    }
+
+    export interface ReactivateResponse {
+      meter: Meter;
+    }
+
+    export interface DeleteResponse {
+      meter: Meter;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      name: string;
+      description?: string;
+      feature_unit: string;
+      query: string;
+      column_definitions?: ColumnDefinitionsCreateInputParam[];
+    }
+    export interface ColumnDefinitionsCreateInputParam {
+      column_name: string;
+      data_type: 'number' | 'string';
+    }
+  }
+}

package/types/resources/PaymentIntent.d.ts

@@ -55,7 +55,14 @@ declare module 'chargebee' {
       | 'alipay_hk'
       | 'paypay'
       | 'gcash'
-      | 'south_korean_cards';
+      | 'south_korean_cards'
+      | 'paynow'
+      | 'bizum'
+      | 'promptpay'
+      | 'dana'
+      | 'touch_n_go'
+      | 'tamara'
+      | 'qpay';
     success_url?: string;
     failure_url?: string;
     created_at: number;
@@ -66,6 +73,7 @@ declare module 'chargebee' {
     gateway?: string;
     active_payment_attempt?: PaymentIntent.PaymentAttempt;
     payment_attempts?: PaymentIntent.PaymentAttempt[];
+    payment_intent_metadata?: PaymentIntent.PaymentIntentMetadata;
     business_entity_id?: string;
   }
 
@@ -155,7 +163,14 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay'
+        | 'dana'
+        | 'touch_n_go'
+        | 'tamara'
+        | 'qpay';
       id_at_gateway?: string;
       error_code?: string;
       error_text?: string;
@@ -219,7 +234,14 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay'
+        | 'dana'
+        | 'touch_n_go'
+        | 'tamara'
+        | 'qpay';
       id_at_gateway?: string;
       error_code?: string;
       error_text?: string;
@@ -228,6 +250,22 @@ declare module 'chargebee' {
       modified_at: number;
       error_detail?: GatewayErrorDetail;
     }
+    export interface PaymentIntentMetadata {
+      source:
+        | 'cb_js'
+        | 'components_fields'
+        | 'checkout_v3'
+        | 'paynow_v3'
+        | 'portal_v3'
+        | 'gift_v3'
+        | 'checkout_v4'
+        | 'payment_component'
+        | 'pc_inapp_v4'
+        | 'pc_fpc_v4';
+      client_ip_address?: string;
+      user_agent?: string;
+      created_at?: number;
+    }
     // REQUEST PARAMS
     //---------------
 
@@ -284,7 +322,14 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay'
+        | 'dana'
+        | 'touch_n_go'
+        | 'tamara'
+        | 'qpay';
       success_url?: string;
       failure_url?: string;
     }
@@ -337,7 +382,14 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay'
+        | 'dana'
+        | 'touch_n_go'
+        | 'tamara'
+        | 'qpay';
       success_url?: string;
       failure_url?: string;
     }

package/types/resources/PaymentSource.d.ts

@@ -479,7 +479,14 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay'
+        | 'dana'
+        | 'touch_n_go'
+        | 'tamara'
+        | 'qpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/PromotionalGrant.d.ts

@@ -7,7 +7,7 @@ declare module 'chargebee' {
     unit_id: string;
     amount: string;
     expires_at: number;
-    metadata?: string;
+    metadata?: any;
   }
 
   export namespace PromotionalGrant {

package/types/resources/Purchase.d.ts

@@ -122,7 +122,14 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay'
+        | 'dana'
+        | 'touch_n_go'
+        | 'tamara'
+        | 'qpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/Quote.d.ts

@@ -429,6 +429,11 @@ declare module 'chargebee' {
         | 'tax_not_configured_external_provider';
       entity_id?: string;
       customer_id?: string;
+      proration_mode?:
+        | 'reset'
+        | 'delta'
+        | 'service_period_revision'
+        | 'adjusted_term';
     }
     export interface LineItemTier {
       line_item_id?: string;

package/types/resources/QuoteLineGroup.d.ts

@@ -74,6 +74,11 @@ declare module 'chargebee' {
         | 'tax_not_configured_external_provider';
       entity_id?: string;
       customer_id?: string;
+      proration_mode?:
+        | 'reset'
+        | 'delta'
+        | 'service_period_revision'
+        | 'adjusted_term';
     }
     export interface LineItemDiscount {
       line_item_id: string;

package/types/resources/QuotedCharge.d.ts

@@ -16,6 +16,7 @@ declare module 'chargebee' {
       amount?: number;
       amount_in_decimal?: string;
       description?: string;
+      entity_description?: string;
       service_period_in_days?: number;
       avalara_sale_type?: 'wholesale' | 'retail' | 'consumed' | 'vendor_use';
       avalara_transaction_type?: number;
@@ -36,6 +37,8 @@ declare module 'chargebee' {
       quantity_in_decimal?: string;
       unit_price?: number;
       unit_price_in_decimal?: string;
+      description?: string;
+      entity_description?: string;
       service_period_days?: number;
     }
     export interface ItemTier {

package/types/resources/Ramp.d.ts

@@ -126,9 +126,10 @@ declare module 'chargebee' {
     export interface DiscountsToAdd {
       id: string;
       invoice_name?: string;
-      type: 'fixed_amount' | 'percentage';
+      type: 'fixed_amount' | 'percentage' | 'offer_quantity';
       percentage?: number;
       amount?: number;
+      quantity?: number;
       duration_type: 'one_time' | 'forever' | 'limited_period';
       period?: number;
       period_unit?: 'day' | 'week' | 'month' | 'year';
@@ -248,6 +249,7 @@ declare module 'chargebee' {
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
+      quantity?: number;
       period?: number;
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
@@ -303,6 +305,7 @@ declare module 'chargebee' {
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
+      quantity?: number;
       period?: number;
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;

package/types/resources/RecordedPurchase.d.ts

@@ -59,6 +59,9 @@ declare module 'chargebee' {
     }
     export interface CustomerCreateInputParam {
       id: string;
+      email?: string;
+      first_name?: string;
+      last_name?: string;
     }
     export interface GooglePlayStoreCreateInputParam {
       purchase_token?: string;