chargebee 3.28.1 → 3.30.0

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' />
@@ -20,6 +23,7 @@
 ///<reference path='./resources/CpqQuoteSignature.d.ts' />
 ///<reference path='./resources/CreditNote.d.ts' />
 ///<reference path='./resources/CreditNoteEstimate.d.ts' />
+///<reference path='./resources/CreditUnit.d.ts' />
 ///<reference path='./resources/Currency.d.ts' />
 ///<reference path='./resources/Customer.d.ts' />
 ///<reference path='./resources/CustomerEntitlement.d.ts' />
@@ -51,8 +55,11 @@
 ///<reference path='./resources/ItemFamily.d.ts' />
 ///<reference path='./resources/ItemPrice.d.ts' />
 ///<reference path='./resources/LedgerAccountBalance.d.ts' />
+///<reference path='./resources/LedgerEntry.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 +177,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 +221,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[]>;
   };
 
@@ -276,6 +280,7 @@ declare module 'chargebee' {
     couponCode: CouponCode.CouponCodeResource;
     couponSet: CouponSet.CouponSetResource;
     creditNote: CreditNote.CreditNoteResource;
+    creditUnit: CreditUnit.CreditUnitResource;
     currency: Currency.CurrencyResource;
     customer: Customer.CustomerResource;
     customerEntitlement: CustomerEntitlement.CustomerEntitlementResource;
@@ -297,6 +302,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,16 @@ declare module 'chargebee' {
     type: TypeEnum;
     name: string;
     description?: string;
-    metered_feature_id: string;
+    metered_feature_id?: string;
+    currency_code?: string;
+    unit_id?: 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 +80,15 @@ declare module 'chargebee' {
       next_offset?: string;
     }
 
+    export interface Threshold {
+      mode: ModeEnum;
+      value: number;
+    }
+    export interface FilterCondition {
+      field: 'plan_price_id';
+      operator: 'equals' | 'not_equals';
+      value: string;
+    }
     // REQUEST PARAMS
     //---------------
 
@@ -83,7 +96,9 @@ declare module 'chargebee' {
       type: TypeEnum;
       name: string;
       description?: string;
-      metered_feature_id: string;
+      metered_feature_id?: string;
+      currency_code?: string;
+      unit_id?: string;
       subscription_id?: string;
       meta?: string;
       threshold?: ThresholdCreateInputParam;
@@ -108,7 +123,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/AttachedItem.d.ts

@@ -11,8 +11,8 @@ declare module 'chargebee' {
     quantity?: number;
     quantity_in_decimal?: string;
     billing_cycles?: number;
-    charge_on_event: ChargeOnEventEnum;
-    charge_once: boolean;
+    charge_on_event?: ChargeOnEventEnum;
+    charge_once?: boolean;
     created_at: number;
     resource_version?: number;
     updated_at?: number;

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;
@@ -25,6 +28,7 @@ declare module 'chargebee' {
     cpq_quote_signature: CpqQuoteSignature;
     credit_note: CreditNote;
     credit_note_estimate: CreditNoteEstimate;
+    credit_unit: CreditUnit;
     currency: Currency;
     customer: Customer;
     customer_entitlement: CustomerEntitlement;
@@ -56,8 +60,11 @@ declare module 'chargebee' {
     item_family: ItemFamily;
     item_price: ItemPrice;
     ledger_account_balance: LedgerAccountBalance;
+    ledger_entry: LedgerEntry;
     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/CreditUnit.d.ts

@@ -0,0 +1,90 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface CreditUnit {
+    id: string;
+    name: string;
+    external_name: string;
+    status?: 'active' | 'archived';
+    resource_version?: number;
+    updated_at?: number;
+    created_at: number;
+    created_by?: string;
+    updated_by?: string;
+    is_unlimited: boolean;
+    overdraft_amount?: string;
+  }
+
+  export namespace CreditUnit {
+    export class CreditUnitResource {
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      update(
+        credit_unit_id: string,
+        input?: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      archive(
+        credit_unit_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ArchiveResponse>>;
+
+      reactivate(
+        credit_unit_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ReactivateResponse>>;
+    }
+
+    export interface ListResponse {
+      list: { credit_unit: CreditUnit }[];
+      next_offset?: string;
+    }
+
+    export interface CreateResponse {
+      credit_unit: CreditUnit;
+    }
+
+    export interface UpdateResponse {
+      credit_unit: CreditUnit;
+    }
+
+    export interface ArchiveResponse {
+      credit_unit: CreditUnit;
+    }
+
+    export interface ReactivateResponse {
+      credit_unit: CreditUnit;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      status?: filter.Enum;
+      id?: filter.String;
+    }
+    export interface CreateInputParam {
+      id: string;
+      name: string;
+      is_unlimited: boolean;
+      overdraft_amount?: string;
+      external_name?: string;
+    }
+    export interface UpdateInputParam {
+      name?: string;
+      external_name?: string;
+    }
+  }
+}

package/types/resources/Customer.d.ts

@@ -774,7 +774,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
@@ -971,7 +978,14 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay'
+        | 'dana'
+        | 'touch_n_go'
+        | 'tamara'
+        | 'qpay';
       /**
        * @deprecated Please refer API docs to use other attributes
        */

package/types/resources/Estimate.d.ts

@@ -387,6 +387,7 @@ declare module 'chargebee' {
       refundable_credits_handling?: RefundableCreditsHandlingEnum;
       contract_term_cancel_option?: ContractTermCancelOptionEnum;
       invoice_date?: number;
+      include_cancellation_day_in_billing?: boolean;
       cancel_reason_code?: string;
       subscription_items?: SubscriptionItemsCancelSubscriptionForItemsInputParam[];
     }
@@ -1070,7 +1071,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
@@ -1172,7 +1180,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
@@ -1298,6 +1313,7 @@ declare module 'chargebee' {
       avalara_service_type?: number;
       date_from?: number;
       date_to?: number;
+      entity_description?: string;
     }
     export interface DiscountsCreateInvoiceForItemsInputParam {
       percentage?: number;
@@ -1325,6 +1341,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

@@ -28,6 +28,7 @@ declare module 'chargebee' {
       TaxWithheldDeletedContent &
       UnbilledChargesDeletedContent &
       CouponUpdatedContent &
+      GrantBlocksCreatedContent &
       OmnichannelSubscriptionItemReactivatedContent &
       OmnichannelSubscriptionItemRenewedContent &
       UnbilledChargesCreatedContent &
@@ -169,6 +170,7 @@ declare module 'chargebee' {
       SubscriptionDeletedContent &
       PaymentSourceAddedContent &
       SubscriptionMovedInContent &
+      LedgerUpdatedContent &
       ItemPriceCreatedContent &
       SubscriptionScheduledCancellationRemovedContent &
       PaymentRefundedContent &
@@ -200,8 +202,10 @@ declare module 'chargebee' {
       OmnichannelSubscriptionItemGracePeriodStartedContent &
       CardExpiryReminderContent &
       TokenCreatedContent &
+      PaymentSourceBusinessEntityChangedContent &
       PromotionalCreditsAddedContent &
       SubscriptionRampUpdatedContent &
+      LedgerAccountBalanceUpdatedContent &
       CustomerEntitlementsUpdatedContent &
       PaymentSourceExpiredContent &
       CustomerMovedOutContent &
@@ -232,6 +236,7 @@ declare module 'chargebee' {
       AttachedItemUpdatedContent &
       PaymentSourceUpdatedContent &
       BusinessEntityDeletedContent &
+      GrantBlocksUpdatedContent &
       AuthorizationVoidedContent &
       SubscriptionRampDeletedContent &
       PlanDeletedContent &

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,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
@@ -324,7 +331,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/GrantBlock.d.ts

@@ -4,6 +4,10 @@
 declare module 'chargebee' {
   export interface GrantBlock {
     id: string;
+    subscription_id?: string;
+    account_type?: 'provisioned' | 'overdraft';
+    unit_id?: string;
+    unit_type?: 'credit_unit';
     granted_amount: string;
     effective_from: number;
     expires_at: number;
@@ -15,17 +19,18 @@ declare module 'chargebee' {
     voided_amount: string;
     origin_grant_block_id?: string;
     status: StatusEnum;
-    metadata?: string;
     grant_source:
       | 'subscription_created'
       | 'subscription_changed'
       | 'top_up'
       | 'promotional_grants'
-      | 'rollover';
-    created_at?: number;
-    account_type?: 'provisioned' | 'overdraft';
-    unit_id?: string;
-    unit_type?: 'credit_unit';
+      | 'rollover'
+      | 'grant_renewal'
+      | 'subscription_renewed';
+    created_at: number;
+    modified_at: number;
+    resource_version?: number;
+    metadata?: any;
   }
 
   export namespace GrantBlock {
@@ -49,6 +54,7 @@ declare module 'chargebee' {
       offset?: string;
       subscription_id: filter.String;
       unit_id?: filter.String;
+      account_type?: filter.Enum;
       effective_from?: filter.Timestamp;
       expires_at?: filter.Timestamp;
       created_at?: filter.Timestamp;