@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

package/sdk/platform/Billing/BillingPlatformModel.d.ts

@@ -2,99 +2,33 @@ export = BillingPlatformModel;
 /**
  * @typedef SubscriptionChargeRes
  * @property {string} [_id] - Unique identifier for the subscription charge
- * @property {string} [product_suit_id] - ID of the product suit associated with
- *   the charge
- * @property {string} [entity_id] - Unique identifier for the entity
- * @property {string} [entity_type] - Type of entity (e.g., subscription, extension)
- * @property {string} [name] - Name of the subscription charge
- * @property {string} [status] - Current status of the subscription charge
- * @property {number} [trial_days] - Number of trial days provided
+ * @property {string} [product_suit_id] - A unique identifier for a product
+ *   suite, which represents a specific collection or group of products within
+ *   the system.
+ * @property {string} [entity_id] - Unique identifier for the entity (eg. extension)
+ * @property {string} [entity_type] - Specifies the type of entity related to
+ *   the operation, such as 'extension' or 'subscription'
+ * @property {string} [name] - The name of the extension plan
+ * @property {string} [status] - Current status of the extension subscription
+ * @property {number} [trial_days] - The number of days allocated for the trial period
  * @property {string} [activated_on] - Date when the charge was activated
  * @property {string} [cancelled_on] - Date when the charge was cancelled
- * @property {boolean} [is_test] - Indicates if the charge is for testing purposes
+ * @property {boolean} [is_test] - Indicates whether the operation or data is in
+ *   a test mode.
  * @property {string} [created_at] - Timestamp when the charge was created
  * @property {string} [modified_at] - Timestamp when the charge was last modified
- * @property {string} [company_id] - Company id
+ * @property {string} [company_id] - The unique identifier of the company.
  * @property {Object[]} [line_items] - List of line items associated with the charge
  */
 /**
- * @typedef ChargeDetails
- * @property {string} [_id] - Unique identifier for the charge.
- * @property {string} [entity_type] - The type of entity associated with the
- *   charge (e.g., 'extension', 'subscription').
- * @property {string} [entity_id] - Unique identifier for the entity associated
- *   with the charge.
- * @property {string} [name] - The name of the charge.
- * @property {string} [term] - Description of the charge term.
- * @property {string} [charge_type] - The type of charge (e.g., 'standalone',
- *   'recurring').
- * @property {string} [pricing_type] - The pricing model for the charge (e.g.,
- *   'one_time', 'recurring').
- * @property {EntityChargePrice} [price]
- * @property {ChargeRecurring} [recurring]
- * @property {string} [status] - Current status of the charge.
- * @property {number} [capped_amount] - Maximum amount that can be charged, if applicable.
- * @property {string} [activated_on] - Date and time when the charge was activated.
- * @property {string} [cancelled_on] - Date and time when the charge was cancelled.
- * @property {string} [billing_date] - Date and time when the charge was billed.
- * @property {SubscriptionTrialPeriod} [current_period]
- * @property {string} [modified_at] - Date and time when the charge details were
- *   last modified.
- * @property {string} [created_at] - Date and time when the charge was created.
- * @property {boolean} [is_test] - Indicates whether the charge is for testing purposes.
- * @property {string} [company_id] - Company id.
- * @property {Object} [meta] - Additional metadata associated with the charge.
- * @property {number} [__v] - Internal version key for the charge record.
+ * @typedef BadRequestSchema
+ * @property {string} [message] - Failure message.
  */
 /**
  * @typedef ResourceNotFound
  * @property {string} [message] - Resource not found with {id}
- * @property {Object} [code]
- * @property {Object} [success]
- */
-/**
- * @typedef CreateOneTimeCharge
- * @property {string} [name] - The name of the one-time charge to be created.
- * @property {OneTimeChargeItem} [charge]
- * @property {boolean} [is_test] - Indicates whether the charge creation is for
- *   testing purposes.
- * @property {string} [return_url] - URL to which the user will be redirected
- *   after creating the charge.
- */
-/**
- * @typedef CreateOneTimeChargeResponse
- * @property {Charge} [charge]
- * @property {string} [confirm_url] - URL to which users are redirected to
- *   confirm or complete the payment or subscription process.
- */
-/**
- * @typedef BadRequest
- * @property {string} [message] - Failure message.
- */
-/**
- * @typedef CreateSubscriptionCharge
- * @property {string} name - The name of the charge.
- * @property {number} [trial_days]
- * @property {ChargeLineItem[]} line_items
- * @property {boolean} [is_test] - Indicates whether the charge is for testing purposes.
- * @property {string} return_url - The URL passed in request which extension
- *   expects in return.
- */
-/**
- * @typedef CreateSubscriptionResponse
- * @property {EntitySubscription} [subscription]
- * @property {string} [confirm_url] - URL to which users are redirected to
- *   confirm or complete the payment or subscription process.
- */
-/**
- * @typedef EntityChargePrice
- * @property {number} [amount] - The amount for the price. The minimum value is 1.
- * @property {string} [currency_code] - The currency code for the price
- */
-/**
- * @typedef ChargeRecurring
- * @property {string} [interval]
- * @property {number} [interval_time]
+ * @property {number} [code] - The HTTP status code associated with the error
+ * @property {boolean} [success] - Indicates if the request was successful
  */
 /**
  * @typedef SubscriptionTrialPeriod
@@ -102,8 +36,9 @@ export = BillingPlatformModel;
  * @property {string} [end_date] - The end date and time of the trial period.
  */
 /**
- * @typedef Charge
- * @property {OneTimeChargeEntity} [final_charge]
+ * @typedef EntityChargePrice
+ * @property {number} [amount] - The amount for the price. The minimum value is 1.
+ * @property {string} [currency_code] - The currency code for the price
  */
 /**
  * @typedef OneTimeChargeItem
@@ -112,92 +47,143 @@ export = BillingPlatformModel;
  * @property {string} [pricing_type] - The type of pricing for the charge item.
  * @property {EntityChargePrice} [price]
  * @property {number} [capped_amount] - The maximum amount that can be charged
- *   for this item, if applicable.
- * @property {boolean} [is_test] - Indicates whether the charge item is for
- *   testing purposes.
+ *   for a particular service or item
+ * @property {boolean} [is_test] - Indicates whether the operation or data is in
+ *   a test mode.
  * @property {Object} [metadata] - Additional metadata associated with the charge item.
  */
 /**
- * @typedef ChargeLineItem
- * @property {string} name - Its name of the extension plan.
- * @property {string} term - It indicates how it will be charged.
- * @property {string} pricing_type - It indicates the extension subscription
- *   will be auto renewed timely.
- * @property {EntityChargePrice} price
- * @property {EntityChargeRecurring} [recurring]
- * @property {number} [capped_amount]
- * @property {number} [trial_days]
- * @property {boolean} [is_test]
- * @property {Object} [metadata]
+ * @typedef CreateOneTimeCharge
+ * @property {string} [name] - The name of the one-time charge to be created.
+ * @property {OneTimeChargeItem} [charge]
+ * @property {boolean} [is_test] - Indicates whether the operation or data is in
+ *   a test mode.
+ * @property {string} [return_url] - URL to which the user will be redirected
+ *   after creating the charge.
  */
 /**
- * @typedef EntitySubscription
- * @property {string} [_id] - Unique identifier for the subscription charge
- * @property {string} [product_suit_id] - ID of the product suit associated with
- *   the charge
- * @property {string} [entity_id] - Unique identifier for the entity
- * @property {string} [entity_type] - Type of entity (e.g., subscription, extension)
- * @property {string} [name] - Name of the subscription charge
- * @property {string} [status] - Current status of the subscription charge
- * @property {number} [trial_days] - Number of trial days provided
- * @property {boolean} [is_test] - Indicates if the charge is for testing purposes
- * @property {string} [created_at] - Timestamp when the charge was created
- * @property {string} [modified_at] - Timestamp when the charge was last modified
- * @property {string} [subscriber_id] - Unique Identifier of the company
- * @property {EntityChargeDetails[]} [line_items]
- * @property {string} [return_url] - The URL passed in request which extension
- *   expects in return.
+ * @typedef ChargeRecurring
+ * @property {string} [interval] - The interval at which the recurring charge is
+ *   applied. Examples include "month", "year", etc.
+ * @property {number} [interval_time]
+ */
+/**
+ * @typedef ChargeDetails
+ * @property {string} [_id] - Unique identifier for the charge.
+ * @property {string} [entity_type] - Specifies the type of entity related to
+ *   the operation, such as 'extension' or 'subscription'
+ * @property {string} [entity_id] - Unique identifier for the entity (eg. extension)
+ * @property {string} [name] - The name of the extension plan
+ * @property {string} [term] - Description of the charge term.
+ * @property {string} [charge_type] - The type of charge (e.g., 'standalone',
+ *   'recurring').
+ * @property {string} [pricing_type] - The pricing model for the charge (e.g.,
+ *   'one_time', 'recurring').
+ * @property {EntityChargePrice} [price]
+ * @property {ChargeRecurring} [recurring]
+ * @property {string} [status] - Current status of the charge.
+ * @property {number} [capped_amount] - The maximum amount that can be charged
+ *   for a particular service or item
+ * @property {string} [activated_on] - Date and time when the charge was activated.
+ * @property {string} [cancelled_on] - Date and time when the charge was cancelled.
+ * @property {string} [billing_date] - The date when the billing occurred. This
+ *   field is optional and may be null if the billing date is not specified.
+ * @property {SubscriptionTrialPeriod} [current_period]
+ * @property {string} [modified_at] - Date and time when the charge details were
+ *   last modified.
+ * @property {string} [created_at] - Date and time when the charge was created.
+ * @property {boolean} [is_test] - Indicates whether the operation or data is in
+ *   a test mode.
+ * @property {string} [company_id] - The unique identifier of the company.
+ * @property {Object} [meta] - Additional metadata associated with the charge.
+ * @property {number} [__v] - Internal version key for the charge record.
  */
 /**
  * @typedef OneTimeChargeEntity
  * @property {string} [term] - Description of the charge term or usage.
  * @property {string} [charge_type] - Type of the charge (e.g., 'subscription',
  *   'extension').
- * @property {number} [capped_amount] - Maximum amount that can be charged. If
- *   no cap, the value should be 0.
- * @property {string} [billing_date] - Date when the charge was billed. Null if
- *   not yet billed.
+ * @property {number} [capped_amount] - The maximum amount that can be charged
+ *   for a particular service or item
+ * @property {string} [billing_date] - The date when the billing occurred. This
+ *   field is optional and may be null if the billing date is not specified.
  * @property {string} [created_at] - Date and time when the charge entity was created.
  * @property {string} [modified_at] - Date and time when the charge entity was
  *   last modified.
  * @property {number} [__v] - Internal version key for the charge record.
  * @property {string} [_id] - Unique identifier for the charge entity.
  * @property {string} [name] - The name of the one-time charge.
- * @property {string} [status] - Current status of the charge (e.g., 'pending',
- *   'completed').
+ * @property {string} [status] - Current status of the charge (e.g., 'pending').
  * @property {string} [activated_on] - Date and time when the charge was
  *   activated. Null if not yet activated.
  * @property {string} [cancelled_on] - Date and time when the charge was
  *   cancelled. Null if not cancelled.
  * @property {Object} [metadata] - Additional metadata associated with the charge.
  * @property {string} [return_url] - URL to redirect to after processing the charge.
- * @property {boolean} [is_test] - Indicates whether the charge is for testing purposes.
+ * @property {boolean} [is_test] - Indicates whether the operation or data is in
+ *   a test mode.
  * @property {string} [pricing_type] - Pricing model for the charge (e.g., 'one_time').
- * @property {string} [subscriber_id] - Unique identifier for the subscriber
- *   associated with the charge.
- * @property {string} [entity_type] - Type of the entity related to the charge
- *   (e.g., 'subscription', 'user').
- * @property {string} [entity_id] - Unique identifier for the entity associated
- *   with the charge.
+ * @property {string} [subscriber_id] - The unique identifier for the company in
+ *   the system.
+ * @property {string} [entity_type] - Specifies the type of entity related to
+ *   the operation, such as 'extension' or 'subscription'
+ * @property {string} [entity_id] - Unique identifier for the entity (eg. extension)
  * @property {Object} [meta] - Additional metadata associated with the charge.
  * @property {EntityChargePrice} [price]
  */
