chargebee 3.0.0-beta.3 → 3.0.0-beta.4

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+### v3.0.0-beta.4 (2024-10-18)
+
+#### New Resource:
+* PaymentScheduleEstimate has been added. 
+
+### New Attributes: 
+* payment_schedule_estimates has been added to Estimate. 
+* usage_accumulation_reset_frequency has been added to ItemPrice.
+* name has been added to PaymentScheduleScheme.
+* usage_accumulation_reset_frequency has been added to QuotedSubscription#SubscriptionItem.
+* usage_accumulation_reset_frequency has been added to Subscription#SubscriptionItem.
+
+### New Endpoints: 
+* Estimate#PaymentSchedule has been added. 
+
+### New Input Params: 
+* usage_accumulation_reset_frequency has been added to ItemPrice#CreateParams. 
+* usage_accumulation_reset_frequency has been added to ItemPrice#UpdateParams. 
+* discounts has been added to PricingPageSession#CreateForNewSubscriptionParams.
+* discounts has been added to PricingPageSession#CreateForExistingSubscriptionParams.
+* invoice_immediately has been added to Quote#ConvertParams.
+
+### Bug Fixes:
+* metadata field not working bug fixed. 
+
+### Dependency 
+* moved @types/node to devDependencies.
+
 ### v3.0.0-beta.3 (2024-09-20)
 * * *
 

package/cjs/environment.js

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

package/cjs/resources/api_endpoints.js

@@ -665,6 +665,7 @@ exports.Endpoints = {
             '/create_invoice_for_items',
             false,
         ],
+        ['paymentSchedules', 'POST', '/estimates', '/payment_schedules', false],
     ],
     quote: [
         ['retrieve', 'GET', '/quotes', null, true],

package/cjs/util.js

@@ -194,7 +194,7 @@ function encodeParams(paramObj, serialized, scope, index) {
                 }
             }
         }
