chargebee 3.0.2 → 3.2.0

package/CHANGELOG.md

@@ -1,3 +1,86 @@
+### v3.2.0 (2024-11-27)
+* * *
+#### New Resource: 
+* OmnichannelSubscriptionItem has been added. 
+
+#### New Attribute: 
+* resource_version has been added to OmnichannelSubscription.
+* resource_version has been added to OmnichannelTransaction.
+* resource_version has been added to RecordedPurchase.
+
+#### New Input Parameters:
+* limit has been added to OmnichannelSubscription#ListRequest.
+* offset has been added to OmnichannelSubscription#ListRequest.
+* customer_id has been added to OmnichannelSubscription#ListRequest.
+* replace_coupon_list has been added to HostedPage#CheckoutExistingRequest.
+* replace_coupon_list has been added to HostedPage#CheckoutExistingForItemsRequest.
+* subscription[po_number] has been added to HostedPage#CheckoutNewForItemsRequest.
+
+#### Removed Subresource: 
+* OmnichannelSubscriptionItem subresource has been removed from OmnichannelSubscription and is now a standalone resource.
+
+#### Removed Attribute: 
+* metadata has been removed from subscription. 
+
+### v3.1.0 (2024-11-14)
+* * *
+
+#### New Resource: 
+* OmnichannelTransaction has been added. 
+* OmnichannelSubscription has been added.
+* RecordedPurchase has been added.
+
+
+#### New Attributes: 
+* business_entity_id has been added to AttachedItem.
+* business_entity_id has been added to DifferentialPrice.
+* business_entity_id has been added to Items.
+* business_entity_id has been added to ItemFamily.
+* business_entity_id has been added to ItemPrice.
+* business_entity_id has been added to PriceVariant.
+* valid_from has been added to coupon.
+
+#### New Input Parameters:
+* business_entity_id has been added to AttachedItem#CreateRequest.
+* preferred_scheme has been added to Card#UpdateCardForCustomerRequest.
+* valid_from has been added to Coupon#CreateForItem &  Coupon#UpdateForItemsRequest.
+* preferred_scheme has been added to Customer#CreateRequest & Customer#CollectPaymentRequest.
+* business_entity_id has been added to DifferentialPrice#CreateRequest.
+* preferred_scheme has been added to Invoice#CreateRequest & Invoice#CreateForChargeItemsAndChargesRequest.
+* business_entity_id has been added to Items#CreateRequest.
+* business_entity_id & include_site_level_resources have been added to Items#ListItemParams.
+* business_entity_id has been added to ItemFamily#CreateRequest.
+* business_entity_id & include_site_level_resources have been added to ItemFamily#ListItemFamilyParams.
+* business_entity_id has been added to ItemPrice#CreateRequest.
+* business_entity_id & include_site_level_resources have been added to ItemPrice#ListItemPriceParams.
+* business_entity_id & include_site_level_resources have been added to PriceVariant#ListItemFamilyParams.
+* business_entity_id has been added to PriceVariant#CreateRequest.
+* business_entity_id & include_site_level_resources have been added to PriceVariant#ListPriceVariantParams.
+* preferred_scheme has been added to Subscription#CreateRequest, Subscription#UpdateRequest.
+* preferred_scheme Subscription#UpdateForItemsRequest, & Subscription#ImportSubscriptionRequest.
+* business_entity_id & include_site_level_resources have been added to Export#ItemFamiliesRequest & Export#ItemsRequest.
+* business_entity_id & include_site_level_resources have been added to Export#ItemPricesRequest Export#PriceVariantsRequest
+* name & flexible_schedules[period] have been added to PaymentScheduleScheme#CreateRequest.
+
+#### New Enum Values: 
+* FUTURE has been added to Coupon#StatusEnum.
+* EXISTING_CUSTOMER & NEW_CUSTOMER have been added to Coupon#TypeEnum.
+* LATE_FAILURE has added to Transation#LinkedPaymentEnum & Transation#StatusEnum.
+* OMNICHANNEL_SUBSCRIPTION, has been added to EntityTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM, has been added to EntityTypeEnum.
+* OMNICHANNEL_TRANSACTION, has been added to EntityTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_RENEWED, has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_CREATED, has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_DOWNGRADE_SCHEDULED, has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_SCHEDULED_DOWNGRADE_REMOVED, has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_DOWNGRADED, has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_EXPIRED, has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_CANCELLATION_SCHEDULED, has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_SCHEDULED_CANCELLATION_REMOVED, has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_RESUBSCRIBED, has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_UPGRADED, has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_CANCELLED, has been added to EventTypeEnum.
+
 ## v3.0.2 (2024-11-09)
 
 ### Bug fixes: 