+/**
+ * @typedef CreateOneTimeChargeResponseSchemas
+ * @property {Charge} [charge]
+ * @property {string} [confirm_url] - URL to which users are redirected to
+ *   confirm or complete the payment or subscription process.
+ */
+/**
+ * @typedef Charge
+ * @property {OneTimeChargeEntity} [final_charge]
+ */
 /**
  * @typedef EntityChargeRecurring
- * @property {string} interval - The interval of the subscription.
+ * @property {string} interval - The interval at which the recurring charge is
+ *   applied. Examples include "month", "year", etc.
+ */
+/**
+ * @typedef ChargeLineItem
+ * @property {string} name - Its name of the extension plan.
+ * @property {string} term - It indicates how it will be charged.
+ * @property {string} pricing_type - Specifies the type of pricing for the
+ *   extension subscription. It indicates whether the subscription will be
+ *   automatically renewed, charged once, or based on usage.
+ * @property {EntityChargePrice} price
+ * @property {EntityChargeRecurring} [recurring]
+ * @property {number} [capped_amount] - The maximum amount that can be charged
+ *   for a particular service or item
+ * @property {number} [trial_days] - The number of days allocated for the trial period
+ * @property {boolean} [is_test] - Indicates whether the operation or data is in
+ *   a test mode.
+ * @property {Object} [metadata]
+ */
+/**
+ * @typedef CreateSubscriptionCharge
+ * @property {string} name - The name of the extension plan
+ * @property {number} [trial_days] - The number of days allocated for the trial period
+ * @property {ChargeLineItem[]} line_items
+ * @property {boolean} [is_test] - Indicates whether the operation or data is in
+ *   a test mode.
+ * @property {string} return_url - The URL to which the user will be redirected
+ *   after the subscription process is complete.
  */
 /**
  * @typedef EntityChargeDetails
- * @property {string} [_id] - Unique identifier for the charge.
- * @property {string} [subscription_id] - Unique identifier of the extension subscription.
- * @property {string} [subscriber_id] - Unique identifier of the
- *   subscriber/company who installed extension subscription.
- * @property {string} [entity_type] - The type of entity associated with the
- *   charge (e.g., 'extension', 'subscription').
- * @property {string} [entity_id] - Unique identifier for the entity associated
- *   with the charge.
- * @property {string} [name] - The name of the charge.
- * @property {string} [term] - Description of the charge term.
+ * @property {string} [_id] - The unique identifier for the charge.
+ * @property {string} [subscription_id] - The unique identifier of the subscription.
+ * @property {string} [subscriber_id] - The unique identifier for the company in
+ *   the system.
+ * @property {string} [entity_type] - Specifies the type of entity related to
+ *   the operation, such as 'extension' or 'subscription'
+ * @property {string} [entity_id] - Unique identifier for the entity (eg. extension)
+ * @property {string} [name] - The name of the extension plan
+ * @property {string} [term] - Detailed description of the terms and conditions
+ *   associated with the charge.
  * @property {string} [charge_type] - The type of charge (e.g., 'standalone',
  *   'recurring').
  * @property {string} [pricing_type] - The pricing model for the charge (e.g.,
@@ -205,23 +191,54 @@ export = BillingPlatformModel;
  * @property {EntityChargePrice} [price]
  * @property {ChargeRecurring} [recurring]
  * @property {string} [status] - Current status of the charge.
- * @property {number} [capped_amount] - Maximum amount that can be charged, if applicable.
+ * @property {number} [capped_amount] - The maximum amount that can be charged
+ *   for a particular service or item
  * @property {string} [activated_on] - Date and time when the charge was activated.
  * @property {string} [cancelled_on] - Date and time when the charge was cancelled.
- * @property {string} [billing_date] - Date and time when the charge was billed.
+ * @property {string} [billing_date] - The date when the billing occurred. This
+ *   field is optional and may be null if the billing date is not specified.
  * @property {SubscriptionTrialPeriod} [current_period]
  * @property {string} [modified_at] - Date and time when the charge details were
  *   last modified.
  * @property {string} [created_at] - Date and time when the charge was created.
- * @property {boolean} [is_test] - Indicates whether the charge is for testing purposes.
- * @property {string} [company_id] - Company id.
+ * @property {boolean} [is_test] - Indicates whether the operation or data is in
+ *   a test mode.
+ * @property {string} [company_id] - The unique identifier of the company.
  * @property {Object} [meta] - Additional metadata associated with the charge.
  * @property {number} [__v] - Internal version key for the charge record.
  */
