chargebee 3.28.1 → 3.29.0

package/types/core.d.ts

@@ -86,7 +86,11 @@ declare module 'chargebee' {
     | 'not_applicable';
   type DiscountTypeEnum = 'fixed_amount' | 'percentage' | 'price';
   type DispositionTypeEnum = 'attachment' | 'inline';
-  type DunningTypeEnum = 'auto_collect' | 'offline' | 'direct_debit';
+  type DunningTypeEnum =
+    | 'auto_collect'
+    | 'offline'
+    | 'direct_debit'
+    | 'real_time_payments';
   type DurationTypeEnum = 'one_time' | 'forever' | 'limited_period';
   type EcheckTypeEnum = 'web' | 'ppd' | 'ccd';
   type EinvoicingMethodEnum = 'automatic' | 'manual' | 'site_default';
@@ -319,6 +323,7 @@ declare module 'chargebee' {
     | 'business_entity_deleted'
     | 'customer_business_entity_changed'
     | 'subscription_business_entity_changed'
+    | 'payment_source_business_entity_changed'
     | 'purchase_created'
     | 'voucher_created'
     | 'voucher_expired'
@@ -539,7 +544,10 @@ declare module 'chargebee' {
     | 'alipay_hk'
     | 'paypay'
     | 'gcash'
-    | 'south_korean_cards';
+    | 'south_korean_cards'
+    | 'paynow'
+    | 'bizum'
+    | 'promptpay';
   type PaymentMethodSavePolicyEnum = 'always' | 'ask' | 'never';
   type PaymentMethodTypeEnum =
     | 'card'
@@ -588,7 +596,10 @@ declare module 'chargebee' {
     | 'alipay_hk'
     | 'paypay'
     | 'gcash'
-    | 'south_korean_cards';
+    | 'south_korean_cards'
+    | 'paynow'
+    | 'bizum'
+    | 'promptpay';
   type PaymentVoucherTypeEnum = 'boleto';
   type PeriodUnitEnum = 'day' | 'week' | 'month' | 'year';
   type PriceTypeEnum = 'tax_exclusive' | 'tax_inclusive';
@@ -628,7 +639,14 @@ declare module 'chargebee' {
     | 'js_api'
     | 'migration'
     | 'external_service';
-  type StatusEnum = 'available' | 'exhausted' | 'scheduled' | 'in_grace_period';
+  type StatusEnum =
+    | 'active'
+    | 'archived'
+    | 'deleted'
+    | 'available'
+    | 'exhausted'
+    | 'scheduled'
+    | 'in_grace_period';
   type TaxExemptReasonEnum =
     | 'tax_not_configured'
     | 'region_non_taxable'
@@ -649,7 +667,16 @@ declare module 'chargebee' {
     | 'special'
     | 'unincorporated'
     | 'other';
-  type TaxOverrideReasonEnum = 'id_exempt' | 'customer_exempt' | 'export';
+  type TaxOverrideReasonEnum =
+    | 'zero_rated'
+    | 'id_exempt'
+    | 'customer_exempt'
+    | 'region_non_taxable'
+    | 'product_exempt'
+    | 'export'
+    | 'high_value_physical_goods'
+    | 'zero_value_item'
+    | 'tax_not_configured_external_provider';
   type TaxabilityEnum = 'taxable' | 'exempt';
   type TaxjarExemptionCategoryEnum = 'wholesale' | 'government' | 'other';
   type TrialEndActionEnum =
@@ -705,10 +732,16 @@ declare module 'chargebee' {
     | 'paypay'
     | 'gcash'
     | 'south_korean_cards'
+    | 'paynow'
+    | 'bizum'
+    | 'promptpay'
     | 'free_trial'
     | 'pay_up_front'
     | 'pay_as_you_go'
-    | 'usage_exceeded';
+    | 'simple'
+    | 'compound'
+    | 'usage_exceeded'
+    | 'spend_exceeded';
   type UnbilledChargesHandlingEnum = 'no_action' | 'invoice';
   type UnbilledChargesOptionEnum = 'invoice' | 'delete';
   type UnpaidInvoicesHandlingEnum = 'no_action' | 'schedule_payment_collection';
@@ -884,6 +917,7 @@ declare module 'chargebee' {
     | 'business_entity_deleted'
     | 'customer_business_entity_changed'
     | 'subscription_business_entity_changed'
+    | 'payment_source_business_entity_changed'
     | 'purchase_created'
     | 'voucher_created'
     | 'voucher_expired'

package/types/index.d.ts

@@ -3,6 +3,8 @@
 ///<reference path='./resources/AdvanceInvoiceSchedule.d.ts' />
 ///<reference path='./resources/Alert.d.ts' />
 ///<reference path='./resources/AlertStatus.d.ts' />
+///<reference path='./resources/AsyncResponse.d.ts' />
+///<reference path='./resources/AsyncResponseList.d.ts' />
 ///<reference path='./resources/AttachedItem.d.ts' />
 ///<reference path='./resources/Attribute.d.ts' />
 ///<reference path='./resources/BillingConfiguration.d.ts' />
@@ -10,6 +12,7 @@
 ///<reference path='./resources/BusinessEntity.d.ts' />
 ///<reference path='./resources/BusinessEntityTransfer.d.ts' />
 ///<reference path='./resources/Card.d.ts' />
+///<reference path='./resources/ColumnDefinition.d.ts' />
 ///<reference path='./resources/Comment.d.ts' />
 ///<reference path='./resources/Configuration.d.ts' />
 ///<reference path='./resources/Contact.d.ts' />
@@ -53,6 +56,8 @@
 ///<reference path='./resources/LedgerAccountBalance.d.ts' />
 ///<reference path='./resources/LedgerOperation.d.ts' />
 ///<reference path='./resources/Metadata.d.ts' />
+///<reference path='./resources/Meter.d.ts' />
+///<reference path='./resources/MeteredFeature.d.ts' />
 ///<reference path='./resources/NonSubscription.d.ts' />
 ///<reference path='./resources/OfferEvent.d.ts' />
 ///<reference path='./resources/OfferFulfillment.d.ts' />
@@ -170,14 +175,14 @@ declare module 'chargebee' {
     httpClient?: HttpClientInterface;
 
     /**
-     * @telemetryAdapter optional telemetry adapter for observability (e.g. OpenTelemetry)
+     * @enableValidation When true, every request's parameters are validated against each endpoint's generated Zod schema before the HTTP request is sent. Violations throw `ChargebeeZodValidationError` with structured Zod issues. Calls with no params argument are validated as `{}`. Required resource ids in the URL path are still checked separately.
      */
-    telemetryAdapter?: TelemetryAdapter;
+    enableValidation?: boolean;
 
     /**
-     * @enableValidation When true, every request's parameters are validated against each endpoint's generated Zod schema before the HTTP request is sent. Violations throw `ChargebeeZodValidationError` with structured Zod issues. Calls with no params argument are validated as `{}`. Required resource ids in the URL path are still checked separately.
+     * @telemetryAdapter optional telemetry adapter for observability (e.g. OpenTelemetry)
      */
-    enableValidation?: boolean;
+    telemetryAdapter?: TelemetryAdapter;
   };
 
   export interface HttpClientInterface {
@@ -214,10 +219,7 @@ declare module 'chargebee' {
     chargebeeApiVersion: 'v1' | 'v2';
     sdkName: string;
     sdkVersion: string;
-    /**
-     * Prebuilt span attributes — pass these to your tracer. Captured `chargebee-*` request
-     * headers appear as `http.request.header.<name>` with string[] values per OTel semconv.
-     */
+    /** Prebuilt span attributes — pass these to your tracer. */
     startAttributes: Record<string, string | string[]>;
   };
 
@@ -297,6 +299,8 @@ declare module 'chargebee' {
     itemPrice: ItemPrice.ItemPriceResource;
     ledgerAccountBalance: LedgerAccountBalance.LedgerAccountBalanceResource;
     ledgerOperation: LedgerOperation.LedgerOperationResource;
+    meter: Meter.MeterResource;
+    meteredFeature: MeteredFeature.MeteredFeatureResource;
     nonSubscription: NonSubscription.NonSubscriptionResource;
     offerEvent: OfferEvent.OfferEventResource;
     offerFulfillment: OfferFulfillment.OfferFulfillmentResource;

package/types/resources/Alert.d.ts

@@ -7,12 +7,15 @@ declare module 'chargebee' {
     type: TypeEnum;
     name: string;
     description?: string;
-    metered_feature_id: string;
+    metered_feature_id?: string;
+    currency_code?: string;
     subscription_id?: string;
     status?: 'enabled' | 'disabled';
     meta?: string;
     created_at: number;
     updated_at: number;
+    threshold?: Alert.Threshold[];
+    filter_conditions?: Alert.FilterCondition[];
   }
 
   export namespace Alert {
@@ -76,6 +79,15 @@ declare module 'chargebee' {
       next_offset?: string;
     }
 
+    export interface Threshold {
+      mode: 'absolute' | 'percentage';
+      value: number;
+    }
+    export interface FilterCondition {
+      field: 'plan_price_id';
+      operator: 'equals' | 'not_equals';
+      value: string;
+    }
     // REQUEST PARAMS
     //---------------
 
@@ -83,7 +95,8 @@ declare module 'chargebee' {
       type: TypeEnum;
       name: string;
       description?: string;
-      metered_feature_id: string;
+      metered_feature_id?: string;
+      currency_code?: string;
       subscription_id?: string;
       meta?: string;
       threshold?: ThresholdCreateInputParam;
@@ -108,7 +121,7 @@ declare module 'chargebee' {
       type?: filter.Enum;
     }
     export interface ThresholdCreateInputParam {
-      mode: ModeEnum;
+      mode?: ModeEnum;
       value: number;
     }
 

package/types/resources/AsyncResponse.d.ts

@@ -0,0 +1,35 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface AsyncResponse {
+    api_version?: string;
+    created_at?: number;
+    completed_at?: number;
+    status: 'success' | 'failed';
+    request?: AsyncResponse.RequestAsyncApi;
+    error_detail?: AsyncResponse.Error;
+    result?: any;
+  }
+
+  export namespace AsyncResponse {
+    export interface RequestAsyncApi {
+      id: string;
+      resource?: string;
+      operation_type?: string;
+      method?: string;
+      uri?: string;
+      idempotency_key?: string;
+    }
+    export interface Error {
+      message?: string;
+      type?: string;
+      api_error_code?: string;
+      error_code?: string;
+      error_msg?: string;
+      http_status_code?: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/AsyncResponseList.d.ts

@@ -0,0 +1,8 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface AsyncResponseList {
+    list?: AsyncResponse[];
+  }
+}

package/types/resources/ColumnDefinition.d.ts

@@ -0,0 +1,9 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface ColumnDefinition {
+    column_name: string;
+    data_type: 'number' | 'string';
+  }
+}

package/types/resources/Content.d.ts

@@ -8,6 +8,8 @@ declare module 'chargebee' {
     advance_invoice_schedule: AdvanceInvoiceSchedule;
     alert: Alert;
     alert_status: AlertStatus;
+    async_response: AsyncResponse;
+    async_response_list: AsyncResponseList;
     attached_item: AttachedItem;
     attribute: Attribute;
     billing_configuration: BillingConfiguration;
@@ -15,6 +17,7 @@ declare module 'chargebee' {
     business_entity: BusinessEntity;
     business_entity_transfer: BusinessEntityTransfer;
     card: Card;
+    column_definition: ColumnDefinition;
     comment: Comment;
     configuration: Configuration;
     contact: Contact;
@@ -58,6 +61,8 @@ declare module 'chargebee' {
     ledger_account_balance: LedgerAccountBalance;
     ledger_operation: LedgerOperation;
     metadata: Metadata;
+    meter: Meter;
+    metered_feature: MeteredFeature;
     non_subscription: NonSubscription;
     offer_event: OfferEvent;
     offer_fulfillment: OfferFulfillment;

package/types/resources/CreditNote.d.ts

@@ -58,6 +58,7 @@ declare module 'chargebee' {
     deleted: boolean;
     tax_category?: string;
     local_currency_exchange_rate?: number;
+    exchange_rates?: CreditNote.ExchangeRate[];
     create_reason_code?: string;
     vat_number_prefix?: string;
     business_entity_id?: string;
@@ -261,6 +262,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;
@@ -388,6 +394,10 @@ declare module 'chargebee' {
         | 'pending';
       tax_application?: 'pre_tax' | 'post_tax';
     }
+    export interface ExchangeRate {
+      currency_code: string;
+      rate: number;
+    }
     export interface ShippingAddress {
       first_name?: string;
       last_name?: string;
@@ -694,6 +704,11 @@ declare module 'chargebee' {
       tax9_amount?: number;
       tax10_name?: string;
       tax10_amount?: number;
+      proration_mode?:
+        | 'reset'
+        | 'delta'
+        | 'service_period_revision'
+        | 'adjusted_term';
     }
   }
 }

package/types/resources/CreditNoteEstimate.d.ts

@@ -70,6 +70,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/Customer.d.ts

@@ -774,7 +774,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -971,7 +974,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       /**
        * @deprecated Please refer API docs to use other attributes
        */

package/types/resources/Estimate.d.ts

@@ -1070,7 +1070,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1172,7 +1175,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1298,6 +1304,7 @@ declare module 'chargebee' {
       avalara_service_type?: number;
       date_from?: number;
       date_to?: number;
+      entity_description?: string;
     }
     export interface DiscountsCreateInvoiceForItemsInputParam {
       percentage?: number;
@@ -1325,6 +1332,8 @@ declare module 'chargebee' {
       unit_price_in_decimal?: string;
       date_from?: number;
       date_to?: number;
+      description?: string;
+      entity_description?: string;
     }
     export interface TaxProvidersFieldsCreateInvoiceForItemsInputParam {
       provider_name?: string;

package/types/resources/Event.d.ts

@@ -200,6 +200,7 @@ declare module 'chargebee' {
       OmnichannelSubscriptionItemGracePeriodStartedContent &
       CardExpiryReminderContent &
       TokenCreatedContent &
+      PaymentSourceBusinessEntityChangedContent &
       PromotionalCreditsAddedContent &
       SubscriptionRampUpdatedContent &
       CustomerEntitlementsUpdatedContent &

package/types/resources/Export.d.ts

@@ -473,6 +473,7 @@ declare module 'chargebee' {
       offline_payment_method?: filter.Enum;
       auto_close_invoices?: filter.Boolean;
       channel?: filter.Enum;
+      decommissioned?: filter.Boolean;
       plan_id?: filter.String;
     }
 

package/types/resources/Feature.d.ts

@@ -13,6 +13,7 @@ declare module 'chargebee' {
     resource_version?: number;
     updated_at?: number;
     created_at: number;
+    metered: boolean;
     levels?: Feature.Level[];
   }
 
@@ -109,6 +110,7 @@ declare module 'chargebee' {
       id?: filter.String;
       status?: filter.Enum;
       type?: filter.Enum;
+      metered?: filter.Boolean;
       [key: `cf_${string}`]: unknown;
     }
     export interface CreateInputParam {

package/types/resources/Gift.d.ts

@@ -228,7 +228,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -324,7 +327,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/GrantBlock.d.ts

@@ -15,7 +15,6 @@ declare module 'chargebee' {
     voided_amount: string;
     origin_grant_block_id?: string;
     status: StatusEnum;
-    metadata?: string;
     grant_source:
       | 'subscription_created'
       | 'subscription_changed'
@@ -26,6 +25,7 @@ declare module 'chargebee' {
     account_type?: 'provisioned' | 'overdraft';
     unit_id?: string;
     unit_type?: 'credit_unit';
+    metadata?: any;
   }
 
   export namespace GrantBlock {

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,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1465,7 +1484,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1505,6 +1527,7 @@ declare module 'chargebee' {
     }
 
     export interface ChargesCreateForChargeItemsAndChargesInputParam {
+      entity_description?: string;
       amount?: number;
       amount_in_decimal?: string;
       description?: string;
@@ -1545,6 +1568,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 +1766,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/LedgerOperation.d.ts

@@ -15,8 +15,6 @@ 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;
@@ -24,12 +22,12 @@ declare module 'chargebee' {
     parent_ledger_operation_id?: string;
     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';
+    metadata?: any;
   }
 
   export namespace LedgerOperation {