package/cjs/environment.js

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

package/cjs/resources/api_endpoints.js

@@ -1096,4 +1096,21 @@ exports.Endpoints = {
             false,
         ],
     ],
+    omnichannelSubscription: [
+        ['retrieve', 'GET', '/omnichannel_subscriptions', null, true],
+        ['list', 'GET', '/omnichannel_subscriptions', null, false],
+        [
+            'omnichannel_transactionsForOmnichannelSubscription',
+            'GET',
+            '/omnichannel_subscriptions',
+            '/omnichannel_transactions',
+            true,
+        ],
+    ],
+    omnichannelTransaction: [],
+    omnichannelSubscriptionItem: [],
+    recordedPurchase: [
+        ['create', 'POST', '/recorded_purchases', null, false],
+        ['retrieve', 'GET', '/recorded_purchases', null, true],
+    ],
 };

package/esm/environment.js

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

package/esm/resources/api_endpoints.js

@@ -1093,4 +1093,21 @@ export const Endpoints = {
             false,
         ],
     ],
+    omnichannelSubscription: [
+        ['retrieve', 'GET', '/omnichannel_subscriptions', null, true],
+        ['list', 'GET', '/omnichannel_subscriptions', null, false],
+        [
+            'omnichannel_transactionsForOmnichannelSubscription',
+            'GET',
+            '/omnichannel_subscriptions',
+            '/omnichannel_transactions',
+            true,
+        ],
+    ],
+    omnichannelTransaction: [],
+    omnichannelSubscriptionItem: [],
+    recordedPurchase: [
+        ['create', 'POST', '/recorded_purchases', null, false],
+        ['retrieve', 'GET', '/recorded_purchases', null, true],
+    ],
 };

package/package.json

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

package/types/core.d.ts