+/**
+ * @typedef EntitySubscription
+ * @property {string} [_id] - Unique identifier for the subscription charge
+ * @property {string} [product_suit_id] - A unique identifier for a product
+ *   suite, which represents a specific collection or group of products within
+ *   the system.
+ * @property {string} [entity_id] - Unique identifier for the entity (eg. extension)
+ * @property {string} [entity_type] - Specifies the type of entity related to
+ *   the operation, such as 'extension' or 'subscription'
+ * @property {string} [name] - The name of the extension plan
+ * @property {string} [status] - Current status of the subscription charge
+ * @property {number} [trial_days] - The number of days allocated for the trial period
+ * @property {boolean} [is_test] - Indicates whether the operation or data is in
+ *   a test mode.
+ * @property {string} [created_at] - Timestamp when the charge was created
+ * @property {string} [modified_at] - Timestamp when the charge was last modified
+ * @property {string} [subscriber_id] - The unique identifier for the company in
+ *   the system.
+ * @property {EntityChargeDetails[]} [line_items]
+ * @property {string} [return_url] - The URL passed in request which extension
+ *   expects in return.
+ */
+/**
+ * @typedef CreateSubscription
+ * @property {EntitySubscription} [subscription]
+ * @property {string} [confirm_url] - URL to which users are redirected to post
+ *   initiation of extension installation.
+ */
 declare class BillingPlatformModel {
 }
 declare namespace BillingPlatformModel {
-    export { SubscriptionChargeRes, ChargeDetails, ResourceNotFound, CreateOneTimeCharge, CreateOneTimeChargeResponse, BadRequest, CreateSubscriptionCharge, CreateSubscriptionResponse, EntityChargePrice, ChargeRecurring, SubscriptionTrialPeriod, Charge, OneTimeChargeItem, ChargeLineItem, EntitySubscription, OneTimeChargeEntity, EntityChargeRecurring, EntityChargeDetails };
+    export { SubscriptionChargeRes, BadRequestSchema, ResourceNotFound, SubscriptionTrialPeriod, EntityChargePrice, OneTimeChargeItem, CreateOneTimeCharge, ChargeRecurring, ChargeDetails, OneTimeChargeEntity, CreateOneTimeChargeResponseSchemas, Charge, EntityChargeRecurring, ChargeLineItem, CreateSubscriptionCharge, EntityChargeDetails, EntitySubscription, CreateSubscription };
 }
 /** @returns {SubscriptionChargeRes} */
 declare function SubscriptionChargeRes(): SubscriptionChargeRes;