-        else if (key === 'meta_data') {
+        else if (key === 'meta_data' || key === "metadata") {
             let attrVal = '';
             if (value !== null) {
                 attrVal = encodeURIComponent(Object.prototype.toString.call(value) === '[object String]'

package/esm/environment.js

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

package/esm/resources/api_endpoints.js

@@ -662,6 +662,7 @@ export const Endpoints = {
             '/create_invoice_for_items',
             false,
         ],
+        ['paymentSchedules', 'POST', '/estimates', '/payment_schedules', false],
     ],
     quote: [
         ['retrieve', 'GET', '/quotes', null, true],

package/esm/util.js

@@ -178,7 +178,7 @@ export function encodeParams(paramObj, serialized, scope, index) {
                 }
             }
         }
-        else if (key === 'meta_data') {
+        else if (key === 'meta_data' || key === "metadata") {
             let attrVal = '';
             if (value !== null) {
                 attrVal = encodeURIComponent(Object.prototype.toString.call(value) === '[object String]'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chargebee",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.4",
   "description": "A library for integrating with Chargebee.",
   "scripts": {
     "prepack": "npm install && npm run build",
@@ -33,7 +33,6 @@
     }
   ],
   "dependencies": {
-    "@types/node": "20.0.0"
   },
   "exports": {
     "types": "./types/index.d.ts",
@@ -59,6 +58,7 @@
     }
   },
   "devDependencies": {
+    "@types/node": "20.0.0",
     "prettier": "^3.3.3",
     "typescript": "^5.5.4"
   },

package/types/core.d.ts

@@ -294,9 +294,9 @@ declare module 'chargebee' {
     | 'voucher_create_failed'
     | 'item_price_entitlements_updated'
     | 'item_price_entitlements_removed'
-    | 'ramp_created'
-    | 'ramp_deleted'
-    | 'ramp_applied'
+    | 'subscription_ramp_created'
+    | 'subscription_ramp_deleted'
+    | 'subscription_ramp_applied'
     | 'subscription_ramp_drafted'
     | 'subscription_ramp_updated'
     | 'price_variant_created'
@@ -551,6 +551,9 @@ declare module 'chargebee' {
   type UnbilledChargesHandling = 'no_action' | 'invoice';
   type UnbilledChargesOption = 'invoice' | 'delete';
   type UnpaidInvoicesHandling = 'no_action' | 'schedule_payment_collection';
+  type UsageAccumulationResetFrequency =
+    | 'never'
+    | 'subscription_billing_frequency';
   type ValidationStatus =
     | 'not_validated'
     | 'valid'

package/types/index.d.ts

@@ -45,6 +45,7 @@
 ///<reference path='./resources/PaymentIntent.d.ts' />
 ///<reference path='./resources/PaymentReferenceNumber.d.ts' />
 ///<reference path='./resources/PaymentSchedule.d.ts' />
+///<reference path='./resources/PaymentScheduleEstimate.d.ts' />
 ///<reference path='./resources/PaymentScheduleScheme.d.ts' />
 ///<reference path='./resources/PaymentSource.d.ts' />
 ///<reference path='./resources/PaymentVoucher.d.ts' />

package/types/resources/Card.d.ts

@@ -31,6 +31,8 @@ declare module 'chargebee' {
       | 'carnet'
       | 'rupay'
       | 'maestro'
+      | 'dankort'
+      | 'cartes_bancaires'
       | 'other'
       | 'not_applicable';
     funding_type:

package/types/resources/Coupon.d.ts

@@ -7,7 +7,7 @@ declare module 'chargebee' {
     id: string;
     name: string;
     invoice_name?: string;
-    discount_type: 'fixed_amount' | 'percentage';
+    discount_type: 'fixed_amount' | 'percentage' | 'offer_quantity';
     discount_percentage?: number;
     discount_amount?: number;
     discount_quantity?: number;
@@ -152,7 +152,7 @@ declare module 'chargebee' {
       id: string;
       name: string;
       invoice_name?: string;
-      discount_type?: 'fixed_amount' | 'percentage';
+      discount_type?: 'fixed_amount' | 'percentage' | 'offer_quantity';
       discount_amount?: number;
       currency_code?: string;
       discount_percentage?: number /**
@@ -180,7 +180,7 @@ declare module 'chargebee' {
       id: string;
       name: string;
       invoice_name?: string;
-      discount_type?: 'fixed_amount' | 'percentage';
+      discount_type?: 'fixed_amount' | 'percentage' | 'offer_quantity';
       discount_amount?: number;
       currency_code?: string;
       discount_percentage?: number /**
@@ -207,7 +207,7 @@ declare module 'chargebee' {
     export interface UpdateForItemsInputParam {
       name?: string;
       invoice_name?: string;
-      discount_type?: 'fixed_amount' | 'percentage';
+      discount_type?: 'fixed_amount' | 'percentage' | 'offer_quantity';
       discount_amount?: number;
       currency_code?: string;
       discount_percentage?: number /**
@@ -249,7 +249,7 @@ declare module 'chargebee' {
     export interface UpdateInputParam {
       name?: string;
       invoice_name?: string;
-      discount_type?: 'fixed_amount' | 'percentage';
+      discount_type?: 'fixed_amount' | 'percentage' | 'offer_quantity';
       discount_amount?: number;
       currency_code?: string;
       discount_percentage?: number /**

package/types/resources/Estimate.d.ts

@@ -8,6 +8,7 @@ declare module 'chargebee' {
     subscription_estimates?: SubscriptionEstimate[];
     invoice_estimate?: InvoiceEstimate;
     invoice_estimates?: InvoiceEstimate[];
+    payment_schedule_estimates?: PaymentScheduleEstimate[];
     next_invoice_estimate?: InvoiceEstimate;
     credit_note_estimates?: CreditNoteEstimate[];
     unbilled_charge_estimates?: UnbilledCharge[];
@@ -119,6 +120,11 @@ declare module 'chargebee' {
         input: CreateInvoiceForItemsInputParam,
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<CreateInvoiceForItemsResponse>>;
+
+      paymentSchedules(
+        input: PaymentSchedulesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<PaymentSchedulesResponse>>;
     }
 
     export interface CreateSubscriptionResponse {
@@ -197,6 +203,10 @@ declare module 'chargebee' {
       estimate: Estimate;
     }
 
+    export interface PaymentSchedulesResponse {
+      estimate: Estimate;
+    }
+
     // REQUEST PARAMS
     //---------------
 
@@ -444,6 +454,12 @@ declare module 'chargebee' {
       discounts?: DiscountsCreateInvoiceForItemsInputParam[];
       tax_providers_fields?: TaxProvidersFieldsCreateInvoiceForItemsInputParam[];
     }
+    export interface PaymentSchedulesInputParam {
+      scheme_id: string;
+      amount?: number;
+      invoice_id?: string;
+      payment_schedule_start_date?: number;
+    }
     export interface BillingAddressCreateSubscriptionInputParam {
       line1?: string;
       line2?: string;

package/types/resources/ItemPrice.d.ts

@@ -34,6 +34,7 @@ declare module 'chargebee' {
     resource_version?: number;
     updated_at?: number;
     created_at: number;
+    usage_accumulation_reset_frequency?: UsageAccumulationResetFrequency;
     archived_at?: number;
     invoice_notes?: string;
     tiers?: ItemPrice.Tier[];
@@ -170,6 +171,7 @@ declare module 'chargebee' {
       metadata?: any;
       show_description_in_invoices?: boolean;
       show_description_in_quotes?: boolean;
+      usage_accumulation_reset_frequency?: UsageAccumulationResetFrequency;
       pricing_model?: PricingModel;
       price?: number;
       price_in_decimal?: string;
@@ -197,6 +199,7 @@ declare module 'chargebee' {
       price_variant_id?: string;
       status?: 'active' | 'archived';
       external_name?: string;
+      usage_accumulation_reset_frequency?: UsageAccumulationResetFrequency;
       currency_code?: string;
       invoice_notes?: string;
       is_taxable?: boolean;

package/types/resources/PaymentScheduleEstimate.d.ts

@@ -0,0 +1,25 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface PaymentScheduleEstimate {
+    id: string;
+    scheme_id: string;
+    entity_type: 'invoice';
+    entity_id?: string;
+    amount: number;
+    currency_code?: string;
+    schedule_entries?: PaymentScheduleEstimate.ScheduleEntry[];
+  }
+
+  export namespace PaymentScheduleEstimate {
+    export interface ScheduleEntry {
+      id: string;
+      date: number;
+      amount: number;
+      status: 'posted' | 'payment_due' | 'paid';
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/PaymentScheduleScheme.d.ts

@@ -4,6 +4,7 @@
 declare module 'chargebee' {
   export interface PaymentScheduleScheme {
     id: string;
+    name?: string;
     description?: string;
     number_of_schedules: number;
     period_unit: 'day' | 'week' | 'month';

package/types/resources/PaymentSource.d.ts

@@ -224,6 +224,8 @@ declare module 'chargebee' {
         | 'carnet'
         | 'rupay'
         | 'maestro'
+        | 'dankort'
+        | 'cartes_bancaires'
         | 'not_applicable';
       funding_type:
         | 'credit'
@@ -419,7 +421,9 @@ declare module 'chargebee' {
         | 'hipercard'
         | 'carnet'
         | 'rupay'
-        | 'maestro';
+        | 'maestro'
+        | 'dankort'
+        | 'cartes_bancaires';
       funding_type?: 'credit' | 'debit' | 'prepaid' | 'not_known';
     }
 

package/types/resources/PricingPageSession.d.ts

@@ -41,11 +41,13 @@ declare module 'chargebee' {
       customer?: CustomerCreateForNewSubscriptionInputParam;
       billing_address?: BillingAddressCreateForNewSubscriptionInputParam;
       shipping_address?: ShippingAddressCreateForNewSubscriptionInputParam;
+      discounts?: DiscountsCreateForNewSubscriptionInputParam[];
     }
     export interface CreateForExistingSubscriptionInputParam {
       redirect_url?: string;
       pricing_page?: PricingPageCreateForExistingSubscriptionInputParam;
       subscription?: SubscriptionCreateForExistingSubscriptionInputParam;
+      discounts?: DiscountsCreateForExistingSubscriptionInputParam[];
     }
     export interface BillingAddressCreateForNewSubscriptionInputParam {
       first_name?: string;
@@ -95,11 +97,34 @@ declare module 'chargebee' {
       id?: string;
     }
 
+    export interface DiscountsCreateForNewSubscriptionInputParam {
+      apply_on: ApplyOn;
+      duration_type: DurationType;
+      percentage?: number;
+      amount?: number;
+      period?: number;
+      period_unit?: PeriodUnit;
+      included_in_mrr?: boolean;
+      item_price_id?: string;
+      label?: string;
+    }
     export interface PricingPageCreateForExistingSubscriptionInputParam {
       id: string;
     }
     export interface SubscriptionCreateForExistingSubscriptionInputParam {
       id: string;
     }
+
+    export interface DiscountsCreateForExistingSubscriptionInputParam {
+      apply_on: ApplyOn;
+      duration_type: DurationType;
+      percentage?: number;
+      amount?: number;
+      period?: number;
+      period_unit?: PeriodUnit;
+      included_in_mrr?: boolean;
+      item_price_id?: string;
+      label?: string;
+    }
   }
 }

package/types/resources/Quote.d.ts

@@ -656,6 +656,7 @@ declare module 'chargebee' {
     }
     export interface ConvertInputParam {
       invoice_date?: number;
+      invoice_immediately?: boolean;
       create_pending_invoices?: boolean;
       first_invoice_pending?: boolean;
       subscription?: SubscriptionConvertInputParam;

package/types/resources/QuotedSubscription.d.ts

@@ -86,6 +86,9 @@ declare module 'chargebee' {
       charge_once?: boolean;
       charge_on_option?: 'immediately' | 'on_event';
       proration_type?: 'full_term' | 'partial_term' | 'none';
+      usage_accumulation_reset_frequency?:
+        | 'never'
+        | 'subscription_billing_frequency';
     }
     export interface ItemTier {
       item_price_id: string;

package/types/resources/Subscription.d.ts

@@ -575,6 +575,9 @@ declare module 'chargebee' {
       charge_once?: boolean;
       charge_on_option?: 'immediately' | 'on_event';
       proration_type?: 'full_term' | 'partial_term' | 'none';
+      usage_accumulation_reset_frequency?:
+        | 'never'
+        | 'subscription_billing_frequency';
     }
     export interface ItemTier {
       item_price_id: string;
@@ -1621,6 +1624,7 @@ declare module 'chargebee' {
        */
       item_type?: ItemType;
       charge_on_option?: ChargeOnOption;
+      usage_accumulation_reset_frequency?: UsageAccumulationResetFrequency;
     }
     export interface DiscountsCreateWithItemsInputParam {
       apply_on: ApplyOn;
@@ -1949,6 +1953,7 @@ declare module 'chargebee' {
        */
       item_type?: ItemType;
       proration_type?: ProrationType;
+      usage_accumulation_reset_frequency?: UsageAccumulationResetFrequency;
     }
     export interface DiscountsUpdateForItemsInputParam {
       apply_on: ApplyOn;