chargebee 3.6.0 → 3.7.0

package/CHANGELOG.md

@@ -1,3 +1,44 @@
+### v3.7.0 (2025-05-15)
+* * * 
+
+### New Resources
+* UsageFile has been added.
+
+### Input Parameter
+* discount[apply_on] has been made optional from required in Estimate#CreateSubItemEstimateRequest.
+* discount[apply_on] has been made optional from required in Estimate#CreateSubItemForCustomerEstimateRequest.
+* discount[apply_on] has been made optional from required in Estimate#UpdateSubscriptionForItemsRequest.
+* discount[apply_on] has been made optional from required in HostedPage#CheckoutNewForItemsRequest.
+* discount[apply_on] has been made optional from required in HostedPage#CheckoutNewForItemsRequest.
+* discount[apply_on] has been made optional from required in HostedPage#CheckoutNewForItemsRequest.
+* discount[apply_on] has been made optional from required in HostedPage#CheckoutNewForItemsRequest.
+* discount[apply_on] has been made optional from required in PricingPageSession#CheckoutNewForItemsRequest.
+* discount[apply_on] has been made optional from required in PricingPageSession#CreateForExistingSubscriptionRequest.
+* discount[apply_on] has been made optional from required in Quote#CreateSubItemsForCustomerQuoteRequest.
+* discount[apply_on] has been made optional from required in Quote#EditCreateSubCustomerQuoteForItemsRequest.
+* discount[apply_on] has been made optional from required in Quote#UpdateSubscriptionQuoteForItemsRequest.
+* discount[apply_on] has been made optional from required in Quote#EditUpdateSubscriptionQuoteForItemsRequest.
+* discount[apply_on] has been made optional from required in Subscription#CreateWithItemsRequest.
+* discount[apply_on] has been made optional from required in Subscription#UpdateForItemsRequest.
+* discount[apply_on] has been made optional from required in Subscription#ImportForItemsRequest.
+* line_item_addresses[] has been added to  Invoice#ImportInvoiceRequest.
+* source has been added to OmnichannelSubscription#OmnichannelSubscriptionListRequest.
+
+### Attributes: 
+* swift_code has been made optional from required in VirtualBankAccount.
+
+### Enum Attributes: 
+* OMNICHANNEL_SUBSCRIPTION_ITEM_PAUSED has been added to EventTypeEnum.
+* PAUSED has been added to OmnichannelSubscriptionItem#StatusEnum.
+* MERCHANT_REVOKED has been added to OmnichannelSubscriptionItem#CancellationReasonEnum.
+
+### v3.6.1 (2025-04-25)
+* * * 
+
+### Bug fixes: 
+* Fixed an issue where the optional boolean field is_percentage_pricing at Item Model was incorrectly marked as required.
+* Fixed an issue where the optional enum field item_applicability at Item Model was incorrectly marked as required.
+
 ### v3.6.0 (2025-04-23)
 * * * 
 

package/cjs/environment.js

@@ -11,7 +11,7 @@ exports.Environment = {
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
     timeout: DEFAULT_TIME_OUT,
-    clientVersion: 'v3.6.0',
+    clientVersion: 'v3.6.1',
     port: DEFAULT_PORT,
     timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
     exportWaitInMillis: DEFAULT_EXPORT_WAIT,

package/cjs/resources/api_endpoints.js

@@ -2860,4 +2860,26 @@ exports.Endpoints = {
         ],
     ],
     omnichannelSubscriptionItemScheduledChange: [],
+    usageFile: [
+        [
+            'upload',
+            'POST',
+            '/usage_files',
+            '/upload',
+            false,
+            'file-ingest',
+            false,
+            {},
+        ],
+        [
+            'status',
+            'GET',
+            '/usage_files',
+            '/status',
+            true,
+            'file-ingest',
+            false,
+            {},
+        ],
+    ],
 };

package/esm/environment.js

@@ -8,7 +8,7 @@ export const Environment = {
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
     timeout: DEFAULT_TIME_OUT,
-    clientVersion: 'v3.6.0',
+    clientVersion: 'v3.6.1',
     port: DEFAULT_PORT,
     timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
     exportWaitInMillis: DEFAULT_EXPORT_WAIT,

package/esm/resources/api_endpoints.js

@@ -2857,4 +2857,26 @@ export const Endpoints = {
         ],
     ],
     omnichannelSubscriptionItemScheduledChange: [],