@@ -231,28 +248,30 @@ type SubscriptionChargeRes = {
      */
     _id?: string;
     /**
-     * - ID of the product suit associated with
-     * the charge
+     * - A unique identifier for a product
+     * suite, which represents a specific collection or group of products within
+     * the system.
      */
     product_suit_id?: string;
     /**
-     * - Unique identifier for the entity
+     * - Unique identifier for the entity (eg. extension)
      */
     entity_id?: string;
     /**
-     * - Type of entity (e.g., subscription, extension)
+     * - Specifies the type of entity related to
+     * the operation, such as 'extension' or 'subscription'
      */
     entity_type?: string;
     /**
-     * - Name of the subscription charge
+     * - The name of the extension plan
      */
     name?: string;
     /**
-     * - Current status of the subscription charge
+     * - Current status of the extension subscription
      */
     status?: string;
     /**
-     * - Number of trial days provided
+     * - The number of days allocated for the trial period
      */
     trial_days?: number;
     /**
@@ -264,7 +283,8 @@ type SubscriptionChargeRes = {
      */
     cancelled_on?: string;
     /**
-     * - Indicates if the charge is for testing purposes
+     * - Indicates whether the operation or data is in
+     * a test mode.
      */
     is_test?: boolean;
     /**
@@ -276,7 +296,7 @@ type SubscriptionChargeRes = {
      */
     modified_at?: string;
     /**
-     * - Company id
+     * - The unique identifier of the company.
      */
     company_id?: string;
     /**
@@ -284,89 +304,13 @@ type SubscriptionChargeRes = {
      */
     line_items?: any[];
 };
