@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.9

package/sdk/platform/Billing/BillingPlatformModel.js

@@ -1,155 +1,52 @@
 const Joi = require("joi");
 
-/**
- * @typedef CompanyInfo
- * @property {string} [company_name]
- * @property {string} [gstin]
- * @property {string} [address]
- * @property {AddressDetails} [address_details]
- * @property {string} [pan]
- * @property {string} [phone]
- * @property {string} [email]
- * @property {string} [cin]
- */
-
-/**
- * @typedef AddressDetails
- * @property {string} [address_line_1]
- * @property {string} [address_line_2]
- * @property {string} [city]
- * @property {string} [pincode]
- * @property {string} [state]
- * @property {string} [country]
- */
-
-/**
- * @typedef InvoiceData
- * @property {InvoiceDetailsData} [invoice]
- * @property {InvoiceItems[]} [invoice_items]
- * @property {CompanyInfo} [shopsense_details]
- */
-
-/**
- * @typedef InvoiceDetailsData
- * @property {number} [attemp]
- * @property {Object} [documents]
- * @property {Object} [payment]
- * @property {Period} [period]
- * @property {Client} [client]
- * @property {Object} [discount]
- * @property {Object} [taxation]
- * @property {string} [_id]
- * @property {boolean} [auto_advance]
- * @property {string} [collection_method]
- * @property {string} [subscriber_id]
- * @property {string} [currency]
- * @property {string} [invoice_url]
- * @property {string} [number]
- * @property {boolean} [paid]
- * @property {Object} [pg_data]
- * @property {string} [receipt_number]
- * @property {string} [statement_descriptor]
- * @property {string} [current_status]
- * @property {StatusTrail[]} [status_trail]
- * @property {number} [subtotal]
- * @property {number} [total]
- * @property {number} [old_settlement]
- * @property {number} [credit_balance]
- * @property {string} [subscription]
- * @property {number} [attempt]
- * @property {string} [next_action_time]
- * @property {number} [credit_note_amount]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- */
-
-/**
- * @typedef Client
- * @property {string} [name]
- * @property {string} [email]
- * @property {string} [phone]
- * @property {string[]} [address_lines]
- */
-
-/**
- * @typedef Period
- * @property {string} [start]
- * @property {string} [end]
- */
-
-/**
- * @typedef StatusTrail
- * @property {string} [value]
- * @property {string} [timestamp]
- * @property {string} [_id]
- */
-
-/**
- * @typedef PaymentCollectRes
- * @property {string} [transaction_id]
- * @property {string} [current_status]
- */
-
 /**
  * @typedef SubscriptionChargeRes
- * @property {string} [_id]
- * @property {string} [product_suit_id]
- * @property {string} [entity_id]
- * @property {string} [entity_type]
- * @property {string} [name]
- * @property {string} [status]
- * @property {number} [trial_days]
- * @property {string} [activated_on]
- * @property {string} [cancelled_on]
- * @property {boolean} [is_test]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- * @property {string} [company_id]
- * @property {Object[]} [line_items]
- */
-
-/**
- * @typedef PostDowngradeRes
- * @property {boolean} [success]
- * @property {DowngradeRes} [data]
- */
-
-/**
- * @typedef DowngradeRes
- * @property {string} [_id]
- * @property {string} [status]
- * @property {string} [subscriber_id]
- * @property {boolean} [activated]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- * @property {string} [plan_id]
- * @property {string} [reason]
- * @property {string} [request_user_id]
- * @property {string} [subscription_id]
+ * @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} [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 {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 {Object[]} [line_items] - List of line items associated with the charge
  */
 
 /**
- * @typedef PaymentStatusData
- * @property {string} [_id]
- * @property {string} [journey]
- * @property {Object[]} [webhook_response]
- * @property {string} [aggregator_status]
- * @property {string} [current_status]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- * @property {number} [__v]
- * @property {string} [aggregator_order_id]
- */
-
-/**
- * @typedef PaymentStatusResponse
- * @property {string} [status]
- * @property {PaymentStatusData} [data]
- */
-
-/**
- * @typedef BadRequest
- * @property {string} [message] - Failure message.
+ * @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.
  */
 
 /**
@@ -159,2377 +56,428 @@ const Joi = require("joi");
  * @property {Object} [success]
  */
 