+    usageFile: [
+        [
+            'upload',
+            'POST',
+            '/usage_files',
+            '/upload',
+            false,
+            'file-ingest',
+            false,
+            {},
+        ],
+        [
+            'status',
+            'GET',
+            '/usage_files',
+            '/status',
+            true,
+            'file-ingest',
+            false,
+            {},
+        ],
+    ],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chargebee",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "A library for integrating with Chargebee.",
   "scripts": {
     "prepack": "npm install && npm run build",

package/types/core.d.ts

@@ -344,6 +344,7 @@ declare module 'chargebee' {
     | 'sales_order_created'
     | 'sales_order_updated'
     | 'omnichannel_subscription_item_changed'
+    | 'omnichannel_subscription_item_paused'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'

package/types/index.d.ts

@@ -81,6 +81,7 @@
 ///<reference path='./resources/UnbilledCharge.d.ts' />
 ///<reference path='./resources/Usage.d.ts' />
 ///<reference path='./resources/UsageEvent.d.ts' />
+///<reference path='./resources/UsageFile.d.ts' />
 ///<reference path='./resources/VirtualBankAccount.d.ts' />
 
 export type Config = {
@@ -180,6 +181,7 @@ declare module 'chargebee' {
     unbilledCharge: UnbilledCharge.UnbilledChargeResource;
     usage: Usage.UsageResource;
     usageEvent: UsageEvent.UsageEventResource;
+    usageFile: UsageFile.UsageFileResource;
     virtualBankAccount: VirtualBankAccount.VirtualBankAccountResource;
   }
 }

package/types/resources/Estimate.d.ts

@@ -615,7 +615,7 @@ declare module 'chargebee' {
       charge_on_option?: ChargeOnOptionEnum;
     }
     export interface DiscountsCreateSubItemEstimateInputParam {
-      apply_on: ApplyOnEnum;
+      apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
@@ -751,7 +751,7 @@ declare module 'chargebee' {
       charge_on_option?: ChargeOnOptionEnum;
     }
     export interface DiscountsCreateSubItemForCustomerEstimateInputParam {
-      apply_on: ApplyOnEnum;
+      apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
@@ -909,7 +909,7 @@ declare module 'chargebee' {
       proration_type?: ProrationTypeEnum;
     }
     export interface DiscountsUpdateSubscriptionForItemsInputParam {
-      apply_on: ApplyOnEnum;
+      apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;

package/types/resources/HostedPage.d.ts

@@ -842,7 +842,7 @@ declare module 'chargebee' {
       charge_on_option?: ChargeOnOptionEnum;
     }
     export interface DiscountsCheckoutNewForItemsInputParam {
-      apply_on: ApplyOnEnum;
+      apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
@@ -977,7 +977,7 @@ declare module 'chargebee' {
       item_type?: ItemTypeEnum;
     }
     export interface DiscountsCheckoutExistingForItemsInputParam {
-      apply_on: ApplyOnEnum;
+      apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;

package/types/resources/Invoice.d.ts

@@ -956,6 +956,7 @@ declare module 'chargebee' {
       taxes?: TaxesImportInvoiceInputParam[];
       payments?: PaymentsImportInvoiceInputParam[];
       notes?: NotesImportInvoiceInputParam[];
+      line_item_addresses?: LineItemAddressesImportInvoiceInputParam[];
     }
     export interface ApplyPaymentsInputParam {
       comment?: string;
@@ -1539,6 +1540,23 @@ declare module 'chargebee' {
       quantity_used_in_decimal?: string;
       unit_amount_in_decimal?: string;
     }
+    export interface LineItemAddressesImportInvoiceInputParam {
+      line_item_id?: string;
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatusEnum;
+    }
     export interface LineItemsImportInvoiceInputParam {
       id?: string;
       date_from?: number;

package/types/resources/Item.d.ts

@@ -19,12 +19,12 @@ declare module 'chargebee' {
     enabled_for_checkout: boolean;
     enabled_in_portal: boolean;
     included_in_mrr?: boolean;
-    item_applicability: 'all' | 'restricted';
+    item_applicability?: 'all' | 'restricted';
     gift_claim_redirect_url?: string;
     unit?: string;
     metered: boolean;
     usage_calculation?: 'sum_of_usages' | 'last_usage' | 'max_usage';
-    is_percentage_pricing: boolean;
+    is_percentage_pricing?: boolean;
     archived_at?: number;
     channel?: ChannelEnum;
     applicable_items?: Item.ApplicableItem[];

package/types/resources/OmnichannelSubscription.d.ts

@@ -67,6 +67,7 @@ declare module 'chargebee' {
     export interface ListInputParam {
       limit?: number;
       offset?: string;
+      source?: filter.Enum;
       customer_id?: filter.String;
     }
     export interface OmnichannelTransactionsForOmnichannelSubscriptionInputParam {

package/types/resources/OmnichannelSubscriptionItem.d.ts

@@ -11,7 +11,8 @@ declare module 'chargebee' {
       | 'expired'
       | 'cancelled'
       | 'in_dunning'
-      | 'in_grace_period';
+      | 'in_grace_period'
+      | 'paused';
     auto_renew_status?: 'off' | 'on';
     current_term_start?: number;
     current_term_end?: number;
@@ -22,7 +23,8 @@ declare module 'chargebee' {
       | 'customer_cancelled'
       | 'customer_did_not_consent_to_price_increase'
       | 'refunded_due_to_app_issue'
-      | 'refunded_for_other_reason';
+      | 'refunded_for_other_reason'
+      | 'merchant_revoked';
     grace_period_expires_at?: number;
     has_scheduled_changes: boolean;
     resource_version?: number;

package/types/resources/PricingPageSession.d.ts

@@ -98,7 +98,7 @@ declare module 'chargebee' {
     }
 
     export interface DiscountsCreateForNewSubscriptionInputParam {
-      apply_on: ApplyOnEnum;
+      apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
@@ -116,7 +116,7 @@ declare module 'chargebee' {
     }
 
     export interface DiscountsCreateForExistingSubscriptionInputParam {
-      apply_on: ApplyOnEnum;
+      apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;

package/types/resources/Quote.d.ts

@@ -1083,7 +1083,7 @@ declare module 'chargebee' {
       charge_on_option?: ChargeOnOptionEnum;
     }
     export interface DiscountsCreateSubItemsForCustomerQuoteInputParam {
-      apply_on: ApplyOnEnum;
+      apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
@@ -1153,7 +1153,7 @@ declare module 'chargebee' {
       charge_on_option?: ChargeOnOptionEnum;
     }
     export interface DiscountsEditCreateSubCustomerQuoteForItemsInputParam {
-      apply_on: ApplyOnEnum;
+      apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
@@ -1249,7 +1249,7 @@ declare module 'chargebee' {
       item_type?: ItemTypeEnum;
     }
     export interface DiscountsUpdateSubscriptionQuoteForItemsInputParam {
-      apply_on: ApplyOnEnum;
+      apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
@@ -1346,7 +1346,7 @@ declare module 'chargebee' {
       item_type?: ItemTypeEnum;
     }
     export interface DiscountsEditUpdateSubscriptionQuoteForItemsInputParam {
-      apply_on: ApplyOnEnum;
+      apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;

package/types/resources/Subscription.d.ts

@@ -1644,7 +1644,7 @@ declare module 'chargebee' {
       usage_accumulation_reset_frequency?: UsageAccumulationResetFrequencyEnum;
     }
     export interface DiscountsCreateWithItemsInputParam {
-      apply_on: ApplyOnEnum;
+      apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
@@ -1981,7 +1981,7 @@ declare module 'chargebee' {
       usage_accumulation_reset_frequency?: UsageAccumulationResetFrequencyEnum;
     }
     export interface DiscountsUpdateForItemsInputParam {
-      apply_on: ApplyOnEnum;
+      apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
@@ -2389,7 +2389,7 @@ declare module 'chargebee' {
       item_type?: ItemTypeEnum;
     }
     export interface DiscountsImportForItemsInputParam {
-      apply_on: ApplyOnEnum;
+      apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;

package/types/resources/UsageFile.d.ts

@@ -0,0 +1,56 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface UsageFile {
+    id: string;
+    name: string;
+    mime_type: string;
+    error_code?: string;
+    error_reason?: string;
+    status?: 'queued' | 'imported' | 'processing' | 'processed' | 'failed';
+    total_records_count?: number;
+    processed_records_count?: number;
+    failed_records_count?: number;
+    file_size_in_bytes?: number;
+    processing_started_at?: number;
+    processing_completed_at?: number;
+    uploaded_by?: string;
+    uploaded_at?: number;
+    upload_details?: UsageFile.UploadDetail;
+  }
+
+  export namespace UsageFile {
+    export class UsageFileResource {
+      upload(
+        input: UploadInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UploadResponse>>;
+
+      status(
+        usage_file_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<StatusResponse>>;
+    }
+
+    export interface UploadResponse {
+      usage_file: UsageFile;
+    }
+
+    export interface StatusResponse {
+      usage_file: UsageFile;
+    }
+
+    export interface UploadDetail {
+      url: string;
+      expires_at: number;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface UploadInputParam {
+      file_name: string;
+      mime_type: string;
+    }
+  }
+}

package/types/resources/VirtualBankAccount.d.ts

@@ -17,7 +17,7 @@ declare module 'chargebee' {
     bank_name?: string;
     account_number: string;
     routing_number?: string;
-    swift_code: string;
+    swift_code?: string;
     gateway: GatewayEnum;
     gateway_account_id: string;
     resource_version?: number;