@@ -132,7 +132,10 @@ declare module 'chargebee' {
     | 'subscription_entitlement'
     | 'item_entitlement'
     | 'business_entity'
-    | 'price_variant';
+    | 'price_variant'
+    | 'omnichannel_subscription'
+    | 'omnichannel_subscription_item'
+    | 'omnichannel_transaction';
   type EventNameEnum = 'cancellation_page_loaded';
   type EventTypeEnum =
     | 'coupon_created'
@@ -310,6 +313,17 @@ declare module 'chargebee' {
     | 'subscription_moved_in'
     | 'subscription_moved_out'
     | 'subscription_movement_failed'
+    | 'omnichannel_subscription_created'
+    | 'omnichannel_subscription_item_renewed'
+    | 'omnichannel_subscription_item_downgrade_scheduled'
+    | 'omnichannel_subscription_item_scheduled_downgrade_removed'
+    | 'omnichannel_subscription_item_downgraded'
+    | 'omnichannel_subscription_item_expired'
+    | 'omnichannel_subscription_item_cancellation_scheduled'
+    | 'omnichannel_subscription_item_scheduled_cancellation_removed'
+    | 'omnichannel_subscription_item_resubscribed'
+    | 'omnichannel_subscription_item_upgraded'
+    | 'omnichannel_subscription_item_cancelled'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'

package/types/index.d.ts

@@ -41,6 +41,9 @@
 ///<reference path='./resources/ItemPrice.d.ts' />
 ///<reference path='./resources/Metadata.d.ts' />
 ///<reference path='./resources/NonSubscription.d.ts' />
+///<reference path='./resources/OmnichannelSubscription.d.ts' />
+///<reference path='./resources/OmnichannelSubscriptionItem.d.ts' />
+///<reference path='./resources/OmnichannelTransaction.d.ts' />
 ///<reference path='./resources/Order.d.ts' />
 ///<reference path='./resources/PaymentIntent.d.ts' />
 ///<reference path='./resources/PaymentReferenceNumber.d.ts' />
@@ -59,6 +62,7 @@
 ///<reference path='./resources/QuotedCharge.d.ts' />
 ///<reference path='./resources/QuotedSubscription.d.ts' />
 ///<reference path='./resources/Ramp.d.ts' />
+///<reference path='./resources/RecordedPurchase.d.ts' />
 ///<reference path='./resources/ResourceMigration.d.ts' />
 ///<reference path='./resources/SiteMigrationDetail.d.ts' />
 ///<reference path='./resources/Subscription.d.ts' />
@@ -142,6 +146,7 @@ declare module 'chargebee' {
     itemFamily: ItemFamily.ItemFamilyResource;
     itemPrice: ItemPrice.ItemPriceResource;
     nonSubscription: NonSubscription.NonSubscriptionResource;
+    omnichannelSubscription: OmnichannelSubscription.OmnichannelSubscriptionResource;
     order: Order.OrderResource;
     paymentIntent: PaymentIntent.PaymentIntentResource;
     paymentScheduleScheme: PaymentScheduleScheme.PaymentScheduleSchemeResource;
@@ -154,6 +159,7 @@ declare module 'chargebee' {
     purchase: Purchase.PurchaseResource;
     quote: Quote.QuoteResource;
     ramp: Ramp.RampResource;
+    recordedPurchase: RecordedPurchase.RecordedPurchaseResource;
     resourceMigration: ResourceMigration.ResourceMigrationResource;
     siteMigrationDetail: SiteMigrationDetail.SiteMigrationDetailResource;
     subscription: Subscription.SubscriptionResource;

package/types/resources/AttachedItem.d.ts

@@ -17,6 +17,7 @@ declare module 'chargebee' {
     resource_version?: number;
     updated_at?: number;
     channel?: ChannelEnum;
+    business_entity_id?: string;
   }
 
   export namespace AttachedItem {
@@ -84,6 +85,7 @@ declare module 'chargebee' {
       quantity_in_decimal?: string;
       charge_on_event?: ChargeOnEventEnum;
       charge_once?: boolean;
+      business_entity_id?: string;
     }
     export interface UpdateInputParam {
       parent_item_id: string;

package/types/resources/Card.d.ts

@@ -137,6 +137,7 @@ declare module 'chargebee' {
       expiry_month: number;
       expiry_year: number;
       cvv?: string;
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;

package/types/resources/Comment.d.ts

@@ -76,6 +76,9 @@ declare module 'chargebee' {
         | 'coupon'
         | 'order'
         | 'business_entity'
+        | 'omnichannel_subscription'
+        | 'omnichannel_subscription_item'
+        | 'omnichannel_transaction'
         | 'item_family'
         | 'item'
         | 'item_price'

package/types/resources/Coupon.d.ts

@@ -14,9 +14,10 @@ declare module 'chargebee' {
     currency_code?: string;
     duration_type: 'one_time' | 'forever' | 'limited_period';
     duration_month?: number;
+    valid_from?: number;
     valid_till?: number;
     max_redemptions?: number;
-    status?: 'active' | 'expired' | 'archived' | 'deleted';
+    status?: 'active' | 'expired' | 'archived' | 'deleted' | 'future';
     apply_discount_on:
       | 'plans'
       | 'plans_and_addons'
@@ -142,7 +143,11 @@ declare module 'chargebee' {
     }
     export interface CouponConstraint {
       entity_type: 'customer';
-      type: 'max_redemptions' | 'unique_by';
+      type:
+        | 'max_redemptions'
+        | 'unique_by'
+        | 'existing_customer'
+        | 'new_customer';
       value?: string;
     }
     // REQUEST PARAMS
@@ -191,6 +196,7 @@ declare module 'chargebee' {
       apply_on: 'invoice_amount' | 'each_specified_item';
       duration_type?: 'one_time' | 'forever' | 'limited_period';
       duration_month?: number;
+      valid_from?: number;
       valid_till?: number;
       max_redemptions?: number;
       invoice_notes?: string;
@@ -218,6 +224,7 @@ declare module 'chargebee' {
       apply_on?: 'invoice_amount' | 'each_specified_item';
       duration_type?: 'one_time' | 'forever' | 'limited_period';
       duration_month?: number;
+      valid_from?: number;
       valid_till?: number;
       max_redemptions?: number;
       invoice_notes?: string;
@@ -286,7 +293,11 @@ declare module 'chargebee' {
     }
     export interface CouponConstraintsCreateForItemsInputParam {
       entity_type: 'customer';
-      type: 'max_redemptions' | 'unique_by';
+      type:
+        | 'max_redemptions'
+        | 'unique_by'
+        | 'existing_customer'
+        | 'new_customer';
       value?: string;
     }
     export interface ItemConstraintsCreateForItemsInputParam {
@@ -302,7 +313,11 @@ declare module 'chargebee' {
     }
     export interface CouponConstraintsUpdateForItemsInputParam {
       entity_type: 'customer';
-      type: 'max_redemptions' | 'unique_by';
+      type:
+        | 'max_redemptions'
+        | 'unique_by'
+        | 'existing_customer'
+        | 'new_customer';
       value?: string;
     }
     export interface ItemConstraintsUpdateForItemsInputParam {

package/types/resources/CreditNote.d.ts

@@ -341,7 +341,8 @@ declare module 'chargebee' {
         | 'voided'
         | 'failure'
         | 'timeout'
-        | 'needs_attention';
+        | 'needs_attention'
+        | 'late_failure';
       txn_date?: number;
       txn_amount?: number;
       refund_reason_code?: string;

package/types/resources/Customer.d.ts

@@ -743,6 +743,7 @@ declare module 'chargebee' {
       expiry_month?: number;
       expiry_year?: number;
       cvv?: string;
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;
@@ -905,6 +906,7 @@ declare module 'chargebee' {
       expiry_month?: number;
       expiry_year?: number;
       cvv?: string;
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;

package/types/resources/DifferentialPrice.d.ts

@@ -16,6 +16,7 @@ declare module 'chargebee' {
     tiers?: DifferentialPrice.Tier[];
     currency_code: string;
     parent_periods?: DifferentialPrice.ParentPeriod[];
+    business_entity_id?: string;
   }
 
   export namespace DifferentialPrice {
@@ -90,6 +91,7 @@ declare module 'chargebee' {
       parent_item_id: string;
       price?: number;
       price_in_decimal?: string;
+      business_entity_id?: string;
       parent_periods?: ParentPeriodsCreateInputParam[];
       tiers?: TiersCreateInputParam[];
     }

package/types/resources/Export.d.ts

@@ -260,15 +260,21 @@ declare module 'chargebee' {
       order?: OrderOrdersInputParam;
     }
     export interface ItemFamiliesInputParam {
+      business_entity_id?: filter.String;
+      include_site_level_resources?: filter.Boolean;
       item_family?: ItemFamilyItemFamiliesInputParam;
     }
     export interface ItemsInputParam {
+      business_entity_id?: filter.String;
+      include_site_level_resources?: filter.Boolean;
       item?: ItemItemsInputParam;
     }
     export interface ItemPricesInputParam {
       item_family_id?: filter.String;
       item_type?: filter.Enum;
       currency_code?: filter.String;
+      business_entity_id?: filter.String;
+      include_site_level_resources?: filter.Boolean;
       item_price?: ItemPriceItemPricesInputParam;
     }
     export interface AttachedItemsInputParam {
@@ -280,6 +286,8 @@ declare module 'chargebee' {
       item_id?: filter.String;
     }
     export interface PriceVariantsInputParam {
+      business_entity_id?: filter.String;
+      include_site_level_resources?: filter.Boolean;
       price_variant?: PriceVariantPriceVariantsInputParam;
     }
     export interface InvoiceRevenueRecognitionInputParam {

package/types/resources/HostedPage.d.ts

@@ -337,6 +337,7 @@ declare module 'chargebee' {
       reactivate_from?: number;
       billing_alignment_mode?: BillingAlignmentModeEnum;
       coupon_ids?: string[];
+      replace_coupon_list?: boolean;
       reactivate?: boolean;
       force_term_reset?: boolean;
       redirect_url?: string;
@@ -362,6 +363,7 @@ declare module 'chargebee' {
       reactivate_from?: number;
       billing_alignment_mode?: BillingAlignmentModeEnum;
       coupon_ids?: string[];
+      replace_coupon_list?: boolean;
       reactivate?: boolean;
       force_term_reset?: boolean;
       change_option?: ChangeOptionEnum;
@@ -808,6 +810,7 @@ declare module 'chargebee' {
       coupon?: string;
       auto_collection?: AutoCollectionEnum;
       invoice_notes?: string;
+      po_number?: string;
       contract_term_billing_cycle_on_renewal?: number;
     }
     export interface CardCheckoutNewForItemsInputParam {

package/types/resources/Invoice.d.ts

@@ -586,7 +586,8 @@ declare module 'chargebee' {
         | 'voided'
         | 'failure'
         | 'timeout'
-        | 'needs_attention';
+        | 'needs_attention'
+        | 'late_failure';
       txn_date?: number;
       txn_amount?: number;
     }
@@ -601,7 +602,8 @@ declare module 'chargebee' {
         | 'voided'
         | 'failure'
         | 'timeout'
-        | 'needs_attention';
+        | 'needs_attention'
+        | 'late_failure';
       txn_amount?: number;
     }
     export interface AppliedCredit {
@@ -1173,6 +1175,7 @@ declare module 'chargebee' {
       expiry_month?: number;
       expiry_year?: number;
       cvv?: string;
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;
@@ -1318,6 +1321,7 @@ declare module 'chargebee' {
       expiry_month?: number;
       expiry_year?: number;
       cvv?: string;
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;
@@ -1597,7 +1601,7 @@ declare module 'chargebee' {
       reference_number?: string;
       custom_payment_method_id?: string;
       id_at_gateway?: string;
-      status?: 'success' | 'failure';
+      status?: 'success' | 'failure' | 'late_failure';
       date?: number;
       error_code?: string;
       error_text?: string;

package/types/resources/Item.d.ts

@@ -30,6 +30,7 @@ declare module 'chargebee' {
     bundle_items?: Item.BundleItem[];
     bundle_configuration?: Item.BundleConfiguration;
     metadata?: any;
+    business_entity_id?: string;
   }
 
   export namespace Item {
@@ -117,6 +118,7 @@ declare module 'chargebee' {
       metered?: boolean;
       usage_calculation?: 'sum_of_usages' | 'last_usage' | 'max_usage';
       metadata?: any;
+      business_entity_id?: string;
       bundle_configuration?: BundleConfigurationCreateInputParam;
       bundle_items_to_add?: BundleItemsToAddCreateInputParam[];
       [key: `cf_${string}`]: unknown;
@@ -164,6 +166,8 @@ declare module 'chargebee' {
       metered?: filter.Boolean;
       usage_calculation?: filter.Enum;
       channel?: filter.Enum;
+      business_entity_id?: filter.String;
+      include_site_level_resources?: filter.Boolean;
       'sort_by[asc]'?: string;
       'sort_by[desc]'?: string;
     }

package/types/resources/ItemFamily.d.ts

@@ -11,6 +11,7 @@ declare module 'chargebee' {
     resource_version?: number;
     updated_at?: number;
     channel?: ChannelEnum;
+    business_entity_id?: string;
   }
 
   export namespace ItemFamily {
@@ -70,6 +71,7 @@ declare module 'chargebee' {
       id: string;
       name: string;
       description?: string;
+      business_entity_id?: string;
       [key: `cf_${string}`]: unknown;
     }
     export interface ListInputParam {
@@ -78,6 +80,8 @@ declare module 'chargebee' {
       id?: filter.String;
       name?: filter.String;
       updated_at?: filter.Timestamp;
+      business_entity_id?: filter.String;
+      include_site_level_resources?: filter.Boolean;
       [key: `cf_${string}`]: unknown;
     }
     export interface UpdateInputParam {

package/types/resources/ItemPrice.d.ts

@@ -48,6 +48,7 @@ declare module 'chargebee' {
     parent_item_id?: string;
     show_description_in_invoices?: boolean;
     show_description_in_quotes?: boolean;
+    business_entity_id?: string;
   }
 
   export namespace ItemPrice {
@@ -172,6 +173,7 @@ declare module 'chargebee' {
       show_description_in_invoices?: boolean;
       show_description_in_quotes?: boolean;
       usage_accumulation_reset_frequency?: UsageAccumulationResetFrequencyEnum;
+      business_entity_id?: string;
       pricing_model?: PricingModelEnum;
       price?: number;
       price_in_decimal?: string;
@@ -243,6 +245,8 @@ declare module 'chargebee' {
       trial_period_unit?: filter.Enum;
       status?: filter.Enum;
       updated_at?: filter.Timestamp;
+      business_entity_id?: filter.String;
+      include_site_level_resources?: filter.Boolean;
       period_unit?: filter.Enum;
       period?: filter.Number;
       channel?: filter.Enum;

package/types/resources/OmnichannelSubscription.d.ts

@@ -0,0 +1,64 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface OmnichannelSubscription {
+    id: string;
+    id_at_source: string;
+    app_id: string;
+    source: 'apple_app_store';
+    customer_id?: string;
+    created_at: number;
+    resource_version?: number;
+    omnichannel_subscription_items: OmnichannelSubscriptionItem[];
+  }
+
+  export namespace OmnichannelSubscription {
+    export class OmnichannelSubscriptionResource {
+      retrieve(
+        omnichannel_subscription_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      omnichannelTransactionsForOmnichannelSubscription(
+        omnichannel_subscription_id: string,
+        input?: OmnichannelTransactionsForOmnichannelSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<
+        ChargebeeResponse<OmnichannelTransactionsForOmnichannelSubscriptionResponse>
+      >;
+    }
+
+    export interface RetrieveResponse {
+      omnichannel_subscription: OmnichannelSubscription;
+    }
+
+    export interface ListResponse {
+      list: { omnichannel_subscription: OmnichannelSubscription }[];
+      next_offset?: string;
+    }
+
+    export interface OmnichannelTransactionsForOmnichannelSubscriptionResponse {
+      list: { omnichannel_transaction: OmnichannelTransaction }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      customer_id?: filter.String;
+    }
+    export interface OmnichannelTransactionsForOmnichannelSubscriptionInputParam {
+      limit?: number;
+      offset?: string;
+    }
+  }
+}

package/types/resources/OmnichannelSubscriptionItem.d.ts

@@ -0,0 +1,19 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface OmnichannelSubscriptionItem {
+    id: string;
+    item_id_at_source: string;
+    status: 'active' | 'expired' | 'cancelled';
+    current_term_start?: number;
+    current_term_end?: number;
+    expired_at?: number;
+    expiration_reason?: 'billing_error' | 'product_not_available' | 'other';
+    cancelled_at?: number;
+    cancellation_reason?:
+      | 'customer_cancelled'
+      | 'customer_did_not_consent_to_price_increase';
+    resource_version?: number;
+  }
+}

package/types/resources/OmnichannelTransaction.d.ts

@@ -0,0 +1,17 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface OmnichannelTransaction {
+    id: string;
+    id_at_source: string;
+    app_id: string;
+    price_currency: string;
+    price_units: number;
+    price_nanos: number;
+    type: 'purchase' | 'renewal';
+    transacted_at: number;
+    created_at: number;
+    resource_version?: number;
+  }
+}

package/types/resources/PaymentScheduleScheme.d.ts

@@ -56,7 +56,12 @@ declare module 'chargebee' {
       number_of_schedules: number;
       period_unit: 'day' | 'week' | 'month';
       period?: number;
-      description?: string;
+      name: string;
+      flexible_schedules?: FlexibleSchedulesCreateInputParam[];
+    }
+    export interface FlexibleSchedulesCreateInputParam {
+      period?: number;
+      amount_percentage?: number;
     }
   }
 }

package/types/resources/PaymentSource.d.ts

@@ -476,6 +476,7 @@ declare module 'chargebee' {
       expiry_month: number;
       expiry_year: number;
       cvv?: string;
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;

package/types/resources/PriceVariant.d.ts

@@ -14,6 +14,7 @@ declare module 'chargebee' {
     updated_at?: number;
     archived_at?: number;
     attributes?: PriceVariant.Attribute[];
+    business_entity_id?: string;
   }
 
   export namespace PriceVariant {
@@ -79,6 +80,7 @@ declare module 'chargebee' {
       external_name?: string;
       description?: string;
       variant_group?: string;
+      business_entity_id?: string;
       attributes?: AttributesCreateInputParam[];
     }
     export interface UpdateInputParam {
@@ -97,6 +99,8 @@ declare module 'chargebee' {
       status?: filter.Enum;
       updated_at?: filter.Timestamp;
       created_at?: filter.Timestamp;
+      business_entity_id?: filter.String;
+      include_site_level_resources?: filter.Boolean;
       'sort_by[asc]'?: string;
       'sort_by[desc]'?: string;
     }

package/types/resources/RecordedPurchase.d.ts

@@ -0,0 +1,61 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface RecordedPurchase {
+    id: string;
+    customer_id: string;
+    app_id: string;
+    source: 'apple_app_store';
+    status: 'in_process' | 'completed' | 'failed';
+    omnichannel_transaction_id?: string;
+    created_at: number;
+    resource_version?: number;
+    linked_omnichannel_subscriptions?: RecordedPurchase.LinkedOmnichannelSubscription[];
+    error_detail?: RecordedPurchase.ErrorDetail;
+  }
+
+  export namespace RecordedPurchase {
+    export class RecordedPurchaseResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        recorded_purchase_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+    }
+
+    export interface CreateResponse {
+      recorded_purchase: RecordedPurchase;
+      customer: Customer;
+    }
+
+    export interface RetrieveResponse {
+      recorded_purchase: RecordedPurchase;
+    }
+
+    export interface LinkedOmnichannelSubscription {
+      omnichannel_subscription_id?: string;
+    }
+    export interface ErrorDetail {
+      error_message?: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      app_id: string;
+      customer?: CustomerCreateInputParam;
+      apple_app_store?: AppleAppStoreCreateInputParam;
+    }
+    export interface CustomerCreateInputParam {
+      id: string;
+    }
+    export interface AppleAppStoreCreateInputParam {
+      transaction_id?: string;
+    }
+  }
+}

package/types/resources/Subscription.d.ts

@@ -85,7 +85,6 @@ declare module 'chargebee' {
     referral_info?: Subscription.ReferralInfo;
     invoice_notes?: string;
     meta_data?: any;
-    metadata?: any;
     deleted: boolean;
     changes_scheduled_at?: number;
     contract_term?: Subscription.ContractTerm;
@@ -1407,6 +1406,7 @@ declare module 'chargebee' {
       expiry_month?: number;
       expiry_year?: number;
       cvv?: string;
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;
@@ -1764,6 +1764,7 @@ declare module 'chargebee' {
       expiry_month?: number;
       expiry_year?: number;
       cvv?: string;
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;
@@ -1922,6 +1923,7 @@ declare module 'chargebee' {
       expiry_month?: number;
       expiry_year?: number;
       cvv?: string;
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;
@@ -2146,6 +2148,7 @@ declare module 'chargebee' {
       expiry_month?: number;
       expiry_year?: number;
       cvv?: string;
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;

package/types/resources/Transaction.d.ts

@@ -24,7 +24,8 @@ declare module 'chargebee' {
       | 'voided'
       | 'failure'
       | 'timeout'
-      | 'needs_attention';
+      | 'needs_attention'
+      | 'late_failure';
     fraud_flag?: 'safe' | 'suspicious' | 'fraudulent';
     initiator_type?: 'customer' | 'merchant';
     three_d_secure?: boolean;
@@ -205,7 +206,7 @@ declare module 'chargebee' {
       cn_date?: number;
       cn_total?: number;
       cn_status: 'adjusted' | 'refunded' | 'refund_due' | 'voided';
-      cn_reference_invoice_id: string;
+      cn_reference_invoice_id?: string;
     }
     export interface LinkedRefund {
       txn_id: string;
@@ -215,7 +216,8 @@ declare module 'chargebee' {
         | 'voided'
         | 'failure'
         | 'timeout'
-        | 'needs_attention';
+        | 'needs_attention'
+        | 'late_failure';
       txn_date: number;
       txn_amount: number;
     }
@@ -227,7 +229,8 @@ declare module 'chargebee' {
         | 'voided'
         | 'failure'
         | 'timeout'
-        | 'needs_attention';
+        | 'needs_attention'
+        | 'late_failure';
       amount?: number;
       date?: number;
     }