-/** @returns {ChargeDetails} */
-declare function ChargeDetails(): ChargeDetails;
-type ChargeDetails = {
-    /**
-     * - Unique identifier for the charge.
-     */
-    _id?: string;
-    /**
-     * - The type of entity associated with the
-     * charge (e.g., 'extension', 'subscription').
-     */
-    entity_type?: string;
-    /**
-     * - Unique identifier for the entity associated
-     * with the charge.
-     */
-    entity_id?: string;
-    /**
-     * - The name of the charge.
-     */
-    name?: string;
-    /**
-     * - Description of the charge term.
-     */
-    term?: string;
-    /**
-     * - The type of charge (e.g., 'standalone',
-     * 'recurring').
-     */
-    charge_type?: string;
-    /**
-     * - The pricing model for the charge (e.g.,
-     * 'one_time', 'recurring').
-     */
-    pricing_type?: string;
-    price?: EntityChargePrice;
-    recurring?: ChargeRecurring;
-    /**
-     * - Current status of the charge.
-     */
-    status?: string;
-    /**
-     * - Maximum amount that can be charged, if applicable.
-     */
-    capped_amount?: number;
-    /**
-     * - Date and time when the charge was activated.
-     */
-    activated_on?: string;
-    /**
-     * - Date and time when the charge was cancelled.
-     */
-    cancelled_on?: string;
-    /**
-     * - Date and time when the charge was billed.
-     */
-    billing_date?: string;
-    current_period?: SubscriptionTrialPeriod;
-    /**
-     * - Date and time when the charge details were
-     * last modified.
-     */
-    modified_at?: string;
-    /**
-     * - Date and time when the charge was created.
-     */
-    created_at?: string;
-    /**
-     * - Indicates whether the charge is for testing purposes.
-     */
-    is_test?: boolean;
-    /**
-     * - Company id.
-     */
-    company_id?: string;
-    /**
-     * - Additional metadata associated with the charge.
-     */
-    meta?: any;
+/** @returns {BadRequestSchema} */
+declare function BadRequestSchema(): BadRequestSchema;
+type BadRequestSchema = {
     /**
-     * - Internal version key for the charge record.
+     * - Failure message.
      */
-    __v?: number;
+    message?: string;
 };
 /** @returns {ResourceNotFound} */
 declare function ResourceNotFound(): ResourceNotFound;
@@ -375,74 +319,26 @@ type ResourceNotFound = {
      * - Resource not found with {id}
      */
     message?: string;
-    code?: any;
-    success?: any;
-};
-/** @returns {CreateOneTimeCharge} */
-declare function CreateOneTimeCharge(): CreateOneTimeCharge;
-type CreateOneTimeCharge = {
     /**
-     * - The name of the one-time charge to be created.
-     */
-    name?: string;
-    charge?: OneTimeChargeItem;
-    /**
-     * - Indicates whether the charge creation is for
-     * testing purposes.
-     */
-    is_test?: boolean;
-    /**
-     * - URL to which the user will be redirected
-     * after creating the charge.
+     * - The HTTP status code associated with the error
      */
-    return_url?: string;
-};
-/** @returns {CreateOneTimeChargeResponse} */
-declare function CreateOneTimeChargeResponse(): CreateOneTimeChargeResponse;
-type CreateOneTimeChargeResponse = {
-    charge?: Charge;
+    code?: number;
     /**
-     * - URL to which users are redirected to
-     * confirm or complete the payment or subscription process.
+     * - Indicates if the request was successful
      */
-    confirm_url?: string;
+    success?: boolean;
 };
-/** @returns {BadRequest} */
-declare function BadRequest(): BadRequest;
-type BadRequest = {
-    /**
-     * - Failure message.
-     */
-    message?: string;
-};
-/** @returns {CreateSubscriptionCharge} */
-declare function CreateSubscriptionCharge(): CreateSubscriptionCharge;
-type CreateSubscriptionCharge = {
-    /**
-     * - The name of the charge.
-     */
-    name: string;
-    trial_days?: number;
-    line_items: ChargeLineItem[];
-    /**
-     * - Indicates whether the charge is for testing purposes.
-     */
-    is_test?: boolean;
+/** @returns {SubscriptionTrialPeriod} */
+declare function SubscriptionTrialPeriod(): SubscriptionTrialPeriod;
+type SubscriptionTrialPeriod = {
     /**
-     * - The URL passed in request which extension
-     * expects in return.
+     * - The start date and time of the trial period.
      */
-    return_url: string;
-};
-/** @returns {CreateSubscriptionResponse} */
-declare function CreateSubscriptionResponse(): CreateSubscriptionResponse;
-type CreateSubscriptionResponse = {
-    subscription?: EntitySubscription;
+    start_date?: string;
     /**
-     * - URL to which users are redirected to
-     * confirm or complete the payment or subscription process.
+     * - The end date and time of the trial period.
      */
-    confirm_url?: string;
+    end_date?: string;
 };
 /** @returns {EntityChargePrice} */
 declare function EntityChargePrice(): EntityChargePrice;
@@ -456,29 +352,6 @@ type EntityChargePrice = {
      */
     currency_code?: string;
 };
-/** @returns {ChargeRecurring} */
-declare function ChargeRecurring(): ChargeRecurring;
-type ChargeRecurring = {
-    interval?: string;
-    interval_time?: number;
-};
-/** @returns {SubscriptionTrialPeriod} */
-declare function SubscriptionTrialPeriod(): SubscriptionTrialPeriod;
-type SubscriptionTrialPeriod = {
-    /**
-     * - The start date and time of the trial period.
-     */
-    start_date?: string;
-    /**
-     * - The end date and time of the trial period.
-     */
-    end_date?: string;
-};
-/** @returns {Charge} */
-declare function Charge(): Charge;
-type Charge = {
-    final_charge?: OneTimeChargeEntity;
-};
 /** @returns {OneTimeChargeItem} */
 declare function OneTimeChargeItem(): OneTimeChargeItem;
 type OneTimeChargeItem = {
@@ -497,12 +370,12 @@ type OneTimeChargeItem = {
     price?: EntityChargePrice;
     /**
      * - The maximum amount that can be charged
-     * for this item, if applicable.
+     * for a particular service or item
      */
     capped_amount?: number;
     /**
-     * - Indicates whether the charge item is for
-     * testing purposes.
+     * - Indicates whether the operation or data is in
+     * a test mode.
      */
     is_test?: boolean;
     /**
@@ -510,83 +383,120 @@ type OneTimeChargeItem = {
      */
     metadata?: any;
 };
-/** @returns {ChargeLineItem} */
-declare function ChargeLineItem(): ChargeLineItem;
-type ChargeLineItem = {
+/** @returns {CreateOneTimeCharge} */
+declare function CreateOneTimeCharge(): CreateOneTimeCharge;
+type CreateOneTimeCharge = {
     /**
-     * - Its name of the extension plan.
+     * - The name of the one-time charge to be created.
      */
-    name: string;
+    name?: string;
+    charge?: OneTimeChargeItem;
     /**
-     * - It indicates how it will be charged.
+     * - Indicates whether the operation or data is in
+     * a test mode.
      */
-    term: string;
+    is_test?: boolean;
     /**
-     * - It indicates the extension subscription
-     * will be auto renewed timely.
+     * - URL to which the user will be redirected
+     * after creating the charge.
      */
-    pricing_type: string;
-    price: EntityChargePrice;
-    recurring?: EntityChargeRecurring;
-    capped_amount?: number;
-    trial_days?: number;
-    is_test?: boolean;
-    metadata?: any;
+    return_url?: string;
 };
-/** @returns {EntitySubscription} */
-declare function EntitySubscription(): EntitySubscription;
-type EntitySubscription = {
+/** @returns {ChargeRecurring} */
+declare function ChargeRecurring(): ChargeRecurring;
+type ChargeRecurring = {
     /**
-     * - Unique identifier for the subscription charge
+     * - The interval at which the recurring charge is
+     * applied. Examples include "month", "year", etc.
+     */
+    interval?: string;
+    interval_time?: number;
+};
+/** @returns {ChargeDetails} */
+declare function ChargeDetails(): ChargeDetails;
+type ChargeDetails = {
+    /**
+     * - Unique identifier for the charge.
      */
     _id?: string;
     /**
-     * - ID of the product suit associated with
-     * the charge
+     * - Specifies the type of entity related to
+     * the operation, such as 'extension' or 'subscription'
      */
-    product_suit_id?: string;
+    entity_type?: string;
     /**
-     * - Unique identifier for the entity
+     * - Unique identifier for the entity (eg. extension)
      */
     entity_id?: string;
     /**
-     * - Type of entity (e.g., subscription, extension)
+     * - The name of the extension plan
      */
-    entity_type?: string;
+    name?: string;
     /**
-     * - Name of the subscription charge
+     * - Description of the charge term.
      */
-    name?: string;
+    term?: string;
     /**
-     * - Current status of the subscription charge
+     * - The type of charge (e.g., 'standalone',
+     * 'recurring').
+     */
+    charge_type?: string;
+    /**
+     * - The pricing model for the charge (e.g.,
+     * 'one_time', 'recurring').
+     */
+    pricing_type?: string;
+    price?: EntityChargePrice;
+    recurring?: ChargeRecurring;
+    /**
+     * - Current status of the charge.
      */
     status?: string;
     /**
-     * - Number of trial days provided
+     * - The maximum amount that can be charged
+     * for a particular service or item
      */
-    trial_days?: number;
+    capped_amount?: number;
     /**
-     * - Indicates if the charge is for testing purposes
+     * - Date and time when the charge was activated.
      */
-    is_test?: boolean;
+    activated_on?: string;
     /**
-     * - Timestamp when the charge was created
+     * - Date and time when the charge was cancelled.
      */
-    created_at?: string;
+    cancelled_on?: string;
     /**
-     * - Timestamp when the charge was last modified
+     * - The date when the billing occurred. This
+     * field is optional and may be null if the billing date is not specified.
+     */
+    billing_date?: string;
+    current_period?: SubscriptionTrialPeriod;
+    /**
+     * - Date and time when the charge details were
+     * last modified.
      */
     modified_at?: string;
     /**
-     * - Unique Identifier of the company
+     * - Date and time when the charge was created.
      */
-    subscriber_id?: string;
-    line_items?: EntityChargeDetails[];
+    created_at?: string;
     /**
-     * - The URL passed in request which extension
-     * expects in return.
+     * - Indicates whether the operation or data is in
+     * a test mode.
      */
-    return_url?: string;
+    is_test?: boolean;
+    /**
+     * - The unique identifier of the company.
+     */
+    company_id?: string;
+    /**
+     * - Additional metadata associated with the charge.
+     */
+    meta?: any;
+    /**
+     * - Internal version key for the charge record.
+     */
+    __v?: number;
 };
 /** @returns {OneTimeChargeEntity} */
 declare function OneTimeChargeEntity(): OneTimeChargeEntity;
@@ -601,13 +511,13 @@ type OneTimeChargeEntity = {
      */
     charge_type?: string;
     /**
-     * - Maximum amount that can be charged. If
-     * no cap, the value should be 0.
+     * - The maximum amount that can be charged
+     * for a particular service or item
      */
     capped_amount?: number;
     /**
-     * - Date when the charge was billed. Null if
-     * not yet billed.
+     * - The date when the billing occurred. This
+     * field is optional and may be null if the billing date is not specified.
      */
     billing_date?: string;
     /**
@@ -632,8 +542,7 @@ type OneTimeChargeEntity = {
      */
     name?: string;
     /**
-     * - Current status of the charge (e.g., 'pending',
-     * 'completed').
+     * - Current status of the charge (e.g., 'pending').
      */
     status?: string;
     /**
@@ -655,7 +564,8 @@ type OneTimeChargeEntity = {
      */
     return_url?: string;
     /**
-     * - Indicates whether the charge is for testing purposes.
+     * - Indicates whether the operation or data is in
+     * a test mode.
      */
     is_test?: boolean;
     /**
@@ -663,18 +573,17 @@ type OneTimeChargeEntity = {
      */
     pricing_type?: string;
     /**
-     * - Unique identifier for the subscriber
-     * associated with the charge.
+     * - The unique identifier for the company in
+     * the system.
      */
     subscriber_id?: string;
     /**
-     * - Type of the entity related to the charge
-     * (e.g., 'subscription', 'user').
+     * - Specifies the type of entity related to
+     * the operation, such as 'extension' or 'subscription'
      */
     entity_type?: string;
     /**
-     * - Unique identifier for the entity associated
-     * with the charge.
+     * - Unique identifier for the entity (eg. extension)
      */
     entity_id?: string;
     /**
@@ -683,46 +592,120 @@ type OneTimeChargeEntity = {
     meta?: any;
     price?: EntityChargePrice;
 };
+/** @returns {CreateOneTimeChargeResponseSchemas} */
+declare function CreateOneTimeChargeResponseSchemas(): CreateOneTimeChargeResponseSchemas;
+type CreateOneTimeChargeResponseSchemas = {
+    charge?: Charge;
+    /**
+     * - URL to which users are redirected to
+     * confirm or complete the payment or subscription process.
+     */
+    confirm_url?: string;
+};
+/** @returns {Charge} */
+declare function Charge(): Charge;
+type Charge = {
+    final_charge?: OneTimeChargeEntity;
+};
 /** @returns {EntityChargeRecurring} */
 declare function EntityChargeRecurring(): EntityChargeRecurring;
 type EntityChargeRecurring = {
     /**
-     * - The interval of the subscription.
+     * - The interval at which the recurring charge is
+     * applied. Examples include "month", "year", etc.
      */
     interval: string;
 };
+/** @returns {ChargeLineItem} */
+declare function ChargeLineItem(): ChargeLineItem;
+type ChargeLineItem = {
+    /**
+     * - Its name of the extension plan.
+     */
+    name: string;
+    /**
+     * - It indicates how it will be charged.
+     */
+    term: string;
+    /**
+     * - Specifies the type of pricing for the
+     * extension subscription. It indicates whether the subscription will be
+     * automatically renewed, charged once, or based on usage.
+     */
+    pricing_type: string;
+    price: EntityChargePrice;
+    recurring?: EntityChargeRecurring;
+    /**
+     * - The maximum amount that can be charged
+     * for a particular service or item
+     */
+    capped_amount?: number;
+    /**
+     * - The number of days allocated for the trial period
+     */
+    trial_days?: number;
+    /**
+     * - Indicates whether the operation or data is in
+     * a test mode.
+     */
+    is_test?: boolean;
+    metadata?: any;
+};
+/** @returns {CreateSubscriptionCharge} */
+declare function CreateSubscriptionCharge(): CreateSubscriptionCharge;
+type CreateSubscriptionCharge = {
+    /**
+     * - The name of the extension plan
+     */
+    name: string;
+    /**
+     * - The number of days allocated for the trial period
+     */
+    trial_days?: number;
+    line_items: ChargeLineItem[];
+    /**
+     * - Indicates whether the operation or data is in
+     * a test mode.
+     */
+    is_test?: boolean;
+    /**
+     * - The URL to which the user will be redirected
+     * after the subscription process is complete.
+     */
+    return_url: string;
+};
 /** @returns {EntityChargeDetails} */
 declare function EntityChargeDetails(): EntityChargeDetails;
 type EntityChargeDetails = {
     /**
-     * - Unique identifier for the charge.
+     * - The unique identifier for the charge.
      */
     _id?: string;
     /**
-     * - Unique identifier of the extension subscription.
+     * - The unique identifier of the subscription.
      */
     subscription_id?: string;
     /**
-     * - Unique identifier of the
-     * subscriber/company who installed extension subscription.
+     * - The unique identifier for the company in
+     * the system.
      */
     subscriber_id?: string;
     /**
-     * - The type of entity associated with the
-     * charge (e.g., 'extension', 'subscription').
+     * - Specifies the type of entity related to
+     * the operation, such as 'extension' or 'subscription'
      */
     entity_type?: string;
     /**
-     * - Unique identifier for the entity associated
-     * with the charge.
+     * - Unique identifier for the entity (eg. extension)
      */
     entity_id?: string;
     /**
-     * - The name of the charge.
+     * - The name of the extension plan
      */
     name?: string;
     /**
-     * - Description of the charge term.
+     * - Detailed description of the terms and conditions
+     * associated with the charge.
      */
     term?: string;
     /**
@@ -742,7 +725,8 @@ type EntityChargeDetails = {
      */
     status?: string;
     /**
-     * - Maximum amount that can be charged, if applicable.
+     * - The maximum amount that can be charged
+     * for a particular service or item
      */
     capped_amount?: number;
     /**
@@ -754,7 +738,8 @@ type EntityChargeDetails = {
      */
     cancelled_on?: string;
     /**
-     * - Date and time when the charge was billed.
+     * - The date when the billing occurred. This
+     * field is optional and may be null if the billing date is not specified.
      */
     billing_date?: string;
     current_period?: SubscriptionTrialPeriod;
@@ -768,11 +753,12 @@ type EntityChargeDetails = {
      */
     created_at?: string;
     /**
-     * - Indicates whether the charge is for testing purposes.
+     * - Indicates whether the operation or data is in
+     * a test mode.
      */
     is_test?: boolean;
     /**
-     * - Company id.
+     * - The unique identifier of the company.
      */
     company_id?: string;
     /**
@@ -784,3 +770,72 @@ type EntityChargeDetails = {
      */
     __v?: number;
 };
+/** @returns {EntitySubscription} */
+declare function EntitySubscription(): EntitySubscription;
+type EntitySubscription = {
+    /**
+     * - Unique identifier for the subscription charge
+     */
+    _id?: string;
+    /**
+     * - A unique identifier for a product
+     * suite, which represents a specific collection or group of products within
+     * the system.
+     */
+    product_suit_id?: string;
+    /**
+     * - Unique identifier for the entity (eg. extension)
+     */
+    entity_id?: string;
+    /**
+     * - Specifies the type of entity related to
+     * the operation, such as 'extension' or 'subscription'
+     */
+    entity_type?: string;
+    /**
+     * - The name of the extension plan
+     */
+    name?: string;
+    /**
+     * - Current status of the subscription charge
+     */
+    status?: string;
+    /**
+     * - The number of days allocated for the trial period
+     */
+    trial_days?: number;
+    /**
+     * - Indicates whether the operation or data is in
+     * a test mode.
+     */
+    is_test?: boolean;
+    /**
+     * - Timestamp when the charge was created
+     */
+    created_at?: string;
+    /**
+     * - Timestamp when the charge was last modified
+     */
+    modified_at?: string;
+    /**
+     * - The unique identifier for the company in
+     * the system.
+     */
+    subscriber_id?: string;
+    line_items?: EntityChargeDetails[];
+    /**
+     * - The URL passed in request which extension
+     * expects in return.
+     */
+    return_url?: string;
+};
+/** @returns {CreateSubscription} */
+declare function CreateSubscription(): CreateSubscription;
+type CreateSubscription = {
+    subscription?: EntitySubscription;
+    /**
+     * - URL to which users are redirected to post
+     * initiation of extension installation.
+     */
+    confirm_url?: string;
+};