-/**
- * @typedef InternalServerError
- * @property {string} [message] - Internal server Server error
- * @property {string} [code] - Error code
- */
-
-/**
- * @typedef CheckValidityResponse
- * @property {boolean} [is_valid]
- * @property {number} [discount_amount]
- */
-
-/**
- * @typedef PlanRecurring
- * @property {string} [interval]
- * @property {number} [interval_count]
- */
-
-/**
- * @typedef PlanMeta
- * @property {string} [seller_status]
- * @property {string} [company]
- * @property {string} [plan_platform_display_name]
- */
-
-/**
- * @typedef Plan
- * @property {Object[]} [fee_components]
- * @property {PlanRecurring} [recurring]
- * @property {boolean} [is_trial_plan]
- * @property {string} [plan_group]
- * @property {string[]} [tag_lines]
- * @property {string} [currency]
- * @property {boolean} [is_active]
- * @property {boolean} [is_visible]
- * @property {number} [trial_period]
- * @property {string[]} [addons]
- * @property {string[]} [tags]
- * @property {string} [type]
- * @property {string} [country]
- * @property {string} [_id]
- * @property {string} [name]
- * @property {string} [description]
- * @property {number} [amount]
- * @property {string} [product_suite_id]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- * @property {Taxation} [taxation]
- * @property {OneTimeFees} [one_time_fees]
- * @property {CreditLine} [credit_line]
- * @property {string} [current_status]
- * @property {string} [channel_type]
- * @property {Object[]} [company_ids]
- * @property {string} [platform]
- * @property {string} [activated_on]
- * @property {PlanMeta} [meta]
- * @property {string} [created_by]
- */
-
-/**
- * @typedef SubscriptionTrialPeriod
- * @property {string} [start_date]
- * @property {string} [end_date]
- */
-
-/**
- * @typedef EntityChargePrice
- * @property {number} [amount] - Amount for price. Minimum value 1
- * @property {string} [currency_code]
- */
-
-/**
- * @typedef OneTimeChargeItem
- * @property {string} [name]
- * @property {string} [term]
- * @property {string} [pricing_type]
- * @property {EntityChargePrice} [price]
- * @property {number} [capped_amount]
- * @property {boolean} [is_test]
- * @property {Object} [metadata]
- */
-
 /**
  * @typedef CreateOneTimeCharge
- * @property {string} [name]
+ * @property {string} [name] - The name of the one-time charge to be created.
  * @property {OneTimeChargeItem} [charge]
- * @property {boolean} [is_test]
- * @property {string} [return_url]
- */
-
-/**
- * @typedef ChargeRecurring
- * @property {string} [interval]
- * @property {number} [interval_time]
- */
-
-/**
- * @typedef ChargeDetails
- * @property {string} [_id]
- * @property {string} [entity_type]
- * @property {string} [entity_id]
- * @property {string} [name]
- * @property {string} [term]
- * @property {string} [charge_type]
- * @property {string} [pricing_type]
- * @property {EntityChargePrice} [price]
- * @property {ChargeRecurring} [recurring]
- * @property {string} [status]
- * @property {number} [capped_amount]
- * @property {string} [activated_on]
- * @property {string} [cancelled_on]
- * @property {string} [billing_date]
- * @property {SubscriptionTrialPeriod} [current_period]
- * @property {string} [modified_at]
- * @property {string} [created_at]
- * @property {boolean} [is_test]
- * @property {string} [company_id]
- * @property {Object} [meta]
- * @property {number} [__v]
- */
-
-/**
- * @typedef OneTimeChargeEntity
- * @property {string} [term]
- * @property {string} [charge_type]
- * @property {number} [capped_amount]
- * @property {string} [billing_date]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- * @property {number} [__v]
- * @property {string} [_id]
- * @property {string} [name]
- * @property {string} [status]
- * @property {string} [activated_on]
- * @property {string} [cancelled_on]
- * @property {Object} [metadata]
- * @property {string} [return_url]
- * @property {boolean} [is_test]
- * @property {string} [pricing_type]
- * @property {string} [subscriber_id]
- * @property {string} [entity_type]
- * @property {string} [entity_id]
- * @property {Object} [meta]
- * @property {EntityChargePrice} [price]
+ * @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]
- */
-
-/**
- * @typedef Charge
- * @property {OneTimeChargeEntity} [final_charge]
- */
-
-/**
- * @typedef InvoiceDetailsStatusTrail
- * @property {string} [_id]
- * @property {string} [value]
- * @property {string} [timestamp]
- */
-
-/**
- * @typedef InvoiceItemsPlanRecurring
- * @property {string} [interval]
- * @property {number} [interval_count]
- */
-
-/**
- * @typedef InvoiceItemsPlan
- * @property {InvoiceItemsPlanRecurring} [recurring]
- * @property {boolean} [is_trial_plan]
- * @property {string} [plan_group]
- * @property {string[]} [tag_lines]
- * @property {string} [currency]
- * @property {boolean} [is_active]
- * @property {boolean} [is_visible]
- * @property {number} [trial_period]
- * @property {string[]} [addons]
- * @property {string[]} [tags]
- * @property {string} [type]
- * @property {string} [country]
- * @property {string} [_id]
- * @property {string} [name]
- * @property {string} [description]
- * @property {number} [amount]
- * @property {string} [product_suite_id]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- */
-
-/**
- * @typedef InvoiceItemsPeriod
- * @property {string} [start]
- * @property {string} [end]
- */
-
-/**
- * @typedef InvoiceItems
- * @property {string} [_id]
- * @property {string} [currency]
- * @property {InvoiceItemsPlan} [plan]
- * @property {string} [name]
- * @property {number} [quantity]
- * @property {string} [description]
- * @property {InvoiceItemsPeriod} [period]
- * @property {number} [unit_amount]
- * @property {number} [amount]
- * @property {string} [type]
- * @property {string} [invoice_id]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- */
-
-/**
- * @typedef InvoicesDataClient
- * @property {string} [name]
- * @property {string} [email]
- * @property {string} [phone]
- * @property {string[]} [address_lines]
- */
-
-/**
- * @typedef InvoicesDataPeriod
- * @property {string} [start]
- * @property {string} [end]
- */
-
-/**
- * @typedef InvoicesDataPaymentMethod
- * @property {string} [pg_payment_method_id]
- */
-
-/**
- * @typedef InvoicesData
- * @property {string} [_id]
- * @property {Object} [documents]
- * @property {Object} [payment]
- * @property {number} [old_settlement]
- * @property {number} [credit_balance]
- * @property {Object} [discount]
- * @property {Object} [taxation]
- * @property {number} [credit_note_amount]
- * @property {InvoicesDataClient} [client]
- * @property {boolean} [auto_advance]
- * @property {string} [currency]
- * @property {boolean} [paid]
- * @property {number} [attemp]
- * @property {string} [collection_method]
- * @property {string} [subscriber_id]
- * @property {string} [invoice_url]
- * @property {string} [number]
- * @property {Object} [pg_data]
- * @property {InvoicesDataPeriod} [period]
- * @property {string} [receipt_number]
- * @property {string} [statement_descriptor]
- * @property {string} [current_status]
- * @property {InvoiceDetailsStatusTrail[]} [status_trail]
- * @property {number} [subtotal]
- * @property {number} [total]
- * @property {string} [subscription]
- * @property {string} [next_action_time]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- * @property {string} [hash_identifier]
- * @property {InvoicesDataPaymentMethod} [payment_method]
- * @property {InvoiceItems[]} [invoice_items]
- */
-
-/**
- * @typedef Invoices
- * @property {InvoicesData[]} [data]
- * @property {number} [start]
- * @property {number} [end]
- * @property {number} [limit]
- * @property {number} [page]
- * @property {number} [total]
- */
-
-/**
- * @typedef Phone
- * @property {string} [phone_number]
- * @property {string} [phone_country_code]
- */
-
-/**
- * @typedef SubscriptionBillingAddress
- * @property {string} [country]
- * @property {string} [state]
- * @property {string} [city]
- * @property {string} [line1]
- * @property {string} [line2]
- * @property {string} [postal_code]
- */
-
-/**
- * @typedef SubscriptionCustomer
- * @property {Phone} [phone]
- * @property {SubscriptionBillingAddress} [billing_address]
- * @property {string} [_id]
- * @property {string} [unique_id]
- * @property {string} [type]
- * @property {string} [name]
- * @property {string} [email]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- * @property {Object} [data]
- * @property {Object} [documents]
- * @property {boolean} [consent]
- * @property {boolean} [comms]
- * @property {number} [credit_balance]
- * @property {BusinessCountryInfo} [business_country_info]
- */
-
-/**
- * @typedef SubscriptionCustomerCreate
- * @property {Phone} [phone]
- * @property {SubscriptionBillingAddress} [billing_address]
- * @property {string} [unique_id]
- * @property {string} [type]
- * @property {string} [name]
- * @property {string} [email]
- */
-
-/**
- * @typedef SubscriptionCurrentPeriod
- * @property {string} [start]
- * @property {string} [end]
- */
-
-/**
- * @typedef SubscriptionPauseCollection
- * @property {string} [behavior]
- * @property {string} [resume_at]
- */
-
-/**
- * @typedef SubscriptionTrial
- * @property {string} [start]
- * @property {string} [end]
- */
-
-/**
- * @typedef SubscriptionInvoiceSettings
- * @property {boolean} [generation]
- * @property {boolean} [charging]
- */
-
-/**
- * @typedef Subscription
- * @property {Object} [meta]
- * @property {SubscriptionCurrentPeriod} [current_period]
- * @property {SubscriptionPauseCollection} [pause_collection]
- * @property {SubscriptionTrial} [trial]
- * @property {SubscriptionInvoiceSettings} [invoice_settings]
- * @property {boolean} [is_active]
- * @property {boolean} [cancel_at_period_end]
- * @property {string} [_id]
- * @property {string} [subscriber_id]
- * @property {string} [plan_id]
- * @property {string} [product_suite_id]
- * @property {Plan} [plan_data]
- * @property {string} [current_status]
- * @property {string} [collection_method]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- * @property {string} [latest_invoice]
- * @property {string} [channel_type]
- * @property {boolean} [freezed]
- * @property {string} [cancel_at]
- * @property {string} [canceled_at]
- */
-
-/**
- * @typedef SubscriptionStatus
- * @property {boolean} [is_enabled]
- * @property {Subscription} [subscription]
- * @property {InvoicesData} [latest_invoice]
- * @property {Plan} [next_plan]
- * @property {Subscription[]} [current_subscriptions]
- * @property {number} [mandate_amount]
- * @property {string} [message]
- */
-
-/**
- * @typedef SubscriptionLimitApplication
- * @property {boolean} [enabled]
- * @property {number} [hard_limit]
- * @property {number} [soft_limit]
- */
-
-/**
- * @typedef SubscriptionLimitMarketplace
- * @property {boolean} [enabled]
- */
-
-/**
- * @typedef SubscriptionLimitOtherPlatform
- * @property {boolean} [enabled]
- */
-
-/**
- * @typedef SubscriptionLimitTeam
- * @property {number} [limit]
- */
-
-/**
- * @typedef SubscriptionLimitProducts
- * @property {boolean} [bulk]
- * @property {number} [limit]
- */
-
-/**
- * @typedef SubscriptionLimitExtensions
- * @property {boolean} [enabled]
- * @property {number} [limit]
- */
-
-/**
- * @typedef SubscriptionLimitIntegrations
- * @property {boolean} [enabled]
- * @property {number} [limit]
- */
-
-/**
- * @typedef SubscriptionLimit
- * @property {SubscriptionLimitApplication} [application]
- * @property {SubscriptionLimitMarketplace} [marketplace]
- * @property {SubscriptionLimitOtherPlatform} [other_platform]
- * @property {SubscriptionLimitTeam} [team]
- * @property {SubscriptionLimitProducts} [products]
- * @property {SubscriptionLimitExtensions} [extensions]
- * @property {SubscriptionLimitIntegrations} [integrations]
- * @property {boolean} [is_trial_plan]
- */
-
-/**
- * @typedef IntentReq
- * @property {string} [unique_external_id]
- * @property {string} [plan_id]
- */
-
-/**
- * @typedef PutIntentReq
- * @property {string} [unique_external_id]
- * @property {string} [setup_intent_id]
- * @property {string} [payment_method_id]
- * @property {boolean} [set_default]
- */
-
-/**
- * @typedef SubscriptionActivateReq
- * @property {string} [unique_id]
- * @property {string} [type]
- * @property {string} [product_suite]
- * @property {string} [plan_id]
- * @property {string} [payment_method]
- * @property {string} [subscription_id]
- * @property {string} [coupon]
- * @property {Object} [meta]
- */
-
-/**
- * @typedef SubscriptionActivateRes
- * @property {boolean} [success]
- * @property {Subscription} [data]
- */
-
-/**
- * @typedef CancelSubscriptionReq
- * @property {string} [unique_id]
- * @property {string} [type]
- * @property {string} [product_suite]
- * @property {string} [subscription_id]
- */
-
-/**
- * @typedef CancelSubscriptionRes
- * @property {boolean} [success]
- * @property {Subscription} [data]
- */
-
-/**
- * @typedef PlanStatusUpdateReq
- * @property {string} [plan_id]
- * @property {string} [reason]
- * @property {string} [seller_status]
- */
-
-/**
- * @typedef SunscribePlan
- * @property {string} [entity_type]
- * @property {string} [collection_type]
- * @property {string} [plan_id]
- * @property {string} [callback_url]
- * @property {Meta} [meta]
- */
-
-/**
- * @typedef Meta
- * @property {boolean} [subscribe]
- * @property {boolean} [is_custom_plan]
- * @property {boolean} [is_plan_upgrade]
- */
-
-/**
- * @typedef SubscribePlanRes
- * @property {string} [redirect_url]
- * @property {string} [transaction_id]
- * @property {string} [current_status]
- * @property {Meta} [meta]
- */
-
-/**
- * @typedef EntityDetail
- * @property {string} [entity]
- * @property {Subscription} [item]
- */
-
-/**
- * @typedef PaymentOptions
- * @property {string} [_id]
- * @property {string} [name]
- * @property {string} [description]
- * @property {string} [logo]
- * @property {string} [aggregator_id]
- * @property {string} [aggregator]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- * @property {number} [__v]
- */
-
-/**
- * @typedef VerifyPaymentReq
- * @property {string} [razorpay_payment_id]
- * @property {string} [razorpay_order_id]
- * @property {string} [razorpay_signature]
- * @property {number} [status_code]
- * @property {string} [provider_type]
- */
-
-/**
- * @typedef Documents
- * @property {string} [pan]
- * @property {string} [gst]
- */
-
-/**
- * @typedef BillingAddress
- * @property {string} [country]
- * @property {string} [state]
- * @property {string} [city]
- * @property {string} [line1]
- * @property {string} [line2]
- * @property {string} [postal_code]
- * @property {string} [country_code]
- */
-
-/**
- * @typedef Currency
- * @property {string} [code]
- * @property {string} [symbol]
- * @property {string} [name]
- */
-
-/**
- * @typedef BusinessCountryInfo
- * @property {string} [country]
- * @property {string} [country_code]
- * @property {Currency} [currency]
- * @property {string} [timezone]
- */
-
-/**
- * @typedef SubscriberData
- * @property {boolean} [pg_user_exists]
- * @property {Object} [id]
- * @property {string} [pg_customer_id]
- * @property {string} [default_payment_method]
- */
-
-/**
- * @typedef Subscriber
- * @property {Documents} [documents]
- * @property {Object} [phone]
- * @property {BillingAddress} [billing_address]
- * @property {boolean} [consent]
- * @property {boolean} [comms]
- * @property {string} [_id]
- * @property {string} [type]
- * @property {string} [unique_id]
- * @property {string} [name]
- * @property {string} [email]
- * @property {BusinessCountryInfo} [business_country_info]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- * @property {number} [credit_balance]
- * @property {SubscriberData} [data]
- */
-
-/**
- * @typedef Author
- * @property {Object} [modified_by_details]
+ * @property {string} [confirm_url] - URL to which users are redirected to
+ *   confirm or complete the payment or subscription process.
  */
 
 /**
- * @typedef EndingBalance
- * @property {number} [amount]
- * @property {string} [old_entry_ref]
+ * @typedef BadRequest
+ * @property {string} [message] - Failure message.
  */
 
 /**
- * @typedef PaymentData
- * @property {string} [transaction_id]
- * @property {string} [aggregator]
- * @property {string} [aggregator_order_id]
+ * @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 CreditTransaction
- * @property {Object} [entity]
- * @property {Author} [author]
- * @property {string} [_id]
- * @property {number} [amount]
- * @property {string} [currency]
- * @property {string} [subscriber_id]
- * @property {string} [description]
- * @property {Object} [is_test]
- * @property {EndingBalance} [ending_balance]
- * @property {PaymentData} [payment]
- * @property {string} [type]
- * @property {string} [created_at]
- * @property {string} [modified_at]
+ * @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 VerifyPaymentData
- * @property {boolean} [success]
- * @property {Subscriber} [subscriber]
- * @property {CreditTransaction} [credit_transaction]
+ * @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 VerifyPaymentRes
- * @property {string} [status]
- * @property {VerifyPaymentData} [data]
- */
-
-/**
- * @typedef DefaultMerchants
- * @property {string} [stripe]
- */
-
-/**
- * @typedef GlobalSettingsPayment
- * @property {DefaultMerchants} [default_merchants]
- */
-
-/**
- * @typedef GlobalSettingsData
- * @property {GlobalSettingsPayment} [payment]
- * @property {boolean} [freeze_panel]
- * @property {string} [_id]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- */
-
-/**
- * @typedef GlobalSettings
- * @property {string} [status]
- * @property {GlobalSettingsData} [data]
- */
-
-/**
- * @typedef MethodChecks
- * @property {string} [address_line1_check]
- * @property {string} [address_postal_code_check]
- * @property {string} [cvc_check]
- */
-
-/**
- * @typedef MethodNetworks
- * @property {string[]} [available]
- * @property {string} [preferred]
- */
-
-/**
- * @typedef MethodSecureUsage
- * @property {boolean} [supported]
- */
-
-/**
- * @typedef MethodDetails
- * @property {string} [id]
- * @property {string} [type]
- * @property {boolean} [mandate_available]
- * @property {number} [mandate_amount]
- * @property {string} [pg_payment_method_id]
- * @property {boolean} [is_default]
- * @property {SubscriptionMethodData} [data]
- */
-
-/**
- * @typedef SubscriptionMethodData
- * @property {string} [brand]
- * @property {MethodChecks} [checks]
- * @property {string} [country]
- * @property {number} [exp_month]
- * @property {number} [exp_year]
- * @property {string} [fingerprint]
- * @property {string} [funding]
- * @property {string} [generated_from]
- * @property {string} [last4]
- * @property {MethodNetworks} [networks]
- * @property {MethodSecureUsage} [three_d_secure_usage]
- * @property {string} [wallet]
- * @property {string} [name]
- * @property {boolean} [is_default]
- */
-
-/**
- * @typedef SubscriptionMethods
- * @property {boolean} [success]
- * @property {MethodDetails[]} [data]
- */
-
-/**
- * @typedef ConfigPublicKey
- * @property {string} [public_key]
- */
-
-/**
- * @typedef ConfigRes
- * @property {boolean} [success]
- * @property {string} [aggregator]
- * @property {ConfigPublicKey} [config]
- */
-
-/**
- * @typedef PlanChangeData
- * @property {number} [total]
- * @property {number} [credit_note_amount]
- * @property {number} [settlement]
- * @property {number} [taxable_amount]
- * @property {number} [gst_amount]
- * @property {number} [gross_total]
- * @property {number} [gst]
- * @property {number} [discount]
- */
-
-/**
- * @typedef PlanChangeDetails
- * @property {string} [status]
- * @property {PlanChangeData} [data]
- */
-
-/**
- * @typedef TransactionMeta
- * @property {string} [invoice_id]
- */
-
-/**
- * @typedef PaymentTransactionDetails
- * @property {Object} [aggregator]
- * @property {string} [currency]
- * @property {string} [current_status]
- * @property {string} [_id]
- * @property {string} [subscriber_id]
- * @property {number} [amount]
- * @property {string} [entity_type]
- * @property {string} [collection_type]
- * @property {TransactionMeta} [meta]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- */
-
-/**
- * @typedef PaymentItems
- * @property {string} [name]
- * @property {string} [code]
- * @property {string} [aggregator]
- */
-
-/**
- * @typedef GetPaymentOptions
- * @property {PaymentItems[]} [payment_options]
- */
-
-/**
- * @typedef TopupReq
- * @property {number} [amount]
- * @property {string} [currency]
- * @property {string} [provider_type]
- */
-
-/**
- * @typedef SetupMandateReq
- * @property {string} [intent_id]
- * @property {string} [payment_method_id]
- */
-
-/**
- * @typedef SetupPaymentReq
- * @property {string} [payment_method]
- * @property {string} [payment_id]
- * @property {string} [plan_id]
- * @property {string} [invoice_id]
- */
-
-/**
- * @typedef SubscriptionRenewReq
- * @property {string} [invoice_id]
- * @property {string} [entity_type]
- * @property {string} [collection_type]
- * @property {string} [callback_url]
- * @property {RenewMeta} [meta]
- */
-
-/**
- * @typedef RenewMeta
- * @property {boolean} [invoice_payment]
- * @property {boolean} [renew]
- */
-
-/**
- * @typedef SubscriptionMethodsReq
- * @property {string} [unique_external_id]
- * @property {string} [setup_intent_id]
- * @property {string} [pg_payment_method_id]
- * @property {boolean} [set_default]
- */
-
-/**
- * @typedef CreditTransactionResponse
- * @property {number} [total] - Total number of transactions
- * @property {number} [limit] - Maximum number of transactions per page
- * @property {number} [page] - Current page number
- * @property {number} [pages] - Total number of pages
- * @property {CreditTransaction[]} [items]
- */
-
-/**
- * @typedef DowngradePlanReq
- * @property {string} [unique_id]
- * @property {string} [type]
- * @property {string} [product_suite]
- * @property {string} [plan_id]
- * @property {string} [reason]
- * @property {string} [platform]
- */
-
-/**
- * @typedef Taxation
- * @property {number} [gst] - GST percentage
- */
-
-/**
- * @typedef OneTimeFees
- * @property {number} [developement]
- * @property {number} [marketing]
- */
-
-/**
- * @typedef CreditLine
- * @property {boolean} [is_active]
- */
-
-/**
- * @typedef StatusMessage
- * @property {string} [status]
- * @property {string} [message]
- * @property {boolean} [success]
- * @property {string} [code]
- */
-
-/**
- * @typedef PaymentCollectReq
- * @property {string} [transaction_id]
- * @property {boolean} [credit_balance]
- * @property {string} [payment_mode]
- * @property {string} [payment_method]
- * @property {string} [invoice_id]
- */
-
-/**
- * @typedef SubscriptionRenewResMeta
- * @property {boolean} [invoice_payment]
- * @property {boolean} [renew]
- */
-
-/**
- * @typedef SubscriptionRenewRes
- * @property {string} [redirect_url]
- * @property {string} [transaction_id]
- * @property {string} [current_status]
- * @property {SubscriptionRenewResMeta} [meta]
- */
-
-/**
- * @typedef SetupIntentRes
- * @property {boolean} [success]
- * @property {SetupIntentData} [data]
- */
-
-/**
- * @typedef SetupIntentData
- * @property {string} [id]
- * @property {string} [client_secret]
- * @property {Object} [customer]
- * @property {string} [status]
- */
-
-/**
- * @typedef SetupPayment
- * @property {string} [id]
- * @property {string} [status]
- * @property {Object} [customer]
- * @property {string} [client_secret]
- * @property {string} [payment_method]
- * @property {string} [mandate]
- * @property {PaymentMethodOptions} [payment_method_options]
- */
-
-/**
- * @typedef PaymentMethodOptions
- * @property {Card} [card]
- */
-
-/**
- * @typedef Card
- * @property {MandateOptions} [mandate_options]
- */
-
-/**
- * @typedef MandateOptions
- * @property {number} [amount]
- */
-
-/**
- * @typedef Message
- * @property {string} [message]
- */
-
-/**
- * @typedef TopupRes
- * @property {string} [status]
- * @property {string} [aggregator_order_id]
- * @property {number} [amount]
- * @property {string} [currency]
- * @property {string} [transaction_id]
- */
-
-/**
- * @typedef CancelTopupReq
- * @property {string} [order_id]
- */
-
-/**
- * @typedef CancelTopupRes
- * @property {string} [_id]
- * @property {string} [subscriber_id]
- * @property {number} [amount]
- * @property {string} [currency]
- * @property {string} [aggregator]
- * @property {string} [aggregator_order_id]
- * @property {string} [created_at]
- * @property {string} [modified_at]
- * @property {number} [__v]
- * @property {string} [aggregator_status]
- * @property {string} [current_status]
- */
-
-/**
- * @typedef DefaultReq
- * @property {string} [payment_method_id]
- */
-
-class BillingPlatformModel {
-  /** @returns {CompanyInfo} */
-  static CompanyInfo() {
-    return Joi.object({
-      company_name: Joi.string().allow(""),
-      gstin: Joi.string().allow(""),
-      address: Joi.string().allow(""),
-      address_details: BillingPlatformModel.AddressDetails(),
-      pan: Joi.string().allow(""),
-      phone: Joi.string().allow(""),
-      email: Joi.string().allow(""),
-      cin: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {AddressDetails} */
-  static AddressDetails() {
-    return Joi.object({
-      address_line_1: Joi.string().allow(""),
-      address_line_2: Joi.string().allow(""),
-      city: Joi.string().allow(""),
-      pincode: Joi.string().allow(""),
-      state: Joi.string().allow(""),
-      country: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {InvoiceData} */
-  static InvoiceData() {
-    return Joi.object({
-      invoice: BillingPlatformModel.InvoiceDetailsData(),
-      invoice_items: Joi.array().items(BillingPlatformModel.InvoiceItems()),
-      shopsense_details: BillingPlatformModel.CompanyInfo(),
-    });
-  }
-
-  /** @returns {InvoiceDetailsData} */
-  static InvoiceDetailsData() {
-    return Joi.object({
-      attemp: Joi.number().allow(null),
-      documents: Joi.any(),
-      payment: Joi.any(),
-      period: BillingPlatformModel.Period(),
-      client: BillingPlatformModel.Client(),
-      discount: Joi.any(),
-      taxation: Joi.any(),
-      _id: Joi.string().allow(""),
-      auto_advance: Joi.boolean(),
-      collection_method: Joi.string().allow(""),
-      subscriber_id: Joi.string().allow(""),
-      currency: Joi.string().allow(""),
-      invoice_url: Joi.string().allow(""),
-      number: Joi.string().allow(""),
-      paid: Joi.boolean(),
-      pg_data: Joi.any(),
-      receipt_number: Joi.string().allow(""),
-      statement_descriptor: Joi.string().allow(""),
-      current_status: Joi.string().allow(""),
-      status_trail: Joi.array().items(BillingPlatformModel.StatusTrail()),
-      subtotal: Joi.number(),
-      total: Joi.number(),
-      old_settlement: Joi.number().allow(null),
-      credit_balance: Joi.number().allow(null),
-      subscription: Joi.string().allow(""),
-      attempt: Joi.number(),
-      next_action_time: Joi.string().allow(""),
-      credit_note_amount: Joi.number(),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {Client} */
-  static Client() {
-    return Joi.object({
-      name: Joi.string().allow(""),
-      email: Joi.string().allow(""),
-      phone: Joi.string().allow(""),
-      address_lines: Joi.array().items(Joi.string().allow("")),
-    });
-  }
-
-  /** @returns {Period} */
-  static Period() {
-    return Joi.object({
-      start: Joi.string().allow(""),
-      end: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {StatusTrail} */
-  static StatusTrail() {
-    return Joi.object({
-      value: Joi.string().allow(""),
-      timestamp: Joi.string().allow(""),
-      _id: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {PaymentCollectRes} */
-  static PaymentCollectRes() {
-    return Joi.object({
-      transaction_id: Joi.string().allow(""),
-      current_status: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SubscriptionChargeRes} */
-  static SubscriptionChargeRes() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      product_suit_id: Joi.string().allow(""),
-      entity_id: Joi.string().allow(""),
-      entity_type: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-      trial_days: Joi.number(),
-      activated_on: Joi.string().allow(""),
-      cancelled_on: Joi.string().allow(""),
-      is_test: Joi.boolean(),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-      company_id: Joi.string().allow(""),
-      line_items: Joi.array().items(Joi.any()),
-    });
-  }
-
-  /** @returns {PostDowngradeRes} */
-  static PostDowngradeRes() {
-    return Joi.object({
-      success: Joi.boolean(),
-      data: BillingPlatformModel.DowngradeRes(),
-    });
-  }
-
-  /** @returns {DowngradeRes} */
-  static DowngradeRes() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-      subscriber_id: Joi.string().allow(""),
-      activated: Joi.boolean(),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-      plan_id: Joi.string().allow(""),
-      reason: Joi.string().allow(""),
-      request_user_id: Joi.string().allow(""),
-      subscription_id: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {PaymentStatusData} */
-  static PaymentStatusData() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      journey: Joi.string().allow(""),
-      webhook_response: Joi.array().items(Joi.any()),
-      aggregator_status: Joi.string().allow(""),
-      current_status: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-      __v: Joi.number(),
-      aggregator_order_id: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {PaymentStatusResponse} */
-  static PaymentStatusResponse() {
-    return Joi.object({
-      status: Joi.string().allow(""),
-      data: BillingPlatformModel.PaymentStatusData(),
-    });
-  }
-
-  /** @returns {BadRequest} */
-  static BadRequest() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {ResourceNotFound} */
-  static ResourceNotFound() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-      code: Joi.any(),
-      success: Joi.any(),
-    });
-  }
-
-  /** @returns {InternalServerError} */
-  static InternalServerError() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-      code: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {CheckValidityResponse} */
-  static CheckValidityResponse() {
-    return Joi.object({
-      is_valid: Joi.boolean(),
-      discount_amount: Joi.number(),
-    });
-  }
-
-  /** @returns {PlanRecurring} */
-  static PlanRecurring() {
-    return Joi.object({
-      interval: Joi.string().allow(""),
-      interval_count: Joi.number(),
-    });
-  }
-
-  /** @returns {PlanMeta} */
-  static PlanMeta() {
-    return Joi.object({
-      seller_status: Joi.string().allow(""),
-      company: Joi.string().allow(""),
-      plan_platform_display_name: Joi.string().allow("").allow(null),
-    });
-  }
-
-  /** @returns {Plan} */
-  static Plan() {
-    return Joi.object({
-      fee_components: Joi.array().items(Joi.any()),
-      recurring: BillingPlatformModel.PlanRecurring(),
-      is_trial_plan: Joi.boolean(),
-      plan_group: Joi.string().allow(""),
-      tag_lines: Joi.array().items(Joi.string().allow("")),
-      currency: Joi.string().allow(""),
-      is_active: Joi.boolean(),
-      is_visible: Joi.boolean(),
-      trial_period: Joi.number(),
-      addons: Joi.array().items(Joi.string().allow("")),
-      tags: Joi.array().items(Joi.string().allow("")),
-      type: Joi.string().allow(""),
-      country: Joi.string().allow(""),
-      _id: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      description: Joi.string().allow(""),
-      amount: Joi.number(),
-      product_suite_id: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-      taxation: BillingPlatformModel.Taxation(),
-      one_time_fees: BillingPlatformModel.OneTimeFees(),
-      credit_line: BillingPlatformModel.CreditLine(),
-      current_status: Joi.string().allow(""),
-      channel_type: Joi.string().allow(""),
-      company_ids: Joi.array().items(Joi.any()),
-      platform: Joi.string().allow("").allow(null),
-      activated_on: Joi.string().allow(""),
-      meta: BillingPlatformModel.PlanMeta(),
-      created_by: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SubscriptionTrialPeriod} */
-  static SubscriptionTrialPeriod() {
-    return Joi.object({
-      start_date: Joi.string().allow(""),
-      end_date: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {EntityChargePrice} */
-  static EntityChargePrice() {
-    return Joi.object({
-      amount: Joi.number(),
-      currency_code: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {OneTimeChargeItem} */
-  static OneTimeChargeItem() {
-    return Joi.object({
-      name: Joi.string().allow(""),
-      term: Joi.string().allow(""),
-      pricing_type: Joi.string().allow(""),
-      price: BillingPlatformModel.EntityChargePrice(),
-      capped_amount: Joi.number(),
-      is_test: Joi.boolean(),
-      metadata: Joi.any(),
-    });
-  }
-
-  /** @returns {CreateOneTimeCharge} */
-  static CreateOneTimeCharge() {
-    return Joi.object({
-      name: Joi.string().allow(""),
-      charge: BillingPlatformModel.OneTimeChargeItem(),
-      is_test: Joi.boolean(),
-      return_url: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {ChargeRecurring} */
-  static ChargeRecurring() {
-    return Joi.object({
-      interval: Joi.string().allow(""),
-      interval_time: Joi.number(),
-    });
-  }
-
-  /** @returns {ChargeDetails} */
-  static ChargeDetails() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      entity_type: Joi.string().allow(""),
-      entity_id: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      term: Joi.string().allow(""),
-      charge_type: Joi.string().allow(""),
-      pricing_type: Joi.string().allow(""),
-      price: BillingPlatformModel.EntityChargePrice(),
-      recurring: BillingPlatformModel.ChargeRecurring(),
-      status: Joi.string().allow(""),
-      capped_amount: Joi.number(),
-      activated_on: Joi.string().allow(""),
-      cancelled_on: Joi.string().allow(""),
-      billing_date: Joi.string().allow(""),
-      current_period: BillingPlatformModel.SubscriptionTrialPeriod(),
-      modified_at: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      is_test: Joi.boolean(),
-      company_id: Joi.string().allow(""),
-      meta: Joi.any(),
-      __v: Joi.number(),
-    });
-  }
-
-  /** @returns {OneTimeChargeEntity} */
-  static OneTimeChargeEntity() {
-    return Joi.object({
-      term: Joi.string().allow(""),
-      charge_type: Joi.string().allow(""),
-      capped_amount: Joi.number(),
-      billing_date: Joi.string().allow("").allow(null),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-      __v: Joi.number(),
-      _id: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-      activated_on: Joi.string().allow("").allow(null),
-      cancelled_on: Joi.string().allow("").allow(null),
-      metadata: Joi.any(),
-      return_url: Joi.string().allow(""),
-      is_test: Joi.boolean(),
-      pricing_type: Joi.string().allow(""),
-      subscriber_id: Joi.string().allow(""),
-      entity_type: Joi.string().allow(""),
-      entity_id: Joi.string().allow(""),
-      meta: Joi.any(),
-      price: BillingPlatformModel.EntityChargePrice(),
-    });
-  }
-
-  /** @returns {CreateOneTimeChargeResponse} */
-  static CreateOneTimeChargeResponse() {
-    return Joi.object({
-      charge: BillingPlatformModel.Charge(),
-      confirm_url: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {Charge} */
-  static Charge() {
-    return Joi.object({
-      final_charge: BillingPlatformModel.OneTimeChargeEntity(),
-    });
-  }
-
-  /** @returns {InvoiceDetailsStatusTrail} */
-  static InvoiceDetailsStatusTrail() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      value: Joi.string().allow(""),
-      timestamp: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {InvoiceItemsPlanRecurring} */
-  static InvoiceItemsPlanRecurring() {
-    return Joi.object({
-      interval: Joi.string().allow(""),
-      interval_count: Joi.number(),
-    });
-  }
-
-  /** @returns {InvoiceItemsPlan} */
-  static InvoiceItemsPlan() {
-    return Joi.object({
-      recurring: BillingPlatformModel.InvoiceItemsPlanRecurring(),
-      is_trial_plan: Joi.boolean(),
-      plan_group: Joi.string().allow(""),
-      tag_lines: Joi.array().items(Joi.string().allow("")),
-      currency: Joi.string().allow(""),
-      is_active: Joi.boolean(),
-      is_visible: Joi.boolean(),
-      trial_period: Joi.number(),
-      addons: Joi.array().items(Joi.string().allow("")),
-      tags: Joi.array().items(Joi.string().allow("")),
-      type: Joi.string().allow(""),
-      country: Joi.string().allow(""),
-      _id: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      description: Joi.string().allow(""),
-      amount: Joi.number(),
-      product_suite_id: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {InvoiceItemsPeriod} */
-  static InvoiceItemsPeriod() {
-    return Joi.object({
-      start: Joi.string().allow(""),
-      end: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {InvoiceItems} */
-  static InvoiceItems() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      currency: Joi.string().allow(""),
-      plan: BillingPlatformModel.InvoiceItemsPlan(),
-      name: Joi.string().allow(""),
-      quantity: Joi.number(),
-      description: Joi.string().allow(""),
-      period: BillingPlatformModel.InvoiceItemsPeriod(),
-      unit_amount: Joi.number(),
-      amount: Joi.number(),
-      type: Joi.string().allow(""),
-      invoice_id: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {InvoicesDataClient} */
-  static InvoicesDataClient() {
-    return Joi.object({
-      name: Joi.string().allow(""),
-      email: Joi.string().allow(""),
-      phone: Joi.string().allow(""),
-      address_lines: Joi.array().items(Joi.string().allow("")),
-    });
-  }
-
-  /** @returns {InvoicesDataPeriod} */
-  static InvoicesDataPeriod() {
-    return Joi.object({
-      start: Joi.string().allow(""),
-      end: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {InvoicesDataPaymentMethod} */
-  static InvoicesDataPaymentMethod() {
-    return Joi.object({
-      pg_payment_method_id: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {InvoicesData} */
-  static InvoicesData() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      documents: Joi.any(),
-      payment: Joi.any(),
-      old_settlement: Joi.number().allow(null),
-      credit_balance: Joi.number().allow(null),
-      discount: Joi.any(),
-      taxation: Joi.any(),
-      credit_note_amount: Joi.number(),
-      client: BillingPlatformModel.InvoicesDataClient(),
-      auto_advance: Joi.boolean(),
-      currency: Joi.string().allow(""),
-      paid: Joi.boolean(),
-      attemp: Joi.number(),
-      collection_method: Joi.string().allow(""),
-      subscriber_id: Joi.string().allow(""),
-      invoice_url: Joi.string().allow(""),
-      number: Joi.string().allow(""),
-      pg_data: Joi.any(),
-      period: BillingPlatformModel.InvoicesDataPeriod(),
-      receipt_number: Joi.string().allow(""),
-      statement_descriptor: Joi.string().allow(""),
-      current_status: Joi.string().allow(""),
-      status_trail: Joi.array().items(
-        BillingPlatformModel.InvoiceDetailsStatusTrail()
-      ),
-      subtotal: Joi.number(),
-      total: Joi.number(),
-      subscription: Joi.string().allow(""),
-      next_action_time: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-      hash_identifier: Joi.string().allow(""),
-      payment_method: BillingPlatformModel.InvoicesDataPaymentMethod(),
-      invoice_items: Joi.array().items(BillingPlatformModel.InvoiceItems()),
-    });
-  }
-
-  /** @returns {Invoices} */
-  static Invoices() {
-    return Joi.object({
-      data: Joi.array().items(BillingPlatformModel.InvoicesData()),
-      start: Joi.number(),
-      end: Joi.number(),
-      limit: Joi.number(),
-      page: Joi.number(),
-      total: Joi.number(),
-    });
-  }
-
-  /** @returns {Phone} */
-  static Phone() {
-    return Joi.object({
-      phone_number: Joi.string().allow(""),
-      phone_country_code: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SubscriptionBillingAddress} */
-  static SubscriptionBillingAddress() {
-    return Joi.object({
-      country: Joi.string().allow(""),
-      state: Joi.string().allow(""),
-      city: Joi.string().allow(""),
-      line1: Joi.string().allow(""),
-      line2: Joi.string().allow(""),
-      postal_code: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SubscriptionCustomer} */
-  static SubscriptionCustomer() {
-    return Joi.object({
-      phone: BillingPlatformModel.Phone(),
-      billing_address: BillingPlatformModel.SubscriptionBillingAddress(),
-      _id: Joi.string().allow(""),
-      unique_id: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      email: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-      data: Joi.any(),
-      documents: Joi.any(),
-      consent: Joi.boolean(),
-      comms: Joi.boolean(),
-      credit_balance: Joi.number().allow(null),
-      business_country_info: BillingPlatformModel.BusinessCountryInfo(),
-    });
-  }
-
-  /** @returns {SubscriptionCustomerCreate} */
-  static SubscriptionCustomerCreate() {
-    return Joi.object({
-      phone: BillingPlatformModel.Phone(),
-      billing_address: BillingPlatformModel.SubscriptionBillingAddress(),
-      unique_id: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      email: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SubscriptionCurrentPeriod} */
-  static SubscriptionCurrentPeriod() {
-    return Joi.object({
-      start: Joi.string().allow(""),
-      end: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SubscriptionPauseCollection} */
-  static SubscriptionPauseCollection() {
-    return Joi.object({
-      behavior: Joi.string().allow(""),
-      resume_at: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SubscriptionTrial} */
-  static SubscriptionTrial() {
-    return Joi.object({
-      start: Joi.string().allow(""),
-      end: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SubscriptionInvoiceSettings} */
-  static SubscriptionInvoiceSettings() {
-    return Joi.object({
-      generation: Joi.boolean(),
-      charging: Joi.boolean(),
-    });
-  }
-
-  /** @returns {Subscription} */
-  static Subscription() {
-    return Joi.object({
-      meta: Joi.any(),
-      current_period: BillingPlatformModel.SubscriptionCurrentPeriod(),
-      pause_collection: BillingPlatformModel.SubscriptionPauseCollection(),
-      trial: BillingPlatformModel.SubscriptionTrial(),
-      invoice_settings: BillingPlatformModel.SubscriptionInvoiceSettings(),
-      is_active: Joi.boolean(),
-      cancel_at_period_end: Joi.boolean(),
-      _id: Joi.string().allow(""),
-      subscriber_id: Joi.string().allow(""),
-      plan_id: Joi.string().allow(""),
-      product_suite_id: Joi.string().allow(""),
-      plan_data: BillingPlatformModel.Plan(),
-      current_status: Joi.string().allow(""),
-      collection_method: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-      latest_invoice: Joi.string().allow(""),
-      channel_type: Joi.string().allow(""),
-      freezed: Joi.boolean(),
-      cancel_at: Joi.string().allow(""),
-      canceled_at: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SubscriptionStatus} */
-  static SubscriptionStatus() {
-    return Joi.object({
-      is_enabled: Joi.boolean(),
-      subscription: BillingPlatformModel.Subscription(),
-      latest_invoice: BillingPlatformModel.InvoicesData(),
-      next_plan: BillingPlatformModel.Plan(),
-      current_subscriptions: Joi.array().items(
-        BillingPlatformModel.Subscription()
-      ),
-      mandate_amount: Joi.number(),
-      message: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SubscriptionLimitApplication} */
-  static SubscriptionLimitApplication() {
-    return Joi.object({
-      enabled: Joi.boolean(),
-      hard_limit: Joi.number(),
-      soft_limit: Joi.number(),
-    });
-  }
-
-  /** @returns {SubscriptionLimitMarketplace} */
-  static SubscriptionLimitMarketplace() {
-    return Joi.object({
-      enabled: Joi.boolean(),
-    });
-  }
-
-  /** @returns {SubscriptionLimitOtherPlatform} */
-  static SubscriptionLimitOtherPlatform() {
-    return Joi.object({
-      enabled: Joi.boolean(),
-    });
-  }
-
-  /** @returns {SubscriptionLimitTeam} */
-  static SubscriptionLimitTeam() {
-    return Joi.object({
-      limit: Joi.number(),
-    });
-  }
-
-  /** @returns {SubscriptionLimitProducts} */
-  static SubscriptionLimitProducts() {
-    return Joi.object({
-      bulk: Joi.boolean(),
-      limit: Joi.number(),
-    });
-  }
-
-  /** @returns {SubscriptionLimitExtensions} */
-  static SubscriptionLimitExtensions() {
-    return Joi.object({
-      enabled: Joi.boolean(),
-      limit: Joi.number(),
-    });
-  }
-
-  /** @returns {SubscriptionLimitIntegrations} */
-  static SubscriptionLimitIntegrations() {
-    return Joi.object({
-      enabled: Joi.boolean(),
-      limit: Joi.number(),
-    });
-  }
-
-  /** @returns {SubscriptionLimit} */
-  static SubscriptionLimit() {
-    return Joi.object({
-      application: BillingPlatformModel.SubscriptionLimitApplication(),
-      marketplace: BillingPlatformModel.SubscriptionLimitMarketplace(),
-      other_platform: BillingPlatformModel.SubscriptionLimitOtherPlatform(),
-      team: BillingPlatformModel.SubscriptionLimitTeam(),
-      products: BillingPlatformModel.SubscriptionLimitProducts(),
-      extensions: BillingPlatformModel.SubscriptionLimitExtensions(),
-      integrations: BillingPlatformModel.SubscriptionLimitIntegrations(),
-      is_trial_plan: Joi.boolean(),
-    });
-  }
-
-  /** @returns {IntentReq} */
-  static IntentReq() {
-    return Joi.object({
-      unique_external_id: Joi.string().allow(""),
-      plan_id: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {PutIntentReq} */
-  static PutIntentReq() {
-    return Joi.object({
-      unique_external_id: Joi.string().allow(""),
-      setup_intent_id: Joi.string().allow(""),
-      payment_method_id: Joi.string().allow(""),
-      set_default: Joi.boolean(),
-    });
-  }
-
-  /** @returns {SubscriptionActivateReq} */
-  static SubscriptionActivateReq() {
-    return Joi.object({
-      unique_id: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-      product_suite: Joi.string().allow(""),
-      plan_id: Joi.string().allow(""),
-      payment_method: Joi.string().allow(""),
-      subscription_id: Joi.string().allow(""),
-      coupon: Joi.string().allow(""),
-      meta: Joi.any(),
-    });
-  }
-
-  /** @returns {SubscriptionActivateRes} */
-  static SubscriptionActivateRes() {
-    return Joi.object({
-      success: Joi.boolean(),
-      data: BillingPlatformModel.Subscription(),
-    });
-  }
-
-  /** @returns {CancelSubscriptionReq} */
-  static CancelSubscriptionReq() {
-    return Joi.object({
-      unique_id: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-      product_suite: Joi.string().allow(""),
-      subscription_id: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {CancelSubscriptionRes} */
-  static CancelSubscriptionRes() {
-    return Joi.object({
-      success: Joi.boolean(),
-      data: BillingPlatformModel.Subscription(),
-    });
-  }
-
-  /** @returns {PlanStatusUpdateReq} */
-  static PlanStatusUpdateReq() {
-    return Joi.object({
-      plan_id: Joi.string().allow(""),
-      reason: Joi.string().allow(""),
-      seller_status: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SunscribePlan} */
-  static SunscribePlan() {
-    return Joi.object({
-      entity_type: Joi.string().allow(""),
-      collection_type: Joi.string().allow(""),
-      plan_id: Joi.string().allow(""),
-      callback_url: Joi.string().allow(""),
-      meta: BillingPlatformModel.Meta(),
-    });
-  }
-
-  /** @returns {Meta} */
-  static Meta() {
-    return Joi.object({
-      subscribe: Joi.boolean(),
-      is_custom_plan: Joi.boolean(),
-      is_plan_upgrade: Joi.boolean(),
-    });
-  }
-
-  /** @returns {SubscribePlanRes} */
-  static SubscribePlanRes() {
-    return Joi.object({
-      redirect_url: Joi.string().allow(""),
-      transaction_id: Joi.string().allow(""),
-      current_status: Joi.string().allow(""),
-      meta: BillingPlatformModel.Meta(),
-    });
-  }
-
-  /** @returns {EntityDetail} */
-  static EntityDetail() {
-    return Joi.object({
-      entity: Joi.string().allow(""),
-      item: BillingPlatformModel.Subscription(),
-    });
-  }
-
-  /** @returns {PaymentOptions} */
-  static PaymentOptions() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      description: Joi.string().allow(""),
-      logo: Joi.string().allow(""),
-      aggregator_id: Joi.string().allow(""),
-      aggregator: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-      __v: Joi.number(),
-    });
-  }
-
-  /** @returns {VerifyPaymentReq} */
-  static VerifyPaymentReq() {
-    return Joi.object({
-      razorpay_payment_id: Joi.string().allow(""),
-      razorpay_order_id: Joi.string().allow(""),
-      razorpay_signature: Joi.string().allow(""),
-      status_code: Joi.number(),
-      provider_type: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {Documents} */
-  static Documents() {
-    return Joi.object({
-      pan: Joi.string().allow(""),
-      gst: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {BillingAddress} */
-  static BillingAddress() {
-    return Joi.object({
-      country: Joi.string().allow(""),
-      state: Joi.string().allow(""),
-      city: Joi.string().allow(""),
-      line1: Joi.string().allow(""),
-      line2: Joi.string().allow(""),
-      postal_code: Joi.string().allow(""),
-      country_code: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {Currency} */
-  static Currency() {
-    return Joi.object({
-      code: Joi.string().allow(""),
-      symbol: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {BusinessCountryInfo} */
-  static BusinessCountryInfo() {
-    return Joi.object({
-      country: Joi.string().allow(""),
-      country_code: Joi.string().allow(""),
-      currency: BillingPlatformModel.Currency(),
-      timezone: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SubscriberData} */
-  static SubscriberData() {
-    return Joi.object({
-      pg_user_exists: Joi.boolean(),
-      id: Joi.any(),
-      pg_customer_id: Joi.string().allow(""),
-      default_payment_method: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {Subscriber} */
-  static Subscriber() {
-    return Joi.object({
-      documents: BillingPlatformModel.Documents(),
-      phone: Joi.any(),
-      billing_address: BillingPlatformModel.BillingAddress(),
-      consent: Joi.boolean(),
-      comms: Joi.boolean(),
-      _id: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-      unique_id: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      email: Joi.string().allow(""),
-      business_country_info: BillingPlatformModel.BusinessCountryInfo(),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-      credit_balance: Joi.number().allow(null),
-      data: BillingPlatformModel.SubscriberData(),
-    });
-  }
-
-  /** @returns {Author} */
-  static Author() {
-    return Joi.object({
-      modified_by_details: Joi.any(),
-    });
-  }
-
-  /** @returns {EndingBalance} */
-  static EndingBalance() {
-    return Joi.object({
-      amount: Joi.number(),
-      old_entry_ref: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {PaymentData} */
-  static PaymentData() {
-    return Joi.object({
-      transaction_id: Joi.string().allow(""),
-      aggregator: Joi.string().allow(""),
-      aggregator_order_id: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {CreditTransaction} */
-  static CreditTransaction() {
-    return Joi.object({
-      entity: Joi.any(),
-      author: BillingPlatformModel.Author(),
-      _id: Joi.string().allow(""),
-      amount: Joi.number(),
-      currency: Joi.string().allow(""),
-      subscriber_id: Joi.string().allow(""),
-      description: Joi.string().allow(""),
-      is_test: Joi.any(),
-      ending_balance: BillingPlatformModel.EndingBalance(),
-      payment: BillingPlatformModel.PaymentData(),
-      type: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {VerifyPaymentData} */
-  static VerifyPaymentData() {
-    return Joi.object({
-      success: Joi.boolean(),
-      subscriber: BillingPlatformModel.Subscriber(),
-      credit_transaction: BillingPlatformModel.CreditTransaction(),
-    });
-  }
-
-  /** @returns {VerifyPaymentRes} */
-  static VerifyPaymentRes() {
-    return Joi.object({
-      status: Joi.string().allow(""),
-      data: BillingPlatformModel.VerifyPaymentData(),
-    });
-  }
-
-  /** @returns {DefaultMerchants} */
-  static DefaultMerchants() {
-    return Joi.object({
-      stripe: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {GlobalSettingsPayment} */
-  static GlobalSettingsPayment() {
-    return Joi.object({
-      default_merchants: BillingPlatformModel.DefaultMerchants(),
-    });
-  }
-
-  /** @returns {GlobalSettingsData} */
-  static GlobalSettingsData() {
-    return Joi.object({
-      payment: BillingPlatformModel.GlobalSettingsPayment(),
-      freeze_panel: Joi.boolean(),
-      _id: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {GlobalSettings} */
-  static GlobalSettings() {
-    return Joi.object({
-      status: Joi.string().allow(""),
-      data: BillingPlatformModel.GlobalSettingsData(),
-    });
-  }
-
-  /** @returns {MethodChecks} */
-  static MethodChecks() {
-    return Joi.object({
-      address_line1_check: Joi.string().allow(""),
-      address_postal_code_check: Joi.string().allow(""),
-      cvc_check: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {MethodNetworks} */
-  static MethodNetworks() {
-    return Joi.object({
-      available: Joi.array().items(Joi.string().allow("")),
-      preferred: Joi.string().allow("").allow(null),
-    });
-  }
-
-  /** @returns {MethodSecureUsage} */
-  static MethodSecureUsage() {
-    return Joi.object({
-      supported: Joi.boolean(),
-    });
-  }
+/**
+ * @typedef ChargeRecurring
+ * @property {string} [interval]
+ * @property {number} [interval_time]
+ */
 
-  /** @returns {MethodDetails} */
-  static MethodDetails() {
-    return Joi.object({
-      id: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-      mandate_available: Joi.boolean(),
-      mandate_amount: Joi.number(),
-      pg_payment_method_id: Joi.string().allow(""),
-      is_default: Joi.boolean(),
-      data: BillingPlatformModel.SubscriptionMethodData(),
-    });
-  }
+/**
+ * @typedef SubscriptionTrialPeriod
+ * @property {string} [start_date] - The start date and time of the trial period.
+ * @property {string} [end_date] - The end date and time of the trial period.
+ */
 
-  /** @returns {SubscriptionMethodData} */
-  static SubscriptionMethodData() {
-    return Joi.object({
-      brand: Joi.string().allow(""),
-      checks: BillingPlatformModel.MethodChecks(),
-      country: Joi.string().allow(""),
-      exp_month: Joi.number(),
-      exp_year: Joi.number(),
-      fingerprint: Joi.string().allow(""),
-      funding: Joi.string().allow(""),
-      generated_from: Joi.string().allow("").allow(null),
-      last4: Joi.string().allow(""),
-      networks: BillingPlatformModel.MethodNetworks(),
-      three_d_secure_usage: BillingPlatformModel.MethodSecureUsage(),
-      wallet: Joi.string().allow("").allow(null),
-      name: Joi.string().allow(""),
-      is_default: Joi.boolean(),
-    });
-  }
+/**
+ * @typedef Charge
+ * @property {OneTimeChargeEntity} [final_charge]
+ */
 
-  /** @returns {SubscriptionMethods} */
-  static SubscriptionMethods() {
-    return Joi.object({
-      success: Joi.boolean(),
-      data: Joi.array().items(BillingPlatformModel.MethodDetails()),
-    });
-  }
+/**
+ * @typedef OneTimeChargeItem
+ * @property {string} [name] - The name of the one-time charge item.
+ * @property {string} [term] - The term or description of the charge.
+ * @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.
+ * @property {Object} [metadata] - Additional metadata associated with the charge item.
+ */
 
-  /** @returns {ConfigPublicKey} */
-  static ConfigPublicKey() {
-    return Joi.object({
-      public_key: Joi.string().allow(""),
-    });
-  }
+/**
+ * @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]
+ */
 
-  /** @returns {ConfigRes} */
-  static ConfigRes() {
-    return Joi.object({
-      success: Joi.boolean(),
-      aggregator: Joi.string().allow(""),
-      config: BillingPlatformModel.ConfigPublicKey(),
-    });
-  }
+/**
+ * @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.
+ */
 
-  /** @returns {PlanChangeData} */
-  static PlanChangeData() {
-    return Joi.object({
-      total: Joi.number(),
-      credit_note_amount: Joi.number(),
-      settlement: Joi.number(),
-      taxable_amount: Joi.number(),
-      gst_amount: Joi.number(),
-      gross_total: Joi.number(),
-      gst: Joi.number(),
-      discount: Joi.number(),
-    });
-  }
+/**
+ * @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 {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} [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 {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 {Object} [meta] - Additional metadata associated with the charge.
+ * @property {EntityChargePrice} [price]
+ */
 
-  /** @returns {PlanChangeDetails} */
-  static PlanChangeDetails() {
-    return Joi.object({
-      status: Joi.string().allow(""),
-      data: BillingPlatformModel.PlanChangeData(),
-    });
-  }
+/**
+ * @typedef EntityChargeRecurring
+ * @property {string} interval - The interval of the subscription.
+ */
 
-  /** @returns {TransactionMeta} */
-  static TransactionMeta() {
-    return Joi.object({
-      invoice_id: Joi.string().allow(""),
-    });
-  }
+/**
+ * @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} [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.
+ */
 
-  /** @returns {PaymentTransactionDetails} */
-  static PaymentTransactionDetails() {
+class BillingPlatformModel {
+  /** @returns {SubscriptionChargeRes} */
+  static SubscriptionChargeRes() {
     return Joi.object({
-      aggregator: Joi.any(),
-      currency: Joi.string().allow(""),
-      current_status: Joi.string().allow(""),
       _id: Joi.string().allow(""),
-      subscriber_id: Joi.string().allow(""),
-      amount: Joi.number(),
+      product_suit_id: Joi.string().allow(""),
+      entity_id: Joi.string().allow(""),
       entity_type: Joi.string().allow(""),
-      collection_type: Joi.string().allow(""),
-      meta: BillingPlatformModel.TransactionMeta(),
+      name: Joi.string().allow(""),
+      status: Joi.string().allow(""),
+      trial_days: Joi.number(),
+      activated_on: Joi.string().allow(""),
+      cancelled_on: Joi.string().allow(""),
+      is_test: Joi.boolean(),
       created_at: Joi.string().allow(""),
       modified_at: Joi.string().allow(""),
+      company_id: Joi.string().allow(""),
+      line_items: Joi.array().items(Joi.any()),
     });
   }
 
-  /** @returns {PaymentItems} */
-  static PaymentItems() {
-    return Joi.object({
-      name: Joi.string().allow(""),
-      code: Joi.string().allow(""),
-      aggregator: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {GetPaymentOptions} */
-  static GetPaymentOptions() {
-    return Joi.object({
-      payment_options: Joi.array().items(BillingPlatformModel.PaymentItems()),
-    });
-  }
-
-  /** @returns {TopupReq} */
-  static TopupReq() {
-    return Joi.object({
-      amount: Joi.number(),
-      currency: Joi.string().allow(""),
-      provider_type: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SetupMandateReq} */
-  static SetupMandateReq() {
-    return Joi.object({
-      intent_id: Joi.string().allow(""),
-      payment_method_id: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SetupPaymentReq} */
-  static SetupPaymentReq() {
-    return Joi.object({
-      payment_method: Joi.string().allow(""),
-      payment_id: Joi.string().allow(""),
-      plan_id: Joi.string().allow(""),
-      invoice_id: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SubscriptionRenewReq} */
-  static SubscriptionRenewReq() {
+  /** @returns {ChargeDetails} */
+  static ChargeDetails() {
     return Joi.object({
-      invoice_id: Joi.string().allow(""),
+      _id: Joi.string().allow(""),
       entity_type: Joi.string().allow(""),
-      collection_type: Joi.string().allow(""),
-      callback_url: Joi.string().allow(""),
-      meta: BillingPlatformModel.RenewMeta(),
-    });
-  }
-
-  /** @returns {RenewMeta} */
-  static RenewMeta() {
-    return Joi.object({
-      invoice_payment: Joi.boolean(),
-      renew: Joi.boolean(),
-    });
-  }
-
-  /** @returns {SubscriptionMethodsReq} */
-  static SubscriptionMethodsReq() {
-    return Joi.object({
-      unique_external_id: Joi.string().allow(""),
-      setup_intent_id: Joi.string().allow(""),
-      pg_payment_method_id: Joi.string().allow(""),
-      set_default: Joi.boolean(),
-    });
-  }
-
-  /** @returns {CreditTransactionResponse} */
-  static CreditTransactionResponse() {
-    return Joi.object({
-      total: Joi.number(),
-      limit: Joi.number(),
-      page: Joi.number(),
-      pages: Joi.number(),
-      items: Joi.array().items(BillingPlatformModel.CreditTransaction()),
-    });
-  }
-
-  /** @returns {DowngradePlanReq} */
-  static DowngradePlanReq() {
-    return Joi.object({
-      unique_id: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-      product_suite: Joi.string().allow(""),
-      plan_id: Joi.string().allow(""),
-      reason: Joi.string().allow(""),
-      platform: Joi.string().allow("").allow(null),
+      entity_id: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      term: Joi.string().allow(""),
+      charge_type: Joi.string().allow(""),
+      pricing_type: Joi.string().allow(""),
+      price: BillingPlatformModel.EntityChargePrice(),
+      recurring: BillingPlatformModel.ChargeRecurring(),
+      status: Joi.string().allow(""),
+      capped_amount: Joi.number(),
+      activated_on: Joi.string().allow(""),
+      cancelled_on: Joi.string().allow(""),
+      billing_date: Joi.string().allow(""),
+      current_period: BillingPlatformModel.SubscriptionTrialPeriod(),
+      modified_at: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
+      is_test: Joi.boolean(),
+      company_id: Joi.string().allow(""),
+      meta: Joi.any(),
+      __v: Joi.number(),
     });
   }
 
-  /** @returns {Taxation} */
-  static Taxation() {
+  /** @returns {ResourceNotFound} */
+  static ResourceNotFound() {
     return Joi.object({
-      gst: Joi.number(),
+      message: Joi.string().allow(""),
+      code: Joi.any(),
+      success: Joi.any(),
     });
   }
 
-  /** @returns {OneTimeFees} */
-  static OneTimeFees() {
+  /** @returns {CreateOneTimeCharge} */
+  static CreateOneTimeCharge() {
     return Joi.object({
-      developement: Joi.number().allow(null),
-      marketing: Joi.number().allow(null),
+      name: Joi.string().allow(""),
+      charge: BillingPlatformModel.OneTimeChargeItem(),
+      is_test: Joi.boolean(),
+      return_url: Joi.string().allow(""),
     });
   }
 
-  /** @returns {CreditLine} */
-  static CreditLine() {
+  /** @returns {CreateOneTimeChargeResponse} */
+  static CreateOneTimeChargeResponse() {
     return Joi.object({
-      is_active: Joi.boolean(),
+      charge: BillingPlatformModel.Charge(),
+      confirm_url: Joi.string().allow(""),
     });
   }
 
-  /** @returns {StatusMessage} */
-  static StatusMessage() {
+  /** @returns {BadRequest} */
+  static BadRequest() {
     return Joi.object({
-      status: Joi.string().allow(""),
       message: Joi.string().allow(""),
-      success: Joi.boolean(),
-      code: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {PaymentCollectReq} */
-  static PaymentCollectReq() {
-    return Joi.object({
-      transaction_id: Joi.string().allow(""),
-      credit_balance: Joi.boolean().allow(null),
-      payment_mode: Joi.string().allow(""),
-      payment_method: Joi.string().allow(""),
-      invoice_id: Joi.string().allow(""),
     });
   }
 
-  /** @returns {SubscriptionRenewResMeta} */
-  static SubscriptionRenewResMeta() {
+  /** @returns {CreateSubscriptionCharge} */
+  static CreateSubscriptionCharge() {
     return Joi.object({
-      invoice_payment: Joi.boolean(),
-      renew: Joi.boolean(),
+      name: Joi.string().allow("").required(),
+      trial_days: Joi.number(),
+      line_items: Joi.array()
+        .items(BillingPlatformModel.ChargeLineItem())
+        .required(),
+      is_test: Joi.boolean(),
+      return_url: Joi.string().allow("").required(),
     });
   }
 
-  /** @returns {SubscriptionRenewRes} */
-  static SubscriptionRenewRes() {
+  /** @returns {CreateSubscriptionResponse} */
+  static CreateSubscriptionResponse() {
     return Joi.object({
-      redirect_url: Joi.string().allow(""),
-      transaction_id: Joi.string().allow(""),
-      current_status: Joi.string().allow(""),
-      meta: BillingPlatformModel.SubscriptionRenewResMeta(),
+      subscription: BillingPlatformModel.EntitySubscription(),
+      confirm_url: Joi.string().allow(""),
     });
   }
 
-  /** @returns {SetupIntentRes} */
-  static SetupIntentRes() {
+  /** @returns {EntityChargePrice} */
+  static EntityChargePrice() {
     return Joi.object({
-      success: Joi.boolean(),
-      data: BillingPlatformModel.SetupIntentData(),
+      amount: Joi.number(),
+      currency_code: Joi.string().allow(""),
     });
   }
 
-  /** @returns {SetupIntentData} */
-  static SetupIntentData() {
+  /** @returns {ChargeRecurring} */
+  static ChargeRecurring() {
     return Joi.object({
-      id: Joi.string().allow(""),
-      client_secret: Joi.string().allow(""),
-      customer: Joi.any(),
-      status: Joi.string().allow(""),
+      interval: Joi.string().allow(""),
+      interval_time: Joi.number(),
     });
   }
 
-  /** @returns {SetupPayment} */
-  static SetupPayment() {
+  /** @returns {SubscriptionTrialPeriod} */
+  static SubscriptionTrialPeriod() {
     return Joi.object({
-      id: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-      customer: Joi.any(),
-      client_secret: Joi.string().allow(""),
-      payment_method: Joi.string().allow(""),
-      mandate: Joi.string().allow(""),
-      payment_method_options: BillingPlatformModel.PaymentMethodOptions(),
+      start_date: Joi.string().allow(""),
+      end_date: Joi.string().allow(""),
     });
   }
 
-  /** @returns {PaymentMethodOptions} */
-  static PaymentMethodOptions() {
+  /** @returns {Charge} */
+  static Charge() {
     return Joi.object({
-      card: BillingPlatformModel.Card(),
+      final_charge: BillingPlatformModel.OneTimeChargeEntity(),
     });
   }
 
-  /** @returns {Card} */
-  static Card() {
+  /** @returns {OneTimeChargeItem} */
+  static OneTimeChargeItem() {
     return Joi.object({
-      mandate_options: BillingPlatformModel.MandateOptions(),
+      name: Joi.string().allow(""),
+      term: Joi.string().allow(""),
+      pricing_type: Joi.string().allow(""),
+      price: BillingPlatformModel.EntityChargePrice(),
+      capped_amount: Joi.number(),
+      is_test: Joi.boolean(),
+      metadata: Joi.any(),
     });
   }
 
-  /** @returns {MandateOptions} */
-  static MandateOptions() {
+  /** @returns {ChargeLineItem} */
+  static ChargeLineItem() {
     return Joi.object({
-      amount: Joi.number(),
+      name: Joi.string().allow("").required(),
+      term: Joi.string().allow("").required(),
+      pricing_type: Joi.string().allow("").required(),
+      price: BillingPlatformModel.EntityChargePrice().required(),
+      recurring: BillingPlatformModel.EntityChargeRecurring(),
+      capped_amount: Joi.number(),
+      trial_days: Joi.number(),
+      is_test: Joi.boolean(),
+      metadata: Joi.any(),
     });
   }
 
-  /** @returns {Message} */
-  static Message() {
+  /** @returns {EntitySubscription} */
+  static EntitySubscription() {
     return Joi.object({
-      message: Joi.string().allow(""),
+      _id: Joi.string().allow(""),
+      product_suit_id: Joi.string().allow(""),
+      entity_id: Joi.string().allow(""),
+      entity_type: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      status: Joi.string().allow(""),
+      trial_days: Joi.number(),
+      is_test: Joi.boolean(),
+      created_at: Joi.string().allow(""),
+      modified_at: Joi.string().allow(""),
+      subscriber_id: Joi.string().allow(""),
+      line_items: Joi.array().items(BillingPlatformModel.EntityChargeDetails()),
+      return_url: Joi.string().allow(""),
     });
   }
 
-  /** @returns {TopupRes} */
-  static TopupRes() {
+  /** @returns {OneTimeChargeEntity} */
+  static OneTimeChargeEntity() {
     return Joi.object({
+      term: Joi.string().allow(""),
+      charge_type: Joi.string().allow(""),
+      capped_amount: Joi.number(),
+      billing_date: Joi.string().allow("").allow(null),
+      created_at: Joi.string().allow(""),
+      modified_at: Joi.string().allow(""),
+      __v: Joi.number(),
+      _id: Joi.string().allow(""),
+      name: Joi.string().allow(""),
       status: Joi.string().allow(""),
-      aggregator_order_id: Joi.string().allow(""),
-      amount: Joi.number(),
-      currency: Joi.string().allow(""),
-      transaction_id: Joi.string().allow(""),
+      activated_on: Joi.string().allow("").allow(null),
+      cancelled_on: Joi.string().allow("").allow(null),
+      metadata: Joi.any(),
+      return_url: Joi.string().allow(""),
+      is_test: Joi.boolean(),
+      pricing_type: Joi.string().allow(""),
+      subscriber_id: Joi.string().allow(""),
+      entity_type: Joi.string().allow(""),
+      entity_id: Joi.string().allow(""),
+      meta: Joi.any(),
+      price: BillingPlatformModel.EntityChargePrice(),
     });
   }
 
-  /** @returns {CancelTopupReq} */
-  static CancelTopupReq() {
+  /** @returns {EntityChargeRecurring} */
+  static EntityChargeRecurring() {
     return Joi.object({
-      order_id: Joi.string().allow(""),
+      interval: Joi.string().allow("").required(),
     });
   }
 
-  /** @returns {CancelTopupRes} */
-  static CancelTopupRes() {
+  /** @returns {EntityChargeDetails} */
+  static EntityChargeDetails() {
     return Joi.object({
       _id: Joi.string().allow(""),
+      subscription_id: Joi.string().allow(""),
       subscriber_id: Joi.string().allow(""),
-      amount: Joi.number(),
-      currency: Joi.string().allow(""),
-      aggregator: Joi.string().allow(""),
-      aggregator_order_id: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
+      entity_type: Joi.string().allow(""),
+      entity_id: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      term: Joi.string().allow(""),
+      charge_type: Joi.string().allow(""),
+      pricing_type: Joi.string().allow(""),
+      price: BillingPlatformModel.EntityChargePrice(),
+      recurring: BillingPlatformModel.ChargeRecurring(),
+      status: Joi.string().allow(""),
+      capped_amount: Joi.number(),
+      activated_on: Joi.string().allow("").allow(null),
+      cancelled_on: Joi.string().allow("").allow(null),
+      billing_date: Joi.string().allow("").allow(null),
+      current_period: BillingPlatformModel.SubscriptionTrialPeriod(),
       modified_at: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
+      is_test: Joi.boolean(),
+      company_id: Joi.string().allow(""),
+      meta: Joi.any(),
       __v: Joi.number(),
-      aggregator_status: Joi.string().allow(""),
-      current_status: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {DefaultReq} */
-  static DefaultReq() {
-    return Joi.object({
-      payment_method_id: Joi.string().allow(""),
     });
   }
 }